Packages

case class VolumeMount(mountPath: String, mountPropagation: Optional[String] = Optional.Absent, name: String, readOnly: Optional[Boolean] = Optional.Absent, subPath: Optional[String] = Optional.Absent, subPathExpr: Optional[String] = Optional.Absent) extends Product with Serializable

VolumeMount describes a mounting of a Volume within a container.

mountPath

Path within the container at which the volume should be mounted. Must not contain ':'.

mountPropagation

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

name

This must match the Name of a Volume.

readOnly

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

subPath

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

subPathExpr

Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $$(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VolumeMount
  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 VolumeMount(mountPath: String, mountPropagation: Optional[String] = Optional.Absent, name: String, readOnly: Optional[Boolean] = Optional.Absent, subPath: Optional[String] = Optional.Absent, subPathExpr: Optional[String] = Optional.Absent)

    mountPath

    Path within the container at which the volume should be mounted. Must not contain ':'.

    mountPropagation

    mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

    name

    This must match the Name of a Volume.

    readOnly

    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

    subPath

    Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

    subPathExpr

    Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $$(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

Value Members

  1. def getMountPath: IO[K8sFailure, String]

    Path within the container at which the volume should be mounted.

    Path within the container at which the volume should be mounted. Must not contain ':'.

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

  2. def getMountPropagation: IO[K8sFailure, String]

    mountPropagation determines how mounts are propagated from the host to container and the other way around.

    mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

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

  3. def getName: IO[K8sFailure, String]

    This must match the Name of a Volume.

    This must match the Name of a Volume.

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

  4. def getReadOnly: IO[K8sFailure, Boolean]

    Mounted read-only if true, read-write otherwise (false or unspecified).

    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

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

  5. def getSubPath: IO[K8sFailure, String]

    Path within the volume from which the container's volume should be mounted.

    Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

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

  6. def getSubPathExpr: IO[K8sFailure, String]

    Expanded path within the volume from which the container's volume should be mounted.

    Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $$(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

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

  7. val mountPath: String
  8. val mountPropagation: Optional[String]
  9. val name: String
  10. val readOnly: Optional[Boolean]
  11. val subPath: Optional[String]
  12. val subPathExpr: Optional[String]