ContainerV1
Classsealednet10.0
Represents a container configuration for a Kubernetes pod.
namespace Aspire.Hosting.Kubernetes.Resources;
public sealed class ContainerV1{ // ...}25 members
Remarks
Section titled Remarks This class defines the properties and behaviors of a container in a Kubernetes deployment. It supports detailed customization, including environmental variables, volume mounts, lifecycle management, probes, and security context settings.
Constructors1
Section titled ConstructorsProperties24
Section titled PropertiesArgsgetList<string> Represents the arguments to pass to the container's entrypoint. These arguments are added after the container's `command` property. If `command` is specified, these arguments are passed exactly as provided; otherwise, they are appended to the container's default entrypoint command.
CommandgetList<string> Gets the command to be executed by the container. Represents an optional list of strings that overrides the default entrypoint of the container's image. Each string in the list corresponds to a command line argument.
Envget Represents a list of environment variables defined for the container. These environment variables can be used within the container during runtime.
EnvFromget Represents a list of environment variable sources for the container. Each item allows referencing a ConfigMap or Secret to populate environment variables within the container. Environment variables defined from these sources can include an optional prefix.
Imageget; setstring Gets or sets the Docker image name for the container. Represents the image to be used in the container, including the repository name, image name, and optional tag.
ImagePullPolicyget; setstring Specifies the image pull policy for the container. Determines when the container's image should be pulled from the repository. Common values are "Always", "IfNotPresent", and "Never". The default value is "IfNotPresent", which means the image will only be pulled if it is not present locally.
Lifecycleget; set Gets or sets the lifecycle definition for the container, specifying actions to take in response to container lifecycle events, such as `PostStart` and `PreStop`.
LivenessProbeget; set Represents the liveness probe configuration for a container. This probe is used to determine if the container is still running and healthy. If the liveness probe fails, the container is restarted. The probe can be configured to use different mechanisms, including: - Executing a specific command inside the container. - Performing an HTTP GET request to a specified endpoint. - Performing a gRPC health check request to a specified service. The probe supports additional parameters such as timeouts, failure thresholds, and retry intervals to ensure flexible and reliable health checks.
Nameget; setstring Gets or sets the name of the container. This property represents the unique name assigned to the container within the pod's definition in a Kubernetes deployment.
Portsget Represents a collection of ports exposed by the container and associated configurations.
ReadinessProbeget; set Defines the readiness probe configuration for a container. The readiness probe determines whether the container is ready to accept network traffic. A container passing its readiness probe is considered healthy and capable of serving network requests. This property accepts an instance of
ProbeV1, enabling you to configure the specific checks, such as HTTP GET, command execution, or GRPC, to assess the readiness state. ResizePolicyget Specifies the resize policies associated with a container in a Kubernetes environment.
Resourcesget; set Represents the resource requirements for a container, including memory and CPU limits and requests. The Resources property allows specifying the compute resources needed for container execution.
RestartPolicyget; setstring? Defines the restart policy for the container. This property indicates how the container should behave when it terminates. Possible values include "Always", "OnFailure", and "Never", which dictate if the container should be restarted unconditionally, only on failure, or not restarted at all, respectively.
StartupProbeget; set Gets or sets the startup probe configuration for the container. This probe is used to determine whether the application within the container has started successfully. The startup probe is executed to check the operational state of the application before the container is marked as ready, ensuring it can handle traffic before proceeding with normal operations.
Stdinget; setbool? Gets or sets a value that determines whether the container's standard input (stdin) stream is kept open. This allows the container to receive input through the stdin stream after the application inside the container starts running.
StdinOnceget; setbool? Gets or sets a value indicating whether the container's standard input (stdin) will be provided only once. When set to true, the container's stdin will remain open until the first read, after which it will be closed. Defaults to null, which indicates the property is not explicitly set.
TerminationMessagePathget; setstring? Specifies the path where the termination message of the container will be written. This property allows the container to provide additional information about its termination, such as error messages or exit codes. If configured, the message written to this path will be retrievable by the container manager or monitoring systems.
TerminationMessagePolicyget; setstring? Gets or sets the policy for capturing the termination message for the container. Defines how termination messages should be created and made available to the container. Possible values may include 'File' or 'FallbackToLogsOnError'. A 'File' policy captures the termination message from a specific file inside the container, while 'FallbackToLogsOnError' captures logs if the message file is inaccessible or unavailable.
Ttyget; setbool? Gets or sets a value indicating whether a TTY (teletypewriter) is allocated for the container. When set to true, a TTY is allocated, enabling interactive command execution. It is typically used for containers that require a terminal-like interaction.
Represents a collection of VolumeDeviceV1 objects that describe mappings of raw block devices within a container.
VolumeMountsget Represents a collection of volume mounts for the container. Each volume mount specifies how a volume will be mounted and accessed within the container.
Aspire