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.
- Alphabetic
- By Inheritance
- SecurityContext
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
- val allowPrivilegeEscalation: Optional[Boolean]
- val capabilities: Optional[Capabilities]
-
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.
-
def
getCapabilities: IO[K8sFailure, Capabilities]
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.
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
def
getSeLinuxOptions: IO[K8sFailure, SELinuxOptions]
Gets seLinuxOptions.
Gets seLinuxOptions.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getSeccompProfile: IO[K8sFailure, SeccompProfile]
Gets seccompProfile.
Gets seccompProfile.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getWindowsOptions: IO[K8sFailure, WindowsSecurityContextOptions]
Gets windowsOptions.
Gets windowsOptions.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
- val privileged: Optional[Boolean]
- val procMount: Optional[String]
- val readOnlyRootFilesystem: Optional[Boolean]
- val runAsGroup: Optional[Long]
- val runAsNonRoot: Optional[Boolean]
- val runAsUser: Optional[Long]
- val seLinuxOptions: Optional[SELinuxOptions]
- val seccompProfile: Optional[SeccompProfile]
- val windowsOptions: Optional[WindowsSecurityContextOptions]