PodSecurityPolicyReview [security.openshift.io/v1]
Esc
Start typing to search...
On this page

PodSecurityPolicyReview [security.openshift.io/v1]

Description

PodSecurityPolicyReview checks which service accounts (not users, since that would be cluster-wide) can create the PodTemplateSpec in question.

Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

Type
`object`
Required
  • spec

Specification

PropertyTypeDescription
apiVersionstringAPIVersion 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/sig-architecture/api-conventions.md#resources
kindstringKind 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/sig-architecture/api-conventions.md#types-kinds
metadataObjectMetametadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specobjectPodSecurityPolicyReviewSpec defines specification for PodSecurityPolicyReview
statusobjectPodSecurityPolicyReviewStatus represents the status of PodSecurityPolicyReview.

.spec

Description

PodSecurityPolicyReviewSpec defines specification for PodSecurityPolicyReview

Type
`object`
Required
  • template
PropertyTypeDescription
serviceAccountNamesarray (string)serviceAccountNames is an optional set of ServiceAccounts to run the check with. If serviceAccountNames is empty, the template.spec.serviceAccountName is used, unless it’s empty, in which case "default" is used instead. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.
templatePodTemplateSpectemplate is the PodTemplateSpec to check. The template.spec.serviceAccountName field is used if serviceAccountNames is empty, unless the template.spec.serviceAccountName is empty, in which case "default" is used. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.

.status

Description

PodSecurityPolicyReviewStatus represents the status of PodSecurityPolicyReview.

Type
`object`
PropertyTypeDescription
allowedServiceAccountsarrayallowedServiceAccounts returns the list of service accounts in this namespace that have the power to create the PodTemplateSpec.
allowedServiceAccounts[]objectServiceAccountPodSecurityPolicyReviewStatus represents ServiceAccount name and related review status

.status.allowedServiceAccounts

Description

allowedServiceAccounts returns the list of service accounts in this namespace that have the power to create the PodTemplateSpec.

Type
`array`

.status.allowedServiceAccounts[]

Description

ServiceAccountPodSecurityPolicyReviewStatus represents ServiceAccount name and related review status

Type
`object`
Required
  • name
PropertyTypeDescription
allowedByObjectReferenceallowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A nil, indicates that it was denied.
namestringname contains the allowed and the denied ServiceAccount name
reasonstringA machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.
templatePodTemplateSpectemplate is the PodTemplateSpec after the defaulting is applied.

API endpoints

The following API endpoints are available:

  • /apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicyreviews
    • POST: create a PodSecurityPolicyReview

/apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicyreviews

Global query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP method
`POST`
Description
create a PodSecurityPolicyReview

Body parameters

ParameterTypeDescription
bodyPodSecurityPolicyReview schema

HTTP responses

HTTP codeReponse body
200 - OKPodSecurityPolicyReview schema
201 - CreatedPodSecurityPolicyReview schema
202 - AcceptedPodSecurityPolicyReview schema
401 - UnauthorizedEmpty