SecurityContext

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

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.

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.

Value Params
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

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

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.

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

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.

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.

Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

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

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

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

Gets capabilities.

Gets capabilities.

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

def getPrivileged: IO[K8sFailure, Boolean]

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

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

def getProcMount: IO[K8sFailure, String]

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.

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.

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

Whether this container has a read-only root filesystem. Default is false.

Whether this container has a read-only root filesystem. Default is false.

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

def getRunAsGroup: IO[K8sFailure, Long]

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.

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.

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

def getRunAsNonRoot: IO[K8sFailure, Boolean]

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.

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.

def getRunAsUser: IO[K8sFailure, Long]

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.

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.

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

Gets seLinuxOptions.

Gets seLinuxOptions.

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

Gets seccompProfile.

Gets seccompProfile.

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

Gets windowsOptions.

Gets windowsOptions.

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

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product