URLPath is the URL path to be used in the HTTP GET 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.

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

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

PredicateType defines the type of Predicate contained within the Statement.

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.

Namespace specifies source resource namespace.

Name specifies name of the resource.

Spec declares policy behaviors.

Status contains policy runtime data.

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

Operator is the operation to perform. Valid operators are Equals, NotEquals, In, AnyIn, AllIn and NotIn, AnyNotIn, AllNotIn.

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

Name is the ConfigMap name.

Namespace is the ConfigMap namespace.

Name is the variable name.

ConfigMap is the ConfigMap reference.

APICall defines an HTTP request to the Kubernetes API server. The JSON data retrieved is stored in the context.

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

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 exclude is being deprecated. Please specify under “any” or “all” instead.

ResourceDescription contains information about the resource being created or modified. Specifying ResourceDescription directly under exclude is being deprecated. Please specify under “any” or “all” instead.

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

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

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

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.

Spec is the information to identify the generate request.

Status contains statistics related to generate request.

Specifies the name of the policy.

ResourceSpec is the information to identify the generate request.

Context …

State represents state of the generate request.

Specifies request status message.

This will track the resources that are generated by the generate Policy. Will be used during clean up resources.

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.

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.

Image is the image name consisting of the registry address, repository, image, and tag. Wildcards (‘*’ and ‘?’) are allowed. See: https://kubernetes.io/docs/concepts/containers/images.

Key is the PEM encoded public key that the image or attestation is signed with.

Roots is the PEM encoded Root certificate chain used for keyless signing

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

Repository is an optional alternate OCI repository to use for image signatures that match this rule. If specified Repository will override the default OCI image repository configured for the installation.

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.

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.

Overlay specifies an overlay pattern to modify resources. DEPRECATED. Use PatchStrategicMerge instead. Scheduled for removal in release 1.5+.

Patches specifies a RFC 6902 JSON Patch to modify resources. DEPRECATED. Use PatchesJSON6902 instead. Scheduled for removal in release 1.5+.

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

ForEachMutation applies policy rule changes to nested elements.

Path specifies path of the resource.

Operation specifies operations supported by JSON Patch. i.e:- add, replace and delete.

Value specifies the value to be applied.

Spec defines policy behaviors and contains one or more rules.

Status contains policy runtime information. Deprecated. Policy metrics are available via the metrics endpoint

Ready indicates if the policy is ready to serve the admission request

Roles is a list of possible role send the request.

ClusterRoles is a list of possible clusterRoles send the request.

UserInfo is the userInfo carried in the admission request.

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

Names are the names of the resources. Each name supports wildcard characters “*” (matches zero or many characters) and “?” (at least one character). NOTE: “Name” is being deprecated in favor of “Names”.

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.

UserInfo contains information about the user performing the operation.

ResourceDescription contains information about the resource being created or modified.

APIVersion specifies resource apiVersion.

Kind specifies resource kind.

Namespace specifies resource namespace.

Name specifies the resource name.

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.

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/

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

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

FailurePolicy defines how unrecognized errors from the admission endpoint are handled. Rules within the same policy share the same failure behavior. Allowed values are Ignore or Fail. Defaults to Fail.

ValidationFailureAction controls if a validation policy rule failure should disallow the admission review request (enforce), or allow (audit) the admission review request and report an error in a policy report. Optional. The default value is “audit”.

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

SchemaValidation skips policy validation checks. Optional. The default value is set to “true”, it must be set to “false” to disable the validation checks.

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.

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.

Message specifies a custom message to be displayed on failure.

ForEach applies policy rule changes to nested elements.

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.

Name specifies violated rule name.

Type specifies violated rule type.

Message specifies violation message.

Status shows the rule response status

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

PolicyReportSummary provides a summary of results

PolicyReportResult provides result details

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

PolicyReportSummary provides a summary of results

PolicyReportResult provides result details

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

PolicyReportSummary provides a summary of results

PolicyReportResult provides result details

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

PolicyReportSummary provides a summary of results

PolicyReportResult provides result details

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

PolicyReportSummary provides a summary of results

PolicyReportResult provides result details

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

PolicyReportSummary provides a summary of results

PolicyReportResult provides result details

Policy is the name of the policy

Rule is the name of the policy rule

Resources is an optional reference to the resource checked by the policy and rule

ResourceSelector is an optional selector for policy results that apply to multiple resources. For example, a policy result may apply to all pods that match a label. Either a Resource or a ResourceSelector can be specified. If neither are provided, the result is assumed to be for the policy report scope.

Message is a short user friendly description of the policy rule

Status indicates the result of the policy rule check

Scored indicates if this policy rule is scored

Data provides additional information for the policy rule

Category indicates policy category

Severity indicates policy severity

Pass provides the count of policies whose requirements were met

Fail provides the count of policies whose requirements were not met

Warn provides the count of unscored policies whose requirements were not met

Error provides the count of policies that could not be evaluated

Skip indicates the count of policies that were not selected for evaluation

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

PolicyReportSummary provides a summary of results

PolicyReportResult provides result details

Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

ScopeSelector is an optional selector for multiple scopes (e.g. Pods). Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

PolicyReportSummary provides a summary of results

PolicyReportResult provides result details

Source is an identifier for the policy engine that manages this report

Policy is the name of the policy

Rule is the name of the policy rule

Resources is an optional reference to the resource checked by the policy and rule

ResourceSelector is an optional selector for policy results that apply to multiple resources. For example, a policy result may apply to all pods that match a label. Either a Resource or a ResourceSelector can be specified. If neither are provided, the result is assumed to be for the policy report scope.

Message is a short user friendly description of the policy rule

Result indicates the outcome of the policy rule execution

Scored indicates if this policy rule is scored

Properties provides additional information for the policy rule

Timestamp indicates the time the result was found

Category indicates policy category

Severity indicates policy severity

Pass provides the count of policies whose requirements were met

Fail provides the count of policies whose requirements were not met

Warn provides the count of unscored policies whose requirements were not met

Error provides the count of policies that could not be evaluated

Skip indicates the count of policies that were not selected for evaluation