Show / Hide Table of Contents

Class V1PodSecurityContext

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.

Inheritance
object
V1PodSecurityContext
Implements
IEquatable<V1PodSecurityContext>
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1PodSecurityContext : IEquatable<V1PodSecurityContext>

Constructors

View Source

V1PodSecurityContext()

Declaration
public V1PodSecurityContext()
View Source

V1PodSecurityContext(V1PodSecurityContext)

Declaration
protected V1PodSecurityContext(V1PodSecurityContext original)
Parameters
Type Name Description
V1PodSecurityContext original

Properties

View Source

AppArmorProfile

appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Declaration
[JsonPropertyName("appArmorProfile")]
public V1AppArmorProfile AppArmorProfile { get; set; }
Property Value
Type Description
V1AppArmorProfile
View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

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.

Declaration
[JsonPropertyName("fsGroup")]
public long? FsGroup { get; set; }
Property Value
Type Description
long?
View Source

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.

Declaration
[JsonPropertyName("fsGroupChangePolicy")]
public string FsGroupChangePolicy { get; set; }
Property Value
Type Description
string
View Source

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.

Declaration
[JsonPropertyName("runAsGroup")]
public long? RunAsGroup { get; set; }
Property Value
Type Description
long?
View Source

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.

Declaration
[JsonPropertyName("runAsNonRoot")]
public bool? RunAsNonRoot { get; set; }
Property Value
Type Description
bool?
View Source

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.

Declaration
[JsonPropertyName("runAsUser")]
public long? RunAsUser { get; set; }
Property Value
Type Description
long?
View Source

SeLinuxChangePolicy

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.

Declaration
[JsonPropertyName("seLinuxChangePolicy")]
public string SeLinuxChangePolicy { get; set; }
Property Value
Type Description
string
View Source

SeLinuxOptions

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.

Declaration
[JsonPropertyName("seLinuxOptions")]
public V1SELinuxOptions SeLinuxOptions { get; set; }
Property Value
Type Description
V1SELinuxOptions
View Source

SeccompProfile

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Declaration
[JsonPropertyName("seccompProfile")]
public V1SeccompProfile SeccompProfile { get; set; }
Property Value
Type Description
V1SeccompProfile
View Source

SupplementalGroups

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.

Declaration
[JsonPropertyName("supplementalGroups")]
public IList<long?> SupplementalGroups { get; set; }
Property Value
Type Description
IList<long?>
View Source

SupplementalGroupsPolicy

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.

Declaration
[JsonPropertyName("supplementalGroupsPolicy")]
public string SupplementalGroupsPolicy { get; set; }
Property Value
Type Description
string
View Source

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.

Declaration
[JsonPropertyName("sysctls")]
public IList<V1Sysctl> Sysctls { get; set; }
Property Value
Type Description
IList<V1Sysctl>
View Source

WindowsOptions

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.

Declaration
[JsonPropertyName("windowsOptions")]
public V1WindowsSecurityContextOptions WindowsOptions { get; set; }
Property Value
Type Description
V1WindowsSecurityContextOptions

Methods

View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)
View Source

Equals(V1PodSecurityContext?)

Declaration
public virtual bool Equals(V1PodSecurityContext? other)
Parameters
Type Name Description
V1PodSecurityContext other
Returns
Type Description
bool
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Operators

View Source

operator ==(V1PodSecurityContext?, V1PodSecurityContext?)

Declaration
public static bool operator ==(V1PodSecurityContext? left, V1PodSecurityContext? right)
Parameters
Type Name Description
V1PodSecurityContext left
V1PodSecurityContext right
Returns
Type Description
bool
View Source

operator !=(V1PodSecurityContext?, V1PodSecurityContext?)

Declaration
public static bool operator !=(V1PodSecurityContext? left, V1PodSecurityContext? right)
Parameters
Type Name Description
V1PodSecurityContext left
V1PodSecurityContext right
Returns
Type Description
bool

Implements

IEquatable<T>
  • View Source
In this article
Back to top Generated by DocFX