SecurityContext class

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

SecurityContext({bool? allowPrivilegeEscalation, Capabilities? capabilities, bool? privileged, String? procMount, bool? readOnlyRootFilesystem, int? runAsGroup, bool? runAsNonRoot, int? runAsUser, SELinuxOptions? seLinuxOptions, SeccompProfile? seccompProfile, WindowsSecurityContextOptions? windowsOptions})

Default constructor.

const

SecurityContext.fromJson(Map<String, dynamic> json)

Creates a SecurityContext from JSON data.

factory

Properties

allowPrivilegeEscalation → bool?

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.

final

capabilities → Capabilities?

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.

final

hashCode → int

The hash code for this object.

no setter, inherited

privileged → bool?

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.

final

procMount → 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. Note that this field cannot be set when spec.os.name is windows.

final

readOnlyRootFilesystem → bool?

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.

final

runAsGroup → int?

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.

final

runAsNonRoot → bool?

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.

final

runAsUser → int?

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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

seccompProfile → SeccompProfile?

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.

final

seLinuxOptions → SELinuxOptions?

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.

final

windowsOptions → WindowsSecurityContextOptions?

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.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object>

Converts a SecurityContext instance to JSON data.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited