This is a cache of https://docs.openshift.com/container-platform/3.11/rest_api/policy/podsecuritypolicy-policy-v1beta1.html. It is a snapshot of the page at 2024-11-27T02:23:04.564+0000.
PodS<strong>e</strong>curityPolicy [policy/v1b<strong>e</strong>ta1] - policy | API r<strong>e</strong>f<strong>e</strong>r<strong>e</strong>nc<strong>e</strong> | Op<strong>e</strong>nShift Contain<strong>e</strong>r Platform 3.11
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
&times;

PodSecurityPolicy [policy/v1beta1]

Description

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.

Type

object

Specification

Property Type Description

.apiVersion

string

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

string

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

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

.spec

object

PodSecurityPolicySpec defines the policy enforced.
.spec
Description

PodSecurityPolicySpec defines the policy enforced.

Type

object

Required

  • seLinux

  • runAsUser

  • supplementalGroups

  • fsGroup

Property Type Description

allowPrivilegeescalation

boolean

allowPrivilegeescalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.

allowedCapabilities

array (string)

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

array

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.

allowedFlexVolumes[]

object

AllowedFlexVolume represents a single Flexvolume that is allowed to be used.

allowedHostPaths

array

allowedHostPaths is a white list of allowed host paths. empty indicates that all host paths may be used.

allowedHostPaths[]

object

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

array (string)

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

array (string)

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

boolean

defaultAllowPrivilegeescalation controls the default setting for whether a process can gain more privileges than its parent process.

forbiddenSysctls

array (string)

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.

fsGroup

object

FSGroupStrategyOptions defines the strategy type and options used to create the strategy.

hostIPC

boolean

hostIPC determines if the policy allows the use of HostIPC in the pod spec.

hostNetwork

boolean

hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.

hostPID

boolean

hostPID determines if the policy allows the use of HostPID in the pod spec.

hostPorts

array

hostPorts determines which host port ranges are allowed to be exposed.

hostPorts[]

object

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

boolean

privileged determines if a pod can request to be run as privileged.

readOnlyRootFilesystem

boolean

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

array (string)

requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.

runAsUser

object

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.

seLinux

object

SeLinuxStrategyOptions defines the strategy type and any options used to create the strategy.

supplementalGroups

object

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.

volumes

array (string)

volumes is a white list of allowed volume plugins. empty indicates that no volumes may be used. To allow all volumes you may use '*'.
.spec.allowedFlexVolumes
Description

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.

Type

array

.spec.allowedFlexVolumes[]
Description

AllowedFlexVolume represents a single Flexvolume that is allowed to be used.

Type

object

Required

  • driver

Property Type Description

driver

string

driver is the name of the Flexvolume driver.
.spec.allowedHostPaths
Description

allowedHostPaths is a white list of allowed host paths. empty indicates that all host paths may be used.

Type

array

.spec.allowedHostPaths[]
Description

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.

Type

object

Property Type Description

pathPrefix

string

pathPrefix is the path prefix that the host volume must match. It does not support *. Trailing slashes are trimmed when validating the path prefix with a host path.

examples: /foo would allow /foo, /foo/ and /foo/bar /foo would not allow /food or /etc/foo

readOnly

boolean

when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.
.spec.fsGroup
Description

FSGroupStrategyOptions defines the strategy type and options used to create the strategy.

Type

object

Property Type Description

ranges

array

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.

ranges[]

object

IDRange provides a min/max of an allowed range of IDs.

rule

string

rule is the strategy that will dictate what FSGroup is used in the SecurityContext.
.spec.fsGroup.ranges
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.

Type

array

.spec.fsGroup.ranges[]
Description

IDRange provides a min/max of an allowed range of IDs.

Type

object

Required

  • min

  • max

Property Type Description

max

integer

max is the end of the range, inclusive.

min

integer

min is the start of the range, inclusive.
.spec.hostPorts
Description

hostPorts determines which host port ranges are allowed to be exposed.

Type

array

.spec.hostPorts[]
Description

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.

Type

object

Required

  • min

  • max

Property Type Description

max

integer

max is the end of the range, inclusive.

min

integer

min is the start of the range, inclusive.
.spec.runAsUser
Description

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.

Type

object

Required

  • rule

Property Type Description

ranges

array

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.

ranges[]

object

IDRange provides a min/max of an allowed range of IDs.

rule

string

rule is the strategy that will dictate the allowable RunAsUser values that may be set.
.spec.runAsUser.ranges
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.

Type

array

.spec.runAsUser.ranges[]
Description

IDRange provides a min/max of an allowed range of IDs.

Type

object

Required

  • min

  • max

Property Type Description

max

integer

max is the end of the range, inclusive.

min

integer

min is the start of the range, inclusive.
.spec.seLinux
Description

SeLinuxStrategyOptions defines the strategy type and any options used to create the strategy.

Type

object

Required

  • rule

Property Type Description

rule

string

rule is the strategy that will dictate the allowable labels that may be set.

seLinuxOptions

SeLinuxOptions core/v1

seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
.spec.supplementalGroups
Description

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.

Type

object

Property Type Description

ranges

array

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.

ranges[]

object

IDRange provides a min/max of an allowed range of IDs.

rule

string

rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
.spec.supplementalGroups.ranges
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.

Type

array

.spec.supplementalGroups.ranges[]
Description

IDRange provides a min/max of an allowed range of IDs.

Type

object

Required

  • min

  • max

Property Type Description

max

integer

max is the end of the range, inclusive.

min

integer

min is the start of the range, inclusive.

API endpoints

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

/apis/policy/v1beta1/podsecuritypolicies

Table 1. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DeLeTe

Description

delete collection of PodSecurityPolicy

Table 2. Query parameters
Parameter Type Description

continue

string

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.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

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.

resourceVersion

string

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.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 3. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

empty
HTTP method

GeT

Description

list or watch objects of kind PodSecurityPolicy

Table 4. Query parameters
Parameter Type Description

continue

string

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.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

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.

resourceVersion

string

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.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 5. HTTP responses
HTTP code Reponse body

200 - OK

PodSecurityPolicyList policy/v1beta1

401 - Unauthorized

empty
HTTP method

POST

Description

create a PodSecurityPolicy

Table 6. Body parameters
Parameter Type Description

body

PodSecurityPolicy policy/v1beta1
Table 7. HTTP responses
HTTP code Reponse body

200 - OK

PodSecurityPolicy policy/v1beta1

201 - Created

PodSecurityPolicy policy/v1beta1

202 - Accepted

PodSecurityPolicy policy/v1beta1

401 - Unauthorized

empty

/apis/policy/v1beta1/podsecuritypolicies/{name}

Table 8. Global path parameters
Parameter Type Description

name

string

name of the PodSecurityPolicy
Table 9. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DeLeTe

Description

delete a PodSecurityPolicy

Table 10. Query parameters
Parameter Type Description

gracePeriodSeconds

integer

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.

orphanDependents

boolean

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.

propagationPolicy

string

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.
Table 11. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1
Table 12. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

empty
HTTP method

GeT

Description

read the specified PodSecurityPolicy

Table 13. Query parameters
Parameter Type Description

exact

boolean

Should the export be exact. exact export maintains cluster-specific fields like 'Namespace'.

export

boolean

Should this value be exported. export strips fields that a user can not specify.
Table 14. HTTP responses
HTTP code Reponse body

200 - OK

PodSecurityPolicy policy/v1beta1

401 - Unauthorized

empty
HTTP method

PATCH

Description

partially update the specified PodSecurityPolicy

Table 15. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 16. HTTP responses
HTTP code Reponse body

200 - OK

PodSecurityPolicy policy/v1beta1

401 - Unauthorized

empty
HTTP method

PUT

Description

replace the specified PodSecurityPolicy

Table 17. Body parameters
Parameter Type Description

body

PodSecurityPolicy policy/v1beta1
Table 18. HTTP responses
HTTP code Reponse body

200 - OK

PodSecurityPolicy policy/v1beta1

201 - Created

PodSecurityPolicy policy/v1beta1

401 - Unauthorized

empty