Spec declares policy behaviors.

Status contains policy runtime data.

Spec defines policy behaviors and contains one or more rules.

Deprecated. Policy metrics are available via the metrics endpoint

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.

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

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

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.

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

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

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

Type defines the type of attestation contained within the Statement.

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

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.

Keys specifies one or more public keys.

Certificates specifies one or more certificates.

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

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

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.

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.

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

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

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

Expressions is a list of CELExpression types.

ParamKind is a tuple of Group Kind and Version.

ParamRef references a parameter resource.

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

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.

IgnoreSCT defines whether to use the Signed Certificate Timestamp (SCT) log to check for a certificate timestamp. Default is false. Set to true if this was opted out during signing.

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

Cert is an optional PEM-encoded public certificate.

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

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.

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.

Namespace specifies source resource namespace.

Name specifies name of the resource.

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

Operator is the conditional operation to perform. Valid operators are: Equals, NotEquals, In, AnyIn, AllIn, NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals, GreaterThan, LessThanOrEquals, LessThan, DurationGreaterThanOrEquals, DurationGreaterThan, DurationLessThanOrEquals, DurationLessThan

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

Message is an optional display message

Name is the ConfigMap name.

Namespace is the ConfigMap namespace.

(Members of APICall are embedded into this type.)

JMESPath is an optional JSON Match Expression that can be used to transform the JSON response returned from the server. For example a JMESPath of "items | length(@)" applied to the API server response for the URLPath "/apis/apps/v1/deployments" will return the total count of deployments across all namespaces.

Name is the variable name.

ConfigMap is the ConfigMap reference.

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.

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

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

GlobalContextEntryReference is a reference to a cached global context entry.

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

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

Order defines the iteration order on the list. Can be Ascending to iterate from first to last element or Descending to iterate in from last to first element.

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

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/

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

PatchesJSON6902 is a list of RFC 6902 JSON Patch declarations used to modify resources. See https://tools.ietf.org/html/rfc6902 and https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/.

Foreach declares a nested foreach iterator

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

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.

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

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/

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

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

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

Foreach declares a nested foreach iterator

ResourceSpec contains information to select the resource.

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.

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.

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.

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.

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

Name of the global context entry

JMESPath is an optional JSON Match Expression that can be used to transform the JSON response returned from the server. For example a JMESPath of "items | length(@)" applied to the API server response for the URLPath "/apis/apps/v1/deployments" will return the total count of deployments across all namespaces.

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

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.

ImageRegistryCredentials provides credentials that will be used for authentication with registry

AllowInsecureRegistry allows insecure access to a registry.

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

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

Type specifies the method of signature validation. The allowed options are Cosign and Notary. By default Cosign is used if a type is not specified.

Deprecated. Use ImageReferences instead.

ImageReferences is a list of matching image reference patterns. At least one pattern in the list must match the image for the rule to apply. Each image reference consists of a registry address (defaults to docker.io), repository, image, and tag (defaults to latest). Wildcards ('*' and '?') are allowed. See: https://kubernetes.io/docs/concepts/containers/images.

SkipImageReferences is a list of matching image reference patterns that should be skipped. At least one pattern in the list must match the image for the rule to be skipped. Each image reference consists of a registry address (defaults to docker.io), repository, image, and tag (defaults to latest). Wildcards ('*' and '?') are allowed. See: https://kubernetes.io/docs/concepts/containers/images.

Deprecated. Use StaticKeyAttestor instead.

Deprecated. Use KeylessAttestor instead.

Deprecated. Use KeylessAttestor instead.

Deprecated. Use KeylessAttestor instead.

Deprecated.

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

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.

Deprecated. Use annotations per Attestor instead.

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.

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

VerifyDigest validates that images have a digest.

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

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

UseCache enables caching of image verify responses for this rule.

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.

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.

Issuer is the certificate issuer used for keyless signing.

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

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

AdditionalExtensions are certificate-extensions used for keyless signing.

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

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

Fields which will be ignored while comparing manifests.

DryRun configuration

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

Any allows specifying resources which will be ORed

All allows specifying resources which will be ANDed

UserInfo contains information about the user performing the operation. Specifying UserInfo directly under match is being deprecated. Please specify under "any" or "all" instead.

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.

Targets defines the target resources to be mutated.

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

PatchesJSON6902 is a list of RFC 6902 JSON Patch declarations used to modify resources. See https://tools.ietf.org/html/rfc6902 and https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/.

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.

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

Version defines the Pod Security Standard versions that Kubernetes supports. Allowed values are v1.19, v1.20, v1.21, v1.22, v1.23, v1.24, v1.25, v1.26, v1.27, v1.28, v1.29, latest. Defaults to latest.

Exclude specifies the Pod Security Standard controls to be excluded.

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

Images selects matching containers and applies the container level PSS. Each image is the image name consisting of the registry address, repository, image, and tag. Empty list matches no containers, PSS checks are applied at the pod level only. Wildcards ('*' and '?') are allowed. See: https://kubernetes.io/docs/concepts/containers/images.

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

Values defines the allowed values that can be excluded.

Deprecated in favor of Conditions

ValidatingAdmissionPolicy contains status information

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

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.

IgnoreTlog skips transparency log verification.

Key is a unique identifier for the data value

Value is the data value

Kinds is a list of resource kinds.

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

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

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

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

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.

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.

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

APIVersion specifies resource apiVersion.

Kind specifies resource kind.

Namespace specifies resource namespace.

Name specifies the resource name.

UID specifies the resource uid.

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

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

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.

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.

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

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/

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

Mutation is used to modify matching resources.

Validation is used to validate matching resources.

Generation is used to create new resources.

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

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.

Count for validate rules in policy

Count for generate rules in policy

Count for mutate rules in policy

Count for verify image rules in policy

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

Namespace name where the Secret exists.

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

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

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

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.

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.

ValidationFailureAction 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. The default value is "Audit".

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

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

Background controls if rules are applied to existing resources during a background scan. Optional. Default value is "true". The value must be set to "false" if the policy rule uses variables that are only available in the admission review request (e.g. user name).

Deprecated.

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

MutateExistingOnPolicyUpdate controls if a mutateExisting policy is applied on policy events. Default value is "false".

Deprecated, use generateExisting instead

GenerateExisting controls whether to trigger generate rule in existing resources If is set to "true" generate rule will be triggered and applied to existing matched resources. Defaults to "false" if not specified.

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.

WebhookConfiguration specifies the custom configuration for Kubernetes admission webhookconfiguration. Requires Kubernetes 1.27 or later.

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

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

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

Reference to a Secret resource that contains a public key

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.

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.

ResourceSpec contains the target resources to load when mutating existing resources.

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

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/

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

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

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

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

Message is a human readable message indicating details about the generation of validating admission policy It is an empty string when validating admission policy is successfully generated.

Message specifies a custom message to be displayed on failure.

Manifest specifies conditions for manifest verification

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.

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

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

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

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

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

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

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

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

MatchCondition configures admission webhook matchConditions.