Package org.cdk8s.plus24.k8s

Interface SecurityContext

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    SecurityContext.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.80.0 (build bce6a1d)",
           date="2023-05-05T16:22:34.260Z")
@Stability(Stable)
public interface SecurityContext
extends software.amazon.jsii.JsiiSerializable
    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.

    • Method Detail

      • getAllowPrivilegeEscalation

        @Stability(Stable)
@Nullable
default Boolean getAllowPrivilegeEscalation()
        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.

      • getCapabilities

        @Stability(Stable)
@Nullable
default Capabilities getCapabilities()
        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.

        Default: the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

      • getPrivileged

        @Stability(Stable)
@Nullable
default Boolean getPrivileged()
        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.

        Default: false. Note that this field cannot be set when spec.os.name is windows.

      • getProcMount

        @Stability(Stable)
@Nullable
default String getProcMount()
        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.

      • getReadOnlyRootFilesystem

        @Stability(Stable)
@Nullable
default Boolean getReadOnlyRootFilesystem()
        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.

        Default: false. Note that this field cannot be set when spec.os.name is windows.

      • getRunAsGroup

        @Stability(Stable)
@Nullable
default Number getRunAsGroup()
        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.

      • getRunAsNonRoot

        @Stability(Stable)
@Nullable
default Boolean getRunAsNonRoot()
        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.

      • getRunAsUser

        @Stability(Stable)
@Nullable
default Number getRunAsUser()
        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.

        Default: 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.

      • getSeccompProfile

        @Stability(Stable)
@Nullable
default SeccompProfile getSeccompProfile()
        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.

      • getSeLinuxOptions

        @Stability(Stable)
@Nullable
default SeLinuxOptions getSeLinuxOptions()
        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.

      • getWindowsOptions

        @Stability(Stable)
@Nullable
default WindowsSecurityContextOptions getWindowsOptions()
        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.