Package io.micronaut.kubernetes.client.openapi.model

Class V1PodSecurityContext

java.lang.Object
io.micronaut.kubernetes.client.openapi.model.V1PodSecurityContext
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen") 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

    • getAppArmorProfile

      public V1AppArmorProfile getAppArmorProfile()
      Returns:
      the appArmorProfile property value

    • setAppArmorProfile

      public void setAppArmorProfile(V1AppArmorProfile appArmorProfile)
      Set the appArmorProfile property value
      Parameters:
      appArmorProfile - property value to set

    • appArmorProfile

      public V1PodSecurityContext appArmorProfile(V1AppArmorProfile appArmorProfile)
      Set appArmorProfile in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getFsGroup

      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:
      the fsGroup property value

    • setFsGroup

      public void setFsGroup(Long fsGroup)
      Set the fsGroup property value
      Parameters:
      fsGroup - property value to set

    • fsGroup

      public V1PodSecurityContext fsGroup(Long fsGroup)
      Set fsGroup in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getFsGroupChangePolicy

      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:
      the fsGroupChangePolicy property value

    • setFsGroupChangePolicy

      public void setFsGroupChangePolicy(String fsGroupChangePolicy)
      Set the fsGroupChangePolicy property value
      Parameters:
      fsGroupChangePolicy - property value to set

    • fsGroupChangePolicy

      public V1PodSecurityContext fsGroupChangePolicy(String fsGroupChangePolicy)
      Set fsGroupChangePolicy in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getRunAsGroup

      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:
      the runAsGroup property value

    • setRunAsGroup

      public void setRunAsGroup(Long runAsGroup)
      Set the runAsGroup property value
      Parameters:
      runAsGroup - property value to set

    • runAsGroup

      public V1PodSecurityContext runAsGroup(Long runAsGroup)
      Set runAsGroup in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getRunAsNonRoot

      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:
      the runAsNonRoot property value

    • setRunAsNonRoot

      public void setRunAsNonRoot(Boolean runAsNonRoot)
      Set the runAsNonRoot property value
      Parameters:
      runAsNonRoot - property value to set

    • runAsNonRoot

      public V1PodSecurityContext runAsNonRoot(Boolean runAsNonRoot)
      Set runAsNonRoot in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getRunAsUser

      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:
      the runAsUser property value

    • setRunAsUser

      public void setRunAsUser(Long runAsUser)
      Set the runAsUser property value
      Parameters:
      runAsUser - property value to set

    • runAsUser

      public V1PodSecurityContext runAsUser(Long runAsUser)
      Set runAsUser in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getSeLinuxChangePolicy

      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:
      the seLinuxChangePolicy property value

    • setSeLinuxChangePolicy

      public void setSeLinuxChangePolicy(String seLinuxChangePolicy)
      Set the seLinuxChangePolicy property value
      Parameters:
      seLinuxChangePolicy - property value to set

    • seLinuxChangePolicy

      public V1PodSecurityContext seLinuxChangePolicy(String seLinuxChangePolicy)
      Set seLinuxChangePolicy in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getSeLinuxOptions

      public V1SELinuxOptions getSeLinuxOptions()
      Returns:
      the seLinuxOptions property value

    • setSeLinuxOptions

      public void setSeLinuxOptions(V1SELinuxOptions seLinuxOptions)
      Set the seLinuxOptions property value
      Parameters:
      seLinuxOptions - property value to set

    • seLinuxOptions

      public V1PodSecurityContext seLinuxOptions(V1SELinuxOptions seLinuxOptions)
      Set seLinuxOptions in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getSeccompProfile

      public V1SeccompProfile getSeccompProfile()
      Returns:
      the seccompProfile property value

    • setSeccompProfile

      public void setSeccompProfile(V1SeccompProfile seccompProfile)
      Set the seccompProfile property value
      Parameters:
      seccompProfile - property value to set

    • seccompProfile

      public V1PodSecurityContext seccompProfile(V1SeccompProfile seccompProfile)
      Set seccompProfile in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getSupplementalGroups

      public List<@NotNull 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:
      the supplementalGroups property value

    • setSupplementalGroups

      public void setSupplementalGroups(List<@NotNull Long> supplementalGroups)
      Set the supplementalGroups property value
      Parameters:
      supplementalGroups - property value to set

    • supplementalGroups

      public V1PodSecurityContext supplementalGroups(List<@NotNull Long> supplementalGroups)
      Set supplementalGroups in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • addSupplementalGroupsItem

      public V1PodSecurityContext addSupplementalGroupsItem(Long supplementalGroupsItem)
      Add an item to the supplementalGroups property in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getSupplementalGroupsPolicy

      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:
      the supplementalGroupsPolicy property value

    • setSupplementalGroupsPolicy

      public void setSupplementalGroupsPolicy(String supplementalGroupsPolicy)
      Set the supplementalGroupsPolicy property value
      Parameters:
      supplementalGroupsPolicy - property value to set

    • supplementalGroupsPolicy

      public V1PodSecurityContext supplementalGroupsPolicy(String supplementalGroupsPolicy)
      Set supplementalGroupsPolicy in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getSysctls

      public List<@Valid 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:
      the sysctls property value

    • setSysctls

      public void setSysctls(List<@Valid V1Sysctl> sysctls)
      Set the sysctls property value
      Parameters:
      sysctls - property value to set

    • sysctls

      public V1PodSecurityContext sysctls(List<@Valid V1Sysctl> sysctls)
      Set sysctls in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • addSysctlsItem

      public V1PodSecurityContext addSysctlsItem(V1Sysctl sysctlsItem)
      Add an item to the sysctls property in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • getWindowsOptions

      public V1WindowsSecurityContextOptions getWindowsOptions()
      Returns:
      the windowsOptions property value

    • setWindowsOptions

      public void setWindowsOptions(V1WindowsSecurityContextOptions windowsOptions)
      Set the windowsOptions property value
      Parameters:
      windowsOptions - property value to set

    • windowsOptions

      public V1PodSecurityContext windowsOptions(V1WindowsSecurityContextOptions windowsOptions)
      Set windowsOptions in a chainable fashion.
      Returns:
      The same instance of V1PodSecurityContext for chaining.

    • 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