Package org.cdk8s.plus23.k8s

Interface PodSecurityContext

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    PodSecurityContext.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.69.0 (build f656c31)",
           date="2022-10-15T03:08:35.612Z")
@Stability(Stable)
public interface PodSecurityContext
extends software.amazon.jsii.JsiiSerializable
    PodSecurityContext holds pod-level security attributes and common container settings.

    Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

    • Method Detail

      • getFsGroup

        @Stability(Stable)
@Nullable
default Number getFsGroup()
        A special supplemental group that applies to all containers in a pod.

        Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:

        1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----

        If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

      • getFsGroupChangePolicy

        @Stability(Stable)
@Nullable
default String getFsGroupChangePolicy()
        fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod.

        This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. 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 SecurityContext. 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. 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 the containers in this pod.

        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 all containers.

        If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

      • getSupplementalGroups

        @Stability(Stable)
@Nullable
default List<Number> getSupplementalGroups()
        A list of groups applied to the first process run in each container, in addition to the container's primary GID.

        If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows.

      • getSysctls

        @Stability(Stable)
@Nullable
default List<Sysctl> getSysctls()
        Sysctls hold a list of namespaced sysctls used for the pod.

        Pods with unsupported sysctls (by the container runtime) might fail to launch. 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 within a container's SecurityContext 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.