Packages

case class PodSecurityContext(fsGroup: Optional[Long] = Optional.Absent, fsGroupChangePolicy: Optional[String] = Optional.Absent, runAsGroup: Optional[Long] = Optional.Absent, runAsNonRoot: Optional[Boolean] = Optional.Absent, runAsUser: Optional[Long] = Optional.Absent, seLinuxOptions: Optional[SELinuxOptions] = Optional.Absent, seccompProfile: Optional[SeccompProfile] = Optional.Absent, supplementalGroups: Optional[Vector[Long]] = Optional.Absent, sysctls: Optional[Vector[Sysctl]] = Optional.Absent, windowsOptions: Optional[WindowsSecurityContextOptions] = Optional.Absent) extends Product with Serializable

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.

fsGroup

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.

fsGroupChangePolicy

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.

runAsGroup

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.

runAsNonRoot

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.

runAsUser

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.

supplementalGroups

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.

sysctls

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PodSecurityContext
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PodSecurityContext(fsGroup: Optional[Long] = Optional.Absent, fsGroupChangePolicy: Optional[String] = Optional.Absent, runAsGroup: Optional[Long] = Optional.Absent, runAsNonRoot: Optional[Boolean] = Optional.Absent, runAsUser: Optional[Long] = Optional.Absent, seLinuxOptions: Optional[SELinuxOptions] = Optional.Absent, seccompProfile: Optional[SeccompProfile] = Optional.Absent, supplementalGroups: Optional[Vector[Long]] = Optional.Absent, sysctls: Optional[Vector[Sysctl]] = Optional.Absent, windowsOptions: Optional[WindowsSecurityContextOptions] = Optional.Absent)

    fsGroup

    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.

    fsGroupChangePolicy

    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.

    runAsGroup

    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.

    runAsNonRoot

    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.

    runAsUser

    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.

    supplementalGroups

    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.

    sysctls

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val fsGroup: Optional[Long]
  8. val fsGroupChangePolicy: Optional[String]
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def getFsGroup: IO[K8sFailure, Long]

    A special supplemental group that applies to all containers in a pod.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  11. def getFsGroupChangePolicy: IO[K8sFailure, String]

    fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  12. def getRunAsGroup: IO[K8sFailure, Long]

    The GID to run the entrypoint of the container process.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  13. def getRunAsNonRoot: IO[K8sFailure, Boolean]

    Indicates that the container must run as a non-root user.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  14. def getRunAsUser: IO[K8sFailure, Long]

    The UID to run the entrypoint of the container process.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  15. def getSeLinuxOptions: IO[K8sFailure, SELinuxOptions]

    Gets seLinuxOptions.

    Gets seLinuxOptions.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  16. def getSeccompProfile: IO[K8sFailure, SeccompProfile]

    Gets seccompProfile.

    Gets seccompProfile.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  17. def getSupplementalGroups: IO[K8sFailure, Vector[Long]]

    A list of groups applied to the first process run in each container, in addition to the container's primary GID.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  18. def getSysctls: IO[K8sFailure, Vector[Sysctl]]

    Sysctls hold a list of namespaced sysctls used for the pod.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  19. def getWindowsOptions: IO[K8sFailure, WindowsSecurityContextOptions]

    Gets windowsOptions.

    Gets windowsOptions.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. val runAsGroup: Optional[Long]
  25. val runAsNonRoot: Optional[Boolean]
  26. val runAsUser: Optional[Long]
  27. val seLinuxOptions: Optional[SELinuxOptions]
  28. val seccompProfile: Optional[SeccompProfile]
  29. val supplementalGroups: Optional[Vector[Long]]
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. val sysctls: Optional[Vector[Sysctl]]
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. val windowsOptions: Optional[WindowsSecurityContextOptions]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped