SecurityContext

data class SecurityContext(val allowPrivilegeEscalation: Boolean? = null, val appArmorProfile: AppArmorProfile? = null, val capabilities: Capabilities? = null, val privileged: Boolean? = null, val procMount: String? = null, val readOnlyRootFilesystem: Boolean? = null, val runAsGroup: Int? = null, val runAsNonRoot: Boolean? = null, val runAsUser: Int? = null, val seLinuxOptions: SELinuxOptions? = null, val seccompProfile: SeccompProfile? = null, val windowsOptions: WindowsSecurityContextOptions? = null)

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.

Constructors

Link copied to clipboard
constructor(allowPrivilegeEscalation: Boolean? = null, appArmorProfile: AppArmorProfile? = null, capabilities: Capabilities? = null, privileged: Boolean? = null, procMount: String? = null, readOnlyRootFilesystem: Boolean? = null, runAsGroup: Int? = null, runAsNonRoot: Boolean? = null, runAsUser: Int? = null, seLinuxOptions: SELinuxOptions? = null, seccompProfile: SeccompProfile? = null, windowsOptions: WindowsSecurityContextOptions? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

Link copied to clipboard

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Link copied to clipboard
val privileged: Boolean? = null

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.

Link copied to clipboard
val procMount: String? = null

procMount denotes the type of proc mount to use for the containers. The default value is Default 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.

Link copied to clipboard

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.

Link copied to clipboard
val runAsGroup: Int? = null

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.

Link copied to clipboard
val runAsNonRoot: Boolean? = null

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.

Link copied to clipboard
val runAsUser: Int? = null

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.

Link copied to clipboard

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

Link copied to clipboard

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. 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.

Link copied to clipboard

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. 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 linux.