Packages

case class SecurityContext(allowPrivilegeEscalation: Optional[Boolean] = Optional.Absent, capabilities: Optional[Capabilities] = Optional.Absent, privileged: Optional[Boolean] = Optional.Absent, procMount: Optional[String] = Optional.Absent, readOnlyRootFilesystem: Optional[Boolean] = Optional.Absent, runAsGroup: Optional[Long] = Optional.Absent, runAsNonRoot: Optional[Boolean] = Optional.Absent, runAsUser: Optional[Long] = Optional.Absent, seLinuxOptions: Optional[SELinuxOptions] = Optional.Absent, seccompProfile: Optional[SeccompProfile] = Optional.Absent, windowsOptions: Optional[WindowsSecurityContextOptions] = Optional.Absent) extends Product with Serializable

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

allowPrivilegeEscalation

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.

procMount

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.

runAsGroup

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SecurityContext
  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 SecurityContext(allowPrivilegeEscalation: Optional[Boolean] = Optional.Absent, capabilities: Optional[Capabilities] = Optional.Absent, privileged: Optional[Boolean] = Optional.Absent, procMount: Optional[String] = Optional.Absent, readOnlyRootFilesystem: Optional[Boolean] = Optional.Absent, runAsGroup: Optional[Long] = Optional.Absent, runAsNonRoot: Optional[Boolean] = Optional.Absent, runAsUser: Optional[Long] = Optional.Absent, seLinuxOptions: Optional[SELinuxOptions] = Optional.Absent, seccompProfile: Optional[SeccompProfile] = Optional.Absent, windowsOptions: Optional[WindowsSecurityContextOptions] = Optional.Absent)

    allowPrivilegeEscalation

    AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

    privileged

    Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.

    procMount

    procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

    readOnlyRootFilesystem

    Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.

    runAsGroup

    The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    runAsNonRoot

    Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    runAsUser

    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

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 allowPrivilegeEscalation: Optional[Boolean]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val capabilities: Optional[Capabilities]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def getAllowPrivilegeEscalation: IO[K8sFailure, Boolean]

    AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process.

    AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

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

  10. def getCapabilities: IO[K8sFailure, Capabilities]

    Gets capabilities.

    Gets capabilities.

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

  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def getPrivileged: IO[K8sFailure, Boolean]

    Run container in privileged mode.

    Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.

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

  13. def getProcMount: IO[K8sFailure, String]

    procMount denotes the type of proc mount to use for the containers.

    procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

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

  14. def getReadOnlyRootFilesystem: IO[K8sFailure, Boolean]

    Whether this container has a read-only root filesystem.

    Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.

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

  15. def getRunAsGroup: IO[K8sFailure, Long]

    The GID to run the entrypoint of the container process.

    The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

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

  16. def getRunAsNonRoot: IO[K8sFailure, Boolean]

    Indicates that the container must run as a non-root user.

    Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

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

  17. def getRunAsUser: IO[K8sFailure, Long]

    The UID to run the entrypoint of the container process.

    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

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

  18. def getSeLinuxOptions: IO[K8sFailure, SELinuxOptions]

    Gets seLinuxOptions.

    Gets seLinuxOptions.

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

  19. def getSeccompProfile: IO[K8sFailure, SeccompProfile]

    Gets seccompProfile.

    Gets seccompProfile.

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

  20. def getWindowsOptions: IO[K8sFailure, WindowsSecurityContextOptions]

    Gets windowsOptions.

    Gets windowsOptions.

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

  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. val privileged: Optional[Boolean]
  26. val procMount: Optional[String]
  27. val readOnlyRootFilesystem: Optional[Boolean]
  28. val runAsGroup: Optional[Long]
  29. val runAsNonRoot: Optional[Boolean]
  30. val runAsUser: Optional[Long]
  31. val seLinuxOptions: Optional[SELinuxOptions]
  32. val seccompProfile: Optional[SeccompProfile]
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. val windowsOptions: Optional[WindowsSecurityContextOptions]

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