Package io.kubernetes.client.openapi.models

Class V1PodSecurityContext

java.lang.Object
io.kubernetes.client.openapi.models.V1PodSecurityContext
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-02-12T23:08:31.638427Z[Etc/UTC]") public class V1PodSecurityContext extends Object
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.

  • Field Details

  • Constructor Details

    • V1PodSecurityContext

      public V1PodSecurityContext()

  • Method Details

    • appArmorProfile

      public V1PodSecurityContext appArmorProfile(V1AppArmorProfile appArmorProfile)

    • getAppArmorProfile

      @Nullable public V1AppArmorProfile getAppArmorProfile()
      Get appArmorProfile
      Returns:
      appArmorProfile

    • setAppArmorProfile

      public void setAppArmorProfile(V1AppArmorProfile appArmorProfile)

    • fsGroup

      public V1PodSecurityContext fsGroup(Long fsGroup)

    • getFsGroup

      @Nullable public Long 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.
      Returns:
      fsGroup

    • setFsGroup

      public void setFsGroup(Long fsGroup)

    • fsGroupChangePolicy

      public V1PodSecurityContext fsGroupChangePolicy(String fsGroupChangePolicy)

    • getFsGroupChangePolicy

      @Nullable public 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.
      Returns:
      fsGroupChangePolicy

    • setFsGroupChangePolicy

      public void setFsGroupChangePolicy(String fsGroupChangePolicy)

    • runAsGroup

      public V1PodSecurityContext runAsGroup(Long runAsGroup)

    • getRunAsGroup

      @Nullable public Long 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.
      Returns:
      runAsGroup

    • setRunAsGroup

      public void setRunAsGroup(Long runAsGroup)

    • runAsNonRoot

      public V1PodSecurityContext runAsNonRoot(Boolean runAsNonRoot)

    • getRunAsNonRoot

      @Nullable public 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.
      Returns:
      runAsNonRoot

    • setRunAsNonRoot

      public void setRunAsNonRoot(Boolean runAsNonRoot)

    • runAsUser

      public V1PodSecurityContext runAsUser(Long runAsUser)

    • getRunAsUser

      @Nullable public Long 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.
      Returns:
      runAsUser

    • setRunAsUser

      public void setRunAsUser(Long runAsUser)

    • seLinuxChangePolicy

      public V1PodSecurityContext seLinuxChangePolicy(String seLinuxChangePolicy)

    • getSeLinuxChangePolicy

      @Nullable public String getSeLinuxChangePolicy()
      seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are \"MountOption\" and \"Recursive\". \"Recursive\" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node. \"MountOption\" mounts all eligible Pod volumes with `-o context` mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. \"MountOption\" value is allowed only when SELinuxMount feature gate is enabled. If not specified and SELinuxMount feature gate is enabled, \"MountOption\" is used. If not specified and SELinuxMount feature gate is disabled, \"MountOption\" is used for ReadWriteOncePod volumes and \"Recursive\" for all other volumes. This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers. All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows.
      Returns:
      seLinuxChangePolicy

    • setSeLinuxChangePolicy

      public void setSeLinuxChangePolicy(String seLinuxChangePolicy)

    • seLinuxOptions

      public V1PodSecurityContext seLinuxOptions(V1SELinuxOptions seLinuxOptions)

    • getSeLinuxOptions

      @Nullable public V1SELinuxOptions getSeLinuxOptions()
      Get seLinuxOptions
      Returns:
      seLinuxOptions

    • setSeLinuxOptions

      public void setSeLinuxOptions(V1SELinuxOptions seLinuxOptions)

    • seccompProfile

      public V1PodSecurityContext seccompProfile(V1SeccompProfile seccompProfile)

    • getSeccompProfile

      @Nullable public V1SeccompProfile getSeccompProfile()
      Get seccompProfile
      Returns:
      seccompProfile

    • setSeccompProfile

      public void setSeccompProfile(V1SeccompProfile seccompProfile)

    • supplementalGroups

      public V1PodSecurityContext supplementalGroups(List<Long> supplementalGroups)

    • addSupplementalGroupsItem

      public V1PodSecurityContext addSupplementalGroupsItem(Long supplementalGroupsItem)

    • getSupplementalGroups

      @Nullable public List<Long> getSupplementalGroups()
      A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows.
      Returns:
      supplementalGroups

    • setSupplementalGroups

      public void setSupplementalGroups(List<Long> supplementalGroups)

    • supplementalGroupsPolicy

      public V1PodSecurityContext supplementalGroupsPolicy(String supplementalGroupsPolicy)

    • getSupplementalGroupsPolicy

      @Nullable public String getSupplementalGroupsPolicy()
      Defines how supplemental groups of the first container processes are calculated. Valid values are \"Merge\" and \"Strict\". If not specified, \"Merge\" is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows.
      Returns:
      supplementalGroupsPolicy

    • setSupplementalGroupsPolicy

      public void setSupplementalGroupsPolicy(String supplementalGroupsPolicy)

    • sysctls

      public V1PodSecurityContext sysctls(List<V1Sysctl> sysctls)

    • addSysctlsItem

      public V1PodSecurityContext addSysctlsItem(V1Sysctl sysctlsItem)

    • getSysctls

      @Nullable public List<V1Sysctl> 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.
      Returns:
      sysctls

    • setSysctls

      public void setSysctls(List<V1Sysctl> sysctls)

    • windowsOptions

      public V1PodSecurityContext windowsOptions(V1WindowsSecurityContextOptions windowsOptions)

    • getWindowsOptions

      @Nullable public V1WindowsSecurityContextOptions getWindowsOptions()
      Get windowsOptions
      Returns:
      windowsOptions

    • setWindowsOptions

      public void setWindowsOptions(V1WindowsSecurityContextOptions windowsOptions)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object