PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.
object
Property | Type | Description |
---|---|---|
|
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
|
|
|
PodSecurityPolicySpec defines the policy enforced. |
PodSecurityPolicySpec defines the policy enforced.
object
seLinux
runAsUser
supplementalGroups
fsGroup
Property | Type | Description |
---|---|---|
|
|
allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. |
|
|
allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author’s discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities. |
|
|
allowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field. |
|
|
AllowedFlexVolume represents a single Flexvolume that is allowed to be used. |
|
|
allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used. |
|
|
AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined. |
|
|
allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. Examples: e.g. "foo/" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc. |
|
|
defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list. |
|
|
defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. |
|
|
forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. Examples: e.g. "foo/" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc. |
|
|
FSGroupStrategyOptions defines the strategy type and options used to create the strategy. |
|
|
hostIPC determines if the policy allows the use of HostIPC in the pod spec. |
|
|
hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. |
|
|
hostPID determines if the policy allows the use of HostPID in the pod spec. |
|
|
hostPorts determines which host port ranges are allowed to be exposed. |
|
|
HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined. |
|
|
privileged determines if a pod can request to be run as privileged. |
|
|
readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to. |
|
|
requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. |
|
|
RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. |
|
|
SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. |
|
|
SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. |
|
|
volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '*'. |
allowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field.
array
AllowedFlexVolume represents a single Flexvolume that is allowed to be used.
object
driver
Property | Type | Description |
---|---|---|
|
|
driver is the name of the Flexvolume driver. |
allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used.
array
AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.
object
Property | Type | Description |
---|---|---|
|
|
pathPrefix is the path prefix that the host volume must match. It does not support Examples: |
|
|
when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly. |
FSGroupStrategyOptions defines the strategy type and options used to create the strategy.
object
Property | Type | Description |
---|---|---|
|
|
ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs. |
|
|
IDRange provides a min/max of an allowed range of IDs. |
|
|
rule is the strategy that will dictate what FSGroup is used in the SecurityContext. |
ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs.
array
IDRange provides a min/max of an allowed range of IDs.
object
min
max
Property | Type | Description |
---|---|---|
|
|
max is the end of the range, inclusive. |
|
|
min is the start of the range, inclusive. |
hostPorts determines which host port ranges are allowed to be exposed.
array
HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined.
object
min
max
Property | Type | Description |
---|---|---|
|
|
max is the end of the range, inclusive. |
|
|
min is the start of the range, inclusive. |
RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.
object
rule
Property | Type | Description |
---|---|---|
|
|
ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs. |
|
|
IDRange provides a min/max of an allowed range of IDs. |
|
|
rule is the strategy that will dictate the allowable RunAsUser values that may be set. |
ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs.
array
IDRange provides a min/max of an allowed range of IDs.
object
min
max
Property | Type | Description |
---|---|---|
|
|
max is the end of the range, inclusive. |
|
|
min is the start of the range, inclusive. |
SELinuxStrategyOptions defines the strategy type and any options used to create the strategy.
object
rule
Property | Type | Description |
---|---|---|
|
|
rule is the strategy that will dictate the allowable labels that may be set. |
|
seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.
object
Property | Type | Description |
---|---|---|
|
|
ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs. |
|
|
IDRange provides a min/max of an allowed range of IDs. |
|
|
rule is the strategy that will dictate what supplemental groups is used in the SecurityContext. |
ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs.
array
IDRange provides a min/max of an allowed range of IDs.
object
min
max
Property | Type | Description |
---|---|---|
|
|
max is the end of the range, inclusive. |
|
|
min is the start of the range, inclusive. |
The following API endpoints are available:
/apis/policy/v1beta1/podsecuritypolicies
DELETE
: delete collection of PodSecurityPolicy
GET
: list or watch objects of kind PodSecurityPolicy
POST
: create a PodSecurityPolicy
/apis/policy/v1beta1/podsecuritypolicies/{name}
DELETE
: delete a PodSecurityPolicy
GET
: read the specified PodSecurityPolicy
PATCH
: partially update the specified PodSecurityPolicy
PUT
: replace the specified PodSecurityPolicy
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
DELETE
delete collection of PodSecurityPolicy
Parameter | Type | Description |
---|---|---|
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
If true, partially initialized resources are included in the response. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
list or watch objects of kind PodSecurityPolicy
Parameter | Type | Description |
---|---|---|
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
If true, partially initialized resources are included in the response. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
POST
create a PodSecurityPolicy
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the PodSecurityPolicy |
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
DELETE
delete a PodSecurityPolicy
Parameter | Type | Description |
---|---|---|
|
|
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
|
|
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
|
|
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
read the specified PodSecurityPolicy
Parameter | Type | Description |
---|---|---|
|
|
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
|
|
Should this value be exported. Export strips fields that a user can not specify. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified PodSecurityPolicy
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace the specified PodSecurityPolicy
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |