Packages

case class Container(args: Optional[Vector[String]] = Optional.Absent, command: Optional[Vector[String]] = Optional.Absent, env: Optional[Vector[EnvVar]] = Optional.Absent, envFrom: Optional[Vector[EnvFromSource]] = Optional.Absent, image: Optional[String] = Optional.Absent, imagePullPolicy: Optional[String] = Optional.Absent, lifecycle: Optional[Lifecycle] = Optional.Absent, livenessProbe: Optional[Probe] = Optional.Absent, name: String, ports: Optional[Vector[ContainerPort]] = Optional.Absent, readinessProbe: Optional[Probe] = Optional.Absent, resources: Optional[ResourceRequirements] = Optional.Absent, securityContext: Optional[SecurityContext] = Optional.Absent, startupProbe: Optional[Probe] = Optional.Absent, stdin: Optional[Boolean] = Optional.Absent, stdinOnce: Optional[Boolean] = Optional.Absent, terminationMessagePath: Optional[String] = Optional.Absent, terminationMessagePolicy: Optional[String] = Optional.Absent, tty: Optional[Boolean] = Optional.Absent, volumeDevices: Optional[Vector[VolumeDevice]] = Optional.Absent, volumeMounts: Optional[Vector[VolumeMount]] = Optional.Absent, workingDir: Optional[String] = Optional.Absent) extends Product with Serializable

A single application container that you want to run within a pod.

args

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

command

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

env

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

envFrom

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.

image

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.

imagePullPolicy

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

name

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

ports

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.

stdin

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.

stdinOnce

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

terminationMessagePath

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.

terminationMessagePolicy

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.

tty

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

volumeDevices

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

volumeMounts

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

workingDir

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Container
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Container(args: Optional[Vector[String]] = Optional.Absent, command: Optional[Vector[String]] = Optional.Absent, env: Optional[Vector[EnvVar]] = Optional.Absent, envFrom: Optional[Vector[EnvFromSource]] = Optional.Absent, image: Optional[String] = Optional.Absent, imagePullPolicy: Optional[String] = Optional.Absent, lifecycle: Optional[Lifecycle] = Optional.Absent, livenessProbe: Optional[Probe] = Optional.Absent, name: String, ports: Optional[Vector[ContainerPort]] = Optional.Absent, readinessProbe: Optional[Probe] = Optional.Absent, resources: Optional[ResourceRequirements] = Optional.Absent, securityContext: Optional[SecurityContext] = Optional.Absent, startupProbe: Optional[Probe] = Optional.Absent, stdin: Optional[Boolean] = Optional.Absent, stdinOnce: Optional[Boolean] = Optional.Absent, terminationMessagePath: Optional[String] = Optional.Absent, terminationMessagePolicy: Optional[String] = Optional.Absent, tty: Optional[Boolean] = Optional.Absent, volumeDevices: Optional[Vector[VolumeDevice]] = Optional.Absent, volumeMounts: Optional[Vector[VolumeMount]] = Optional.Absent, workingDir: Optional[String] = Optional.Absent)

    args

    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

    command

    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

    env

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

    envFrom

    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.

    image

    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.

    imagePullPolicy

    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

    name

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

    ports

    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.

    stdin

    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.

    stdinOnce

    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

    terminationMessagePath

    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.

    terminationMessagePolicy

    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.

    tty

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

    volumeDevices

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

    volumeMounts

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

    workingDir

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val args: Optional[Vector[String]]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. val command: Optional[Vector[String]]
  8. val env: Optional[Vector[EnvVar]]
  9. val envFrom: Optional[Vector[EnvFromSource]]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def getArgs: IO[K8sFailure, Vector[String]]

    Arguments to the entrypoint.

    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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def getCommand: IO[K8sFailure, Vector[String]]

    Entrypoint array.

    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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  14. def getEnv: IO[K8sFailure, Vector[EnvVar]]

    List of environment variables to set in the container.

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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  15. def getEnvFrom: IO[K8sFailure, Vector[EnvFromSource]]

    List of sources to populate environment variables in the container.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  16. def getImage: IO[K8sFailure, String]

    Docker image name.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  17. def getImagePullPolicy: IO[K8sFailure, String]

    Image pull policy.

    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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  18. def getLifecycle: IO[K8sFailure, Lifecycle]

    Gets lifecycle.

    Gets lifecycle.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  19. def getLivenessProbe: IO[K8sFailure, Probe]

    Gets livenessProbe.

    Gets livenessProbe.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  20. def getName: IO[K8sFailure, String]

    Name of the container specified as a DNS_LABEL.

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

    This effect always succeeds, it is safe to use the field name directly.

  21. def getPorts: IO[K8sFailure, Vector[ContainerPort]]

    List of ports to expose from the container.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  22. def getReadinessProbe: IO[K8sFailure, Probe]

    Gets readinessProbe.

    Gets readinessProbe.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  23. def getResources: IO[K8sFailure, ResourceRequirements]

    Gets resources.

    Gets resources.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  24. def getSecurityContext: IO[K8sFailure, SecurityContext]

    Gets securityContext.

    Gets securityContext.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  25. def getStartupProbe: IO[K8sFailure, Probe]

    Gets startupProbe.

    Gets startupProbe.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  26. def getStdin: IO[K8sFailure, Boolean]

    Whether this container should allocate a buffer for stdin in the container runtime.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  27. def getStdinOnce: IO[K8sFailure, Boolean]

    Whether the container runtime should close the stdin channel after it has been opened by a single attach.

    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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  28. def getTerminationMessagePath: IO[K8sFailure, String]

    Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  29. def getTerminationMessagePolicy: IO[K8sFailure, String]

    Indicate how the termination message should be populated.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  30. def getTty: IO[K8sFailure, Boolean]

    Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.

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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  31. def getVolumeDevices: IO[K8sFailure, Vector[VolumeDevice]]

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

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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  32. def getVolumeMounts: IO[K8sFailure, Vector[VolumeMount]]

    Pod volumes to mount into the container's filesystem.

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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  33. def getWorkingDir: IO[K8sFailure, String]

    Container's working directory.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  34. val image: Optional[String]
  35. val imagePullPolicy: Optional[String]
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. val lifecycle: Optional[Lifecycle]
  38. val livenessProbe: Optional[Probe]
  39. val name: String
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. val ports: Optional[Vector[ContainerPort]]
  44. val readinessProbe: Optional[Probe]
  45. val resources: Optional[ResourceRequirements]
  46. val securityContext: Optional[SecurityContext]
  47. val startupProbe: Optional[Probe]
  48. val stdin: Optional[Boolean]
  49. val stdinOnce: Optional[Boolean]
  50. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  51. val terminationMessagePath: Optional[String]
  52. val terminationMessagePolicy: Optional[String]
  53. val tty: Optional[Boolean]
  54. val volumeDevices: Optional[Vector[VolumeDevice]]
  55. val volumeMounts: Optional[Vector[VolumeMount]]
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. val workingDir: Optional[String]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped