ClusterPolicy v1 — kyverno.io

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object required

Spec declares policy behaviors.

admission boolean

Admission controls if rules are applied during admission. Optional. Default value is "true".

applyRules string

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`.

enum: All, One

background boolean

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 boolean

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".

failurePolicy string

Deprecated, use failurePolicy under the webhookConfiguration instead.

enum: Ignore, Fail

generateExisting boolean

Deprecated, use generateExisting under the generate rule instead

generateExistingOnPolicyUpdate boolean

Deprecated, use generateExisting instead

mutateExistingOnPolicyUpdate boolean

Deprecated, use mutateExistingOnPolicyUpdate under the mutate rule instead

rules []object

Rules is a list of Rule instances. A Policy contains multiple rules and each rule can validate, mutate, or generate resources.

celPreconditions []object

CELPreconditions are used to determine if a policy rule should be applied by evaluating a set of CEL conditions. It can only be used with the validate.cel subrule

expression string required

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 string 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 []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

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 string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

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 object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

exclude object

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 []object

All allows specifying resources which will be ANDed

clusterRoles []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

ResourceDescription contains information about the resource being created or modified.

annotations object

Annotations is a map of annotations (key-value pairs of type string). Annotation keys and values support the wildcard characters "*" (matches zero or many characters) and "?" (matches at least one character).

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

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 []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

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 object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

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 []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

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 string required

Name of the object being referenced.

namespace string

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 []object

Any allows specifying resources which will be ORed

clusterRoles []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

ResourceDescription contains information about the resource being created or modified.

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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 []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

ResourceDescription contains information about the resource being created or modified. Requires at least one tag to be specified when under MatchResources. Specifying ResourceDescription directly under match is being deprecated. Please specify under "any" or "all" instead.

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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.

generate object

Generation is used to create new resources.

apiVersion string

APIVersion specifies resource apiVersion.

clone object

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 string

Name specifies name of the resource.

namespace string

Namespace specifies source resource namespace.

cloneList object

CloneList specifies the list of source resource used to populate each generated resource.

kinds []string

Kinds is a list of resource kinds.

namespace string

Namespace specifies source resource namespace.

selector object

Selector is a label selector. Label keys and values in `matchLabels`. wildcard characters are not supported.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

data object

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.

foreach []object

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.

apiVersion string

APIVersion specifies resource apiVersion.

clone object

name string

Name specifies name of the resource.

namespace string

Namespace specifies source resource namespace.

cloneList object

CloneList specifies the list of source resource used to populate each generated resource.

kinds []string

Kinds is a list of resource kinds.

namespace string

Namespace specifies source resource namespace.

selector object

Selector is a label selector. Label keys and values in `matchLabels`. wildcard characters are not supported.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

context []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

method string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

configMap object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

data object

kind string

Kind specifies resource kind.

list string

List specifies a JMESPath expression that results in one or more elements to which the validation logic is applied.

name string

Name specifies the resource name.

namespace string

Namespace specifies resource namespace.

preconditions object

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/

all []object

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 object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

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

enum: Equals, NotEquals, In, AnyIn, AllIn, NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals, GreaterThan, LessThanOrEquals, LessThan, DurationGreaterThanOrEquals, DurationGreaterThan, DurationLessThanOrEquals, DurationLessThan

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

any []object

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 object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

uid string

UID specifies the resource uid.

generateExisting boolean

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 string

Kind specifies resource kind.

name string

Name specifies the resource name.

namespace string

Namespace specifies resource namespace.

orphanDownstreamOnPolicyDelete boolean

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 boolean

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 string

UID specifies the resource uid.

imageExtractors object

ImageExtractors defines a mapping from kinds to ImageExtractorConfigs. This config is only valid for verifyImages rules.

match object required

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 []object

All allows specifying resources which will be ANDed

clusterRoles []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

ResourceDescription contains information about the resource being created or modified.

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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 []object

Any allows specifying resources which will be ORed

clusterRoles []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

ResourceDescription contains information about the resource being created or modified.

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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 []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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.

mutate object

Mutation is used to modify matching resources.

foreach []object

ForEach applies mutation rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.

context []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

method string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

configMap object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

foreach object

Foreach declares a nested foreach iterator

list string

List specifies a JMESPath expression that results in one or more elements to which the validation logic is applied.

order string

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.

enum: Ascending, Descending

patchStrategicMerge object

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 string

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/.

preconditions object

all []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

any []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

mutateExistingOnPolicyUpdate boolean

MutateExistingOnPolicyUpdate controls if the mutateExisting rule will be applied on policy events.

patchStrategicMerge object

patchesJson6902 string

targets []object

Targets defines the target resources to be mutated.

apiVersion string

APIVersion specifies resource apiVersion.

context []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

method string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

configMap object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

kind string

Kind specifies resource kind.

name string

Name specifies the resource name.

namespace string

Namespace specifies resource namespace.

preconditions object

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 object

Selector allows you to select target resources with their labels.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

uid string

UID specifies the resource uid.

name string required

Name is a label to identify the rule, It must be unique within the policy.

maxLength: 63

preconditions object

reportProperties object

ReportProperties are the additional properties from the rule that will be added to the policy report result

skipBackgroundRequests boolean

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.

validate object

Validation is used to validate matching resources.

allowExistingViolations boolean

AllowExistingViolations allows prexisting violating resources to continue violating a policy.

anyPattern object

AnyPattern specifies list of validation patterns. At least one of the patterns must be satisfied for the validation rule to succeed.

assert object

Assert defines a kyverno-json assertion tree.

cel object

CEL allows validation checks using the Common Expression Language (https://kubernetes.io/docs/reference/using-api/cel/).

auditAnnotations []object

AuditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request.

key string required

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 string 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 []object

Expressions is a list of CELExpression types.

expression string required

Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables: - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value. For example, a variable named 'foo' can be accessed as 'variables.foo'. - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the request resource. The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible. Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples: - Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"} - Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"} - Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"} Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and non-intersecting elements in `Y` are appended, retaining their partial order. - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with non-intersecting keys are appended, retaining their partial order. Required.

message string

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 string

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 string

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 boolean

Generate specifies whether to generate a Kubernetes ValidatingAdmissionPolicy from the rule. Optional. Defaults to "false" if not specified.

paramKind object

ParamKind is a tuple of Group Kind and Version.

apiVersion string

APIVersion is the API group version the resources belong to. In format of "group/version". Required.

kind string

Kind is the API kind the resources belong to. Required.

paramRef object

ParamRef references a parameter resource.

name string

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 string

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 string

`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 object

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 []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

variables []object

Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy.

expression string required

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 string required

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 object

Deny defines conditions used to pass or fail a validation rule.

conditions object

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 string

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.

enum: Audit, Enforce

failureActionOverrides []object

FailureActionOverrides is a Cluster Policy attribute that specifies FailureAction namespace-wise. It overrides FailureAction for the specified namespaces.

action string

ValidationFailureAction defines the policy validation failure action

enum: audit, enforce, Audit, Enforce

namespaceSelector object

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 []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

foreach []object

ForEach applies validate rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.

anyPattern object

AnyPattern specifies list of validation patterns. At least one of the patterns must be satisfied for the validation rule to succeed.

context []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

method string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

configMap object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

deny object

Deny defines conditions used to pass or fail a validation rule.

conditions object

elementScope boolean

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 object

Foreach declares a nested foreach iterator

list string

List specifies a JMESPath expression that results in one or more elements to which the validation logic is applied.

pattern object

Pattern specifies an overlay-style pattern used to check resources.

preconditions object

all []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

any []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

manifests object

Manifest specifies conditions for manifest verification

annotationDomain string

AnnotationDomain is custom domain of annotation for message and signature. Default is "cosign.sigstore.dev".

attestors []object

Attestors specified the required attestors (i.e. authorities)

count integer

Count specifies the required number of entries that must match. If the count is null, all entries must match (a logical AND). If the count is 1, at least one entry must match (a logical OR). If the count contains a value N, then N must be less than or equal to the size of entries, and at least N entries must match.

minimum: 1

entries []object

Entries contains the available attestors. An attestor can be a static key, attributes for keyless verification, or a nested attestor declaration.

annotations object

Annotations are used for image verification. Every specified key-value pair must exist and match in the verified payload. The payload may contain other key-value pairs.

attestor object

Attestor is a nested set of Attestor used to specify a more complex set of match authorities.

certificates object

Certificates specifies one or more certificates.

cert string

Cert is an optional PEM-encoded public certificate.

certChain string

CertChain is an optional PEM encoded set of certificates used to verify.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

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 object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

keyless object

Keyless is a set of attribute used to verify a Sigstore keyless attestor. See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.

additionalExtensions object

AdditionalExtensions are certificate-extensions used for keyless signing.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

issuer string

Issuer is the certificate issuer used for keyless signing.

issuerRegExp string

IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

roots string

Roots is an optional set of PEM encoded trusted root certificates. If not provided, the system roots are used.

subject string

Subject is the verified identity used for keyless signing, for example the email address.

subjectRegExp string

SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.

keys object

Keys specifies one or more public keys.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

kms string

KMS provides the URI to the public key stored in a Key Management System. See: https://github.com/sigstore/cosign/blob/main/KMS.md

publicKeys string

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 object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

secret object

Reference to a Secret resource that contains a public key

name string required

Name of the secret. The provided secret must contain a key named cosign.pub.

namespace string required

Namespace name where the Secret exists.

signatureAlgorithm string

Deprecated. Use attestor.signatureAlgorithm instead.

repository string

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.

signatureAlgorithm string

Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.

dryRun object

DryRun configuration

enable boolean

namespace string

ignoreFields []object

Fields which will be ignored while comparing manifests.

fields []string

objects []object

group string

kind string

name string

namespace string

version string

repository string

Repository is an optional alternate OCI repository to use for resource bundle reference. The repository can be overridden per Attestor or Attestation.

message string

Message specifies a custom message to be displayed on failure.

pattern object

Pattern specifies an overlay-style pattern used to check resources.

podSecurity object

PodSecurity applies exemptions for Kubernetes Pod Security admission by specifying exclusions for Pod Security Standards controls.

exclude []object

Exclude specifies the Pod Security Standard controls to be excluded.

controlName string required

ControlName specifies the name of the Pod Security Standard control. See: https://kubernetes.io/docs/concepts/security/pod-security-standards/

enum: HostProcess, Host Namespaces, Privileged Containers, Capabilities, HostPath Volumes, Host Ports, AppArmor, SELinux, /proc Mount Type, Seccomp, Sysctls, Volume Types, Privilege Escalation, Running as Non-root, Running as Non-root user

images []string

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 string

RestrictedField selects the field for the given Pod Security Standard control. When not set, all restricted fields for the control are selected.

values []string

Values defines the allowed values that can be excluded.

level string

Level defines the Pod Security Standard level to be applied to workloads. Allowed values are privileged, baseline, and restricted.

enum: privileged, baseline, restricted

version string

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.

enum: 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

verifyImages []object

VerifyImages is used to verify image signatures and mutate them to add a digest

additionalExtensions object

Deprecated.

annotations object

Deprecated. Use annotations per Attestor instead.

attestations []object

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.

attestors []object

Attestors specify the required attestors (i.e. authorities).

count integer

minimum: 1

entries []object

Entries contains the available attestors. An attestor can be a static key, attributes for keyless verification, or a nested attestor declaration.

annotations object

Annotations are used for image verification. Every specified key-value pair must exist and match in the verified payload. The payload may contain other key-value pairs.

attestor object

Attestor is a nested set of Attestor used to specify a more complex set of match authorities.

certificates object

Certificates specifies one or more certificates.

cert string

Cert is an optional PEM-encoded public certificate.

certChain string

CertChain is an optional PEM encoded set of certificates used to verify.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

keyless object

Keyless is a set of attribute used to verify a Sigstore keyless attestor. See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.

additionalExtensions object

AdditionalExtensions are certificate-extensions used for keyless signing.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

issuer string

Issuer is the certificate issuer used for keyless signing.

issuerRegExp string

IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

roots string

Roots is an optional set of PEM encoded trusted root certificates. If not provided, the system roots are used.

subject string

Subject is the verified identity used for keyless signing, for example the email address.

subjectRegExp string

SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.

keys object

Keys specifies one or more public keys.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

kms string

KMS provides the URI to the public key stored in a Key Management System. See: https://github.com/sigstore/cosign/blob/main/KMS.md

publicKeys string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

secret object

Reference to a Secret resource that contains a public key

name string required

Name of the secret. The provided secret must contain a key named cosign.pub.

namespace string required

Namespace name where the Secret exists.

signatureAlgorithm string

Deprecated. Use attestor.signatureAlgorithm instead.

repository string

signatureAlgorithm string

Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.

conditions []object

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.

all []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

any []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

name string

Name is the variable name.

predicateType string

Deprecated in favour of 'Type', to be removed soon

type string

Type defines the type of attestation contained within the Statement.

attestors []object

Attestors specified the required attestors (i.e. authorities)

count integer

minimum: 1

entries []object

Entries contains the available attestors. An attestor can be a static key, attributes for keyless verification, or a nested attestor declaration.

annotations object

Annotations are used for image verification. Every specified key-value pair must exist and match in the verified payload. The payload may contain other key-value pairs.

attestor object

Attestor is a nested set of Attestor used to specify a more complex set of match authorities.

certificates object

Certificates specifies one or more certificates.

cert string

Cert is an optional PEM-encoded public certificate.

certChain string

CertChain is an optional PEM encoded set of certificates used to verify.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

keyless object

Keyless is a set of attribute used to verify a Sigstore keyless attestor. See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.

additionalExtensions object

AdditionalExtensions are certificate-extensions used for keyless signing.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

issuer string

Issuer is the certificate issuer used for keyless signing.

issuerRegExp string

IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

roots string

Roots is an optional set of PEM encoded trusted root certificates. If not provided, the system roots are used.

subject string

Subject is the verified identity used for keyless signing, for example the email address.

subjectRegExp string

SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.

keys object

Keys specifies one or more public keys.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

kms string

KMS provides the URI to the public key stored in a Key Management System. See: https://github.com/sigstore/cosign/blob/main/KMS.md

publicKeys string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

secret object

Reference to a Secret resource that contains a public key

name string required

Name of the secret. The provided secret must contain a key named cosign.pub.

namespace string required

Namespace name where the Secret exists.

signatureAlgorithm string

Deprecated. Use attestor.signatureAlgorithm instead.

repository string

signatureAlgorithm string

Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.

cosignOCI11 boolean

CosignOCI11 enables the experimental OCI 1.1 behaviour in cosign image verification. Defaults to false.

failureAction string

Allowed values are Audit or Enforce.

enum: Audit, Enforce

image string

Deprecated. Use ImageReferences instead.

imageReferences []string

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 object

ImageRegistryCredentials provides credentials that will be used for authentication with registry.

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

issuer string

Deprecated. Use KeylessAttestor instead.

key string

Deprecated. Use StaticKeyAttestor instead.

mutateDigest boolean

MutateDigest enables replacement of image tags with digests. Defaults to true.

repository string

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 boolean

Required validates that images are verified i.e. have matched passed a signature or attestation check.

roots string

Deprecated. Use KeylessAttestor instead.

skipImageReferences []string

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.

subject string

Deprecated. Use KeylessAttestor instead.

type string

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.

enum: Cosign, SigstoreBundle, Notary

useCache boolean

UseCache enables caching of image verify responses for this rule.

validate object

Validation checks conditions across multiple image verification attestations or context entries

deny object

Deny defines conditions used to pass or fail a validation rule.

conditions object

message string

Message specifies a custom message to be displayed on failure.

verifyDigest boolean

VerifyDigest validates that images have a digest.

schemaValidation boolean

Deprecated.

useServerSideApply boolean

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.

validationFailureAction string

Deprecated, use validationFailureAction under the validate rule instead.

enum: audit, enforce, Audit, Enforce

validationFailureActionOverrides []object

Deprecated, use validationFailureActionOverrides under the validate rule instead.

action string

ValidationFailureAction defines the policy validation failure action

enum: audit, enforce, Audit, Enforce

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

webhookConfiguration object

WebhookConfiguration specifies the custom configuration for Kubernetes admission webhookconfiguration.

failurePolicy string

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.

enum: Ignore, Fail

matchConditions []object

MatchCondition configures admission webhook matchConditions. Requires Kubernetes 1.27 or later.

expression string required

name string required

timeoutSeconds integer

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.

format: int32

webhookTimeoutSeconds integer

Deprecated, use webhookTimeoutSeconds under webhookConfiguration instead.

format: int32

status object

Status contains policy runtime data.

autogen object

AutogenStatus contains autogen status information.

rules []object

Rules is a list of Rule instances. It contains auto generated rules added for pod controllers

celPreconditions []object

CELPreconditions are used to determine if a policy rule should be applied by evaluating a set of CEL conditions. It can only be used with the validate.cel subrule

expression string required

name string required

context []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

method string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

configMap object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

exclude object

all []object

All allows specifying resources which will be ANDed

clusterRoles []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

ResourceDescription contains information about the resource being created or modified.

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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 []object

Any allows specifying resources which will be ORed

clusterRoles []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

ResourceDescription contains information about the resource being created or modified.

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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 []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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.

generate object

Generation is used to create new resources.

apiVersion string

APIVersion specifies resource apiVersion.

clone object

name string

Name specifies name of the resource.

namespace string

Namespace specifies source resource namespace.

cloneList object

CloneList specifies the list of source resource used to populate each generated resource.

kinds []string

Kinds is a list of resource kinds.

namespace string

Namespace specifies source resource namespace.

selector object

Selector is a label selector. Label keys and values in `matchLabels`. wildcard characters are not supported.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

data object

foreach []object

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.

apiVersion string

APIVersion specifies resource apiVersion.

clone object

name string

Name specifies name of the resource.

namespace string

Namespace specifies source resource namespace.

cloneList object

CloneList specifies the list of source resource used to populate each generated resource.

kinds []string

Kinds is a list of resource kinds.

namespace string

Namespace specifies source resource namespace.

selector object

Selector is a label selector. Label keys and values in `matchLabels`. wildcard characters are not supported.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

context []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

method string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

configMap object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

data object

kind string

Kind specifies resource kind.

list string

List specifies a JMESPath expression that results in one or more elements to which the validation logic is applied.

name string

Name specifies the resource name.

namespace string

Namespace specifies resource namespace.

preconditions object

all []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

any []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

uid string

UID specifies the resource uid.

generateExisting boolean

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 string

Kind specifies resource kind.

name string

Name specifies the resource name.

namespace string

Namespace specifies resource namespace.

orphanDownstreamOnPolicyDelete boolean

synchronize boolean

uid string

UID specifies the resource uid.

imageExtractors object

ImageExtractors defines a mapping from kinds to ImageExtractorConfigs. This config is only valid for verifyImages rules.

match object required

all []object

All allows specifying resources which will be ANDed

clusterRoles []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

ResourceDescription contains information about the resource being created or modified.

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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 []object

Any allows specifying resources which will be ORed

clusterRoles []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

ResourceDescription contains information about the resource being created or modified.

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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 []string

ClusterRoles is the list of cluster-wide role names for the user.

resources object

annotations object

kinds []string

Kinds is a list of resource kinds.

name string

Name is the name of the resource. The name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character). NOTE: "Name" is being deprecated in favor of "Names".

names []string

Names are the names of the resources. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

Namespaces is a list of namespaces names. Each name supports wildcard characters "*" (matches zero or many characters) and "?" (at least one character).

operations []string

Operations can contain values ["CREATE, "UPDATE", "CONNECT", "DELETE"], which are used to match a specific action.

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

roles []string

Roles is the list of namespaced role names for the user.

subjects []object

Subjects is the list of subject names like users, user groups, and service accounts.

apiGroup string

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 string required

name string required

Name of the object being referenced.

namespace string

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.

mutate object

Mutation is used to modify matching resources.

foreach []object

ForEach applies mutation rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.

context []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

method string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

configMap object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

foreach object

Foreach declares a nested foreach iterator

list string

List specifies a JMESPath expression that results in one or more elements to which the validation logic is applied.

order string

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.

enum: Ascending, Descending

patchStrategicMerge object

patchesJson6902 string

preconditions object

all []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

any []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

mutateExistingOnPolicyUpdate boolean

MutateExistingOnPolicyUpdate controls if the mutateExisting rule will be applied on policy events.

patchStrategicMerge object

patchesJson6902 string

targets []object

Targets defines the target resources to be mutated.

apiVersion string

APIVersion specifies resource apiVersion.

context []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

method string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

configMap object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

kind string

Kind specifies resource kind.

name string

Name specifies the resource name.

namespace string

Namespace specifies resource namespace.

preconditions object

selector object

Selector allows you to select target resources with their labels.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

uid string

UID specifies the resource uid.

name string required

Name is a label to identify the rule, It must be unique within the policy.

maxLength: 63

preconditions object

reportProperties object

ReportProperties are the additional properties from the rule that will be added to the policy report result

skipBackgroundRequests boolean

validate object

Validation is used to validate matching resources.

allowExistingViolations boolean

AllowExistingViolations allows prexisting violating resources to continue violating a policy.

anyPattern object

AnyPattern specifies list of validation patterns. At least one of the patterns must be satisfied for the validation rule to succeed.

assert object

Assert defines a kyverno-json assertion tree.

cel object

CEL allows validation checks using the Common Expression Language (https://kubernetes.io/docs/reference/using-api/cel/).

auditAnnotations []object

AuditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request.

key string required

valueExpression string required

expressions []object

Expressions is a list of CELExpression types.

expression string required

message string

messageExpression string

reason string

generate boolean

Generate specifies whether to generate a Kubernetes ValidatingAdmissionPolicy from the rule. Optional. Defaults to "false" if not specified.

paramKind object

ParamKind is a tuple of Group Kind and Version.

apiVersion string

APIVersion is the API group version the resources belong to. In format of "group/version". Required.

kind string

Kind is the API kind the resources belong to. Required.

paramRef object

ParamRef references a parameter resource.

name string

namespace string

parameterNotFoundAction string

selector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

variables []object

expression string required

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 string required

deny object

Deny defines conditions used to pass or fail a validation rule.

conditions object

failureAction string

enum: Audit, Enforce

failureActionOverrides []object

FailureActionOverrides is a Cluster Policy attribute that specifies FailureAction namespace-wise. It overrides FailureAction for the specified namespaces.

action string

ValidationFailureAction defines the policy validation failure action

enum: audit, enforce, Audit, Enforce

namespaceSelector object

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

namespaces []string

foreach []object

ForEach applies validate rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.

anyPattern object

AnyPattern specifies list of validation patterns. At least one of the patterns must be satisfied for the validation rule to succeed.

context []object

Context defines variables and data sources that can be used during rule execution.

apiCall object

APICall is an HTTP request to the Kubernetes API server, or other JSON web service. The data returned is stored in the context with the name for the context entry.

data []object

The data object specifies the POST data sent to the server. Only applicable when the method field is set to POST.

key string required

Key is a unique identifier for the data value

value object required

Value is the data value

default object

Default is an optional arbitrary JSON object that the context value is set to, if the apiCall returns error.

jmesPath string

method string

Method is the HTTP request type (GET or POST). Defaults to GET.

enum: GET, POST

service object

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 string

CABundle is a PEM encoded CA bundle which will be used to validate the server certificate.

headers []object

Headers is a list of optional HTTP headers to be included in the request.

key string required

Key is the header key

value string required

Value is the header value

url string required

URL is the JSON web service URL. A typical form is `https://{service}.{namespace}:{port}/{path}`.

urlPath string

configMap object

ConfigMap is the ConfigMap reference.

name string required

Name is the ConfigMap name.

namespace string

Namespace is the ConfigMap namespace.

globalReference object

GlobalContextEntryReference is a reference to a cached global context entry.

jmesPath string

name string required

Name of the global context entry

imageRegistry object

ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

jmesPath string

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 string required

Reference is image reference to a container image in the registry. Example: ghcr.io/kyverno/kyverno:latest

name string required

Name is the variable name.

variable object

Variable defines an arbitrary JMESPath context variable that can be defined inline.

default object

Default is an optional arbitrary JSON object that the variable may take if the JMESPath expression evaluates to nil

jmesPath string

JMESPath is an optional JMESPath Expression that can be used to transform the variable.

value object

Value is any arbitrary JSON object representable in YAML or JSON form.

deny object

Deny defines conditions used to pass or fail a validation rule.

conditions object

elementScope boolean

foreach object

Foreach declares a nested foreach iterator

list string

List specifies a JMESPath expression that results in one or more elements to which the validation logic is applied.

pattern object

Pattern specifies an overlay-style pattern used to check resources.

preconditions object

all []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

any []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

manifests object

Manifest specifies conditions for manifest verification

annotationDomain string

AnnotationDomain is custom domain of annotation for message and signature. Default is "cosign.sigstore.dev".

attestors []object

Attestors specified the required attestors (i.e. authorities)

count integer

minimum: 1

entries []object

Entries contains the available attestors. An attestor can be a static key, attributes for keyless verification, or a nested attestor declaration.

annotations object

Annotations are used for image verification. Every specified key-value pair must exist and match in the verified payload. The payload may contain other key-value pairs.

attestor object

Attestor is a nested set of Attestor used to specify a more complex set of match authorities.

certificates object

Certificates specifies one or more certificates.

cert string

Cert is an optional PEM-encoded public certificate.

certChain string

CertChain is an optional PEM encoded set of certificates used to verify.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

keyless object

Keyless is a set of attribute used to verify a Sigstore keyless attestor. See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.

additionalExtensions object

AdditionalExtensions are certificate-extensions used for keyless signing.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

issuer string

Issuer is the certificate issuer used for keyless signing.

issuerRegExp string

IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

roots string

Roots is an optional set of PEM encoded trusted root certificates. If not provided, the system roots are used.

subject string

Subject is the verified identity used for keyless signing, for example the email address.

subjectRegExp string

SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.

keys object

Keys specifies one or more public keys.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

kms string

KMS provides the URI to the public key stored in a Key Management System. See: https://github.com/sigstore/cosign/blob/main/KMS.md

publicKeys string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

secret object

Reference to a Secret resource that contains a public key

name string required

Name of the secret. The provided secret must contain a key named cosign.pub.

namespace string required

Namespace name where the Secret exists.

signatureAlgorithm string

Deprecated. Use attestor.signatureAlgorithm instead.

repository string

signatureAlgorithm string

Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.

dryRun object

DryRun configuration

enable boolean

namespace string

ignoreFields []object

Fields which will be ignored while comparing manifests.

fields []string

objects []object

group string

kind string

name string

namespace string

version string

repository string

Repository is an optional alternate OCI repository to use for resource bundle reference. The repository can be overridden per Attestor or Attestation.

message string

Message specifies a custom message to be displayed on failure.

pattern object

Pattern specifies an overlay-style pattern used to check resources.

podSecurity object

PodSecurity applies exemptions for Kubernetes Pod Security admission by specifying exclusions for Pod Security Standards controls.

exclude []object

Exclude specifies the Pod Security Standard controls to be excluded.

controlName string required

ControlName specifies the name of the Pod Security Standard control. See: https://kubernetes.io/docs/concepts/security/pod-security-standards/

images []string

restrictedField string

RestrictedField selects the field for the given Pod Security Standard control. When not set, all restricted fields for the control are selected.

values []string

Values defines the allowed values that can be excluded.

level string

Level defines the Pod Security Standard level to be applied to workloads. Allowed values are privileged, baseline, and restricted.

enum: privileged, baseline, restricted

version string

enum: 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

verifyImages []object

VerifyImages is used to verify image signatures and mutate them to add a digest

additionalExtensions object

Deprecated.

annotations object

Deprecated. Use annotations per Attestor instead.

attestations []object

attestors []object

Attestors specify the required attestors (i.e. authorities).

count integer

minimum: 1

entries []object

Entries contains the available attestors. An attestor can be a static key, attributes for keyless verification, or a nested attestor declaration.

annotations object

Annotations are used for image verification. Every specified key-value pair must exist and match in the verified payload. The payload may contain other key-value pairs.

attestor object

Attestor is a nested set of Attestor used to specify a more complex set of match authorities.

certificates object

Certificates specifies one or more certificates.

cert string

Cert is an optional PEM-encoded public certificate.

certChain string

CertChain is an optional PEM encoded set of certificates used to verify.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

keyless object

Keyless is a set of attribute used to verify a Sigstore keyless attestor. See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.

additionalExtensions object

AdditionalExtensions are certificate-extensions used for keyless signing.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

issuer string

Issuer is the certificate issuer used for keyless signing.

issuerRegExp string

IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

roots string

Roots is an optional set of PEM encoded trusted root certificates. If not provided, the system roots are used.

subject string

Subject is the verified identity used for keyless signing, for example the email address.

subjectRegExp string

SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.

keys object

Keys specifies one or more public keys.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

kms string

KMS provides the URI to the public key stored in a Key Management System. See: https://github.com/sigstore/cosign/blob/main/KMS.md

publicKeys string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

secret object

Reference to a Secret resource that contains a public key

name string required

Name of the secret. The provided secret must contain a key named cosign.pub.

namespace string required

Namespace name where the Secret exists.

signatureAlgorithm string

Deprecated. Use attestor.signatureAlgorithm instead.

repository string

signatureAlgorithm string

Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.

conditions []object

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.

all []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

any []object

key object

Key is the context entry (using JMESPath) for conditional rule evaluation.

message string

Message is an optional display message

operator string

value object

Value is the conditional value, or set of values. The values can be fixed set or can be variables declared using JMESPath.

name string

Name is the variable name.

predicateType string

Deprecated in favour of 'Type', to be removed soon

type string

Type defines the type of attestation contained within the Statement.

attestors []object

Attestors specified the required attestors (i.e. authorities)

count integer

minimum: 1

entries []object

Entries contains the available attestors. An attestor can be a static key, attributes for keyless verification, or a nested attestor declaration.

annotations object

Annotations are used for image verification. Every specified key-value pair must exist and match in the verified payload. The payload may contain other key-value pairs.

attestor object

Attestor is a nested set of Attestor used to specify a more complex set of match authorities.

certificates object

Certificates specifies one or more certificates.

cert string

Cert is an optional PEM-encoded public certificate.

certChain string

CertChain is an optional PEM encoded set of certificates used to verify.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

keyless object

Keyless is a set of attribute used to verify a Sigstore keyless attestor. See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.

additionalExtensions object

AdditionalExtensions are certificate-extensions used for keyless signing.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

issuer string

Issuer is the certificate issuer used for keyless signing.

issuerRegExp string

IssuerRegExp is the regular expression to match certificate issuer used for keyless signing.

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

roots string

Roots is an optional set of PEM encoded trusted root certificates. If not provided, the system roots are used.

subject string

Subject is the verified identity used for keyless signing, for example the email address.

subjectRegExp string

SubjectRegExp is the regular expression to match identity used for keyless signing, for example the email address.

keys object

Keys specifies one or more public keys.

ctlog object

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 boolean

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 string

PubKey, if set, is used to validate SCTs against a custom source.

tsaCertChain string

kms string

KMS provides the URI to the public key stored in a Key Management System. See: https://github.com/sigstore/cosign/blob/main/KMS.md

publicKeys string

rekor object

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 boolean

IgnoreTlog skips transparency log verification.

pubkey string

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 string

URL is the address of the transparency log. Defaults to the public Rekor log instance https://rekor.sigstore.dev.

secret object

Reference to a Secret resource that contains a public key

name string required

Name of the secret. The provided secret must contain a key named cosign.pub.

namespace string required

Namespace name where the Secret exists.

signatureAlgorithm string

Deprecated. Use attestor.signatureAlgorithm instead.

repository string

signatureAlgorithm string

Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.

cosignOCI11 boolean

CosignOCI11 enables the experimental OCI 1.1 behaviour in cosign image verification. Defaults to false.

failureAction string

Allowed values are Audit or Enforce.

enum: Audit, Enforce

image string

Deprecated. Use ImageReferences instead.

imageReferences []string

imageRegistryCredentials object

ImageRegistryCredentials provides credentials that will be used for authentication with registry.

allowInsecureRegistry boolean

AllowInsecureRegistry allows insecure access to a registry.

providers []string

Providers specifies a list of OCI Registry names, whose authentication providers are provided. It can be of one of these values: default,google,azure,amazon,github.

secrets []string

Secrets specifies a list of secrets that are provided for credentials. Secrets must live in the Kyverno namespace.

issuer string

Deprecated. Use KeylessAttestor instead.

key string

Deprecated. Use StaticKeyAttestor instead.

mutateDigest boolean

MutateDigest enables replacement of image tags with digests. Defaults to true.

repository string

required boolean

Required validates that images are verified i.e. have matched passed a signature or attestation check.

roots string

Deprecated. Use KeylessAttestor instead.

skipImageReferences []string

subject string

Deprecated. Use KeylessAttestor instead.

type string

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.

enum: Cosign, SigstoreBundle, Notary

useCache boolean

UseCache enables caching of image verify responses for this rule.

validate object

Validation checks conditions across multiple image verification attestations or context entries

deny object

Deny defines conditions used to pass or fail a validation rule.

conditions object

message string

Message specifies a custom message to be displayed on failure.

verifyDigest boolean

VerifyDigest validates that images have a digest.

conditions []object

lastTransitionTime string required

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.

format: date-time

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

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.

format: int64

minimum: 0

reason string required

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.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

type of condition in CamelCase or in foo.example.com/CamelCase.

pattern: ^([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])$

maxLength: 316

ready boolean

Deprecated in favor of Conditions

rulecount object

RuleCountStatus contains four variables which describes counts for validate, generate, mutate and verify images rules

generate integer required

Count for generate rules in policy

mutate integer required

Count for mutate rules in policy

validate integer required

Count for validate rules in policy

verifyimages integer required

Count for verify image rules in policy

validatingadmissionpolicy object

ValidatingAdmissionPolicy contains status information

generated boolean required

Generated indicates whether a validating admission policy is generated from the policy or not

message string required

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.