Space API

The Space API describes the types and parameters for the core Space components.

Kind
Group/Version
authorization.spaces.upbound.io/v1alpha1
authorization.spaces.upbound.io/v1alpha1
A ObjectRoleBinding binds a namespaced API object to a set of subjects, at varying access levels. For now, there can be at most one ObjectRoleBinding pointing to each API object.
ObjectRoleBindingSpec is ObjectRoleBinding’s spec.
Object references the object to which the listed subjects should have access at varying levels. The object value is immutable after creation.
APIGroup defines the apiGroup of the object being pointed to. With some minor differences, this is essentially matched as a DNS subdomain, like how Kubernetes validates it. The Kubernetes legacy core group is denoted as ‘core’.
Name points to the .metadata.name of the object targeted. Kubernetes validates this as a DNS 1123 subdomain.
Resource defines the resource type (often kind in plural, e.g. controlplanes) being pointed to. With some minor differences, this is essentially matched as a DNS label, like how Kubernetes validates it.
Subjects should be a map type with both kind+name as a key
Kind of subject being referenced. Values defined by this API group are for now only ‘UpboundTeam’.
Name (identifier) of the subject (of the specified kind) being referenced. The identifier must be 2-100 chars, [a-zA-Z0-9-], no repeating dashes, can’t start/end with a dash. Notably, a UUID fits that format.
Role this subject has on the associated Object. The list of valid roles is defined for each target API resource separately. For namespaces, valid values are ‘viewer’, ’editor’, and ‘admin’. The format of this is essentially a RFC 1035 label with underscores instead of dashes, minimum three characters long.
ObjectRoleBindingStatus is RoleBindings’ status.
observability.spaces.upbound.io/v1alpha1
observability.spaces.upbound.io/v1alpha1
SharedTelemetryConfig defines a telemetry configuration over a set of ControlPlanes.
SharedTelemetryConfigSpec defines a telemetry configuration over a set of ControlPlanes.
ControlPlaneSelector defines the selector for ControlPlanes on which to configure telemetry.
A resource is matched if any of the label selector matches. In case when the list is empty, resource is matched too.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
A resource is selected if its metadata.name matches any of the provided names. In case when the list is empty, resource is matched too.
ExportPipeline defines the telemetry exporter pipeline to configure on the selected ControlPlanes.
Metrics defines the metrics exporter pipeline to configure on the selected ControlPlanes. The value has to be present in the spec.exporters field.
Traces defines the traces exporter pipeline to configure on the selected ControlPlanes. The value has to be present in the spec.exporters field.
Exporters defines the exporters to configure on the selected ControlPlanes. Untyped as we use the underlying OpenTelemetryOperator to configure the OpenTelemetry collector’s exporters. Use the OpenTelemetry Collector documentation to configure the exporters. Currently only supported exporters are push based exporters.
SharedTelemetryConfigStatus represents the observed state of a SharedTelemetryConfig.
Conditions of the resource.
LastTransitionTime is the last time this condition transitioned from one status to another.
A Message containing details about this condition’s last transition from one status to another, if any.
ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
A Reason for this condition’s last transition from one status to another.
Status of this condition; is it currently True, False, or Unknown?
Type of this condition. At most one of each condition type may apply to a resource at any point in time.
list of provisioning failures.
Conditions of the resource.
LastTransitionTime is the last time this condition transitioned from one status to another.
A Message containing details about this condition’s last transition from one status to another, if any.
ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
A Reason for this condition’s last transition from one status to another.
Status of this condition; is it currently True, False, or Unknown?
Type of this condition. At most one of each condition type may apply to a resource at any point in time.
ControlPlane name where the failure occurred.
ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.
ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.
List of successfully provisioned targets.
SelectedControlPlanes represents the names of the selected ControlPlanes.
policy.spaces.upbound.io/v1alpha1
policy.spaces.upbound.io/v1alpha1
SharedUpboundPolicy specifies a shared Kyverno policy projected into the specified ControlPlanes of the same namespace as SharedUpboundPolicy.
SharedUpboundPolicySpec defines the desired state of SharedUpboundPolicy.
Default: true
Admission controls if rules are applied during admission. Optional. Default value is ’true'.
ApplyRules controls how rules in a policy are applied. Rule are processed in the order of declaration. When set to One processing stops after a rule has been applied i.e. the rule matches and results in a pass, fail, or error. When set to All all rules in the policy are processed. The default is All.
Default: true
Background controls if rules are applied to existing resources during a background scan. Optional. Default value is ’true’. The value must be set to ‘false’ if the policy rule uses variables that are only available in the admission review request (e.g. user name).
The policy is projected only to control planes matching the provided selector. Either names or a labelSelector must be specified.
A resource is matched if any of the label selector matches. In case when the list is empty, resource is matched too.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
A resource is selected if its metadata.name matches any of the provided names. In case when the list is empty, resource is matched too.
FailurePolicy defines how unexpected policy errors and webhook response timeout errors are handled. Rules within the same policy share the same failure behavior. This field should not be accessed directly, instead GetFailurePolicy() should be used. Allowed values are Ignore or Fail. Defaults to Fail.
GenerateExisting controls whether to trigger generate rule in existing resources If is set to ’true’ generate rule will be triggered and applied to existing matched resources. Defaults to ‘false’ if not specified.
Deprecated, use generateExisting instead
MutateExistingOnPolicyUpdate controls if a mutateExisting policy is applied on policy events. Default value is ‘false’.
The metadata of the policy to be created.
Annotations that are set on projected resource.
Labels that are set on projected resource.
PolicyName is the name to use when creating policy within a control plane. optional, if not set, SharedUpboundPolicy name will be used. When set, it is immutable.
Rules is a list of Rule instances. A Policy contains multiple rules and each rule can validate, mutate, or generate resources.
CELPreconditions are used to determine if a policy rule should be applied by evaluating a set of CEL conditions. It can only be used with the validate.cel subrule

Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:

‘object’ - The object from the incoming request. The value is null for DELETE requests. ‘oldObject’ - The existing object. The value is null for CREATE requests. ‘request’ - Attributes of the admission request(https://pkg.go.dev/k8s.io/kubernetes/pkg/apis/admission#AdmissionRequest). ‘authorizer’ - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz ‘authorizer.requestResource’ - A CEL ResourceCheck constructed from the ‘authorizer’ and configured with the request resource. Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/

Required.

Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, ‘-’, ‘’ or ‘.’, and must start and end with an alphanumeric character (e.g. ‘MyName’, or ‘my.name’, or ‘123-abc’, regex used for validation is ‘([A-Za-z0-9][-A-Za-z0-9.]*)?[A-Za-z0-9]’) with an optional DNS subdomain prefix and ‘/’ (e.g. ’example.com/MyName’)

Required.

Context defines variables and data sources that can be used during rule execution.
APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.
Data specifies the POST data sent to the server.
Key is a unique identifier for the data value
Value is the data value
JMESPath is an optional JSON Match Expression that can be used to transform the JSON response returned from the server. For example a JMESPath of ‘items | length(@)’ applied to the API server response for the URLPath ‘/apis/apps/v1/deployments’ will return the total count of deployments across all namespaces.
Default: GET
Method is the HTTP request type (GET or POST).
Service is an API call to a JSON web service
CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.
URL is the JSON web service URL. A typical form is https://{service}.{namespace}:{port}/{path}.
URLPath is the URL path to be used in the HTTP GET or POST request to the Kubernetes API server (e.g. ‘/api/v1/namespaces’ or ‘/apis/apps/v1/deployments’). The format required is the same format used by the kubectl get --raw command. See https://kyverno.io/docs/writing-policies/external-data-sources/#variables-from-kubernetes-api-server-calls for details.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.
ImageRegistryCredentials provides credentials that will be used for authentication with registry
AllowInsecureRegistry allows insecure access to a registry.
Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.
Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.
JMESPath is an optional JSON Match Expression that can be used to transform the ImageData struct returned as a result of processing the image reference.
Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest
Name is the variable name.
Variable defines an arbitrary JMESPath context variable that can be defined inline.
Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil
JMESPath is an optional JMESPath Expression that can be used to transform the variable.
Value is any arbitrary JSON object representable in YAML or JSON form.
ExcludeResources defines when this policy rule should not be applied. The exclude criteria can include resource information (e.g. kind, name, namespace, labels) and admission review request information like the name or role.
All allows specifying resources which will be ANDed
ClusterRoles is the list of cluster-wide role names for the user.
ResourceDescription contains information about the resource being created or modified.
Annotations is a map of annotations (key-value pairs of type string). Annotation keys and values support the wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (matches at least one character).
Kinds is a list of resource kinds.
Name is the name of the resource. The name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character). NOTE: ‘Name’ is being deprecated in favor of ‘Names’.
Names are the names of the resources. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
NamespaceSelector is a label selector for the resource namespace. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character).Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Namespaces is a list of namespaces names. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
Operations can contain values [‘CREATE, ‘UPDATE’, ‘CONNECT’, ‘DELETE’], which are used to match a specific action.
Selector is a label selector. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character). Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Roles is the list of namespaced role names for the user.
Subjects is the list of subject names like users, user groups, and service accounts.
APIGroup holds the API group of the referenced subject. Defaults to ’’ for ServiceAccount subjects. Defaults to ‘rbac.authorization.k8s.io’ for User and Group subjects.
Kind of object being referenced. Values defined by this API group are ‘User’, ‘Group’, and ‘ServiceAccount’. If the Authorizer does not recognized the kind value, the Authorizer should report an error.
Name of the object being referenced.
Namespace of the referenced object. If the object kind is non-namespace, such as ‘User’ or ‘Group’, and this value is not empty the Authorizer should report an error.
Any allows specifying resources which will be ORed
ClusterRoles is the list of cluster-wide role names for the user.
ResourceDescription contains information about the resource being created or modified.
Annotations is a map of annotations (key-value pairs of type string). Annotation keys and values support the wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (matches at least one character).
Kinds is a list of resource kinds.
Name is the name of the resource. The name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character). NOTE: ‘Name’ is being deprecated in favor of ‘Names’.
Names are the names of the resources. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
NamespaceSelector is a label selector for the resource namespace. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character).Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Namespaces is a list of namespaces names. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
Operations can contain values [‘CREATE, ‘UPDATE’, ‘CONNECT’, ‘DELETE’], which are used to match a specific action.
Selector is a label selector. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character). Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Roles is the list of namespaced role names for the user.
Subjects is the list of subject names like users, user groups, and service accounts.
APIGroup holds the API group of the referenced subject. Defaults to ’’ for ServiceAccount subjects. Defaults to ‘rbac.authorization.k8s.io’ for User and Group subjects.
Kind of object being referenced. Values defined by this API group are ‘User’, ‘Group’, and ‘ServiceAccount’. If the Authorizer does not recognized the kind value, the Authorizer should report an error.
Name of the object being referenced.
Namespace of the referenced object. If the object kind is non-namespace, such as ‘User’ or ‘Group’, and this value is not empty the Authorizer should report an error.
ClusterRoles is the list of cluster-wide role names for the user.
ResourceDescription contains information about the resource being created or modified. Requires at least one tag to be specified when under MatchResources. Specifying ResourceDescription directly under match is being deprecated. Please specify under ‘any’ or ‘all’ instead.
Annotations is a map of annotations (key-value pairs of type string). Annotation keys and values support the wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (matches at least one character).
Kinds is a list of resource kinds.
Name is the name of the resource. The name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character). NOTE: ‘Name’ is being deprecated in favor of ‘Names’.
Names are the names of the resources. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
NamespaceSelector is a label selector for the resource namespace. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character).Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Namespaces is a list of namespaces names. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
Operations can contain values [‘CREATE, ‘UPDATE’, ‘CONNECT’, ‘DELETE’], which are used to match a specific action.
Selector is a label selector. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character). Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Roles is the list of namespaced role names for the user.
Subjects is the list of subject names like users, user groups, and service accounts.
APIGroup holds the API group of the referenced subject. Defaults to ’’ for ServiceAccount subjects. Defaults to ‘rbac.authorization.k8s.io’ for User and Group subjects.
Kind of object being referenced. Values defined by this API group are ‘User’, ‘Group’, and ‘ServiceAccount’. If the Authorizer does not recognized the kind value, the Authorizer should report an error.
Name of the object being referenced.
Namespace of the referenced object. If the object kind is non-namespace, such as ‘User’ or ‘Group’, and this value is not empty the Authorizer should report an error.
Generation is used to create new resources.
APIVersion specifies resource apiVersion.
Clone specifies the source resource used to populate each generated resource. At most one of Data or Clone can be specified. If neither are provided, the generated resource will be created with default data only.
Name specifies name of the resource.
Namespace specifies source resource namespace.
CloneList specifies the list of source resource used to populate each generated resource.
Kinds is a list of resource kinds.
Namespace specifies source resource namespace.
Selector is a label selector. Label keys and values in matchLabels. wildcard characters are not supported.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Data provides the resource declaration used to populate each generated resource. At most one of Data or Clone must be specified. If neither are provided, the generated resource will be created with default data only.
Kind specifies resource kind.
Name specifies the resource name.
Namespace specifies resource namespace.
Synchronize controls if generated resources should be kept in-sync with their source resource. If Synchronize is set to ’true’ changes to generated resources will be overwritten with resource data from Data or the resource specified in the Clone declaration. Optional. Defaults to ‘false’ if not specified.
UID specifies the resource uid.
ImageExtractors defines a mapping from kinds to ImageExtractorConfigs. This config is only valid for verifyImages rules.
MatchResources defines when this policy rule should be applied. The match criteria can include resource information (e.g. kind, name, namespace, labels) and admission review request information like the user name or role. At least one kind is required.
All allows specifying resources which will be ANDed
ClusterRoles is the list of cluster-wide role names for the user.
ResourceDescription contains information about the resource being created or modified.
Annotations is a map of annotations (key-value pairs of type string). Annotation keys and values support the wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (matches at least one character).
Kinds is a list of resource kinds.
Name is the name of the resource. The name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character). NOTE: ‘Name’ is being deprecated in favor of ‘Names’.
Names are the names of the resources. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
NamespaceSelector is a label selector for the resource namespace. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character).Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Namespaces is a list of namespaces names. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
Operations can contain values [‘CREATE, ‘UPDATE’, ‘CONNECT’, ‘DELETE’], which are used to match a specific action.
Selector is a label selector. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character). Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Roles is the list of namespaced role names for the user.
Subjects is the list of subject names like users, user groups, and service accounts.
APIGroup holds the API group of the referenced subject. Defaults to ’’ for ServiceAccount subjects. Defaults to ‘rbac.authorization.k8s.io’ for User and Group subjects.
Kind of object being referenced. Values defined by this API group are ‘User’, ‘Group’, and ‘ServiceAccount’. If the Authorizer does not recognized the kind value, the Authorizer should report an error.
Name of the object being referenced.
Namespace of the referenced object. If the object kind is non-namespace, such as ‘User’ or ‘Group’, and this value is not empty the Authorizer should report an error.
Any allows specifying resources which will be ORed
ClusterRoles is the list of cluster-wide role names for the user.
ResourceDescription contains information about the resource being created or modified.
Annotations is a map of annotations (key-value pairs of type string). Annotation keys and values support the wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (matches at least one character).
Kinds is a list of resource kinds.
Name is the name of the resource. The name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character). NOTE: ‘Name’ is being deprecated in favor of ‘Names’.
Names are the names of the resources. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
NamespaceSelector is a label selector for the resource namespace. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character).Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Namespaces is a list of namespaces names. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
Operations can contain values [‘CREATE, ‘UPDATE’, ‘CONNECT’, ‘DELETE’], which are used to match a specific action.
Selector is a label selector. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character). Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Roles is the list of namespaced role names for the user.
Subjects is the list of subject names like users, user groups, and service accounts.
APIGroup holds the API group of the referenced subject. Defaults to ’’ for ServiceAccount subjects. Defaults to ‘rbac.authorization.k8s.io’ for User and Group subjects.
Kind of object being referenced. Values defined by this API group are ‘User’, ‘Group’, and ‘ServiceAccount’. If the Authorizer does not recognized the kind value, the Authorizer should report an error.
Name of the object being referenced.
Namespace of the referenced object. If the object kind is non-namespace, such as ‘User’ or ‘Group’, and this value is not empty the Authorizer should report an error.
ClusterRoles is the list of cluster-wide role names for the user.
ResourceDescription contains information about the resource being created or modified. Requires at least one tag to be specified when under MatchResources. Specifying ResourceDescription directly under match is being deprecated. Please specify under ‘any’ or ‘all’ instead.
Annotations is a map of annotations (key-value pairs of type string). Annotation keys and values support the wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (matches at least one character).
Kinds is a list of resource kinds.
Name is the name of the resource. The name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character). NOTE: ‘Name’ is being deprecated in favor of ‘Names’.
Names are the names of the resources. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
NamespaceSelector is a label selector for the resource namespace. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character).Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Namespaces is a list of namespaces names. Each name supports wildcard characters ‘*’ (matches zero or many characters) and ‘?’ (at least one character).
Operations can contain values [‘CREATE, ‘UPDATE’, ‘CONNECT’, ‘DELETE’], which are used to match a specific action.
Selector is a label selector. Label keys and values in matchLabels support the wildcard characters * (matches zero or many characters) and ? (matches one character). Wildcards allows writing label selectors like [‘storage.k8s.io/’: ‘’]. Note that using [’’ : ‘’] matches any key and value but does not match an empty label set.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Roles is the list of namespaced role names for the user.
Subjects is the list of subject names like users, user groups, and service accounts.
APIGroup holds the API group of the referenced subject. Defaults to ’’ for ServiceAccount subjects. Defaults to ‘rbac.authorization.k8s.io’ for User and Group subjects.
Kind of object being referenced. Values defined by this API group are ‘User’, ‘Group’, and ‘ServiceAccount’. If the Authorizer does not recognized the kind value, the Authorizer should report an error.
Name of the object being referenced.
Namespace of the referenced object. If the object kind is non-namespace, such as ‘User’ or ‘Group’, and this value is not empty the Authorizer should report an error.
Mutation is used to modify matching resources.
ForEach applies mutation rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.
Context defines variables and data sources that can be used during rule execution.
APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.
Data specifies the POST data sent to the server.
Key is a unique identifier for the data value
Value is the data value
JMESPath is an optional JSON Match Expression that can be used to transform the JSON response returned from the server. For example a JMESPath of ‘items | length(@)’ applied to the API server response for the URLPath ‘/apis/apps/v1/deployments’ will return the total count of deployments across all namespaces.
Default: GET
Method is the HTTP request type (GET or POST).
Service is an API call to a JSON web service
CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.
URL is the JSON web service URL. A typical form is https://{service}.{namespace}:{port}/{path}.
URLPath is the URL path to be used in the HTTP GET or POST request to the Kubernetes API server (e.g. ‘/api/v1/namespaces’ or ‘/apis/apps/v1/deployments’). The format required is the same format used by the kubectl get --raw command. See https://kyverno.io/docs/writing-policies/external-data-sources/#variables-from-kubernetes-api-server-calls for details.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.
ImageRegistryCredentials provides credentials that will be used for authentication with registry
AllowInsecureRegistry allows insecure access to a registry.
Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.
Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.
JMESPath is an optional JSON Match Expression that can be used to transform the ImageData struct returned as a result of processing the image reference.
Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest
Name is the variable name.
Variable defines an arbitrary JMESPath context variable that can be defined inline.
Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil
JMESPath is an optional JMESPath Expression that can be used to transform the variable.
Value is any arbitrary JSON object representable in YAML or JSON form.
Foreach declares a nested foreach iterator
List specifies a JMESPath expression that results in one or more elements to which the validation logic is applied.
Order defines the iteration order on the list. Can be Ascending to iterate from first to last element or Descending to iterate in from last to first element.
PatchesJSON6902 is a list of RFC 6902 JSON Patch declarations used to modify resources. See https://tools.ietf.org/html/rfc6902 and https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/.
AnyAllConditions are used to determine if a policy rule should be applied by evaluating a set of conditions. The declaration can contain nested any or all statements. See: https://kyverno.io/docs/writing-policies/preconditions/
AllConditions enable variable-based conditional rule execution. This is useful for finer control of when an rule is applied. A condition can reference object data using JMESPath notation. Here, all of the conditions need to pass
Key is the context entry (using JMESPath) for conditional rule evaluation.
Message is an optional display message
Operator is the conditional operation to perform. Valid operators are: Equals, NotEquals, In, AnyIn, AllIn, NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals, GreaterThan, LessThanOrEquals, LessThan, DurationGreaterThanOrEquals, DurationGreaterThan, DurationLessThanOrEquals, DurationLessThan
Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.
AnyConditions enable variable-based conditional rule execution. This is useful for finer control of when an rule is applied. A condition can reference object data using JMESPath notation. Here, at least one of the conditions need to pass
Key is the context entry (using JMESPath) for conditional rule evaluation.
Message is an optional display message
Operator is the conditional operation to perform. Valid operators are: Equals, NotEquals, In, AnyIn, AllIn, NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals, GreaterThan, LessThanOrEquals, LessThan, DurationGreaterThanOrEquals, DurationGreaterThan, DurationLessThanOrEquals, DurationLessThan
Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.
PatchesJSON6902 is a list of RFC 6902 JSON Patch declarations used to modify resources. See https://tools.ietf.org/html/rfc6902 and https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/.
Targets defines the target resources to be mutated.
APIVersion specifies resource apiVersion.
Context defines variables and data sources that can be used during rule execution.
APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.
Data specifies the POST data sent to the server.
Key is a unique identifier for the data value
Value is the data value
JMESPath is an optional JSON Match Expression that can be used to transform the JSON response returned from the server. For example a JMESPath of ‘items | length(@)’ applied to the API server response for the URLPath ‘/apis/apps/v1/deployments’ will return the total count of deployments across all namespaces.
Default: GET
Method is the HTTP request type (GET or POST).
Service is an API call to a JSON web service
CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.
URL is the JSON web service URL. A typical form is https://{service}.{namespace}:{port}/{path}.
URLPath is the URL path to be used in the HTTP GET or POST request to the Kubernetes API server (e.g. ‘/api/v1/namespaces’ or ‘/apis/apps/v1/deployments’). The format required is the same format used by the kubectl get --raw command. See https://kyverno.io/docs/writing-policies/external-data-sources/#variables-from-kubernetes-api-server-calls for details.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.
ImageRegistryCredentials provides credentials that will be used for authentication with registry
AllowInsecureRegistry allows insecure access to a registry.
Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.
Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.
JMESPath is an optional JSON Match Expression that can be used to transform the ImageData struct returned as a result of processing the image reference.
Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest
Name is the variable name.
Variable defines an arbitrary JMESPath context variable that can be defined inline.
Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil
JMESPath is an optional JMESPath Expression that can be used to transform the variable.
Value is any arbitrary JSON object representable in YAML or JSON form.
Kind specifies resource kind.
Name specifies the resource name.
Namespace specifies resource namespace.
Preconditions are used to determine if a policy rule should be applied by evaluating a set of conditions. The declaration can contain nested any or all statements. A direct list of conditions (without any or all statements is supported for backwards compatibility but will be deprecated in the next major release. See: https://kyverno.io/docs/writing-policies/preconditions/
UID specifies the resource uid.
Name is a label to identify the rule, It must be unique within the policy.
Preconditions are used to determine if a policy rule should be applied by evaluating a set of conditions. The declaration can contain nested any or all statements. A direct list of conditions (without any or all statements is supported for backwards compatibility but will be deprecated in the next major release. See: https://kyverno.io/docs/writing-policies/preconditions/
Default: true
SkipBackgroundRequests bypasses admission requests that are sent by the background controller. The default value is set to ’true’, it must be set to ‘false’ to apply generate and mutateExisting rules to those requests.
Validation is used to validate matching resources.
AnyPattern specifies list of validation patterns. At least one of the patterns must be satisfied for the validation rule to succeed.
CEL allows validation checks using the Common Expression Language (https://kubernetes.io/docs/reference/using-api/cel/).
AuditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request.

key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length.

The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: ‘{ValidatingAdmissionPolicy name}/{key}’.

If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded.

Required.

valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb.

If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list.

Required.

Expressions is a list of CELExpression types.

Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables:

  • ‘object’ - The object from the incoming request. The value is null for DELETE requests.
  • ‘oldObject’ - The existing object. The value is null for CREATE requests.
  • ‘request’ - Attributes of the API request(ref).
  • ‘params’ - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind.
  • ’namespaceObject’ - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources.
  • ‘variables’ - Map of composited variables, from its name to its lazily evaluated value. For example, a variable named ‘foo’ can be accessed as ‘variables.foo’.
  • ‘authorizer’ - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
  • ‘authorizer.requestResource’ - A CEL ResourceCheck constructed from the ‘authorizer’ and configured with the request resource.

The apiVersion, kind, metadata.name and metadata.generateName are always accessible from the root of the object. No other metadata properties are accessible.

Only property names of the form [a-zA-Z_.-/][a-zA-Z0-9_.-/]* are accessible. Accessible property names are escaped according to the following rules when accessed in the expression:

  • ‘__’ escapes to ‘underscores
  • ‘.’ escapes to ‘dot
  • ‘-’ escapes to ‘dash
  • ‘/’ escapes to ‘slash
  • Property names that exactly match a CEL RESERVED keyword escape to ‘{keyword}’. The keywords are: ’true’, ‘false’, ’null’, ‘in’, ‘as’, ‘break’, ‘const’, ‘continue’, ’else’, ‘for’, ‘function’, ‘if’, ‘import’, ’let’, ’loop’, ‘package’, ’namespace’, ‘return’. Examples:
    • Expression accessing a property named ’namespace’: {‘Expression’: ‘object.namespace > 0’}
    • Expression accessing a property named ‘x-prop’: {‘Expression’: ‘object.x__dash__prop > 0’}
    • Expression accessing a property named ‘redact__d’: {‘Expression’: ‘object.redact__underscores__d > 0’}

Equality on arrays with list type of ‘set’ or ‘map’ ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:

  • ‘set’: X + Y performs a union where the array positions of all elements in X are preserved and non-intersecting elements in Y are appended, retaining their partial order.
  • ‘map’: X + Y performs a merge where the array positions of all keys in X are preserved but the values are overwritten by values in Y when the key sets of X and Y intersect. Elements in Y with non-intersecting keys are appended, retaining their partial order. Required.
Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is ‘failed rule: {Rule}’. e.g. ‘must be a URL with the host matching spec.host’ If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is ‘failed Expression: {Expression}’.
messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the expression except for ‘authorizer’ and ‘authorizer.requestResource’. Example: ‘object.x must be less than max (’+string(params.max)+’)’
Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: ‘Unauthorized’, ‘Forbidden’, ‘Invalid’, ‘RequestEntityTooLarge’. If not set, StatusReasonInvalid is used in the response to the client.
ParamKind is a tuple of Group Kind and Version.
APIVersion is the API group version the resources belong to. In format of ‘group/version’. Required.
Kind is the API kind the resources belong to. Required.
ParamRef references a parameter resource.

name is the name of the resource being referenced.

name and selector are mutually exclusive properties. If one is set, the other must be unset.

namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both name and selector fields.

A per-namespace parameter may be used by specifying a namespace-scoped paramKind in the policy and leaving this field empty.

  • If paramKind is cluster-scoped, this field MUST be unset. Setting this field results in a configuration error.

  • If paramKind is namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error.

parameterNotFoundAction controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to Allow, then no matched parameters will be treated as successful validation by the binding. If set to Deny, then no matched parameters will be subject to the failurePolicy of the policy.

Allowed values are Allow or Deny Default to Deny

selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind.

If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together.

One of name or selector must be set, but name and selector are mutually exclusive properties. If one is set, the other must be unset.

matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is ‘key’, the operator is ‘In’, and the values array contains only ‘value’. The requirements are ANDed.
Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under variables in other expressions of the policy.
Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation.
Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through variables For example, if name is ‘foo’, the variable will be available as variables.foo
Deny defines conditions used to pass or fail a validation rule.
Multiple conditions can be declared under an any or all statement. A direct list of conditions (without any or all statements) is also supported for backwards compatibility but will be deprecated in the next major release. See: https://kyverno.io/docs/writing-policies/validate/#deny-rules
ForEach applies validate rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.
AnyPattern specifies list of validation patterns. At least one of the patterns must be satisfied for the validation rule to succeed.
Context defines variables and data sources that can be used during rule execution.
APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.
Data specifies the POST data sent to the server.
Key is a unique identifier for the data value
Value is the data value
JMESPath is an optional JSON Match Expression that can be used to transform the JSON response returned from the server. For example a JMESPath of ‘items | length(@)’ applied to the API server response for the URLPath ‘/apis/apps/v1/deployments’ will return the total count of deployments across all namespaces.
Default: GET
Method is the HTTP request type (GET or POST).
Service is an API call to a JSON web service
CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.
URL is the JSON web service URL. A typical form is https://{service}.{namespace}:{port}/{path}.
URLPath is the URL path to be used in the HTTP GET or POST request to the Kubernetes API server (e.g. ‘/api/v1/namespaces’ or ‘/apis/apps/v1/deployments’). The format required is the same format used by the kubectl get --raw command. See https://kyverno.io/docs/writing-policies/external-data-sources/#variables-from-kubernetes-api-server-calls for details.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.
ImageRegistryCredentials provides credentials that will be used for authentication with registry
AllowInsecureRegistry allows insecure access to a registry.
Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.
Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.
JMESPath is an optional JSON Match Expression that can be used to transform the ImageData struct returned as a result of processing the image reference.
Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest
Name is the variable name.
Variable defines an arbitrary JMESPath context variable that can be defined inline.
Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil
JMESPath is an optional JMESPath Expression that can be used to transform the variable.
Value is any arbitrary JSON object representable in YAML or JSON form.
Deny defines conditions used to pass or fail a validation rule.
Multiple conditions can be declared under an any or all statement. A direct list of conditions (without any or all statements) is also supported for backwards compatibility but will be deprecated in the next major release. See: https://kyverno.io/docs/writing-policies/validate/#deny-rules
ElementScope specifies whether to use the current list element as the scope for validation. Defaults to ’true’ if not specified. When set to ‘false’, ‘request.object’ is used as the validation scope within the foreach block to allow referencing other elements in the subtree.
Foreach declares a nested foreach iterator
List specifies a JMESPath expression that results in one or more elements to which the validation logic is applied.
Pattern specifies an overlay-style pattern used to check resources.
AnyAllConditions are used to determine if a policy rule should be applied by evaluating a set of conditions. The declaration can contain nested any or all statements. See: https://kyverno.io/docs/writing-policies/preconditions/
AllConditions enable variable-based conditional rule execution. This is useful for finer control of when an rule is applied. A condition can reference object data using JMESPath notation. Here, all of the conditions need to pass
Key is the context entry (using JMESPath) for conditional rule evaluation.
Message is an optional display message
Operator is the conditional operation to perform. Valid operators are: Equals, NotEquals, In, AnyIn, AllIn, NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals, GreaterThan, LessThanOrEquals, LessThan, DurationGreaterThanOrEquals, DurationGreaterThan, DurationLessThanOrEquals, DurationLessThan
Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.
AnyConditions enable variable-based conditional rule execution. This is useful for finer control of when an rule is applied. A condition can reference object data using JMESPath notation. Here, at least one of the conditions need to pass
Key is the context entry (using JMESPath) for conditional rule evaluation.
Message is an optional display message
Operator is the conditional operation to perform. Valid operators are: Equals, NotEquals, In, AnyIn, AllIn, NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals, GreaterThan, LessThanOrEquals, LessThan, DurationGreaterThanOrEquals, DurationGreaterThan, DurationLessThanOrEquals, DurationLessThan
Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.
Manifest specifies conditions for manifest verification
AnnotationDomain is custom domain of annotation for message and signature. Default is ‘cosign.sigstore.dev’.
Attestors specified the required attestors (i.e. authorities)
Count specifies the required number of entries that must match. If the count is null, all entries must match (a logical AND). If the count is 1, at least one entry must match (a logical OR). If the count contains a value N, then N must be less than or equal to the size of entries, and at least N entries must match.
Entries contains the available attestors. An attestor can be a static key, attributes for keyless verification, or a nested attestor declaration.
Annotations are used for image verification. Every specified key-value pair must exist and match in the verified payload. The payload may contain other key-value pairs.
Attestor is a nested set of Attestor used to specify a more complex set of match authorities.