ClusterPolicy declares validation, mutation, and generation behaviors for matching resources.
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/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
Each additional property must conform to the following schema
Type: stringCreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
Each additional property must conform to the following schema
Type: stringManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
No Additional ItemsManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
Same definition as creationTimestampName must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
No Additional ItemsOwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
API version of the referent.
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
Spec declares policy behaviors.
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.
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).
EmitWarning enables API response warnings for mutate policy rules or validate policy rules with validationFailureAction set to Audit.
Enabling this option will extend admission request processing times. The default value is "false".
Deprecated, use failurePolicy under the webhookConfiguration instead.
Deprecated, use generateExisting under the generate rule instead
Deprecated, use generateExisting instead
Deprecated, use mutateExistingOnPolicyUpdate under the mutate rule instead
Rules is a list of Rule instances. A Policy contains multiple rules and
each rule can validate, mutate, or generate resources.
Rule defines a validation, mutation, or generation control for matching resources.
Each rules contains a match declaration to select resources, and an optional exclude
declaration to specify which resources to exclude.
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
MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.
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(/pkg/apis/admission/types.go#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.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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
No Additional ItemsResourceFilter allow users to "AND" or "OR" between resources
ClusterRoles is the list of cluster-wide role names for the user.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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
No Additional ItemsResourceFilter allow users to "AND" or "OR" between resources
ClusterRoles is the list of cluster-wide role names for the user.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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.
No Additional ItemsNamespace 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringData 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.
ForEach applies generate 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.
No Additional ItemsAPIVersion 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.
No Additional ItemsNamespace 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringContext defines variables and data sources that can be used during rule execution.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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.
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.
List specifies a JMESPath expression that results in one or more elements
to which the validation logic is applied.
Name specifies the resource name.
Namespace specifies resource namespace.
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/
UID specifies the resource uid.
GenerateExisting controls whether to trigger the rule in existing resources
If is set to "true" the rule will be triggered and applied to existing matched resources.
Kind specifies resource kind.
Name specifies the resource name.
Namespace specifies resource namespace.
OrphanDownstreamOnPolicyDelete controls whether generated resources should be deleted when the rule that generated
them is deleted with synchronization enabled. This option is only applicable to generate rules of the data type.
See https://kyverno.io/docs/writing-policies/generate/#data-examples.
Defaults to "false" if not specified.
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.
Each additional property must conform to the following schema
Type: array of objectJMESPath is an optional JMESPath expression to apply to the image value.
This is useful when the extracted image begins with a prefix like 'docker://'.
The 'trimprefix' function may be used to trim the prefix: trimprefix(@, 'docker://').
Note - Image digest mutation may not be used when applying a JMESPAth to an image.
Key is an optional name of the field within 'path' that will be used to uniquely identify an image.
Note - this field MUST be unique.
Name is the entry the image will be available under 'images.<name>' in the context.
If this field is not defined, image entries will appear under 'images.custom'.
Path is the path to the object containing the image field in a custom resource.
It should be slash-separated. Each slash-separated key must be a valid YAML key or a wildcard '*'.
Wildcard keys are expanded in case of arrays or objects.
Value is an optional name of the field within 'path' that points to the image URI.
This is useful when a custom 'key' is also defined.
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
No Additional ItemsResourceFilter allow users to "AND" or "OR" between resources
ClusterRoles is the list of cluster-wide role names for the user.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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
No Additional ItemsResourceFilter allow users to "AND" or "OR" between resources
ClusterRoles is the list of cluster-wide role names for the user.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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.
No Additional ItemsForEachMutation 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.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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.
PatchStrategicMerge is a strategic merge patch used to modify resources.
See https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
and https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/patchesstrategicmerge/.
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/kustomization/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/
MutateExistingOnPolicyUpdate controls if the mutateExisting rule will be applied on policy events.
PatchStrategicMerge is a strategic merge patch used to modify resources.
See https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
and https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/patchesstrategicmerge/.
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/kustomization/patchesjson6902/.
Targets defines the target resources to be mutated.
No Additional ItemsTargetResourceSpec defines targets for mutating existing resources.
APIVersion specifies resource apiVersion.
Context defines variables and data sources that can be used during rule execution.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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/
Selector allows you to select target resources with their labels.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringUID specifies the resource uid.
Name is a label to identify the rule, It must be unique within the policy.
Must be at most 63 characters long
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.
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.
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.
Assert defines a kyverno-json assertion tree.
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.
No Additional ItemsAuditAnnotation describes how to produce an audit annotation for an 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.
No Additional ItemsValidation specifies the CEL expression which is used to apply the validation.
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:
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.xdashprop > 0"}
- Expression accessing a property named "redactd": {"Expression": "object.redactunderscoresd > 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.
Generate specifies whether to generate a Kubernetes ValidatingAdmissionPolicy from the rule.
Optional. Defaults to "false" if not specified.
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.
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.
A single parameter used for all admission requests can be configured
by setting the name field, leaving selector blank, and setting namespace
if paramKind is namespace-scoped.
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
Required
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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringVariables 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.
Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.
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.
See: https://kyverno.io/docs/writing-policies/validate/#deny-rules
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.
FailureAction defines if a validation policy rule violation should block
the admission review request (Enforce), or allow (Audit) the admission review request
and report an error in a policy report. Optional.
Allowed values are Audit or Enforce.
FailureActionOverrides is a Cluster Policy attribute that specifies FailureAction
namespace-wise. It overrides FailureAction for the specified namespaces.
ValidationFailureAction defines the policy validation failure action
A label selector is a label query over a set of resources. The result of matchLabels and
matchExpressions are ANDed. An empty label selector matches all objects. A null
label selector matches no objects.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringForEach 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.
No Additional ItemsForEachValidation 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.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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/
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)
No Additional ItemsCount 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.
Value must be greater or equal to 1
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.
Each additional property must conform to the following schema
Type: stringAttestor is a nested set of Attestor used to specify a more complex set of match authorities.
Certificates specifies one or more certificates.
Cert is an optional PEM-encoded public certificate.
CertChain is an optional PEM encoded set of certificates used to verify.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Keyless is a set of attribute used to verify a Sigstore keyless attestor.
See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.
AdditionalExtensions are certificate-extensions used for keyless signing.
Each additional property must conform to the following schema
Type: stringCTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Issuer is the certificate issuer used for keyless signing.
IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Roots is an optional set of PEM encoded trusted root certificates.
If not provided, the system roots are used.
Subject is the verified identity used for keyless signing, for example the email address.
SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.
Keys specifies one or more public keys.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
KMS provides the URI to the public key stored in a Key Management System. See:
https://github.com/sigstore/cosign/blob/main/KMS.md
Keys is a set of X.509 public keys used to verify image signatures. The keys can be directly
specified or can be a variable reference to a key specified in a ConfigMap (see
https://kyverno.io/docs/writing-policies/variables/), or reference a standard Kubernetes Secret
elsewhere in the cluster by specifying it in the format "k8s://<namespace>/<secret_name>".
The named Secret must specify a key cosign.pub containing the public key used for
verification, (see https://github.com/sigstore/cosign/blob/main/KMS.md#kubernetes-secret).
When multiple keys are specified each key is processed as a separate staticKey entry
(.attestors[*].entries.keys) within the set of attestors and the count is applied across the keys.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Reference to a Secret resource that contains a public key
Name of the secret. The provided secret must contain a key named cosign.pub.
Namespace name where the Secret exists.
Deprecated. Use attestor.signatureAlgorithm instead.
Repository is an optional alternate OCI repository to use for signatures and attestations that match this rule.
If specified Repository will override other OCI image repository locations for this Attestor.
Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.
DryRun configuration
Fields which will be ignored while comparing manifests.
No Additional ItemsRepository is an optional alternate OCI repository to use for resource bundle reference.
The repository can be overridden per Attestor or Attestation.
Message specifies a custom message to be displayed on failure.
Pattern specifies an overlay-style pattern used to check resources.
PodSecurity applies exemptions for Kubernetes Pod Security admission
by specifying exclusions for Pod Security Standards controls.
Exclude specifies the Pod Security Standard controls to be excluded.
No Additional ItemsPodSecurityStandard specifies the Pod Security Standard controls to be excluded.
ControlName specifies the name of the Pod Security Standard control.
See: https://kubernetes.io/docs/concepts/security/pod-security-standards/
Images selects matching containers and applies the container level PSS.
Each image is the image name consisting of the registry address, repository, image, and tag.
Empty list matches no containers, PSS checks are applied at the pod level only.
Wildcards ('*' and '?') are allowed. See: https://kubernetes.io/docs/concepts/containers/images.
RestrictedField selects the field for the given Pod Security Standard control.
When not set, all restricted fields for the control are selected.
Values defines the allowed values that can be excluded.
No Additional ItemsLevel defines the Pod Security Standard level to be applied to workloads.
Allowed values are privileged, baseline, and restricted.
Version defines the Pod Security Standard versions that Kubernetes supports.
Allowed values are v1.19, v1.20, v1.21, v1.22, v1.23, v1.24, v1.25, v1.26, v1.27, v1.28, v1.29, v1.30, v1.31, v1.32, latest. Defaults to latest.
VerifyImages is used to verify image signatures and mutate them to add a digest
No Additional ItemsImageVerification validates that images that match the specified pattern
are signed with the supplied public key. Once the image is verified it is
mutated to include the SHA digest retrieved during the registration.
Attestations are optional checks for signed in-toto Statements used to verify the image.
See https://github.com/in-toto/attestation. Kyverno fetches signed attestations from the
OCI registry and decodes them into a list of Statement declarations.
Attestation are checks for signed in-toto Statements that are used to verify the image.
See https://github.com/in-toto/attestation. Kyverno fetches signed attestations from the
OCI registry and decodes them into a list of Statements.
Attestors specify the required attestors (i.e. authorities).
No Additional ItemsCount 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.
Value must be greater or equal to 1
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.
Each additional property must conform to the following schema
Type: stringAttestor is a nested set of Attestor used to specify a more complex set of match authorities.
Certificates specifies one or more certificates.
Cert is an optional PEM-encoded public certificate.
CertChain is an optional PEM encoded set of certificates used to verify.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Keyless is a set of attribute used to verify a Sigstore keyless attestor.
See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.
AdditionalExtensions are certificate-extensions used for keyless signing.
Each additional property must conform to the following schema
Type: stringCTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Issuer is the certificate issuer used for keyless signing.
IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Roots is an optional set of PEM encoded trusted root certificates.
If not provided, the system roots are used.
Subject is the verified identity used for keyless signing, for example the email address.
SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.
Keys specifies one or more public keys.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
KMS provides the URI to the public key stored in a Key Management System. See:
https://github.com/sigstore/cosign/blob/main/KMS.md
Keys is a set of X.509 public keys used to verify image signatures. The keys can be directly
specified or can be a variable reference to a key specified in a ConfigMap (see
https://kyverno.io/docs/writing-policies/variables/), or reference a standard Kubernetes Secret
elsewhere in the cluster by specifying it in the format "k8s://<namespace>/<secret_name>".
The named Secret must specify a key cosign.pub containing the public key used for
verification, (see https://github.com/sigstore/cosign/blob/main/KMS.md#kubernetes-secret).
When multiple keys are specified each key is processed as a separate staticKey entry
(.attestors[*].entries.keys) within the set of attestors and the count is applied across the keys.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Reference to a Secret resource that contains a public key
Name of the secret. The provided secret must contain a key named cosign.pub.
Namespace name where the Secret exists.
Deprecated. Use attestor.signatureAlgorithm instead.
Repository is an optional alternate OCI repository to use for signatures and attestations that match this rule.
If specified Repository will override other OCI image repository locations for this Attestor.
Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.
Conditions are used to verify attributes within a Predicate. If no Conditions are specified
the attestation check is satisfied as long there are predicates that match the predicate type.
AnyAllConditions consists of conditions wrapped denoting a logical criteria to be fulfilled.
AnyConditions get fulfilled when at least one of its sub-conditions passes.
AllConditions get fulfilled only when all of its sub-conditions pass.
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
Condition defines variable-based conditional criteria for rule execution.
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
Condition defines variable-based conditional criteria for rule execution.
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.
Name is the variable name.
Deprecated in favour of 'Type', to be removed soon
Type defines the type of attestation contained within the Statement.
Attestors specified the required attestors (i.e. authorities)
No Additional ItemsCount 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.
Value must be greater or equal to 1
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.
Each additional property must conform to the following schema
Type: stringAttestor is a nested set of Attestor used to specify a more complex set of match authorities.
Certificates specifies one or more certificates.
Cert is an optional PEM-encoded public certificate.
CertChain is an optional PEM encoded set of certificates used to verify.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Keyless is a set of attribute used to verify a Sigstore keyless attestor.
See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.
AdditionalExtensions are certificate-extensions used for keyless signing.
Each additional property must conform to the following schema
Type: stringCTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Issuer is the certificate issuer used for keyless signing.
IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Roots is an optional set of PEM encoded trusted root certificates.
If not provided, the system roots are used.
Subject is the verified identity used for keyless signing, for example the email address.
SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.
Keys specifies one or more public keys.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
KMS provides the URI to the public key stored in a Key Management System. See:
https://github.com/sigstore/cosign/blob/main/KMS.md
Keys is a set of X.509 public keys used to verify image signatures. The keys can be directly
specified or can be a variable reference to a key specified in a ConfigMap (see
https://kyverno.io/docs/writing-policies/variables/), or reference a standard Kubernetes Secret
elsewhere in the cluster by specifying it in the format "k8s://<namespace>/<secret_name>".
The named Secret must specify a key cosign.pub containing the public key used for
verification, (see https://github.com/sigstore/cosign/blob/main/KMS.md#kubernetes-secret).
When multiple keys are specified each key is processed as a separate staticKey entry
(.attestors[*].entries.keys) within the set of attestors and the count is applied across the keys.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Reference to a Secret resource that contains a public key
Name of the secret. The provided secret must contain a key named cosign.pub.
Namespace name where the Secret exists.
Deprecated. Use attestor.signatureAlgorithm instead.
Repository is an optional alternate OCI repository to use for signatures and attestations that match this rule.
If specified Repository will override other OCI image repository locations for this Attestor.
Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.
Allowed values are Audit or Enforce.
ImageReferences is a list of matching image reference patterns. At least one pattern in the
list must match the image for the rule to apply. Each image reference consists of a registry
address (defaults to docker.io), repository, image, and tag (defaults to latest).
Wildcards ('*' and '?') are allowed. See: https://kubernetes.io/docs/concepts/containers/images.
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
Secrets specifies a list of secrets that are provided for credentials.
Secrets must live in the Kyverno namespace.
MutateDigest enables replacement of image tags with digests.
Defaults to true.
Repository is an optional alternate OCI repository to use for image signatures and attestations that match this rule.
If specified Repository will override the default OCI image repository configured for the installation.
The repository can also be overridden per Attestor or Attestation.
Required validates that images are verified i.e. have matched passed a signature or attestation check.
SkipImageReferences is a list of matching image reference patterns that should be skipped.
At least one pattern in the list must match the image for the rule to be skipped. Each image reference
consists of a registry address (defaults to docker.io), repository, image, and tag (defaults to latest).
Wildcards ('*' and '?') are allowed. See: https://kubernetes.io/docs/concepts/containers/images.
Type specifies the method of signature validation. The allowed options
are Cosign and Notary. By default Cosign is used if a type is not specified.
UseCache enables caching of image verify responses for this rule
Validation checks conditions across multiple image
verification attestations or context entries
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
Message specifies a custom message to be displayed on failure.
VerifyDigest validates that images have a digest.
Deprecated.
UseServerSideApply controls whether to use server-side apply for generate rules
If is set to "true" create & update for generate rules will use apply instead of create/update.
Defaults to "false" if not specified.
Deprecated, use validationFailureAction under the validate rule instead.
Deprecated, use validationFailureActionOverrides under the validate rule instead.
No Additional ItemsValidationFailureAction defines the policy validation failure action
A label selector is a label query over a set of resources. The result of matchLabels and
matchExpressions are ANDed. An empty label selector matches all objects. A null
label selector matches no objects.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringWebhookConfiguration specifies the custom configuration for Kubernetes admission webhookconfiguration.
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.
MatchCondition configures admission webhook matchConditions.
Requires Kubernetes 1.27 or later.
MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.
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(/pkg/apis/admission/types.go#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.
TimeoutSeconds specifies the maximum time in seconds allowed to apply this policy.
After the configured time expires, the admission request may fail, or may simply ignore the policy results,
based on the failure policy. The default timeout is 10s, the value must be between 1 and 30 seconds.
Deprecated, use webhookTimeoutSeconds under webhookConfiguration instead.
Status contains policy runtime data.
AutogenStatus contains autogen status information.
Rules is a list of Rule instances. It contains auto generated rules added for pod controllers
No Additional ItemsRule defines a validation, mutation, or generation control for matching resources.
Each rules contains a match declaration to select resources, and an optional exclude
declaration to specify which resources to exclude.
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
MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.
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(/pkg/apis/admission/types.go#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.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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
No Additional ItemsResourceFilter allow users to "AND" or "OR" between resources
ClusterRoles is the list of cluster-wide role names for the user.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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
No Additional ItemsResourceFilter allow users to "AND" or "OR" between resources
ClusterRoles is the list of cluster-wide role names for the user.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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.
No Additional ItemsNamespace 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringData 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.
ForEach applies generate 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.
No Additional ItemsAPIVersion 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.
No Additional ItemsNamespace 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringContext defines variables and data sources that can be used during rule execution.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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.
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.
List specifies a JMESPath expression that results in one or more elements
to which the validation logic is applied.
Name specifies the resource name.
Namespace specifies resource namespace.
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/
UID specifies the resource uid.
GenerateExisting controls whether to trigger the rule in existing resources
If is set to "true" the rule will be triggered and applied to existing matched resources.
Kind specifies resource kind.
Name specifies the resource name.
Namespace specifies resource namespace.
OrphanDownstreamOnPolicyDelete controls whether generated resources should be deleted when the rule that generated
them is deleted with synchronization enabled. This option is only applicable to generate rules of the data type.
See https://kyverno.io/docs/writing-policies/generate/#data-examples.
Defaults to "false" if not specified.
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.
Each additional property must conform to the following schema
Type: array of objectJMESPath is an optional JMESPath expression to apply to the image value.
This is useful when the extracted image begins with a prefix like 'docker://'.
The 'trimprefix' function may be used to trim the prefix: trimprefix(@, 'docker://').
Note - Image digest mutation may not be used when applying a JMESPAth to an image.
Key is an optional name of the field within 'path' that will be used to uniquely identify an image.
Note - this field MUST be unique.
Name is the entry the image will be available under 'images.<name>' in the context.
If this field is not defined, image entries will appear under 'images.custom'.
Path is the path to the object containing the image field in a custom resource.
It should be slash-separated. Each slash-separated key must be a valid YAML key or a wildcard '*'.
Wildcard keys are expanded in case of arrays or objects.
Value is an optional name of the field within 'path' that points to the image URI.
This is useful when a custom 'key' is also defined.
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
No Additional ItemsResourceFilter allow users to "AND" or "OR" between resources
ClusterRoles is the list of cluster-wide role names for the user.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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
No Additional ItemsResourceFilter allow users to "AND" or "OR" between resources
ClusterRoles is the list of cluster-wide role names for the user.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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.
No Additional ItemsResourceDescription 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).
Each additional property must conform to the following schema
Type: stringKinds is a list of resource kinds.
No Additional ItemsName 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringNamespaces 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.
No Additional ItemsAdmissionOperation can have one of the 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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringRoles is the list of namespaced role names for the user.
No Additional ItemsSubjects is the list of subject names like users, user groups, and service accounts.
No Additional ItemsSubject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
or a value for non-objects such as user and group names.
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.
No Additional ItemsForEachMutation 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.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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.
PatchStrategicMerge is a strategic merge patch used to modify resources.
See https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
and https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/patchesstrategicmerge/.
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/kustomization/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/
MutateExistingOnPolicyUpdate controls if the mutateExisting rule will be applied on policy events.
PatchStrategicMerge is a strategic merge patch used to modify resources.
See https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
and https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/patchesstrategicmerge/.
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/kustomization/patchesjson6902/.
Targets defines the target resources to be mutated.
No Additional ItemsTargetResourceSpec defines targets for mutating existing resources.
APIVersion specifies resource apiVersion.
Context defines variables and data sources that can be used during rule execution.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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/
Selector allows you to select target resources with their labels.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringUID specifies the resource uid.
Name is a label to identify the rule, It must be unique within the policy.
Must be at most 63 characters long
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/
ReportProperties are the additional properties from the rule that will be added to the policy report result
Each additional property must conform to the following schema
Type: stringSkipBackgroundRequests 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.
AllowExistingViolations allows prexisting violating resources to continue violating a policy.
AnyPattern specifies list of validation patterns. At least one of the patterns
must be satisfied for the validation rule to succeed.
Assert defines a kyverno-json assertion tree.
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.
No Additional ItemsAuditAnnotation describes how to produce an audit annotation for an 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.
No Additional ItemsValidation specifies the CEL expression which is used to apply the validation.
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:
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.xdashprop > 0"}
- Expression accessing a property named "redactd": {"Expression": "object.redactunderscoresd > 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.
Generate specifies whether to generate a Kubernetes ValidatingAdmissionPolicy from the rule.
Optional. Defaults to "false" if not specified.
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.
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.
A single parameter used for all admission requests can be configured
by setting the name field, leaving selector blank, and setting namespace
if paramKind is namespace-scoped.
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
Required
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.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringVariables 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.
Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.
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
FailureAction defines if a validation policy rule violation should block
the admission review request (Enforce), or allow (Audit) the admission review request
and report an error in a policy report. Optional.
Allowed values are Audit or Enforce.
FailureActionOverrides is a Cluster Policy attribute that specifies FailureAction
namespace-wise. It overrides FailureAction for the specified namespaces.
ValidationFailureAction defines the policy validation failure action
A label selector is a label query over a set of resources. The result of matchLabels and
matchExpressions are ANDed. An empty label selector matches all objects. A null
label selector matches no objects.
matchExpressions is a list of label selector requirements. The requirements are ANDed.
No Additional ItemsA label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
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.
Each additional property must conform to the following schema
Type: stringForEach 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.
No Additional ItemsForEachValidation 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.
No Additional ItemsContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.
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.
The data object specifies the POST data sent to the server.
Only applicable when the method field is set to POST.
RequestData contains the HTTP POST data
Key is a unique identifier for the data value
Value is the data value
Default is an optional arbitrary JSON object that the context
value is set to, if the apiCall returns error.
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.
Method is the HTTP request type (GET or POST). Defaults to GET.
Service is an API call to a JSON web service.
This is used for non-Kubernetes API server calls.
It's mutually exclusive with the URLPath field.
CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.
Headers is a list of optional HTTP headers to be included in the request.
No Additional ItemsKey is the header key
Value is the header value
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.
It's mutually exclusive with the Service field.
ConfigMap is the ConfigMap reference.
Name is the ConfigMap name.
Namespace is the ConfigMap namespace.
GlobalContextEntryReference is a reference to a cached global context entry.
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.
Name of the global context entry
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
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/
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)
No Additional ItemsCount 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.
Value must be greater or equal to 1
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.
Each additional property must conform to the following schema
Type: stringAttestor is a nested set of Attestor used to specify a more complex set of match authorities.
Certificates specifies one or more certificates.
Cert is an optional PEM-encoded public certificate.
CertChain is an optional PEM encoded set of certificates used to verify.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Keyless is a set of attribute used to verify a Sigstore keyless attestor.
See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.
AdditionalExtensions are certificate-extensions used for keyless signing.
Each additional property must conform to the following schema
Type: stringCTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Issuer is the certificate issuer used for keyless signing.
IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Roots is an optional set of PEM encoded trusted root certificates.
If not provided, the system roots are used.
Subject is the verified identity used for keyless signing, for example the email address.
SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.
Keys specifies one or more public keys.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
KMS provides the URI to the public key stored in a Key Management System. See:
https://github.com/sigstore/cosign/blob/main/KMS.md
Keys is a set of X.509 public keys used to verify image signatures. The keys can be directly
specified or can be a variable reference to a key specified in a ConfigMap (see
https://kyverno.io/docs/writing-policies/variables/), or reference a standard Kubernetes Secret
elsewhere in the cluster by specifying it in the format "k8s://<namespace>/<secret_name>".
The named Secret must specify a key cosign.pub containing the public key used for
verification, (see https://github.com/sigstore/cosign/blob/main/KMS.md#kubernetes-secret).
When multiple keys are specified each key is processed as a separate staticKey entry
(.attestors[*].entries.keys) within the set of attestors and the count is applied across the keys.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Reference to a Secret resource that contains a public key
Name of the secret. The provided secret must contain a key named cosign.pub.
Namespace name where the Secret exists.
Deprecated. Use attestor.signatureAlgorithm instead.
Repository is an optional alternate OCI repository to use for signatures and attestations that match this rule.
If specified Repository will override other OCI image repository locations for this Attestor.
Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.
DryRun configuration
Fields which will be ignored while comparing manifests.
No Additional ItemsRepository is an optional alternate OCI repository to use for resource bundle reference.
The repository can be overridden per Attestor or Attestation.
Message specifies a custom message to be displayed on failure.
Pattern specifies an overlay-style pattern used to check resources.
PodSecurity applies exemptions for Kubernetes Pod Security admission
by specifying exclusions for Pod Security Standards controls.
Exclude specifies the Pod Security Standard controls to be excluded.
No Additional ItemsPodSecurityStandard specifies the Pod Security Standard controls to be excluded.
ControlName specifies the name of the Pod Security Standard control.
See: https://kubernetes.io/docs/concepts/security/pod-security-standards/
Images selects matching containers and applies the container level PSS.
Each image is the image name consisting of the registry address, repository, image, and tag.
Empty list matches no containers, PSS checks are applied at the pod level only.
Wildcards ('*' and '?') are allowed. See: https://kubernetes.io/docs/concepts/containers/images.
RestrictedField selects the field for the given Pod Security Standard control.
When not set, all restricted fields for the control are selected.
Values defines the allowed values that can be excluded.
No Additional ItemsLevel defines the Pod Security Standard level to be applied to workloads.
Allowed values are privileged, baseline, and restricted.
Version defines the Pod Security Standard versions that Kubernetes supports.
Allowed values are v1.19, v1.20, v1.21, v1.22, v1.23, v1.24, v1.25, v1.26, v1.27, v1.28, v1.29, v1.30, v1.31, v1.32, latest. Defaults to latest.
VerifyImages is used to verify image signatures and mutate them to add a digest
No Additional ItemsImageVerification validates that images that match the specified pattern
are signed with the supplied public key. Once the image is verified it is
mutated to include the SHA digest retrieved during the registration.
Deprecated.
Each additional property must conform to the following schema
Type: stringDeprecated. Use annotations per Attestor instead.
Each additional property must conform to the following schema
Type: stringAttestations are optional checks for signed in-toto Statements used to verify the image.
See https://github.com/in-toto/attestation. Kyverno fetches signed attestations from the
OCI registry and decodes them into a list of Statement declarations.
Attestation are checks for signed in-toto Statements that are used to verify the image.
See https://github.com/in-toto/attestation. Kyverno fetches signed attestations from the
OCI registry and decodes them into a list of Statements.
Attestors specify the required attestors (i.e. authorities).
No Additional ItemsCount 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.
Value must be greater or equal to 1
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.
Each additional property must conform to the following schema
Type: stringAttestor is a nested set of Attestor used to specify a more complex set of match authorities.
Certificates specifies one or more certificates.
Cert is an optional PEM-encoded public certificate.
CertChain is an optional PEM encoded set of certificates used to verify.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Keyless is a set of attribute used to verify a Sigstore keyless attestor.
See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.
AdditionalExtensions are certificate-extensions used for keyless signing.
Each additional property must conform to the following schema
Type: stringCTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Issuer is the certificate issuer used for keyless signing.
IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Roots is an optional set of PEM encoded trusted root certificates.
If not provided, the system roots are used.
Subject is the verified identity used for keyless signing, for example the email address.
SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.
Keys specifies one or more public keys.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
KMS provides the URI to the public key stored in a Key Management System. See:
https://github.com/sigstore/cosign/blob/main/KMS.md
Keys is a set of X.509 public keys used to verify image signatures. The keys can be directly
specified or can be a variable reference to a key specified in a ConfigMap (see
https://kyverno.io/docs/writing-policies/variables/), or reference a standard Kubernetes Secret
elsewhere in the cluster by specifying it in the format "k8s://<namespace>/<secret_name>".
The named Secret must specify a key cosign.pub containing the public key used for
verification, (see https://github.com/sigstore/cosign/blob/main/KMS.md#kubernetes-secret).
When multiple keys are specified each key is processed as a separate staticKey entry
(.attestors[*].entries.keys) within the set of attestors and the count is applied across the keys.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Reference to a Secret resource that contains a public key
Name of the secret. The provided secret must contain a key named cosign.pub.
Namespace name where the Secret exists.
Deprecated. Use attestor.signatureAlgorithm instead.
Repository is an optional alternate OCI repository to use for signatures and attestations that match this rule.
If specified Repository will override other OCI image repository locations for this Attestor.
Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.
Conditions are used to verify attributes within a Predicate. If no Conditions are specified
the attestation check is satisfied as long there are predicates that match the predicate type.
AnyAllConditions consists of conditions wrapped denoting a logical criteria to be fulfilled.
AnyConditions get fulfilled when at least one of its sub-conditions passes.
AllConditions get fulfilled only when all of its sub-conditions pass.
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
Condition defines variable-based conditional criteria for rule execution.
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
Condition defines variable-based conditional criteria for rule execution.
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.
Name is the variable name.
Deprecated in favour of 'Type', to be removed soon
Type defines the type of attestation contained within the Statement.
Attestors specified the required attestors (i.e. authorities)
No Additional ItemsCount 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.
Value must be greater or equal to 1
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.
Each additional property must conform to the following schema
Type: stringAttestor is a nested set of Attestor used to specify a more complex set of match authorities.
Certificates specifies one or more certificates.
Cert is an optional PEM-encoded public certificate.
CertChain is an optional PEM encoded set of certificates used to verify.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Keyless is a set of attribute used to verify a Sigstore keyless attestor.
See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.
AdditionalExtensions are certificate-extensions used for keyless signing.
Each additional property must conform to the following schema
Type: stringCTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
Issuer is the certificate issuer used for keyless signing.
IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Roots is an optional set of PEM encoded trusted root certificates.
If not provided, the system roots are used.
Subject is the verified identity used for keyless signing, for example the email address.
SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.
Keys specifies one or more public keys.
CTLog (certificate timestamp log) provides a configuration for validation of Signed Certificate
Timestamps (SCTs). If the value is unset, the default behavior by Cosign is used.
IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate
timestamp. Default is false. Set to true if this was opted out during signing.
PubKey, if set, is used to validate SCTs against a custom source.
TSACertChain, if set, is the PEM-encoded certificate chain file for the RFC3161 timestamp authority. Must
contain the root CA certificate. Optionally may contain intermediate CA certificates, and
may contain the leaf TSA certificate if not present in the timestamurce.
KMS provides the URI to the public key stored in a Key Management System. See:
https://github.com/sigstore/cosign/blob/main/KMS.md
Keys is a set of X.509 public keys used to verify image signatures. The keys can be directly
specified or can be a variable reference to a key specified in a ConfigMap (see
https://kyverno.io/docs/writing-policies/variables/), or reference a standard Kubernetes Secret
elsewhere in the cluster by specifying it in the format "k8s://<namespace>/<secret_name>".
The named Secret must specify a key cosign.pub containing the public key used for
verification, (see https://github.com/sigstore/cosign/blob/main/KMS.md#kubernetes-secret).
When multiple keys are specified each key is processed as a separate staticKey entry
(.attestors[*].entries.keys) within the set of attestors and the count is applied across the keys.
Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (https://rekor.sigstore.dev) is used.
IgnoreTlog skips transparency log verification.
RekorPubKey is an optional PEM-encoded public key to use for a custom Rekor.
If set, this will be used to validate transparency log signatures from a custom Rekor.
URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.
Reference to a Secret resource that contains a public key
Name of the secret. The provided secret must contain a key named cosign.pub.
Namespace name where the Secret exists.
Deprecated. Use attestor.signatureAlgorithm instead.
Repository is an optional alternate OCI repository to use for signatures and attestations that match this rule.
If specified Repository will override other OCI image repository locations for this Attestor.
Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.
CosignOCI11 enables the experimental OCI 1.1 behaviour in cosign image verification.
Defaults to false.
Allowed values are Audit or Enforce.
Deprecated. Use ImageReferences instead.
ImageReferences is a list of matching image reference patterns. At least one pattern in the
list must match the image for the rule to apply. Each image reference consists of a registry
address (defaults to docker.io), repository, image, and tag (defaults to latest).
Wildcards ('*' and '?') are allowed. See: https://kubernetes.io/docs/concepts/containers/images.
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.
ImageRegistryCredentialsProvidersType provides the list of credential providers required.
Secrets specifies a list of secrets that are provided for credentials.
Secrets must live in the Kyverno namespace.
Deprecated. Use KeylessAttestor instead.
Deprecated. Use StaticKeyAttestor instead.
MutateDigest enables replacement of image tags with digests.
Defaults to true.
Repository is an optional alternate OCI repository to use for image signatures and attestations that match this rule.
If specified Repository will override the default OCI image repository configured for the installation.
The repository can also be overridden per Attestor or Attestation.
Required validates that images are verified i.e. have matched passed a signature or attestation check.
Deprecated. Use KeylessAttestor instead.
SkipImageReferences is a list of matching image reference patterns that should be skipped.
At least one pattern in the list must match the image for the rule to be skipped. Each image reference
consists of a registry address (defaults to docker.io), repository, image, and tag (defaults to latest).
Wildcards ('*' and '?') are allowed. See: https://kubernetes.io/docs/concepts/containers/images.
Deprecated. Use KeylessAttestor instead.
Type specifies the method of signature validation. The allowed options
are Cosign, Sigstore Bundle and Notary. By default Cosign is used if a type is not specified.
UseCache enables caching of image verify responses for this rule.
Validation checks conditions across multiple image
verification attestations or context entries
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
Message specifies a custom message to be displayed on failure.
VerifyDigest validates that images have a digest.
Condition contains details for one aspect of the current state of this API Resource.
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message is a human readable message indicating details about the transition.
This may be an empty string.
Must be at most 32768 characters long
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.
Value must be greater or equal to 0
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
Must be at least 1 characters long
Must be at most 1024 characters long
status of the condition, one of True, False, Unknown.
type of condition in CamelCase or in foo.example.com/CamelCase.
Must match regular expression:^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
Must be at most 316 characters long
Deprecated in favor of Conditions
RuleCountStatus contains four variables which describes counts for
validate, generate, mutate and verify images rules
Count for generate rules in policy
Count for mutate rules in policy
Count for validate rules in policy
Count for verify image rules in policy
ValidatingAdmissionPolicy contains status information
Generated indicates whether a validating admission policy is generated from the policy or not
Message is a human readable message indicating details about the generation of validating admission policy
It is an empty string when validating admission policy is successfully generated.