Struct IoK8sApiCoreV1ContainerBuilder

pub struct IoK8sApiCoreV1ContainerBuilder { /* private fields */ }

Builder for IoK8sApiCoreV1Container.

Implementations

impl IoK8sApiCoreV1ContainerBuilder

pub fn args(&mut self, value: Vec<String>) -> &mut Self

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

pub fn command(&mut self, value: Vec<String>) -> &mut Self

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

pub fn env(&mut self, value: Vec<IoK8sApiCoreV1EnvVar>) -> &mut Self

List of environment variables to set in the container. Cannot be updated.

pub fn env_from(&mut self, value: Vec<IoK8sApiCoreV1EnvFromSource>) -> &mut Self

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

pub fn image(&mut self, value: String) -> &mut Self

Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

pub fn image_pull_policy( &mut self, value: Option<IoK8sApiCoreV1ContainerImagePullPolicy>, ) -> &mut Self

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

Possible enum values:

• "Always" means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
• "IfNotPresent" means that kubelet pulls if the image isn’t present on disk. Container will fail if the image isn’t present and the pull fails.
• "Never" means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn’t present

pub fn lifecycle(&mut self, value: Option<IoK8sApiCoreV1Lifecycle>) -> &mut Self

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

pub fn liveness_probe( &mut self, value: Option<IoK8sApiCoreV1Probe>, ) -> &mut Self

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

pub fn name(&mut self, value: Option<String>) -> &mut Self

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

pub fn ports(&mut self, value: Vec<IoK8sApiCoreV1ContainerPort>) -> &mut Self

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Cannot be updated.

pub fn readiness_probe( &mut self, value: Option<IoK8sApiCoreV1Probe>, ) -> &mut Self

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

pub fn resources( &mut self, value: Option<IoK8sApiCoreV1ResourceRequirements>, ) -> &mut Self

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

pub fn security_context( &mut self, value: Option<IoK8sApiCoreV1SecurityContext>, ) -> &mut Self

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

pub fn startup_probe(&mut self, value: Option<IoK8sApiCoreV1Probe>) -> &mut Self

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

pub fn stdin(&mut self, value: Option<bool>) -> &mut Self

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

pub fn stdin_once(&mut self, value: Option<bool>) -> &mut Self

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

pub fn termination_message_path(&mut self, value: Option<String>) -> &mut Self

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

pub fn termination_message_policy( &mut self, value: Option<IoK8sApiCoreV1ContainerTerminationMessagePolicy>, ) -> &mut Self

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

Possible enum values:

• "FallbackToLogsOnError" will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents.
• "File" is the default behavior and will set the container status message to the contents of the container’s terminationMessagePath when the container exits.

pub fn tty(&mut self, value: Option<bool>) -> &mut Self

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

pub fn volume_devices( &mut self, value: Vec<IoK8sApiCoreV1VolumeDevice>, ) -> &mut Self

volumeDevices is the list of block devices to be used by the container.

pub fn volume_mounts( &mut self, value: Vec<IoK8sApiCoreV1VolumeMount>, ) -> &mut Self

Pod volumes to mount into the container’s filesystem. Cannot be updated.

pub fn working_dir(&mut self, value: Option<String>) -> &mut Self

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

pub fn build( &self, ) -> Result<IoK8sApiCoreV1Container, IoK8sApiCoreV1ContainerBuilderError>

Builds a new IoK8sApiCoreV1Container.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for IoK8sApiCoreV1ContainerBuilder

fn clone(&self) -> IoK8sApiCoreV1ContainerBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for IoK8sApiCoreV1ContainerBuilder

fn default() -> Self

Returns the “default value” for a type.