2022-10-21 16:51:15 +02:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1, shrink-to-fit=no" >
< link rel = "stylesheet" href = "https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity = "sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin = "anonymous" >
< title > Kyverno API< / title >
< style >
.bg-blue {
color: #ffffff;
background-color: #1589dd;
}
< / style >
< / head >
< body >
< div class = "container" >
< nav class = "navbar navbar-expand-lg navbar-dark bg-dark" >
< a class = "navbar-brand" href = "#" > < p > < b > Packages : < / b > < / p > < / a >
< ul style = "list-style:none" >
< li >
< a href = "#kyverno.io%2fv1" > < b style = "color: white" > kyverno.io/v1< / b > < / a >
< / li >
< li >
< a href = "#kyverno.io%2fv1alpha2" > < b style = "color: white" > kyverno.io/v1alpha2< / b > < / a >
< / li >
< li >
< a href = "#kyverno.io%2fv1beta1" > < b style = "color: white" > kyverno.io/v1beta1< / b > < / a >
< / li >
< li >
2023-12-19 12:43:39 +02:00
< a href = "#kyverno.io%2fv2" > < b style = "color: white" > kyverno.io/v2< / b > < / a >
< / li >
< li >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io%2fv2alpha1" > < b style = "color: white" > kyverno.io/v2alpha1< / b > < / a >
< / li >
< li >
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io%2fv2beta1" > < b style = "color: white" > kyverno.io/v2beta1< / b > < / a >
< / li >
< li >
2024-01-26 19:10:29 +05:30
< a href = "#reports.kyverno.io%2fv1" > < b style = "color: white" > reports.kyverno.io/v1< / b > < / a >
< / li >
< li >
2022-10-21 16:51:15 +02:00
< a href = "#wgpolicyk8s.io%2fv1alpha2" > < b style = "color: white" > wgpolicyk8s.io/v1alpha2< / b > < / a >
< / li >
< / ul >
< / nav >
< h2 id = "kyverno.io/v1" > kyverno.io/v1< / h2 >
Resource Types:
< ul > < li >
< a href = "#kyverno.io/v1.ClusterPolicy" > ClusterPolicy< / a >
< / li > < li >
< a href = "#kyverno.io/v1.Policy" > Policy< / a >
< / li > < / ul >
< hr / >
< h3 id = "kyverno.io/v1.ClusterPolicy" > ClusterPolicy
< / h3 >
< p >
< p > ClusterPolicy declares validation, mutation, and generation behaviors for matching resources.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > ClusterPolicy< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Spec" >
Spec
< / a >
< / em >
< / td >
< td >
< p > Spec declares policy behaviors.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > rules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Rule" >
[]Rule
< / a >
< / em >
< / td >
< td >
< p > Rules is a list of Rule instances. A Policy contains multiple rules and
each rule can validate, mutate, or generate resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > applyRules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ApplyRulesType" >
ApplyRulesType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ApplyRules controls how rules in a policy are applied. Rule are processed in
the order of declaration. When set to < code > One< / code > processing stops after a rule has
been applied i.e. the rule matches and results in a pass, fail, or error. When
set to < code > All< / code > all rules in the policy are processed. The default is < code > All< / code > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > failurePolicy< / code > < br / >
< em >
< a href = "#kyverno.io/v1.FailurePolicyType" >
FailurePolicyType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > FailurePolicy defines how unexpected policy errors and webhook response timeout errors are handled.
Rules within the same policy share the same failure behavior.
2022-10-21 23:43:36 +05:30
This field should not be accessed directly, instead < code > GetFailurePolicy()< / code > should be used.
2022-10-21 16:51:15 +02:00
Allowed values are Ignore or Fail. Defaults to Fail.< / p >
< / td >
< / tr >
< tr >
< td >
< code > validationFailureAction< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureAction" >
ValidationFailureAction
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.
2023-01-02 16:16:13 +01:00
Allowed values are audit or enforce. The default value is “ Audit” .< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > validationFailureActionOverrides< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureActionOverride" >
[]ValidationFailureActionOverride
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction
namespace-wise. It overrides ValidationFailureAction for the specified namespaces.< / p >
< / td >
< / tr >
< tr >
< td >
2023-06-28 14:54:27 +02:00
< code > admission< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Admission controls if rules are applied during admission.
Optional. Default value is “ true” .< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > schemaValidation< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-12-18 18:32:11 +02:00
< p > Deprecated.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > webhookTimeoutSeconds< / code > < br / >
< em >
int32
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > mutateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > MutateExistingOnPolicyUpdate controls if a mutateExisting policy is applied on policy events.
Default value is “ false” .< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-24 00:36:51 +08:00
< code > generateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Deprecated, use generateExisting instead< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-03 17:34:55 +08:00
< code > generateExisting< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-03-03 17:34:55 +08:00
< p > GenerateExisting controls whether to trigger generate rule in existing resources
2022-10-21 16:51:15 +02:00
If is set to “ true” generate rule will be triggered and applied to existing matched resources.
Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
2023-08-02 18:59:37 +01:00
< tr >
< td >
< code > useServerSideApply< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
2024-01-27 21:00:22 +08:00
< tr >
< td >
< code > webhookConfiguration< / code > < br / >
< em >
< a href = "#kyverno.io/v1.WebhookConfiguration" >
WebhookConfiguration
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > WebhookConfiguration specifies the custom configuration for Kubernetes admission webhookconfiguration.
Requires Kubernetes 1.27 or later.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PolicyStatus" >
PolicyStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Status contains policy runtime data.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.Policy" > Policy
< / h3 >
< p >
< p > Policy declares validation, mutation, and generation behaviors for matching resources.
See: < a href = "https://kyverno.io/docs/writing-policies/" > https://kyverno.io/docs/writing-policies/< / a > for more information.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > Policy< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Spec" >
Spec
< / a >
< / em >
< / td >
< td >
< p > Spec defines policy behaviors and contains one or more rules.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > rules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Rule" >
[]Rule
< / a >
< / em >
< / td >
< td >
< p > Rules is a list of Rule instances. A Policy contains multiple rules and
each rule can validate, mutate, or generate resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > applyRules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ApplyRulesType" >
ApplyRulesType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ApplyRules controls how rules in a policy are applied. Rule are processed in
the order of declaration. When set to < code > One< / code > processing stops after a rule has
been applied i.e. the rule matches and results in a pass, fail, or error. When
set to < code > All< / code > all rules in the policy are processed. The default is < code > All< / code > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > failurePolicy< / code > < br / >
< em >
< a href = "#kyverno.io/v1.FailurePolicyType" >
FailurePolicyType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > FailurePolicy defines how unexpected policy errors and webhook response timeout errors are handled.
Rules within the same policy share the same failure behavior.
2022-10-21 23:43:36 +05:30
This field should not be accessed directly, instead < code > GetFailurePolicy()< / code > should be used.
2022-10-21 16:51:15 +02:00
Allowed values are Ignore or Fail. Defaults to Fail.< / p >
< / td >
< / tr >
< tr >
< td >
< code > validationFailureAction< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureAction" >
ValidationFailureAction
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.
2023-01-02 16:16:13 +01:00
Allowed values are audit or enforce. The default value is “ Audit” .< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > validationFailureActionOverrides< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureActionOverride" >
[]ValidationFailureActionOverride
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction
namespace-wise. It overrides ValidationFailureAction for the specified namespaces.< / p >
< / td >
< / tr >
< tr >
< td >
2023-06-28 14:54:27 +02:00
< code > admission< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Admission controls if rules are applied during admission.
Optional. Default value is “ true” .< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > schemaValidation< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-12-18 18:32:11 +02:00
< p > Deprecated.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > webhookTimeoutSeconds< / code > < br / >
< em >
int32
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > mutateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > MutateExistingOnPolicyUpdate controls if a mutateExisting policy is applied on policy events.
Default value is “ false” .< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-24 00:36:51 +08:00
< code > generateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Deprecated, use generateExisting instead< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-03 17:34:55 +08:00
< code > generateExisting< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-03-03 17:34:55 +08:00
< p > GenerateExisting controls whether to trigger generate rule in existing resources
2022-10-21 16:51:15 +02:00
If is set to “ true” generate rule will be triggered and applied to existing matched resources.
Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
2023-08-02 18:59:37 +01:00
< tr >
< td >
< code > useServerSideApply< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
2024-01-27 21:00:22 +08:00
< tr >
< td >
< code > webhookConfiguration< / code > < br / >
< em >
< a href = "#kyverno.io/v1.WebhookConfiguration" >
WebhookConfiguration
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > WebhookConfiguration specifies the custom configuration for Kubernetes admission webhookconfiguration.
Requires Kubernetes 1.27 or later.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PolicyStatus" >
PolicyStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-09-01 03:53:44 +05:30
< p > Deprecated. Policy metrics are available via the metrics endpoint< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.APICall" > APICall
< / h3 >
< p >
(< em > Appears on:< / em >
2024-02-01 11:58:31 +01:00
< a href = "#kyverno.io/v1.ContextEntry" > ContextEntry< / a > ,
2024-02-01 13:32:13 +01:00
< a href = "#kyverno.io/v2alpha1.ExternalAPICall" > ExternalAPICall< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > urlPath< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-04-26 16:31:44 -07:00
< p > URLPath is the URL path to be used in the HTTP GET or POST request to the
2022-10-21 16:51:15 +02:00
Kubernetes API server (e.g. “ /api/v1/namespaces” or “ /apis/apps/v1/deployments” ).
2023-04-26 16:31:44 -07:00
The format required is the same format used by the < code > kubectl get --raw< / code > command.
See < a href = "https://kyverno.io/docs/writing-policies/external-data-sources/#variables-from-kubernetes-api-server-calls" > https://kyverno.io/docs/writing-policies/external-data-sources/#variables-from-kubernetes-api-server-calls< / a >
for details.< / p >
< / td >
< / tr >
< tr >
< td >
< code > method< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Method" >
Method
< / a >
< / em >
< / td >
< td >
< p > Method is the HTTP request type (GET or POST).< / p >
< / td >
< / tr >
< tr >
< td >
< code > data< / code > < br / >
< em >
< a href = "#kyverno.io/v1.RequestData" >
[]RequestData
< / a >
< / em >
< / td >
< td >
< p > Data specifies the POST data sent to the server.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-27 00:36:49 -08:00
< code > service< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ServiceCall" >
ServiceCall
< / a >
< / em >
< / td >
< td >
< p > Service is an API call to a JSON web service< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > jmesPath< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > JMESPath is an optional JSON Match Expression that can be used to
2022-12-27 00:36:49 -08:00
transform the JSON response returned from the server. For example
2022-10-21 16:51:15 +02:00
a JMESPath of “ items | length(@)” applied to the API server response
2022-12-27 00:36:49 -08:00
for the URLPath “ /apis/apps/v1/deployments” will return the total count
2022-10-21 16:51:15 +02:00
of deployments across all namespaces.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-03-29 06:22:21 +02:00
< h3 id = "kyverno.io/v1.AdmissionOperation" > AdmissionOperation
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ResourceDescription" > ResourceDescription< / a > ,
< a href = "#kyverno.io/v2beta1.ResourceDescription" > ResourceDescription< / a > )
< / p >
< p >
< p > AdmissionOperation can have one of the values CREATE, UPDATE, CONNECT, DELETE, which are used to match a specific action.< / p >
< / p >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.AnyAllConditions" > AnyAllConditions
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Attestation" > Attestation< / a > ,
< a href = "#kyverno.io/v1.ForEachMutation" > ForEachMutation< / a > ,
2022-12-08 11:31:28 +01:00
< a href = "#kyverno.io/v1.ForEachValidation" > ForEachValidation< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
< p > AnyAllConditions consists of conditions wrapped denoting a logical criteria to be fulfilled.
AnyConditions get fulfilled when at least one of its sub-conditions passes.
AllConditions get fulfilled only when all of its sub-conditions pass.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > any< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Condition" >
[]Condition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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< / p >
< / td >
< / tr >
< tr >
< td >
< code > all< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Condition" >
[]Condition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ApplyRulesType" > ApplyRulesType
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Spec" > Spec< / a > ,
< a href = "#kyverno.io/v2beta1.Spec" > Spec< / a > )
< / p >
< p >
< p > ApplyRulesType controls whether processing stops after one rule is applied or all rules are applied.< / p >
< / p >
< h3 id = "kyverno.io/v1.Attestation" > Attestation
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ImageVerification" > ImageVerification< / a > ,
< a href = "#kyverno.io/v2beta1.ImageVerification" > ImageVerification< / a > )
< / p >
< p >
< p > Attestation are checks for signed in-toto Statements that are used to verify the image.
See < a href = "https://github.com/in-toto/attestation" > https://github.com/in-toto/attestation< / a > . Kyverno fetches signed attestations from the
OCI registry and decodes them into a list of Statements.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > predicateType< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated in favour of ‘ Type’ , to be removed soon< / p >
2023-06-01 13:35:28 +05:30
< / td >
< / tr >
< tr >
< td >
< code > type< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Type defines the type of attestation contained within the Statement.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-02 06:09:44 +08:00
< code > attestors< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AttestorSet" >
[]AttestorSet
< / a >
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > Attestors specify the required attestors (i.e. authorities).< / p >
2022-12-02 06:09:44 +08:00
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AnyAllConditions" >
[]AnyAllConditions
< / a >
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.Attestor" > Attestor
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.AttestorSet" > AttestorSet< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > keys< / code > < br / >
< em >
< a href = "#kyverno.io/v1.StaticKeyAttestor" >
StaticKeyAttestor
< / a >
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > Keys specifies one or more public keys.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > certificates< / code > < br / >
< em >
< a href = "#kyverno.io/v1.CertificateAttestor" >
CertificateAttestor
< / a >
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > Certificates specifies one or more certificates.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > keyless< / code > < br / >
< em >
< a href = "#kyverno.io/v1.KeylessAttestor" >
KeylessAttestor
< / a >
< / em >
< / td >
< td >
< p > Keyless is a set of attribute used to verify a Sigstore keyless attestor.
See < a href = "https://github.com/sigstore/cosign/blob/main/KEYLESS.md" > https://github.com/sigstore/cosign/blob/main/KEYLESS.md< / a > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > attestor< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > Attestor is a nested set of Attestor used to specify a more complex set of match authorities.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > annotations< / code > < br / >
< em >
map[string]string
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > repository< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.AttestorSet" > AttestorSet
< / h3 >
< p >
(< em > Appears on:< / em >
2022-12-02 06:09:44 +08:00
< a href = "#kyverno.io/v1.Attestation" > Attestation< / a > ,
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v1.ImageVerification" > ImageVerification< / a > ,
< a href = "#kyverno.io/v1.Manifests" > Manifests< / a > ,
< a href = "#kyverno.io/v2beta1.ImageVerification" > ImageVerification< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > count< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > entries< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Attestor" >
[]Attestor
< / a >
< / em >
< / td >
< td >
< p > Entries contains the available attestors. An attestor can be a static key,
attributes for keyless verification, or a nested attestor declaration.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.AutogenStatus" > AutogenStatus
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.PolicyStatus" > PolicyStatus< / a > )
< / p >
< p >
< p > AutogenStatus contains autogen status information.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > rules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Rule" >
[]Rule
< / a >
< / em >
< / td >
< td >
< p > Rules is a list of Rule instances. It contains auto generated rules added for pod controllers< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-06-01 00:30:55 +03:00
< h3 id = "kyverno.io/v1.CEL" > CEL
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Validation" > Validation< / a > ,
< a href = "#kyverno.io/v2beta1.Validation" > Validation< / a > )
< / p >
< p >
< p > CEL allows validation checks using the Common Expression Language (< a href = "https://kubernetes.io/docs/reference/using-api/cel/" > https://kubernetes.io/docs/reference/using-api/cel/< / a > ).< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > expressions< / code > < br / >
< em >
2023-08-22 14:33:33 +03:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#validation-v1alpha1-admissionregistration" >
[]Kubernetes admissionregistration/v1alpha1.Validation
2023-06-01 00:30:55 +03:00
< / a >
< / em >
< / td >
< td >
< p > Expressions is a list of CELExpression types.< / p >
< / td >
< / tr >
< tr >
< td >
< code > paramKind< / code > < br / >
< em >
2023-08-22 14:33:33 +03:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#paramkind-v1alpha1-admissionregistration" >
Kubernetes admissionregistration/v1alpha1.ParamKind
2023-06-01 00:30:55 +03:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ParamKind is a tuple of Group Kind and Version.< / p >
< / td >
< / tr >
< tr >
< td >
< code > paramRef< / code > < br / >
< em >
2023-08-22 14:33:33 +03:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#paramref-v1alpha1-admissionregistration" >
Kubernetes admissionregistration/v1alpha1.ParamRef
2023-06-01 00:30:55 +03:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ParamRef references a parameter resource.< / p >
< / td >
< / tr >
< tr >
< td >
< code > auditAnnotations< / code > < br / >
< em >
2023-08-22 14:33:33 +03:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#auditannotation-v1alpha1-admissionregistration" >
[]Kubernetes admissionregistration/v1alpha1.AuditAnnotation
2023-06-01 00:30:55 +03:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > AuditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request.< / p >
< / td >
< / tr >
2023-08-24 13:00:27 +03:00
< tr >
< td >
< code > variables< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#variable-v1alpha1-admissionregistration" >
[]Kubernetes admissionregistration/v1alpha1.Variable
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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 < code > variables< / code > in other expressions of the policy.< / p >
< / td >
< / tr >
2023-06-01 00:30:55 +03:00
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.CTLog" > CTLog
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.CertificateAttestor" > CertificateAttestor< / a > ,
< a href = "#kyverno.io/v1.KeylessAttestor" > KeylessAttestor< / a > ,
< a href = "#kyverno.io/v1.StaticKeyAttestor" > StaticKeyAttestor< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2023-08-15 19:55:55 +05:30
< code > ignoreSCT< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > 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.< / p >
2023-08-15 19:55:55 +05:30
< / td >
< / tr >
< tr >
< td >
2023-08-30 12:09:49 +05:30
< code > pubkey< / code > < br / >
2023-08-15 19:55:55 +05:30
< em >
2023-08-30 12:09:49 +05:30
string
2023-08-15 19:55:55 +05:30
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > PubKey, if set, is used to validate SCTs against a custom source.< / p >
2023-08-15 19:55:55 +05:30
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.CertificateAttestor" > CertificateAttestor
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Attestor" > Attestor< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > cert< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > Cert is an optional PEM-encoded public certificate.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > certChain< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > CertChain is an optional PEM encoded set of certificates used to verify.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > rekor< / code > < br / >
< em >
2023-08-30 12:09:49 +05:30
< a href = "#kyverno.io/v1.Rekor" >
Rekor
< / a >
< / em >
< / td >
< td >
< p > Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (< a href = "https://rekor.sigstore.dev" > https://rekor.sigstore.dev< / a > ) is used.< / p >
< / td >
< / tr >
< tr >
< td >
< code > ctlog< / code > < br / >
< em >
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v1.CTLog" >
CTLog
< / a >
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > 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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.CloneFrom" > CloneFrom
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Generation" > Generation< / a > )
< / p >
< p >
< p > CloneFrom provides the location of the source resource used to generate target resources.
The resource kind is derived from the match criteria.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > namespace< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Namespace specifies source resource namespace.< / p >
< / td >
< / tr >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Name specifies name of the resource.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.Condition" > Condition
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.AnyAllConditions" > AnyAllConditions< / a > )
< / p >
< p >
< p > Condition defines variable-based conditional criteria for rule execution.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > key< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< p > Key is the context entry (using JMESPath) for conditional rule evaluation.< / p >
< / td >
< / tr >
< tr >
< td >
< code > operator< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ConditionOperator" >
ConditionOperator
< / a >
< / em >
< / td >
< td >
< p > 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< / p >
< / td >
< / tr >
< tr >
< td >
< code > value< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Value is the conditional value, or set of values. The values can be fixed set
or can be variables declared using JMESPath.< / p >
< / td >
< / tr >
2023-05-08 00:34:23 -07:00
< tr >
< td >
< code > message< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Message is an optional display message< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ConditionOperator" > ConditionOperator
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Condition" > Condition< / a > )
< / p >
< p >
< p > ConditionOperator is the operation performed on condition key and value.< / p >
< / p >
< h3 id = "kyverno.io/v1.ConfigMapReference" > ConfigMapReference
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ContextEntry" > ContextEntry< / a > )
< / p >
< p >
< p > ConfigMapReference refers to a ConfigMap< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Name is the ConfigMap name.< / p >
< / td >
< / tr >
< tr >
< td >
< code > namespace< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Namespace is the ConfigMap namespace.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ContextEntry" > ContextEntry
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ForEachMutation" > ForEachMutation< / a > ,
< a href = "#kyverno.io/v1.ForEachValidation" > ForEachValidation< / a > ,
< a href = "#kyverno.io/v1.Rule" > Rule< / a > ,
2023-04-03 21:58:58 +02:00
< a href = "#kyverno.io/v1.TargetResourceSpec" > TargetResourceSpec< / a > ,
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v2.CleanupPolicySpec" > CleanupPolicySpec< / a > ,
2023-10-12 14:45:33 +03:00
< a href = "#kyverno.io/v2beta1.CleanupPolicySpec" > CleanupPolicySpec< / a > ,
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v2beta1.Rule" > Rule< / a > )
< / p >
< p >
< p > ContextEntry adds variables and data sources to a rule Context. Either a
ConfigMap reference or a APILookup must be provided.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Name is the variable name.< / p >
< / td >
< / tr >
< tr >
< td >
< code > configMap< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ConfigMapReference" >
ConfigMapReference
< / a >
< / em >
< / td >
< td >
< p > ConfigMap is the ConfigMap reference.< / p >
< / td >
< / tr >
< tr >
< td >
< code > apiCall< / code > < br / >
< em >
< a href = "#kyverno.io/v1.APICall" >
APICall
< / a >
< / em >
< / td >
< td >
2022-12-27 00:36:49 -08:00
< p > 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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > imageRegistry< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ImageRegistry" >
ImageRegistry
< / a >
< / em >
< / td >
< td >
< p > ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image
details.< / p >
< / td >
< / tr >
< tr >
< td >
< code > variable< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Variable" >
Variable
< / a >
< / em >
< / td >
< td >
< p > Variable defines an arbitrary JMESPath context variable that can be defined inline.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.Deny" > Deny
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ForEachValidation" > ForEachValidation< / a > ,
< a href = "#kyverno.io/v1.Validation" > Validation< / a > )
< / p >
< p >
< p > Deny specifies a list of conditions used to pass or fail a validation rule.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< p > Multiple conditions can be declared under an < code > any< / code > or < code > all< / code > statement. A direct list
of conditions (without < code > any< / code > or < code > all< / code > statements) is also supported for backwards compatibility
but will be deprecated in the next major release.
See: < a href = "https://kyverno.io/docs/writing-policies/validate/#deny-rules" > https://kyverno.io/docs/writing-policies/validate/#deny-rules< / a > < / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.DryRunOption" > DryRunOption
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Manifests" > Manifests< / a > )
< / p >
< p >
< p > DryRunOption is a configuration for dryrun.
If enable is set to “ true” , manifest verification performs “ dryrun & compare”
which provides robust matching against changes by defaults and other admission controllers.
Dryrun requires additional permissions. See config/dryrun/dryrun_rbac.yaml< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > enable< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > namespace< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.FailurePolicyType" > FailurePolicyType
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Spec" > Spec< / a > ,
< a href = "#kyverno.io/v2beta1.Spec" > Spec< / a > )
< / p >
< p >
< p > FailurePolicyType specifies a failure policy that defines how unrecognized errors from the admission endpoint are handled.< / p >
< / p >
< h3 id = "kyverno.io/v1.ForEachMutation" > ForEachMutation
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Mutation" > Mutation< / a > )
< / p >
< p >
2023-01-20 16:56:35 +08:00
< p > ForEachMutation 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.< / p >
2022-10-21 16:51:15 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > list< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > List specifies a JMESPath expression that results in one or more elements
to which the validation logic is applied.< / p >
< / td >
< / tr >
< tr >
< td >
2023-05-05 17:40:23 +02:00
< code > order< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ForeachOrder" >
ForeachOrder
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
< code > preconditions< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > AnyAllConditions are used to determine if a policy rule should be applied by evaluating a
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements.
See: < a href = "https://kyverno.io/docs/writing-policies/preconditions/" > https://kyverno.io/docs/writing-policies/preconditions/< / a > < / p >
< / td >
< / tr >
< tr >
< td >
< code > patchStrategicMerge< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PatchStrategicMerge is a strategic merge patch used to modify resources.
See < a href = "https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/" > https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/< / a >
and < a href = "https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/" > https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/< / a > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > patchesJson6902< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PatchesJSON6902 is a list of RFC 6902 JSON Patch declarations used to modify resources.
See < a href = "https://tools.ietf.org/html/rfc6902" > https://tools.ietf.org/html/rfc6902< / a > and < a href = "https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/" > https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/< / a > .< / p >
< / td >
< / tr >
2022-12-12 07:20:20 -08:00
< tr >
< td >
< code > foreach< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Foreach declares a nested foreach iterator< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ForEachValidation" > ForEachValidation
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Validation" > Validation< / a > ,
< a href = "#kyverno.io/v2beta1.Validation" > Validation< / a > )
< / p >
< p >
2023-01-20 16:56:35 +08:00
< p > ForEachValidation 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.< / p >
2022-10-21 16:51:15 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > list< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > List specifies a JMESPath expression that results in one or more elements
to which the validation logic is applied.< / p >
< / td >
< / tr >
< tr >
< td >
< code > elementScope< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
< code > preconditions< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > AnyAllConditions are used to determine if a policy rule should be applied by evaluating a
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements.
See: < a href = "https://kyverno.io/docs/writing-policies/preconditions/" > https://kyverno.io/docs/writing-policies/preconditions/< / a > < / p >
< / td >
< / tr >
< tr >
< td >
< code > pattern< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Pattern specifies an overlay-style pattern used to check resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > anyPattern< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > AnyPattern specifies list of validation patterns. At least one of the patterns
must be satisfied for the validation rule to succeed.< / p >
< / td >
< / tr >
< tr >
< td >
< code > deny< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Deny" >
Deny
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Deny defines conditions used to pass or fail a validation rule.< / p >
< / td >
< / tr >
2022-12-12 07:20:20 -08:00
< tr >
< td >
< code > foreach< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Foreach declares a nested foreach iterator< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
2023-05-05 17:40:23 +02:00
< h3 id = "kyverno.io/v1.ForeachOrder" > ForeachOrder
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ForEachMutation" > ForEachMutation< / a > )
< / p >
< p >
< p > ForeachOrder specifies the iteration order in foreach statements.< / p >
< / p >
2023-03-01 11:48:18 +08:00
< h3 id = "kyverno.io/v1.GenerateType" > GenerateType
(< code > string< / code > alias)< / p > < / h3 >
< p >
< / p >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.Generation" > Generation
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Rule" > Rule< / a > ,
< a href = "#kyverno.io/v2beta1.Rule" > Rule< / a > )
< / p >
< p >
< p > Generation defines how new resources should be created and managed.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > ResourceSpec< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceSpec" >
ResourceSpec
< / a >
< / em >
< / td >
< td >
< p > ResourceSpec contains information to select the resource.< / p >
< / td >
< / tr >
< tr >
< td >
< code > synchronize< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
2024-01-31 19:50:38 +08:00
< code > orphanDownstreamOnPolicyDelete< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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 < a href = "https://kyverno.io/docs/writing-policies/generate/#data-examples" > https://kyverno.io/docs/writing-policies/generate/#data-examples< / a > .
Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > data< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > clone< / code > < br / >
< em >
< a href = "#kyverno.io/v1.CloneFrom" >
CloneFrom
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > cloneList< / code > < br / >
< em >
< a href = "#kyverno.io/v1.CloneList" >
CloneList
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > CloneList specifies the list of source resource used to populate each generated resource.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2024-02-01 11:58:31 +01:00
< h3 id = "kyverno.io/v1.GlobalContextEntryReference" > GlobalContextEntryReference
< / h3 >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Name of the global context entry< / p >
< / td >
< / tr >
< tr >
< td >
< code > jmesPath< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.ImageExtractorConfig" > ImageExtractorConfig
< / h3 >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > path< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Path is the path to the object containing the image field in a custom resource.
It should be slash-separated. Each slash-separated key must be a valid YAML key or a wildcard ‘ *’ .
Wildcard keys are expanded in case of arrays or objects.< / p >
< / td >
< / tr >
< tr >
< td >
< code > value< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Value is an optional name of the field within ‘ path’ that points to the image URI.
This is useful when a custom ‘ key’ is also defined.< / p >
< / td >
< / tr >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Name is the entry the image will be available under ‘ images.< name > ’ in the context.
If this field is not defined, image entries will appear under ‘ images.custom’ .< / p >
< / td >
< / tr >
< tr >
< td >
< code > key< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Key is an optional name of the field within ‘ path’ that will be used to uniquely identify an image.
Note - this field MUST be unique.< / p >
< / td >
< / tr >
2023-02-08 06:54:59 -05:00
< tr >
< td >
< code > jmesPath< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > JMESPath is an optional JMESPath expression to apply to the image value.
This is useful when the extracted image begins with a prefix like ‘ docker://’ .
The ‘ trim_prefix’ function may be used to trim the prefix: trim_prefix(@, ‘ docker://’ ).
Note - Image digest mutation may not be used when applying a JMESPAth to an image.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ImageExtractorConfigs" > ImageExtractorConfigs
(< code > map[string][]github.com/kyverno/kyverno/api/kyverno/v1.ImageExtractorConfig< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Rule" > Rule< / a > ,
< a href = "#kyverno.io/v2beta1.Rule" > Rule< / a > )
< / p >
< p >
< / p >
< h3 id = "kyverno.io/v1.ImageRegistry" > ImageRegistry
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ContextEntry" > ContextEntry< / a > )
< / p >
< p >
< p > ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image
details.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > reference< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Reference is image reference to a container image in the registry.
Example: ghcr.io/kyverno/kyverno:latest< / p >
< / td >
< / tr >
< tr >
< td >
< code > jmesPath< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
2023-06-16 19:07:08 +05:30
< tr >
< td >
< code > imageRegistryCredentials< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ImageRegistryCredentials" >
ImageRegistryCredentials
< / a >
< / em >
< / td >
< td >
< p > ImageRegistryCredentials provides credentials that will be used for authentication with registry< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ImageRegistryCredentials" > ImageRegistryCredentials
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ImageRegistry" > ImageRegistry< / a > ,
< a href = "#kyverno.io/v1.ImageVerification" > ImageVerification< / a > ,
< a href = "#kyverno.io/v2beta1.ImageVerification" > ImageVerification< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > allowInsecureRegistry< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > AllowInsecureRegistry allows insecure access to a registry.< / p >
2023-06-16 19:07:08 +05:30
< / td >
< / tr >
< tr >
< td >
2023-06-17 01:55:46 +05:30
< code > providers< / code > < br / >
2023-06-16 19:07:08 +05:30
< em >
2023-06-17 01:55:46 +05:30
< a href = "#kyverno.io/v1.ImageRegistryCredentialsProvidersType" >
[]ImageRegistryCredentialsProvidersType
2023-06-16 19:07:08 +05:30
< / a >
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > 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.< / p >
2023-06-16 19:07:08 +05:30
< / td >
< / tr >
< tr >
< td >
< code > secrets< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > Secrets specifies a list of secrets that are provided for credentials.
Secrets must live in the Kyverno namespace.< / p >
2023-06-16 19:07:08 +05:30
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
2023-06-17 01:55:46 +05:30
< h3 id = "kyverno.io/v1.ImageRegistryCredentialsProvidersType" > ImageRegistryCredentialsProvidersType
2023-06-16 19:07:08 +05:30
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ImageRegistryCredentials" > ImageRegistryCredentials< / a > )
< / p >
< p >
2023-06-17 01:55:46 +05:30
< p > ImageRegistryCredentialsProvidersType provides the list of credential providers required.< / p >
2023-06-16 19:07:08 +05:30
< / p >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.ImageVerification" > ImageVerification
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Rule" > Rule< / a > )
< / p >
< p >
< p > ImageVerification validates that images that match the specified pattern
are signed with the supplied public key. Once the image is verified it is
mutated to include the SHA digest retrieved during the registration.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2023-02-20 08:26:10 -08:00
< code > type< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ImageVerificationType" >
ImageVerificationType
< / a >
< / em >
< / td >
< td >
< p > Type specifies the method of signature validation. The allowed options
2023-06-01 13:35:28 +05:30
are Cosign and Notary. By default Cosign is used if a type is not specified.< / p >
2023-02-20 08:26:10 -08:00
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > image< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated. Use ImageReferences instead.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > imageReferences< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< p > 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: < a href = "https://kubernetes.io/docs/concepts/containers/images" > https://kubernetes.io/docs/concepts/containers/images< / a > .< / p >
< / td >
< / tr >
< tr >
< td >
2024-01-23 17:57:39 +05:30
< code > skipImageReferences< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< p > 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: < a href = "https://kubernetes.io/docs/concepts/containers/images" > https://kubernetes.io/docs/concepts/containers/images< / a > .< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > key< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated. Use StaticKeyAttestor instead.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > roots< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated. Use KeylessAttestor instead.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > subject< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated. Use KeylessAttestor instead.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > issuer< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated. Use KeylessAttestor instead.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > additionalExtensions< / code > < br / >
< em >
map[string]string
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > attestors< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AttestorSet" >
[]AttestorSet
< / a >
< / em >
< / td >
< td >
< p > Attestors specified the required attestors (i.e. authorities)< / p >
< / td >
< / tr >
< tr >
< td >
< code > attestations< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Attestation" >
[]Attestation
< / a >
< / em >
< / td >
< td >
< p > Attestations are optional checks for signed in-toto Statements used to verify the image.
See < a href = "https://github.com/in-toto/attestation" > https://github.com/in-toto/attestation< / a > . Kyverno fetches signed attestations from the
OCI registry and decodes them into a list of Statement declarations.< / p >
< / td >
< / tr >
< tr >
< td >
< code > annotations< / code > < br / >
< em >
map[string]string
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated. Use annotations per Attestor instead.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > repository< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > mutateDigest< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > MutateDigest enables replacement of image tags with digests.
Defaults to true.< / p >
< / td >
< / tr >
< tr >
< td >
< code > verifyDigest< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > VerifyDigest validates that images have a digest.< / p >
< / td >
< / tr >
< tr >
< td >
< code > required< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Required validates that images are verified i.e. have matched passed a signature or attestation check.< / p >
< / td >
< / tr >
2023-06-16 19:07:08 +05:30
< tr >
< td >
< code > imageRegistryCredentials< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ImageRegistryCredentials" >
ImageRegistryCredentials
< / a >
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > ImageRegistryCredentials provides credentials that will be used for authentication with registry.< / p >
2023-06-16 19:07:08 +05:30
< / td >
< / tr >
2023-08-07 01:24:52 +05:30
< tr >
< td >
< code > useCache< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > UseCache enables caching of image verify responses for this rule.< / p >
2023-08-07 01:24:52 +05:30
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
2023-02-20 08:26:10 -08:00
< h3 id = "kyverno.io/v1.ImageVerificationType" > ImageVerificationType
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
2023-06-16 19:07:08 +05:30
< a href = "#kyverno.io/v1.ImageVerification" > ImageVerification< / a > ,
< a href = "#kyverno.io/v2beta1.ImageVerification" > ImageVerification< / a > )
2023-02-20 08:26:10 -08:00
< / p >
< p >
< p > ImageVerificationType selects the type of verification algorithm< / p >
< / p >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.KeylessAttestor" > KeylessAttestor
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Attestor" > Attestor< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > rekor< / code > < br / >
< em >
2023-08-30 12:09:49 +05:30
< a href = "#kyverno.io/v1.Rekor" >
Rekor
< / a >
< / em >
< / td >
< td >
< p > Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (< a href = "https://rekor.sigstore.dev" > https://rekor.sigstore.dev< / a > ) is used.< / p >
< / td >
< / tr >
< tr >
< td >
< code > ctlog< / code > < br / >
< em >
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v1.CTLog" >
CTLog
< / a >
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > 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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > issuer< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Issuer is the certificate issuer used for keyless signing.< / p >
< / td >
< / tr >
< tr >
< td >
< code > subject< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > Subject is the verified identity used for keyless signing, for example the email address.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > roots< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Roots is an optional set of PEM encoded trusted root certificates.
If not provided, the system roots are used.< / p >
< / td >
< / tr >
< tr >
< td >
< code > additionalExtensions< / code > < br / >
< em >
map[string]string
< / em >
< / td >
< td >
< p > AdditionalExtensions are certificate-extensions used for keyless signing.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.Manifests" > Manifests
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Validation" > Validation< / a > ,
< a href = "#kyverno.io/v2beta1.Validation" > Validation< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > attestors< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AttestorSet" >
[]AttestorSet
< / a >
< / em >
< / td >
< td >
< p > Attestors specified the required attestors (i.e. authorities)< / p >
< / td >
< / tr >
< tr >
< td >
< code > annotationDomain< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > AnnotationDomain is custom domain of annotation for message and signature. Default is “ cosign.sigstore.dev” .< / p >
< / td >
< / tr >
< tr >
< td >
< code > ignoreFields< / code > < br / >
< em >
< a href = "#kyverno.io/v1.IgnoreFieldList" >
IgnoreFieldList
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Fields which will be ignored while comparing manifests.< / p >
< / td >
< / tr >
< tr >
< td >
< code > dryRun< / code > < br / >
< em >
< a href = "#kyverno.io/v1.DryRunOption" >
DryRunOption
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > DryRun configuration< / p >
< / td >
< / tr >
< tr >
< td >
< code > repository< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Repository is an optional alternate OCI repository to use for resource bundle reference.
The repository can be overridden per Attestor or Attestation.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.MatchResources" > MatchResources
< / h3 >
< p >
(< em > Appears on:< / em >
2022-12-08 11:31:28 +01:00
< a href = "#kyverno.io/v1.Rule" > Rule< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
< p > MatchResources is used to specify resource and admission review request data for
which a policy rule is applicable.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > any< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceFilters" >
ResourceFilters
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Any allows specifying resources which will be ORed< / p >
< / td >
< / tr >
< tr >
< td >
< code > all< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceFilters" >
ResourceFilters
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > All allows specifying resources which will be ANDed< / p >
< / td >
< / tr >
< tr >
< td >
< code > UserInfo< / code > < br / >
< em >
< a href = "#kyverno.io/v1.UserInfo" >
UserInfo
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > UserInfo contains information about the user performing the operation.
Specifying UserInfo directly under match is being deprecated.
Please specify under “ any” or “ all” instead.< / p >
< / td >
< / tr >
< tr >
< td >
< code > resources< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceDescription" >
ResourceDescription
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-27 00:36:49 -08:00
< h3 id = "kyverno.io/v1.Method" > Method
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
2023-04-26 16:31:44 -07:00
< a href = "#kyverno.io/v1.APICall" > APICall< / a > )
2022-12-27 00:36:49 -08:00
< / p >
< p >
< p > Method is a HTTP request type.< / p >
< / p >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.Mutation" > Mutation
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Rule" > Rule< / a > ,
< a href = "#kyverno.io/v2beta1.Rule" > Rule< / a > )
< / p >
< p >
< p > Mutation defines how resource are modified.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > targets< / code > < br / >
< em >
2023-04-03 21:58:58 +02:00
< a href = "#kyverno.io/v1.TargetResourceSpec" >
[]TargetResourceSpec
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Targets defines the target resources to be mutated.< / p >
< / td >
< / tr >
< tr >
< td >
< code > patchStrategicMerge< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PatchStrategicMerge is a strategic merge patch used to modify resources.
See < a href = "https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/" > https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/< / a >
and < a href = "https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/" > https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/< / a > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > patchesJson6902< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PatchesJSON6902 is a list of RFC 6902 JSON Patch declarations used to modify resources.
See < a href = "https://tools.ietf.org/html/rfc6902" > https://tools.ietf.org/html/rfc6902< / a > and < a href = "https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/" > https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/< / a > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > foreach< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ForEachMutation" >
[]ForEachMutation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ObjectFieldBinding" > ObjectFieldBinding
< / h3 >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > fields< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > objects< / code > < br / >
< em >
github.com/sigstore/k8s-manifest-sigstore/pkg/k8smanifest.ObjectReferenceList
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.PodSecurity" > PodSecurity
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Validation" > Validation< / a > ,
< a href = "#kyverno.io/v2beta1.Validation" > Validation< / a > )
< / p >
< p >
< p > PodSecurity applies exemptions for Kubernetes Pod Security admission
by specifying exclusions for Pod Security Standards controls.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > level< / code > < br / >
< em >
k8s.io/pod-security-admission/api.Level
< / em >
< / td >
< td >
< p > Level defines the Pod Security Standard level to be applied to workloads.
Allowed values are privileged, baseline, and restricted.< / p >
< / td >
< / tr >
< tr >
< td >
< code > version< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Version defines the Pod Security Standard versions that Kubernetes supports.
2023-04-03 20:50:11 +08:00
Allowed values are v1.19, v1.20, v1.21, v1.22, v1.23, v1.24, v1.25, v1.26, latest. Defaults to latest.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > exclude< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PodSecurityStandard" >
[]PodSecurityStandard
< / a >
< / em >
< / td >
< td >
< p > Exclude specifies the Pod Security Standard controls to be excluded.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.PodSecurityStandard" > PodSecurityStandard
< / h3 >
< p >
(< em > Appears on:< / em >
2024-01-26 20:43:07 +02:00
< a href = "#kyverno.io/v1.PodSecurity" > PodSecurity< / a > ,
< a href = "#kyverno.io/v2.PolicyExceptionSpec" > PolicyExceptionSpec< / a > ,
< a href = "#kyverno.io/v2beta1.PolicyExceptionSpec" > PolicyExceptionSpec< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
< p > PodSecurityStandard specifies the Pod Security Standard controls to be excluded.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > controlName< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > ControlName specifies the name of the Pod Security Standard control.
See: < a href = "https://kubernetes.io/docs/concepts/security/pod-security-standards/" > https://kubernetes.io/docs/concepts/security/pod-security-standards/< / a > < / p >
< / td >
< / tr >
< tr >
< td >
< code > images< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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: < a href = "https://kubernetes.io/docs/concepts/containers/images" > https://kubernetes.io/docs/concepts/containers/images< / a > .< / p >
< / td >
< / tr >
2023-12-26 19:58:08 +05:30
< tr >
< td >
< code > restrictedField< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > RestrictedField selects the field for the given Pod Security Standard control.
When not set, all restricted fields for the control are selected.< / p >
< / td >
< / tr >
< tr >
< td >
< code > values< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Values defines the allowed values that can be excluded.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.PolicyInterface" > PolicyInterface
< / h3 >
< p >
< p > PolicyInterface abstracts the concrete policy type (Policy vs ClusterPolicy)< / p >
< / p >
< h3 id = "kyverno.io/v1.PolicyStatus" > PolicyStatus
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ClusterPolicy" > ClusterPolicy< / a > ,
< a href = "#kyverno.io/v1.Policy" > Policy< / a > ,
< a href = "#kyverno.io/v2beta1.ClusterPolicy" > ClusterPolicy< / a > ,
< a href = "#kyverno.io/v2beta1.Policy" > Policy< / a > )
< / p >
< p >
2023-09-01 03:53:44 +05:30
< p > Deprecated. Policy metrics are now available via the “ /metrics” endpoint.
2022-10-21 16:51:15 +02:00
See: < a href = "https://kyverno.io/docs/monitoring-kyverno-with-prometheus-metrics/" > https://kyverno.io/docs/monitoring-kyverno-with-prometheus-metrics/< / a > < / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > ready< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated in favor of Conditions< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#condition-v1-meta" >
[]Kubernetes meta/v1.Condition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > autogen< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AutogenStatus" >
AutogenStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
2022-10-27 15:35:32 +05:30
< tr >
< td >
< code > rulecount< / code > < br / >
< em >
< a href = "#kyverno.io/v1.RuleCountStatus" >
RuleCountStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
2023-08-31 13:25:21 +03:00
< tr >
< td >
< code > validatingadmissionpolicy< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidatingAdmissionPolicyStatus" >
ValidatingAdmissionPolicyStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ValidatingAdmissionPolicy contains status information< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
2023-08-30 12:09:49 +05:30
< h3 id = "kyverno.io/v1.Rekor" > Rekor
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.CertificateAttestor" > CertificateAttestor< / a > ,
< a href = "#kyverno.io/v1.KeylessAttestor" > KeylessAttestor< / a > ,
< a href = "#kyverno.io/v1.StaticKeyAttestor" > StaticKeyAttestor< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > url< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > URL is the address of the transparency log. Defaults to the public Rekor log instance < a href = "https://rekor.sigstore.dev" > https://rekor.sigstore.dev< / a > .< / p >
2023-08-30 12:09:49 +05:30
< / td >
< / tr >
< tr >
< td >
< code > pubkey< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > 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.< / p >
2023-08-30 12:09:49 +05:30
< / td >
< / tr >
< tr >
< td >
< code > ignoreTlog< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > IgnoreTlog skips transparency log verification.< / p >
2023-08-30 12:09:49 +05:30
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-27 00:36:49 -08:00
< h3 id = "kyverno.io/v1.RequestData" > RequestData
< / h3 >
< p >
(< em > Appears on:< / em >
2023-04-26 16:31:44 -07:00
< a href = "#kyverno.io/v1.APICall" > APICall< / a > )
2022-12-27 00:36:49 -08:00
< / p >
< p >
< p > RequestData contains the HTTP POST data< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > key< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Key is a unique identifier for the data value< / p >
< / td >
< / tr >
< tr >
< td >
< code > value< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< p > Value is the data value< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.ResourceDescription" > ResourceDescription
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.MatchResources" > MatchResources< / a > ,
< a href = "#kyverno.io/v1.ResourceFilter" > ResourceFilter< / a > )
< / p >
< p >
< p > ResourceDescription contains criteria used to match resources.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > kinds< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Kinds is a list of resource kinds.< / p >
< / td >
< / tr >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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” .< / p >
< / td >
< / tr >
< tr >
< td >
< code > names< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Names are the names of the resources. Each name supports wildcard characters
“ *” (matches zero or many characters) and “ ?” (at least one character).< / p >
< / td >
< / tr >
< tr >
< td >
< code > namespaces< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Namespaces is a list of namespaces names. Each name supports wildcard characters
“ *” (matches zero or many characters) and “ ?” (at least one character).< / p >
< / td >
< / tr >
< tr >
< td >
< code > annotations< / code > < br / >
< em >
map[string]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > selector< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta" >
Kubernetes meta/v1.LabelSelector
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Selector is a label selector. Label keys and values in < code > matchLabels< / code > support the wildcard
characters < code > *< / code > (matches zero or many characters) and < code > ?< / code > (matches one character).
Wildcards allows writing label selectors like [“ storage.k8s.io/< em > ” : “ < / em > ” ]. Note that
using [” < em > ” : “ < / em > ” ] matches any key and value but does not match an empty label set.< / p >
< / td >
< / tr >
< tr >
< td >
< code > namespaceSelector< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta" >
Kubernetes meta/v1.LabelSelector
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > NamespaceSelector is a label selector for the resource namespace. Label keys and values
in < code > matchLabels< / code > support the wildcard characters < code > *< / code > (matches zero or many characters)
and < code > ?< / code > (matches one character).Wildcards allows writing label selectors like
[“ storage.k8s.io/< em > ” : “ < / em > ” ]. Note that using [” < em > ” : “ < / em > ” ] matches any key and value but
does not match an empty label set.< / p >
< / td >
< / tr >
2023-03-29 06:22:21 +02:00
< tr >
< td >
< code > operations< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AdmissionOperation" >
[]AdmissionOperation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Operations can contain values [“ CREATE, “ UPDATE” , “ CONNECT” , “ DELETE” ], which are used to match a specific action.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ResourceFilter" > ResourceFilter
< / h3 >
< p >
< p > ResourceFilter allow users to “ AND” or “ OR” between resources< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > UserInfo< / code > < br / >
< em >
< a href = "#kyverno.io/v1.UserInfo" >
UserInfo
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > UserInfo contains information about the user performing the operation.< / p >
< / td >
< / tr >
< tr >
< td >
< code > resources< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceDescription" >
ResourceDescription
< / a >
< / em >
< / td >
< td >
< p > ResourceDescription contains information about the resource being created or modified.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ResourceFilters" > ResourceFilters
(< code > []github.com/kyverno/kyverno/api/kyverno/v1.ResourceFilter< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.MatchResources" > MatchResources< / a > ,
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v2.MatchResources" > MatchResources< / a > ,
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v2beta1.MatchResources" > MatchResources< / a > )
< / p >
< p >
< p > ResourceFilters is a slice of ResourceFilter< / p >
< / p >
< h3 id = "kyverno.io/v1.ResourceSpec" > ResourceSpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Generation" > Generation< / a > ,
2023-04-03 21:58:58 +02:00
< a href = "#kyverno.io/v1.TargetResourceSpec" > TargetResourceSpec< / a > ,
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v1beta1.UpdateRequestSpec" > UpdateRequestSpec< / a > ,
2023-12-23 02:09:02 +02:00
< a href = "#kyverno.io/v1beta1.UpdateRequestStatus" > UpdateRequestStatus< / a > ,
< a href = "#kyverno.io/v2.UpdateRequestSpec" > UpdateRequestSpec< / a > ,
< a href = "#kyverno.io/v2.UpdateRequestStatus" > UpdateRequestStatus< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > APIVersion specifies resource apiVersion.< / p >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Kind specifies resource kind.< / p >
< / td >
< / tr >
< tr >
< td >
< code > namespace< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Namespace specifies resource namespace.< / p >
< / td >
< / tr >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Name specifies the resource name.< / p >
< / td >
< / tr >
2023-11-06 16:07:13 +05:30
< tr >
< td >
< code > uid< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#uid-types-pkg" >
k8s.io/apimachinery/pkg/types.UID
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > UID specifies the resource uid.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.Rule" > Rule
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.AutogenStatus" > AutogenStatus< / a > ,
< a href = "#kyverno.io/v1.Spec" > Spec< / a > )
< / p >
< p >
< p > Rule defines a validation, mutation, or generation control for matching resources.
Each rules contains a match declaration to select resources, and an optional exclude
declaration to specify which resources to exclude.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Name is a label to identify the rule, It must be unique within the policy.< / p >
< / td >
< / tr >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > exclude< / code > < br / >
< em >
< a href = "#kyverno.io/v1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > imageExtractors< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ImageExtractorConfigs" >
ImageExtractorConfigs
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ImageExtractors defines a mapping from kinds to ImageExtractorConfigs.
This config is only valid for verifyImages rules.< / p >
< / td >
< / tr >
< tr >
< td >
< code > preconditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Preconditions are used to determine if a policy rule should be applied by evaluating a
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements. A direct list
of conditions (without < code > any< / code > or < code > all< / code > statements is supported for backwards compatibility but
will be deprecated in the next major release.
See: < a href = "https://kyverno.io/docs/writing-policies/preconditions/" > https://kyverno.io/docs/writing-policies/preconditions/< / a > < / p >
< / td >
< / tr >
< tr >
< td >
2023-06-01 00:30:55 +03:00
< code > celPreconditions< / code > < br / >
< em >
2023-08-24 17:06:37 +03:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#matchcondition-v1alpha1-admissionregistration" >
[]Kubernetes admissionregistration/v1alpha1.MatchCondition
2023-06-01 00:30:55 +03:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > mutate< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Mutation" >
Mutation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Mutation is used to modify matching resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > validate< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Validation" >
Validation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Validation is used to validate matching resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > generate< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Generation" >
Generation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Generation is used to create new resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > verifyImages< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ImageVerification" >
[]ImageVerification
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > VerifyImages is used to verify image signatures and mutate them to add a digest< / p >
< / td >
< / tr >
2023-12-19 14:25:12 +08:00
< tr >
< td >
< code > skipBackgroundRequests< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
2022-10-27 15:35:32 +05:30
< h3 id = "kyverno.io/v1.RuleCountStatus" > RuleCountStatus
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.PolicyStatus" > PolicyStatus< / a > )
< / p >
< p >
< p > RuleCountStatus contains four variables which describes counts for
validate, generate, mutate and verify images rules< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > validate< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< p > Count for validate rules in policy< / p >
< / td >
< / tr >
< tr >
< td >
< code > generate< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< p > Count for generate rules in policy< / p >
< / td >
< / tr >
< tr >
< td >
< code > mutate< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< p > Count for mutate rules in policy< / p >
< / td >
< / tr >
< tr >
< td >
< code > verifyimages< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< p > Count for verify image rules in policy< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.SecretReference" > SecretReference
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.StaticKeyAttestor" > StaticKeyAttestor< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2022-11-07 10:59:16 +05:30
< p > Name of the secret. The provided secret must contain a key named cosign.pub.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > namespace< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2022-11-07 10:59:16 +05:30
< p > Namespace name where the Secret exists.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-27 00:36:49 -08:00
< h3 id = "kyverno.io/v1.ServiceCall" > ServiceCall
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.APICall" > APICall< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2023-04-26 16:31:44 -07:00
< code > url< / code > < br / >
2022-12-27 00:36:49 -08:00
< em >
string
< / em >
< / td >
< td >
2023-04-26 16:31:44 -07:00
< p > URL is the JSON web service URL. A typical form is
< code > https://{service}.{namespace}:{port}/{path}< / code > .< / p >
2022-12-27 00:36:49 -08:00
< / td >
< / tr >
< tr >
< td >
< code > caBundle< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > CABundle is a PEM encoded CA bundle which will be used to validate
the server certificate.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.Spec" > Spec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ClusterPolicy" > ClusterPolicy< / a > ,
< a href = "#kyverno.io/v1.Policy" > Policy< / a > )
< / p >
< p >
< p > Spec contains a list of Rule instances and other policy controls.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > rules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Rule" >
[]Rule
< / a >
< / em >
< / td >
< td >
< p > Rules is a list of Rule instances. A Policy contains multiple rules and
each rule can validate, mutate, or generate resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > applyRules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ApplyRulesType" >
ApplyRulesType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ApplyRules controls how rules in a policy are applied. Rule are processed in
the order of declaration. When set to < code > One< / code > processing stops after a rule has
been applied i.e. the rule matches and results in a pass, fail, or error. When
set to < code > All< / code > all rules in the policy are processed. The default is < code > All< / code > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > failurePolicy< / code > < br / >
< em >
< a href = "#kyverno.io/v1.FailurePolicyType" >
FailurePolicyType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > FailurePolicy defines how unexpected policy errors and webhook response timeout errors are handled.
Rules within the same policy share the same failure behavior.
2022-10-21 23:43:36 +05:30
This field should not be accessed directly, instead < code > GetFailurePolicy()< / code > should be used.
2022-10-21 16:51:15 +02:00
Allowed values are Ignore or Fail. Defaults to Fail.< / p >
< / td >
< / tr >
< tr >
< td >
< code > validationFailureAction< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureAction" >
ValidationFailureAction
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.
2023-01-02 16:16:13 +01:00
Allowed values are audit or enforce. The default value is “ Audit” .< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > validationFailureActionOverrides< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureActionOverride" >
[]ValidationFailureActionOverride
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction
namespace-wise. It overrides ValidationFailureAction for the specified namespaces.< / p >
< / td >
< / tr >
< tr >
< td >
2023-06-28 14:54:27 +02:00
< code > admission< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Admission controls if rules are applied during admission.
Optional. Default value is “ true” .< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > schemaValidation< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-12-18 18:32:11 +02:00
< p > Deprecated.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > webhookTimeoutSeconds< / code > < br / >
< em >
int32
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > mutateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > MutateExistingOnPolicyUpdate controls if a mutateExisting policy is applied on policy events.
Default value is “ false” .< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-24 00:36:51 +08:00
< code > generateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Deprecated, use generateExisting instead< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-03 17:34:55 +08:00
< code > generateExisting< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-03-03 17:34:55 +08:00
< p > GenerateExisting controls whether to trigger generate rule in existing resources
2022-10-21 16:51:15 +02:00
If is set to “ true” generate rule will be triggered and applied to existing matched resources.
Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
2023-08-02 18:59:37 +01:00
< tr >
< td >
< code > useServerSideApply< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
2024-01-27 21:00:22 +08:00
< tr >
< td >
< code > webhookConfiguration< / code > < br / >
< em >
< a href = "#kyverno.io/v1.WebhookConfiguration" >
WebhookConfiguration
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > WebhookConfiguration specifies the custom configuration for Kubernetes admission webhookconfiguration.
Requires Kubernetes 1.27 or later.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.StaticKeyAttestor" > StaticKeyAttestor
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Attestor" > Attestor< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > publicKeys< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > 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
2022-12-27 22:19:26 +08:00
< a href = "https://kyverno.io/docs/writing-policies/variables/)" > https://kyverno.io/docs/writing-policies/variables/)< / a > , 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 < code > cosign.pub< / code > containing the public key used for
verification, (see < a href = "https://github.com/sigstore/cosign/blob/main/KMS.md#kubernetes-secret" > https://github.com/sigstore/cosign/blob/main/KMS.md#kubernetes-secret< / a > ).
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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > signatureAlgorithm< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-12-21 08:57:33 +01:00
< p > Specify signature algorithm for public keys. Supported values are sha224, sha256, sha384 and sha512.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > kms< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > KMS provides the URI to the public key stored in a Key Management System. See:
< a href = "https://github.com/sigstore/cosign/blob/main/KMS.md" > https://github.com/sigstore/cosign/blob/main/KMS.md< / a > < / p >
< / td >
< / tr >
< tr >
< td >
< code > secret< / code > < br / >
< em >
< a href = "#kyverno.io/v1.SecretReference" >
SecretReference
< / a >
< / em >
< / td >
< td >
< p > Reference to a Secret resource that contains a public key< / p >
< / td >
< / tr >
< tr >
< td >
< code > rekor< / code > < br / >
< em >
2023-08-30 12:09:49 +05:30
< a href = "#kyverno.io/v1.Rekor" >
Rekor
< / a >
< / em >
< / td >
< td >
< p > Rekor provides configuration for the Rekor transparency log service. If an empty object
is provided the public instance of Rekor (< a href = "https://rekor.sigstore.dev" > https://rekor.sigstore.dev< / a > ) is used.< / p >
< / td >
< / tr >
< tr >
< td >
< code > ctlog< / code > < br / >
< em >
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v1.CTLog" >
CTLog
< / a >
< / em >
< / td >
< td >
2023-10-31 10:22:07 +05:30
< p > 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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-04-03 21:58:58 +02:00
< h3 id = "kyverno.io/v1.TargetResourceSpec" > TargetResourceSpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Mutation" > Mutation< / a > )
< / p >
< p >
< p > TargetResourceSpec defines targets for mutating existing resources.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > ResourceSpec< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceSpec" >
ResourceSpec
< / a >
< / em >
< / td >
< td >
< p > ResourceSpec contains the target resources to load when mutating existing resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
< code > preconditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Preconditions are used to determine if a policy rule should be applied by evaluating a
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements. A direct list
of conditions (without < code > any< / code > or < code > all< / code > statements is supported for backwards compatibility but
will be deprecated in the next major release.
See: < a href = "https://kyverno.io/docs/writing-policies/preconditions/" > https://kyverno.io/docs/writing-policies/preconditions/< / a > < / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.UserInfo" > UserInfo
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.MatchResources" > MatchResources< / a > ,
< a href = "#kyverno.io/v1.ResourceFilter" > ResourceFilter< / a > ,
< a href = "#kyverno.io/v2beta1.ResourceFilter" > ResourceFilter< / a > )
< / p >
< p >
< p > UserInfo contains information about the user performing the operation.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > roles< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Roles is the list of namespaced role names for the user.< / p >
< / td >
< / tr >
< tr >
< td >
< code > clusterRoles< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ClusterRoles is the list of cluster-wide role names for the user.< / p >
< / td >
< / tr >
< tr >
< td >
< code > subjects< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#subject-v1-rbac" >
[]Kubernetes rbac/v1.Subject
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Subjects is the list of subject names like users, user groups, and service accounts.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-08-31 13:25:21 +03:00
< h3 id = "kyverno.io/v1.ValidatingAdmissionPolicyStatus" > ValidatingAdmissionPolicyStatus
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.PolicyStatus" > PolicyStatus< / a > )
< / p >
< p >
< p > ValidatingAdmissionPolicy contains status information< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > generated< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Generated indicates whether a validating admission policy is generated from the policy or not< / p >
< / td >
< / tr >
< tr >
< td >
< code > message< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v1.Validation" > Validation
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Rule" > Rule< / a > )
< / p >
< p >
< p > Validation defines checks to be performed on matching resources.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > message< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Message specifies a custom message to be displayed on failure.< / p >
< / td >
< / tr >
< tr >
< td >
< code > manifests< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Manifests" >
Manifests
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Manifest specifies conditions for manifest verification< / p >
< / td >
< / tr >
< tr >
< td >
< code > foreach< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ForEachValidation" >
[]ForEachValidation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > pattern< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Pattern specifies an overlay-style pattern used to check resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > anyPattern< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > AnyPattern specifies list of validation patterns. At least one of the patterns
must be satisfied for the validation rule to succeed.< / p >
< / td >
< / tr >
< tr >
< td >
< code > deny< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Deny" >
Deny
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Deny defines conditions used to pass or fail a validation rule.< / p >
< / td >
< / tr >
< tr >
< td >
< code > podSecurity< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PodSecurity" >
PodSecurity
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PodSecurity applies exemptions for Kubernetes Pod Security admission
by specifying exclusions for Pod Security Standards controls.< / p >
< / td >
< / tr >
2023-06-01 00:30:55 +03:00
< tr >
< td >
< code > cel< / code > < br / >
< em >
< a href = "#kyverno.io/v1.CEL" >
CEL
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > CEL allows validation checks using the Common Expression Language (< a href = "https://kubernetes.io/docs/reference/using-api/cel/" > https://kubernetes.io/docs/reference/using-api/cel/< / a > ).< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.ValidationFailureAction" > ValidationFailureAction
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Spec" > Spec< / a > ,
< a href = "#kyverno.io/v1.ValidationFailureActionOverride" > ValidationFailureActionOverride< / a > ,
< a href = "#kyverno.io/v2beta1.Spec" > Spec< / a > )
< / p >
< p >
< p > ValidationFailureAction defines the policy validation failure action< / p >
< / p >
< h3 id = "kyverno.io/v1.ValidationFailureActionOverride" > ValidationFailureActionOverride
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Spec" > Spec< / a > ,
< a href = "#kyverno.io/v2beta1.Spec" > Spec< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > action< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureAction" >
ValidationFailureAction
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > namespaces< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< / td >
< / tr >
2023-01-18 05:21:34 -05:00
< tr >
< td >
< code > namespaceSelector< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta" >
Kubernetes meta/v1.LabelSelector
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1.Variable" > Variable
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.ContextEntry" > ContextEntry< / a > )
< / p >
< p >
< p > Variable defines an arbitrary JMESPath context variable that can be defined inline.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > value< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Value is any arbitrary JSON object representable in YAML or JSON form.< / p >
< / td >
< / tr >
< tr >
< td >
< code > jmesPath< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > JMESPath is an optional JMESPath Expression that can be used to
transform the variable.< / p >
< / td >
< / tr >
< tr >
< td >
< code > default< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Default is an optional arbitrary JSON object that the variable may take if the JMESPath
expression evaluates to nil< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2024-01-27 21:00:22 +08:00
< h3 id = "kyverno.io/v1.WebhookConfiguration" > WebhookConfiguration
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1.Spec" > Spec< / a > )
< / p >
< p >
< p > WebhookConfiguration specifies the configuration for Kubernetes admission webhookconfiguration.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > matchConditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#matchcondition-v1-admissionregistration" >
[]Kubernetes admissionregistration/v1.MatchCondition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > MatchCondition configures admission webhook matchConditions.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h2 id = "kyverno.io/v1alpha2" > kyverno.io/v1alpha2< / h2 >
2022-11-08 14:12:35 +05:30
< p >
2022-12-08 12:45:47 +01:00
< p > Package v1alpha2 contains API Schema definitions for the policy v1alpha2 API group< / p >
2022-11-08 14:12:35 +05:30
< / p >
Resource Types:
< ul > < li >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1alpha2.AdmissionReport" > AdmissionReport< / a >
< / li > < li >
< a href = "#kyverno.io/v1alpha2.BackgroundScanReport" > BackgroundScanReport< / a >
< / li > < li >
< a href = "#kyverno.io/v1alpha2.ClusterAdmissionReport" > ClusterAdmissionReport< / a >
2022-11-08 14:12:35 +05:30
< / li > < li >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1alpha2.ClusterBackgroundScanReport" > ClusterBackgroundScanReport< / a >
2022-11-08 14:12:35 +05:30
< / li > < / ul >
< hr / >
2022-12-08 12:45:47 +01:00
< h3 id = "kyverno.io/v1alpha2.AdmissionReport" > AdmissionReport
2022-11-08 14:12:35 +05:30
< / h3 >
< p >
2022-12-08 12:45:47 +01:00
< p > AdmissionReport is the Schema for the AdmissionReports API< / p >
2022-11-08 14:12:35 +05:30
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
2022-12-08 12:45:47 +01:00
kyverno.io/v1alpha2
2022-11-08 14:12:35 +05:30
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
2022-12-08 12:45:47 +01:00
< td > < code > AdmissionReport< / code > < / td >
2022-11-08 14:12:35 +05:30
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2023-12-22 16:09:00 +02:00
< a href = "#kyverno.io/v2.AdmissionReportSpec" >
2022-12-08 12:45:47 +01:00
AdmissionReportSpec
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > owner< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2022-12-08 12:45:47 +01:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#ownerreference-v1-meta" >
Kubernetes meta/v1.OwnerReference
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > Owner is a reference to the report owner (e.g. a Deployment, Namespace, or Node)< / p >
2022-11-08 14:12:35 +05:30
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > summary< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2022-12-08 12:45:47 +01:00
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2022-12-08 12:45:47 +01:00
< p > PolicyReportSummary provides a summary of results< / p >
2022-11-08 14:12:35 +05:30
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > results< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2022-12-08 12:45:47 +01:00
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2022-12-08 12:45:47 +01:00
< p > PolicyReportResult provides result details< / p >
2022-11-08 14:12:35 +05:30
< / td >
< / tr >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h3 id = "kyverno.io/v1alpha2.BackgroundScanReport" > BackgroundScanReport
2022-11-08 14:12:35 +05:30
< / h3 >
< p >
2022-12-08 12:45:47 +01:00
< p > BackgroundScanReport is the Schema for the BackgroundScanReports API< / p >
2022-11-08 14:12:35 +05:30
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
2022-12-08 12:45:47 +01:00
kyverno.io/v1alpha2
2022-11-08 14:12:35 +05:30
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
2022-12-08 12:45:47 +01:00
< td > < code > BackgroundScanReport< / code > < / td >
2022-11-08 14:12:35 +05:30
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2023-12-22 16:09:00 +02:00
< a href = "#kyverno.io/v2.BackgroundScanReportSpec" >
2022-12-08 12:45:47 +01:00
BackgroundScanReportSpec
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > summary< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2022-12-08 12:45:47 +01:00
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2022-12-08 12:45:47 +01:00
< p > PolicyReportSummary provides a summary of results< / p >
2022-11-08 14:12:35 +05:30
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > results< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2022-12-08 12:45:47 +01:00
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2022-12-08 12:45:47 +01:00
< p > PolicyReportResult provides result details< / p >
2022-11-08 14:12:35 +05:30
< / td >
< / tr >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h3 id = "kyverno.io/v1alpha2.ClusterAdmissionReport" > ClusterAdmissionReport
2022-11-08 14:12:35 +05:30
< / h3 >
< p >
2022-12-08 12:45:47 +01:00
< p > ClusterAdmissionReport is the Schema for the ClusterAdmissionReports API< / p >
2022-11-08 14:12:35 +05:30
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v1alpha2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > ClusterAdmissionReport< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2022-12-08 12:45:47 +01:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
2022-11-08 14:12:35 +05:30
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > spec< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2023-12-22 16:09:00 +02:00
< a href = "#kyverno.io/v2.AdmissionReportSpec" >
2022-12-08 12:45:47 +01:00
AdmissionReportSpec
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > owner< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#ownerreference-v1-meta" >
Kubernetes meta/v1.OwnerReference
< / a >
< / em >
< / td >
< td >
< p > Owner is a reference to the report owner (e.g. a Deployment, Namespace, or Node)< / p >
2022-11-08 14:12:35 +05:30
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > summary< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2022-12-08 12:45:47 +01:00
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
2022-11-08 14:12:35 +05:30
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
2022-11-08 14:12:35 +05:30
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > results< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2022-12-08 12:45:47 +01:00
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
2022-11-08 14:12:35 +05:30
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2022-12-08 12:45:47 +01:00
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / table >
2022-11-08 14:12:35 +05:30
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h3 id = "kyverno.io/v1alpha2.ClusterBackgroundScanReport" > ClusterBackgroundScanReport
2022-11-08 14:12:35 +05:30
< / h3 >
< p >
2022-12-08 12:45:47 +01:00
< p > ClusterBackgroundScanReport is the Schema for the ClusterBackgroundScanReports API< / p >
2022-11-08 14:12:35 +05:30
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v1alpha2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > ClusterBackgroundScanReport< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
2022-11-08 14:12:35 +05:30
< em >
2022-12-08 12:45:47 +01:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2023-12-22 16:09:00 +02:00
< a href = "#kyverno.io/v2.BackgroundScanReportSpec" >
2022-12-08 12:45:47 +01:00
BackgroundScanReportSpec
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h3 id = "kyverno.io/v1alpha2.ReportInterface" > ReportInterface
2022-10-21 16:51:15 +02:00
< / h3 >
< p >
2022-12-08 12:45:47 +01:00
< p > ReportInterface abstracts the concrete report change request type< / p >
< / p >
< h2 id = "kyverno.io/v1beta1" > kyverno.io/v1beta1< / h2 >
< p >
< p > Package v1beta1 contains API Schema definitions for the policy v1beta1 API group< / p >
< / p >
Resource Types:
< ul > < li >
< a href = "#kyverno.io/v1beta1.UpdateRequest" > UpdateRequest< / a >
< / li > < / ul >
< hr / >
< h3 id = "kyverno.io/v1beta1.UpdateRequest" > UpdateRequest
< / h3 >
< p >
< p > UpdateRequest is a request to process mutate and generate rules in background.< / p >
2022-10-21 16:51:15 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
2022-12-08 12:45:47 +01:00
kyverno.io/v1beta1
2022-10-21 16:51:15 +02:00
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
2022-12-08 12:45:47 +01:00
< td > < code > UpdateRequest< / code > < / td >
2022-10-21 16:51:15 +02:00
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1beta1.UpdateRequestSpec" >
UpdateRequestSpec
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2023-02-22 18:49:09 +08:00
< p > ResourceSpec is the information to identify the trigger resource.< / p >
2022-10-21 16:51:15 +02:00
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > requestType< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1beta1.RequestType" >
RequestType
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > Type represents request type for background processing< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > policy< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
string
< / em >
< / td >
< td >
< p > Specifies the name of the policy.< / p >
< / td >
< / tr >
< tr >
< td >
2023-02-10 22:56:17 +08:00
< code > rule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Rule is the associate rule name of the current UR.< / p >
< / td >
< / tr >
< tr >
< td >
2023-02-22 18:49:09 +08:00
< code > deleteDownstream< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > DeleteDownstream represents whether the downstream needs to be deleted.< / p >
< / td >
< / tr >
< tr >
< td >
2023-02-10 22:56:17 +08:00
< code > synchronize< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Synchronize represents the sync behavior of the corresponding rule
Optional. Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > resource< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceSpec" >
ResourceSpec
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2023-02-22 18:49:09 +08:00
< p > ResourceSpec is the information to identify the trigger resource.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > context< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1beta1.UpdateRequestSpecContext" >
UpdateRequestSpecContext
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > Context … < / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< / table >
< / td >
< / tr >
2022-12-08 12:45:47 +01:00
< tr >
< td >
< code > status< / code > < br / >
< em >
< a href = "#kyverno.io/v1beta1.UpdateRequestStatus" >
UpdateRequestStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Status contains statistics related to update request.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h3 id = "kyverno.io/v1beta1.AdmissionRequestInfoObject" > AdmissionRequestInfoObject
2022-10-21 16:51:15 +02:00
< / h3 >
< p >
2022-12-08 12:45:47 +01:00
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1beta1.UpdateRequestSpecContext" > UpdateRequestSpecContext< / a > )
< / p >
< p >
< p > AdmissionRequestInfoObject stores the admission request and operation details< / p >
2022-10-21 16:51:15 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > admissionRequest< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#admissionrequest-v1-admission" >
Kubernetes admission/v1.AdmissionRequest
< / a >
< / em >
2022-10-21 16:51:15 +02:00
< / td >
< td >
2022-12-08 12:45:47 +01:00
< em > (Optional)< / em >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > operation< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#operation-v1-admission" >
Kubernetes admission/v1.Operation
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< em > (Optional)< / em >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
2022-12-08 12:45:47 +01:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v1beta1.RequestInfo" > RequestInfo
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1beta1.UpdateRequestSpecContext" > UpdateRequestSpecContext< / a > )
< / p >
< p >
< p > RequestInfo contains permission info carried in an admission request.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
2022-10-21 16:51:15 +02:00
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > roles< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
[]string
2022-10-21 16:51:15 +02:00
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< em > (Optional)< / em >
< p > Roles is a list of possible role send the request.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > clusterRoles< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
[]string
2022-10-21 16:51:15 +02:00
< / em >
< / td >
< td >
< em > (Optional)< / em >
2022-12-08 12:45:47 +01:00
< p > ClusterRoles is a list of possible clusterRoles send the request.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > userInfo< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#userinfo-v1-authentication" >
Kubernetes authentication/v1.UserInfo
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2022-12-08 12:45:47 +01:00
< p > UserInfo is the userInfo carried in the admission request.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h3 id = "kyverno.io/v1beta1.RequestType" > RequestType
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1beta1.UpdateRequestSpec" > UpdateRequestSpec< / a > )
< / p >
< p >
< / p >
< h3 id = "kyverno.io/v1beta1.UpdateRequestSpec" > UpdateRequestSpec
2022-10-21 16:51:15 +02:00
< / h3 >
< p >
(< em > Appears on:< / em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1beta1.UpdateRequest" > UpdateRequest< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
2022-12-08 12:45:47 +01:00
< p > UpdateRequestSpec stores the request specification.< / p >
2022-10-21 16:51:15 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > requestType< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1beta1.RequestType" >
RequestType
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > Type represents request type for background processing< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > policy< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
string
< / em >
< / td >
< td >
< p > Specifies the name of the policy.< / p >
< / td >
< / tr >
< tr >
< td >
2023-02-10 22:56:17 +08:00
< code > rule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Rule is the associate rule name of the current UR.< / p >
< / td >
< / tr >
< tr >
< td >
2023-02-22 18:49:09 +08:00
< code > deleteDownstream< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > DeleteDownstream represents whether the downstream needs to be deleted.< / p >
< / td >
< / tr >
< tr >
< td >
2023-02-10 22:56:17 +08:00
< code > synchronize< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Synchronize represents the sync behavior of the corresponding rule
Optional. Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > resource< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceSpec" >
ResourceSpec
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2023-02-22 18:49:09 +08:00
< p > ResourceSpec is the information to identify the trigger resource.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > context< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1beta1.UpdateRequestSpecContext" >
UpdateRequestSpecContext
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > Context … < / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h3 id = "kyverno.io/v1beta1.UpdateRequestSpecContext" > UpdateRequestSpecContext
2022-10-21 16:51:15 +02:00
< / h3 >
< p >
(< em > Appears on:< / em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1beta1.UpdateRequestSpec" > UpdateRequestSpec< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
2022-12-08 12:45:47 +01:00
< p > UpdateRequestSpecContext stores the context to be shared.< / p >
2022-10-21 16:51:15 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > userInfo< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1beta1.RequestInfo" >
RequestInfo
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > admissionRequestInfo< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v1beta1.AdmissionRequestInfoObject" >
AdmissionRequestInfoObject
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h3 id = "kyverno.io/v1beta1.UpdateRequestState" > UpdateRequestState
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1beta1.UpdateRequestStatus" > UpdateRequestStatus< / a > )
< / p >
< p >
< p > UpdateRequestState defines the state of request.< / p >
< / p >
< h3 id = "kyverno.io/v1beta1.UpdateRequestStatus" > UpdateRequestStatus
2022-10-21 16:51:15 +02:00
< / h3 >
< p >
2022-12-08 12:45:47 +01:00
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1beta1.UpdateRequest" > UpdateRequest< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
2022-12-08 12:45:47 +01:00
< p > UpdateRequestStatus defines the observed state of UpdateRequest< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > handler< / code > < br / >
< em >
string
< / em >
< / td >
< td >
2023-09-01 03:53:44 +05:30
< p > Deprecated< / p >
2022-12-08 12:45:47 +01:00
< / td >
< / tr >
< tr >
< td >
< code > state< / code > < br / >
< em >
< a href = "#kyverno.io/v1beta1.UpdateRequestState" >
UpdateRequestState
< / a >
< / em >
< / td >
< td >
< p > State represents state of the update request.< / p >
< / td >
< / tr >
< tr >
< td >
< code > message< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Specifies request status message.< / p >
< / td >
< / tr >
< tr >
< td >
< code > generatedResources< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceSpec" >
[]ResourceSpec
< / a >
< / em >
< / td >
< td >
< p > This will track the resources that are updated by the generate Policy.
Will be used during clean up resources.< / p >
< / td >
< / tr >
2023-12-19 14:25:12 +08:00
< tr >
< td >
< code > retryCount< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< / td >
< / tr >
2022-12-08 12:45:47 +01:00
< / tbody >
< / table >
< hr / >
2023-12-19 12:43:39 +02:00
< h2 id = "kyverno.io/v2" > kyverno.io/v2< / h2 >
< p >
< / p >
Resource Types:
< ul > < li >
2023-12-22 16:09:00 +02:00
< a href = "#kyverno.io/v2.AdmissionReport" > AdmissionReport< / a >
< / li > < li >
< a href = "#kyverno.io/v2.BackgroundScanReport" > BackgroundScanReport< / a >
< / li > < li >
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v2.CleanupPolicy" > CleanupPolicy< / a >
< / li > < li >
2023-12-22 16:09:00 +02:00
< a href = "#kyverno.io/v2.ClusterAdmissionReport" > ClusterAdmissionReport< / a >
< / li > < li >
< a href = "#kyverno.io/v2.ClusterBackgroundScanReport" > ClusterBackgroundScanReport< / a >
< / li > < li >
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v2.ClusterCleanupPolicy" > ClusterCleanupPolicy< / a >
< / li > < li >
2023-12-19 12:43:39 +02:00
< a href = "#kyverno.io/v2.PolicyException" > PolicyException< / a >
2023-12-23 02:09:02 +02:00
< / li > < li >
< a href = "#kyverno.io/v2.UpdateRequest" > UpdateRequest< / a >
2023-12-19 12:43:39 +02:00
< / li > < / ul >
< hr / >
2023-12-22 16:09:00 +02:00
< h3 id = "kyverno.io/v2.AdmissionReport" > AdmissionReport
2023-12-19 12:43:39 +02:00
< / h3 >
< p >
2023-12-22 16:09:00 +02:00
< p > AdmissionReport is the Schema for the AdmissionReports API< / p >
2023-12-19 12:43:39 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
2023-12-22 16:09:00 +02:00
< td > < code > AdmissionReport< / code > < / td >
2023-12-19 12:43:39 +02:00
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2023-12-22 16:09:00 +02:00
< a href = "#kyverno.io/v2.AdmissionReportSpec" >
AdmissionReportSpec
2023-12-19 12:43:39 +02:00
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
2023-12-22 16:09:00 +02:00
< code > owner< / code > < br / >
2023-12-19 12:43:39 +02:00
< em >
2023-12-22 16:09:00 +02:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#ownerreference-v1-meta" >
Kubernetes meta/v1.OwnerReference
< / a >
2023-12-19 12:43:39 +02:00
< / em >
< / td >
< td >
2023-12-22 16:09:00 +02:00
< p > Owner is a reference to the report owner (e.g. a Deployment, Namespace, or Node)< / p >
2023-12-19 12:43:39 +02:00
< / td >
< / tr >
< tr >
< td >
2023-12-22 16:09:00 +02:00
< code > summary< / code > < br / >
2023-12-19 12:43:39 +02:00
< em >
2023-12-22 16:09:00 +02:00
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
2023-12-19 12:43:39 +02:00
< / a >
< / em >
< / td >
< td >
2023-12-22 16:09:00 +02:00
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
2023-12-19 12:43:39 +02:00
< / td >
< / tr >
< tr >
< td >
2023-12-22 16:09:00 +02:00
< code > results< / code > < br / >
2023-12-19 12:43:39 +02:00
< em >
2023-12-22 16:09:00 +02:00
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
2023-12-19 12:43:39 +02:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-12-22 16:09:00 +02:00
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2.BackgroundScanReport" > BackgroundScanReport
< / h3 >
< p >
< p > BackgroundScanReport is the Schema for the BackgroundScanReports API< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2
< / code >
2023-12-19 12:43:39 +02:00
< / td >
< / tr >
< tr >
< td >
2023-12-22 16:09:00 +02:00
< code > kind< / code > < br / >
string
< / td >
< td > < code > BackgroundScanReport< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
2023-12-19 12:43:39 +02:00
< em >
2023-12-22 16:09:00 +02:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
2023-12-19 12:43:39 +02:00
< / a >
< / em >
< / td >
< td >
2023-12-22 16:09:00 +02:00
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2.BackgroundScanReportSpec" >
BackgroundScanReportSpec
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / table >
2023-12-19 12:43:39 +02:00
< / td >
< / tr >
2023-12-22 16:09:00 +02:00
< / tbody >
2023-12-19 12:43:39 +02:00
< / table >
2023-12-22 16:09:00 +02:00
< hr / >
2023-12-22 19:43:27 +01:00
< h3 id = "kyverno.io/v2.CleanupPolicy" > CleanupPolicy
< / h3 >
< p >
< p > CleanupPolicy defines a rule for resource cleanup.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > CleanupPolicy< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2.CleanupPolicySpec" >
CleanupPolicySpec
< / a >
< / em >
< / td >
< td >
< p > Spec declares policy behaviors.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > MatchResources defines when cleanuppolicy 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > exclude< / code > < br / >
< em >
< a href = "#kyverno.io/v2.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ExcludeResources defines when cleanuppolicy 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > schedule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > The schedule in Cron format< / p >
< / td >
< / tr >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Conditions defines the conditions used to select the resources which will be cleaned up.< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < br / >
< em >
< a href = "#kyverno.io/v2.CleanupPolicyStatus" >
CleanupPolicyStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Status contains policy runtime data.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-22 16:09:00 +02:00
< h3 id = "kyverno.io/v2.ClusterAdmissionReport" > ClusterAdmissionReport
< / h3 >
< p >
< p > ClusterAdmissionReport is the Schema for the ClusterAdmissionReports API< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > ClusterAdmissionReport< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2.AdmissionReportSpec" >
AdmissionReportSpec
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > owner< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#ownerreference-v1-meta" >
Kubernetes meta/v1.OwnerReference
< / a >
< / em >
< / td >
< td >
< p > Owner is a reference to the report owner (e.g. a Deployment, Namespace, or Node)< / p >
< / td >
< / tr >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2.ClusterBackgroundScanReport" > ClusterBackgroundScanReport
< / h3 >
< p >
< p > ClusterBackgroundScanReport is the Schema for the ClusterBackgroundScanReports API< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > ClusterBackgroundScanReport< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2.BackgroundScanReportSpec" >
BackgroundScanReportSpec
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-22 19:43:27 +01:00
< h3 id = "kyverno.io/v2.ClusterCleanupPolicy" > ClusterCleanupPolicy
2023-12-22 16:09:00 +02:00
< / h3 >
< p >
2023-12-22 19:43:27 +01:00
< p > ClusterCleanupPolicy defines rule for resource cleanup.< / p >
2023-12-22 16:09:00 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
2023-12-22 19:43:27 +01:00
< td > < code > ClusterCleanupPolicy< / code > < / td >
2023-12-22 16:09:00 +02:00
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v2.CleanupPolicySpec" >
CleanupPolicySpec
2023-12-22 16:09:00 +02:00
< / a >
< / em >
< / td >
< td >
2023-12-22 19:43:27 +01:00
< p > Spec declares policy behaviors.< / p >
2023-12-22 16:09:00 +02:00
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
2023-12-22 19:43:27 +01:00
< code > context< / code > < br / >
2023-12-22 16:09:00 +02:00
< em >
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
2023-12-22 16:09:00 +02:00
< / em >
< / td >
< td >
2023-12-22 19:43:27 +01:00
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
2023-12-22 16:09:00 +02:00
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v2.MatchResources" >
2023-12-22 16:09:00 +02:00
MatchResources
< / a >
< / em >
< / td >
< td >
2023-12-22 19:43:27 +01:00
< p > MatchResources defines when cleanuppolicy 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.< / p >
2023-12-22 16:09:00 +02:00
< / td >
< / tr >
< tr >
< td >
2023-12-22 19:43:27 +01:00
< code > exclude< / code > < br / >
2023-12-22 16:09:00 +02:00
< em >
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v2.MatchResources" >
MatchResources
2023-12-22 16:09:00 +02:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-12-22 19:43:27 +01:00
< p > ExcludeResources defines when cleanuppolicy 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.< / p >
2023-12-22 16:09:00 +02:00
< / td >
< / tr >
< tr >
< td >
2023-12-22 19:43:27 +01:00
< code > schedule< / code > < br / >
2023-12-22 16:09:00 +02:00
< em >
2023-12-22 19:43:27 +01:00
string
2023-12-22 16:09:00 +02:00
< / em >
< / td >
< td >
2023-12-22 19:43:27 +01:00
< p > The schedule in Cron format< / p >
2023-12-22 16:09:00 +02:00
< / td >
< / tr >
< tr >
< td >
2023-12-22 19:43:27 +01:00
< code > conditions< / code > < br / >
2023-12-22 16:09:00 +02:00
< em >
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v2.AnyAllConditions" >
AnyAllConditions
2023-12-22 16:09:00 +02:00
< / a >
< / em >
< / td >
< td >
2023-12-22 19:43:27 +01:00
< em > (Optional)< / em >
< p > Conditions defines the conditions used to select the resources which will be cleaned up.< / p >
2023-12-22 16:09:00 +02:00
< / td >
< / tr >
2023-12-22 19:43:27 +01:00
< / table >
2023-12-22 16:09:00 +02:00
< / td >
< / tr >
< tr >
< td >
2023-12-22 19:43:27 +01:00
< code > status< / code > < br / >
2023-12-22 16:09:00 +02:00
< em >
2023-12-22 19:43:27 +01:00
< a href = "#kyverno.io/v2.CleanupPolicyStatus" >
CleanupPolicyStatus
2023-12-22 16:09:00 +02:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-12-22 19:43:27 +01:00
< p > Status contains policy runtime data.< / p >
2023-12-22 16:09:00 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-22 19:43:27 +01:00
< h3 id = "kyverno.io/v2.PolicyException" > PolicyException
2023-12-22 16:09:00 +02:00
< / h3 >
< p >
2023-12-22 19:43:27 +01:00
< p > PolicyException declares resources to be excluded from specified policies.< / p >
2023-12-22 16:09:00 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2023-12-22 19:43:27 +01:00
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2
< / code >
2023-12-22 16:09:00 +02:00
< / td >
2023-12-22 19:43:27 +01:00
< / tr >
< tr >
2023-12-22 16:09:00 +02:00
< td >
2023-12-22 19:43:27 +01:00
< code > kind< / code > < br / >
string
2023-12-22 16:09:00 +02:00
< / td >
2023-12-22 19:43:27 +01:00
< td > < code > PolicyException< / code > < / td >
2023-12-22 16:09:00 +02:00
< / tr >
< tr >
< td >
2023-12-22 19:43:27 +01:00
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2.PolicyExceptionSpec" >
PolicyExceptionSpec
< / a >
< / em >
< / td >
< td >
< p > Spec declares policy exception behaviors.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Background controls if exceptions are applied to existing policies 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > Match defines match clause used to check if a resource applies to the exception< / p >
< / td >
< / tr >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Conditions are used to determine if a resource applies to the exception by evaluating a
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements.< / p >
< / td >
< / tr >
< tr >
< td >
< code > exceptions< / code > < br / >
< em >
< a href = "#kyverno.io/v2.Exception" >
[]Exception
< / a >
< / em >
< / td >
< td >
< p > Exceptions is a list policy/rules to be excluded< / p >
< / td >
< / tr >
2024-01-26 20:43:07 +02:00
< tr >
< td >
< code > podSecurity< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PodSecurityStandard" >
[]PodSecurityStandard
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PodSecurity specifies the Pod Security Standard controls to be excluded.
Applicable only to policies that have validate.podSecurity subrule.< / p >
< / td >
< / tr >
2023-12-22 19:43:27 +01:00
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-23 02:09:02 +02:00
< h3 id = "kyverno.io/v2.UpdateRequest" > UpdateRequest
< / h3 >
< p >
< p > UpdateRequest is a request to process mutate and generate rules in background.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > UpdateRequest< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2.UpdateRequestSpec" >
UpdateRequestSpec
< / a >
< / em >
< / td >
< td >
< p > ResourceSpec is the information to identify the trigger resource.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > requestType< / code > < br / >
< em >
< a href = "#kyverno.io/v2.RequestType" >
RequestType
< / a >
< / em >
< / td >
< td >
< p > Type represents request type for background processing< / p >
< / td >
< / tr >
< tr >
< td >
< code > policy< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Specifies the name of the policy.< / p >
< / td >
< / tr >
< tr >
< td >
< code > rule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Rule is the associate rule name of the current UR.< / p >
< / td >
< / tr >
< tr >
< td >
< code > deleteDownstream< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > DeleteDownstream represents whether the downstream needs to be deleted.< / p >
< / td >
< / tr >
< tr >
< td >
< code > synchronize< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Synchronize represents the sync behavior of the corresponding rule
Optional. Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
< tr >
< td >
< code > resource< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceSpec" >
ResourceSpec
< / a >
< / em >
< / td >
< td >
< p > ResourceSpec is the information to identify the trigger resource.< / p >
< / td >
< / tr >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v2.UpdateRequestSpecContext" >
UpdateRequestSpecContext
< / a >
< / em >
< / td >
< td >
< p > Context … < / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < br / >
< em >
< a href = "#kyverno.io/v2.UpdateRequestStatus" >
UpdateRequestStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Status contains statistics related to update request.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-22 19:43:27 +01:00
< h3 id = "kyverno.io/v2.AdmissionReportSpec" > AdmissionReportSpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1alpha2.AdmissionReport" > AdmissionReport< / a > ,
< a href = "#kyverno.io/v1alpha2.ClusterAdmissionReport" > ClusterAdmissionReport< / a > ,
< a href = "#kyverno.io/v2.AdmissionReport" > AdmissionReport< / a > ,
< a href = "#kyverno.io/v2.ClusterAdmissionReport" > ClusterAdmissionReport< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > owner< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#ownerreference-v1-meta" >
Kubernetes meta/v1.OwnerReference
< / a >
< / em >
< / td >
< td >
< p > Owner is a reference to the report owner (e.g. a Deployment, Namespace, or Node)< / p >
< / td >
< / tr >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-23 02:09:02 +02:00
< h3 id = "kyverno.io/v2.AdmissionRequestInfoObject" > AdmissionRequestInfoObject
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.UpdateRequestSpecContext" > UpdateRequestSpecContext< / a > )
< / p >
< p >
< p > AdmissionRequestInfoObject stores the admission request and operation details< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > admissionRequest< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#admissionrequest-v1-admission" >
Kubernetes admission/v1.AdmissionRequest
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > operation< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#operation-v1-admission" >
Kubernetes admission/v1.Operation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-22 19:43:27 +01:00
< h3 id = "kyverno.io/v2.AnyAllConditions" > AnyAllConditions
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.CleanupPolicySpec" > CleanupPolicySpec< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > any< / code > < br / >
< em >
< a href = "#kyverno.io/v2.Condition" >
[]Condition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > all< / code > < br / >
< em >
< a href = "#kyverno.io/v2.Condition" >
[]Condition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2.BackgroundScanReportSpec" > BackgroundScanReportSpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v1alpha2.BackgroundScanReport" > BackgroundScanReport< / a > ,
< a href = "#kyverno.io/v1alpha2.ClusterBackgroundScanReport" > ClusterBackgroundScanReport< / a > ,
< a href = "#kyverno.io/v2.BackgroundScanReport" > BackgroundScanReport< / a > ,
< a href = "#kyverno.io/v2.ClusterBackgroundScanReport" > ClusterBackgroundScanReport< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
2023-12-22 16:09:00 +02:00
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
2023-12-19 12:43:39 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-22 19:43:27 +01:00
< h3 id = "kyverno.io/v2.CleanupPolicySpec" > CleanupPolicySpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.CleanupPolicy" > CleanupPolicy< / a > ,
< a href = "#kyverno.io/v2.ClusterCleanupPolicy" > ClusterCleanupPolicy< / a > )
< / p >
< p >
< p > CleanupPolicySpec stores specifications for selecting resources that the user needs to delete
and schedule when the matching resources needs deleted.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > MatchResources defines when cleanuppolicy 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > exclude< / code > < br / >
< em >
< a href = "#kyverno.io/v2.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ExcludeResources defines when cleanuppolicy 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > schedule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > The schedule in Cron format< / p >
< / td >
< / tr >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Conditions defines the conditions used to select the resources which will be cleaned up.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2.CleanupPolicyStatus" > CleanupPolicyStatus
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.CleanupPolicy" > CleanupPolicy< / a > ,
< a href = "#kyverno.io/v2.ClusterCleanupPolicy" > ClusterCleanupPolicy< / a > )
< / p >
< p >
< p > CleanupPolicyStatus stores the status of the policy.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#condition-v1-meta" >
[]Kubernetes meta/v1.Condition
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > lastExecutionTime< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#time-v1-meta" >
Kubernetes meta/v1.Time
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2.Condition" > Condition
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.AnyAllConditions" > AnyAllConditions< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > key< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< p > Key is the context entry (using JMESPath) for conditional rule evaluation.< / p >
< / td >
< / tr >
< tr >
< td >
< code > operator< / code > < br / >
< em >
< a href = "#kyverno.io/v2.ConditionOperator" >
ConditionOperator
< / a >
< / em >
< / td >
< td >
< p > 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< / p >
< / td >
< / tr >
< tr >
< td >
< code > value< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Value is the conditional value, or set of values. The values can be fixed set
or can be variables declared using JMESPath.< / p >
< / td >
< / tr >
< tr >
< td >
< code > message< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Message is an optional display message< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2.ConditionOperator" > ConditionOperator
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.Condition" > Condition< / a > )
< / p >
< p >
< p > ConditionOperator is the operation performed on condition key and value.< / p >
< / p >
2023-12-19 12:43:39 +02:00
< h3 id = "kyverno.io/v2.Exception" > Exception
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.PolicyExceptionSpec" > PolicyExceptionSpec< / a > )
< / p >
< p >
< p > Exception stores infos about a policy and rules< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > policyName< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > PolicyName identifies the policy to which the exception is applied.
The policy name uses the format < namespace > /< name > unless it
references a ClusterPolicy.< / p >
< / td >
< / tr >
< tr >
< td >
< code > ruleNames< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< p > RuleNames identifies the rules to which the exception is applied.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-22 19:43:27 +01:00
< h3 id = "kyverno.io/v2.MatchResources" > MatchResources
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.CleanupPolicySpec" > CleanupPolicySpec< / a > )
< / p >
< p >
< p > MatchResources is used to specify resource and admission review request data for
which a policy rule is applicable.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > any< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceFilters" >
ResourceFilters
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Any allows specifying resources which will be ORed< / p >
< / td >
< / tr >
< tr >
< td >
< code > all< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceFilters" >
ResourceFilters
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > All allows specifying resources which will be ANDed< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-12-19 12:43:39 +02:00
< h3 id = "kyverno.io/v2.PolicyExceptionSpec" > PolicyExceptionSpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.PolicyException" > PolicyException< / a > )
< / p >
< p >
< p > PolicyExceptionSpec stores policy exception spec< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Background controls if exceptions are applied to existing policies 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > Match defines match clause used to check if a resource applies to the exception< / p >
< / td >
< / tr >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Conditions are used to determine if a resource applies to the exception by evaluating a
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements.< / p >
< / td >
< / tr >
< tr >
< td >
< code > exceptions< / code > < br / >
< em >
< a href = "#kyverno.io/v2.Exception" >
[]Exception
< / a >
< / em >
< / td >
< td >
< p > Exceptions is a list policy/rules to be excluded< / p >
< / td >
< / tr >
2024-01-26 20:43:07 +02:00
< tr >
< td >
< code > podSecurity< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PodSecurityStandard" >
[]PodSecurityStandard
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PodSecurity specifies the Pod Security Standard controls to be excluded.
Applicable only to policies that have validate.podSecurity subrule.< / p >
< / td >
< / tr >
2023-12-19 12:43:39 +02:00
< / tbody >
< / table >
< hr / >
2023-12-23 02:09:02 +02:00
< h3 id = "kyverno.io/v2.RequestInfo" > RequestInfo
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.UpdateRequestSpecContext" > UpdateRequestSpecContext< / a > )
< / p >
< p >
< p > RequestInfo contains permission info carried in an admission request.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > roles< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Roles is a list of possible role send the request.< / p >
< / td >
< / tr >
< tr >
< td >
< code > clusterRoles< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ClusterRoles is a list of possible clusterRoles send the request.< / p >
< / td >
< / tr >
< tr >
< td >
< code > userInfo< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#userinfo-v1-authentication" >
Kubernetes authentication/v1.UserInfo
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > UserInfo is the userInfo carried in the admission request.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2.RequestType" > RequestType
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.UpdateRequestSpec" > UpdateRequestSpec< / a > )
< / p >
< p >
< / p >
< h3 id = "kyverno.io/v2.UpdateRequestSpec" > UpdateRequestSpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.UpdateRequest" > UpdateRequest< / a > )
< / p >
< p >
< p > UpdateRequestSpec stores the request specification.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > requestType< / code > < br / >
< em >
< a href = "#kyverno.io/v2.RequestType" >
RequestType
< / a >
< / em >
< / td >
< td >
< p > Type represents request type for background processing< / p >
< / td >
< / tr >
< tr >
< td >
< code > policy< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Specifies the name of the policy.< / p >
< / td >
< / tr >
< tr >
< td >
< code > rule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Rule is the associate rule name of the current UR.< / p >
< / td >
< / tr >
< tr >
< td >
< code > deleteDownstream< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > DeleteDownstream represents whether the downstream needs to be deleted.< / p >
< / td >
< / tr >
< tr >
< td >
< code > synchronize< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Synchronize represents the sync behavior of the corresponding rule
Optional. Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
< tr >
< td >
< code > resource< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceSpec" >
ResourceSpec
< / a >
< / em >
< / td >
< td >
< p > ResourceSpec is the information to identify the trigger resource.< / p >
< / td >
< / tr >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v2.UpdateRequestSpecContext" >
UpdateRequestSpecContext
< / a >
< / em >
< / td >
< td >
< p > Context … < / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2.UpdateRequestSpecContext" > UpdateRequestSpecContext
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.UpdateRequestSpec" > UpdateRequestSpec< / a > )
< / p >
< p >
< p > UpdateRequestSpecContext stores the context to be shared.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > userInfo< / code > < br / >
< em >
< a href = "#kyverno.io/v2.RequestInfo" >
RequestInfo
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > admissionRequestInfo< / code > < br / >
< em >
< a href = "#kyverno.io/v2.AdmissionRequestInfoObject" >
AdmissionRequestInfoObject
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2.UpdateRequestState" > UpdateRequestState
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.UpdateRequestStatus" > UpdateRequestStatus< / a > )
< / p >
< p >
< p > UpdateRequestState defines the state of request.< / p >
< / p >
< h3 id = "kyverno.io/v2.UpdateRequestStatus" > UpdateRequestStatus
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2.UpdateRequest" > UpdateRequest< / a > )
< / p >
< p >
< p > UpdateRequestStatus defines the observed state of UpdateRequest< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > state< / code > < br / >
< em >
< a href = "#kyverno.io/v2.UpdateRequestState" >
UpdateRequestState
< / a >
< / em >
< / td >
< td >
< p > State represents state of the update request.< / p >
< / td >
< / tr >
< tr >
< td >
< code > message< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Specifies request status message.< / p >
< / td >
< / tr >
< tr >
< td >
< code > generatedResources< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceSpec" >
[]ResourceSpec
< / a >
< / em >
< / td >
< td >
< p > This will track the resources that are updated by the generate Policy.
Will be used during clean up resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > retryCount< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-12-08 12:45:47 +01:00
< h2 id = "kyverno.io/v2alpha1" > kyverno.io/v2alpha1< / h2 >
< p >
2022-10-21 16:51:15 +02:00
< / p >
Resource Types:
< ul > < li >
2023-10-09 23:01:24 +08:00
< a href = "#kyverno.io/v2alpha1.CleanupPolicy" > CleanupPolicy< / a >
< / li > < li >
< a href = "#kyverno.io/v2alpha1.ClusterCleanupPolicy" > ClusterCleanupPolicy< / a >
< / li > < li >
2024-02-01 11:58:31 +01:00
< a href = "#kyverno.io/v2alpha1.GlobalContextEntry" > GlobalContextEntry< / a >
< / li > < li >
2022-12-13 14:02:54 -05:00
< a href = "#kyverno.io/v2alpha1.PolicyException" > PolicyException< / a >
2022-10-21 16:51:15 +02:00
< / li > < / ul >
< hr / >
2023-10-09 23:01:24 +08:00
< h3 id = "kyverno.io/v2alpha1.CleanupPolicy" > CleanupPolicy
2022-10-21 16:51:15 +02:00
< / h3 >
< p >
2023-10-09 23:01:24 +08:00
< p > CleanupPolicy defines a rule for resource cleanup.< / p >
2022-10-21 16:51:15 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
2022-12-08 12:45:47 +01:00
kyverno.io/v2alpha1
2022-10-21 16:51:15 +02:00
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
2023-10-09 23:01:24 +08:00
< td > < code > CleanupPolicy< / code > < / td >
2022-10-21 16:51:15 +02:00
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2023-10-12 14:45:33 +03:00
< a href = "#kyverno.io/v2beta1.CleanupPolicySpec" >
2023-10-09 23:01:24 +08:00
CleanupPolicySpec
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2023-10-09 23:01:24 +08:00
< p > Spec declares policy behaviors.< / p >
2022-10-21 16:51:15 +02:00
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
2023-10-09 23:01:24 +08:00
< code > context< / code > < br / >
2023-04-20 12:36:13 +05:30
< em >
2023-10-09 23:01:24 +08:00
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
2023-04-20 12:36:13 +05:30
< / em >
< / td >
< td >
2023-10-09 23:01:24 +08:00
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
2023-04-20 12:36:13 +05:30
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > match< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2023-10-09 23:01:24 +08:00
< p > MatchResources defines when cleanuppolicy 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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2023-10-09 23:01:24 +08:00
< code > exclude< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2023-10-09 23:01:24 +08:00
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2023-10-09 23:01:24 +08:00
< em > (Optional)< / em >
< p > ExcludeResources defines when cleanuppolicy 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > schedule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > The schedule in Cron format< / p >
< / td >
< / tr >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Conditions defines the conditions used to select the resources which will be cleaned up.< / p >
2022-12-08 12:45:47 +01:00
< / td >
2022-10-21 16:51:15 +02:00
< / tr >
< / table >
< / td >
< / tr >
2023-10-09 23:01:24 +08:00
< tr >
< td >
< code > status< / code > < br / >
< em >
2023-10-12 14:45:33 +03:00
< a href = "#kyverno.io/v2beta1.CleanupPolicyStatus" >
2023-10-09 23:01:24 +08:00
CleanupPolicyStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Status contains policy runtime data.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
2023-10-09 23:01:24 +08:00
< h3 id = "kyverno.io/v2alpha1.ClusterCleanupPolicy" > ClusterCleanupPolicy
2022-10-21 16:51:15 +02:00
< / h3 >
< p >
2023-10-09 23:01:24 +08:00
< p > ClusterCleanupPolicy defines rule for resource cleanup.< / p >
2022-10-21 16:51:15 +02:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > apiVersion< / code > < br / >
string< / td >
2022-10-21 16:51:15 +02:00
< td >
2022-12-08 12:45:47 +01:00
< code >
2023-10-09 23:01:24 +08:00
kyverno.io/v2alpha1
2022-12-08 12:45:47 +01:00
< / code >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > kind< / code > < br / >
string
2022-10-21 16:51:15 +02:00
< / td >
2023-10-09 23:01:24 +08:00
< td > < code > ClusterCleanupPolicy< / code > < / td >
2022-10-21 16:51:15 +02:00
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > metadata< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
2022-10-21 16:51:15 +02:00
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > spec< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2023-10-12 14:45:33 +03:00
< a href = "#kyverno.io/v2beta1.CleanupPolicySpec" >
2022-12-08 12:45:47 +01:00
CleanupPolicySpec
< / a >
2022-10-21 16:51:15 +02:00
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > Spec declares policy behaviors.< / p >
< br / >
< br / >
< table class = "table table-striped" >
2022-10-21 16:51:15 +02:00
< tr >
< td >
2023-04-20 12:36:13 +05:30
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > match< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > MatchResources defines when cleanuppolicy 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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > exclude< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< em > (Optional)< / em >
< p > ExcludeResources defines when cleanuppolicy 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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > schedule< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
string
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > The schedule in Cron format< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > conditions< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< em > (Optional)< / em >
2023-01-04 17:03:56 +08:00
< p > Conditions defines the conditions used to select the resources which will be cleaned up.< / p >
2022-12-08 12:45:47 +01:00
< / td >
< / tr >
< / table >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > status< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2023-10-12 14:45:33 +03:00
< a href = "#kyverno.io/v2beta1.CleanupPolicyStatus" >
2022-12-08 12:45:47 +01:00
CleanupPolicyStatus
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< em > (Optional)< / em >
< p > Status contains policy runtime data.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2024-02-01 11:58:31 +01:00
< h3 id = "kyverno.io/v2alpha1.GlobalContextEntry" > GlobalContextEntry
< / h3 >
< p >
< p > GlobalContextEntry declares resources to be cached.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2alpha1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > GlobalContextEntry< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2alpha1.GlobalContextEntrySpec" >
GlobalContextEntrySpec
< / a >
< / em >
< / td >
< td >
< p > Spec declares policy exception behaviors.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > kubernetesResource< / code > < br / >
< em >
2024-02-01 13:32:13 +01:00
< a href = "#kyverno.io/v2alpha1.KubernetesResource" >
2024-02-01 11:58:31 +01:00
KubernetesResource
< / a >
< / em >
< / td >
< td >
< p > KubernetesResource stores infos about kubernetes resource that should be cached< / p >
< / td >
< / tr >
< tr >
< td >
< code > apiCall< / code > < br / >
< em >
2024-02-01 13:32:13 +01:00
< a href = "#kyverno.io/v2alpha1.ExternalAPICall" >
2024-02-01 11:58:31 +01:00
ExternalAPICall
< / a >
< / em >
< / td >
< td >
< p > APICall stores infos about API call that should be cached< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < br / >
< em >
< a href = "#kyverno.io/v2alpha1.GlobalContextEntryStatus" >
GlobalContextEntryStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Status contains globalcontextentry runtime data.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-10-09 23:01:24 +08:00
< h3 id = "kyverno.io/v2alpha1.PolicyException" > PolicyException
2022-12-13 14:02:54 -05:00
< / h3 >
< p >
2023-10-09 23:01:24 +08:00
< p > PolicyException declares resources to be excluded from specified policies.< / p >
2022-12-13 14:02:54 -05:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
2023-10-09 23:01:24 +08:00
kyverno.io/v2alpha1
2022-12-13 14:02:54 -05:00
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
2023-10-09 23:01:24 +08:00
< td > < code > PolicyException< / code > < / td >
2022-12-13 14:02:54 -05:00
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2023-10-09 23:01:24 +08:00
< a href = "#kyverno.io/v2beta1.PolicyExceptionSpec" >
PolicyExceptionSpec
2022-12-13 14:02:54 -05:00
< / a >
< / em >
< / td >
< td >
2023-10-09 23:01:24 +08:00
< p > Spec declares policy exception behaviors.< / p >
2022-12-13 14:02:54 -05:00
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
2023-10-09 23:01:24 +08:00
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Background controls if exceptions are applied to existing policies 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > Match defines match clause used to check if a resource applies to the exception< / p >
< / td >
< / tr >
< tr >
< td >
2023-10-24 16:15:52 +05:30
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Conditions are used to determine if a resource applies to the exception by evaluating a
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements.< / p >
< / td >
< / tr >
< tr >
< td >
2023-10-09 23:01:24 +08:00
< code > exceptions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Exception" >
[]Exception
< / a >
< / em >
< / td >
< td >
< p > Exceptions is a list policy/rules to be excluded< / p >
< / td >
< / tr >
2024-01-26 20:43:07 +02:00
< tr >
< td >
< code > podSecurity< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PodSecurityStandard" >
[]PodSecurityStandard
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PodSecurity specifies the Pod Security Standard controls to be excluded.
Applicable only to policies that have validate.podSecurity subrule.< / p >
< / td >
< / tr >
2023-10-09 23:01:24 +08:00
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2alpha1.CleanupPolicyInterface" > CleanupPolicyInterface
< / h3 >
< p >
< p > CleanupPolicyInterface abstracts the concrete policy type (CleanupPolicy vs ClusterCleanupPolicy)< / p >
< / p >
2024-02-01 13:32:13 +01:00
< h3 id = "kyverno.io/v2alpha1.ExternalAPICall" > ExternalAPICall
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2alpha1.GlobalContextEntrySpec" > GlobalContextEntrySpec< / a > )
< / p >
< p >
< p > ExternalAPICall stores infos about API call that should be cached< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > APICall< / code > < br / >
< em >
< a href = "#kyverno.io/v1.APICall" >
APICall
< / a >
< / em >
< / td >
< td >
< p >
(Members of < code > APICall< / code > are embedded into this type.)
< / p >
< / td >
< / tr >
< tr >
< td >
2024-02-02 17:36:51 +05:30
< code > refreshInterval< / code > < br / >
2024-02-01 13:32:13 +01:00
< em >
2024-02-02 17:36:51 +05:30
< a href = "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" >
Kubernetes meta/v1.Duration
< / a >
2024-02-01 13:32:13 +01:00
< / em >
< / td >
< td >
2024-02-02 17:36:51 +05:30
< p > RefreshInterval defines the interval in duration at which to poll the APICall< / p >
2024-02-01 13:32:13 +01:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2024-02-01 11:58:31 +01:00
< h3 id = "kyverno.io/v2alpha1.GlobalContextEntrySpec" > GlobalContextEntrySpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2alpha1.GlobalContextEntry" > GlobalContextEntry< / a > )
< / p >
< p >
< p > GlobalContextEntrySpec stores policy exception spec< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > kubernetesResource< / code > < br / >
< em >
2024-02-01 13:32:13 +01:00
< a href = "#kyverno.io/v2alpha1.KubernetesResource" >
2024-02-01 11:58:31 +01:00
KubernetesResource
< / a >
< / em >
< / td >
< td >
< p > KubernetesResource stores infos about kubernetes resource that should be cached< / p >
< / td >
< / tr >
< tr >
< td >
< code > apiCall< / code > < br / >
< em >
2024-02-01 13:32:13 +01:00
< a href = "#kyverno.io/v2alpha1.ExternalAPICall" >
2024-02-01 11:58:31 +01:00
ExternalAPICall
< / a >
< / em >
< / td >
< td >
< p > APICall stores infos about API call that should be cached< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2alpha1.GlobalContextEntryStatus" > GlobalContextEntryStatus
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2alpha1.GlobalContextEntry" > GlobalContextEntry< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > ready< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Deprecated in favor of Conditions< / p >
< / td >
< / tr >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#condition-v1-meta" >
[]Kubernetes meta/v1.Condition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2024-02-01 13:32:13 +01:00
< h3 id = "kyverno.io/v2alpha1.KubernetesResource" > KubernetesResource
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2alpha1.GlobalContextEntrySpec" > GlobalContextEntrySpec< / a > )
< / p >
< p >
< p > KubernetesResource stores infos about kubernetes resource that should be cached< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > group< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Group defines the group of the resource< / p >
< / td >
< / tr >
< tr >
< td >
< code > version< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Version defines the version of the resource< / p >
< / td >
< / tr >
< tr >
< td >
< code > resource< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Resource defines the type of the resource< / p >
< / td >
< / tr >
< tr >
< td >
< code > namespace< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Namespace defines the namespace of the resource. Leave empty for cluster scoped resources.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-10-12 14:45:33 +03:00
< h2 id = "kyverno.io/v2beta1" > kyverno.io/v2beta1< / h2 >
Resource Types:
< ul > < li >
< a href = "#kyverno.io/v2beta1.CleanupPolicy" > CleanupPolicy< / a >
< / li > < li >
< a href = "#kyverno.io/v2beta1.ClusterCleanupPolicy" > ClusterCleanupPolicy< / a >
< / li > < li >
< a href = "#kyverno.io/v2beta1.ClusterPolicy" > ClusterPolicy< / a >
< / li > < li >
< a href = "#kyverno.io/v2beta1.Policy" > Policy< / a >
< / li > < li >
< a href = "#kyverno.io/v2beta1.PolicyException" > PolicyException< / a >
< / li > < / ul >
< hr / >
< h3 id = "kyverno.io/v2beta1.CleanupPolicy" > CleanupPolicy
2023-10-09 23:01:24 +08:00
< / h3 >
< p >
2023-10-12 14:45:33 +03:00
< p > CleanupPolicy defines a rule for resource cleanup.< / p >
2023-10-09 23:01:24 +08:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2023-10-12 14:45:33 +03:00
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2beta1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > CleanupPolicy< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.CleanupPolicySpec" >
CleanupPolicySpec
< / a >
< / em >
< / td >
< td >
< p > Spec declares policy behaviors.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
2023-04-20 12:36:13 +05:30
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > match< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > MatchResources defines when cleanuppolicy 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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > exclude< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2022-12-08 12:45:47 +01:00
< p > ExcludeResources defines when cleanuppolicy 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.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > schedule< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
string
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< p > The schedule in Cron format< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
2022-12-08 12:45:47 +01:00
< code > conditions< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
2022-12-08 12:45:47 +01:00
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
2022-10-21 16:51:15 +02:00
< / a >
< / em >
< / td >
< td >
2022-12-08 12:45:47 +01:00
< em > (Optional)< / em >
2023-01-04 17:03:56 +08:00
< p > Conditions defines the conditions used to select the resources which will be cleaned up.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
2023-10-12 14:45:33 +03:00
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.CleanupPolicyStatus" >
CleanupPolicyStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Status contains policy runtime data.< / p >
< / td >
< / tr >
2023-10-09 23:01:24 +08:00
< / tbody >
2022-12-08 12:45:47 +01:00
< / table >
2023-10-09 23:01:24 +08:00
< hr / >
2023-10-12 14:45:33 +03:00
< h3 id = "kyverno.io/v2beta1.ClusterCleanupPolicy" > ClusterCleanupPolicy
2023-10-09 23:01:24 +08:00
< / h3 >
< p >
2023-10-12 14:45:33 +03:00
< p > ClusterCleanupPolicy defines rule for resource cleanup.< / p >
2023-10-09 23:01:24 +08:00
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2023-10-12 14:45:33 +03:00
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2beta1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > ClusterCleanupPolicy< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.CleanupPolicySpec" >
CleanupPolicySpec
< / a >
< / em >
< / td >
< td >
< p > Spec declares policy behaviors.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > MatchResources defines when cleanuppolicy 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > exclude< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ExcludeResources defines when cleanuppolicy 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > schedule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > The schedule in Cron format< / p >
< / td >
< / tr >
< tr >
< td >
2023-10-09 23:01:24 +08:00
< code > conditions< / code > < br / >
< em >
2023-10-12 14:45:33 +03:00
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
2023-10-09 23:01:24 +08:00
< / a >
< / em >
< / td >
< td >
2023-10-12 14:45:33 +03:00
< em > (Optional)< / em >
< p > Conditions defines the conditions used to select the resources which will be cleaned up.< / p >
< / td >
< / tr >
< / table >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
2023-09-26 13:02:17 +03:00
< tr >
< td >
2023-10-12 14:45:33 +03:00
< code > status< / code > < br / >
2023-09-26 13:02:17 +03:00
< em >
2023-10-12 14:45:33 +03:00
< a href = "#kyverno.io/v2beta1.CleanupPolicyStatus" >
CleanupPolicyStatus
2023-09-26 13:02:17 +03:00
< / a >
< / em >
< / td >
< td >
2023-10-12 14:45:33 +03:00
< em > (Optional)< / em >
< p > Status contains policy runtime data.< / p >
2023-09-26 13:02:17 +03:00
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2beta1.ClusterPolicy" > ClusterPolicy
< / h3 >
< p >
< p > ClusterPolicy declares validation, mutation, and generation behaviors for matching resources.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2beta1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > ClusterPolicy< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Spec" >
Spec
< / a >
< / em >
< / td >
< td >
< p > Spec declares policy behaviors.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > rules< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Rule" >
[]Rule
< / a >
< / em >
< / td >
< td >
< p > Rules is a list of Rule instances. A Policy contains multiple rules and
each rule can validate, mutate, or generate resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > applyRules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ApplyRulesType" >
ApplyRulesType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ApplyRules controls how rules in a policy are applied. Rule are processed in
the order of declaration. When set to < code > One< / code > processing stops after a rule has
been applied i.e. the rule matches and results in a pass, fail, or error. When
set to < code > All< / code > all rules in the policy are processed. The default is < code > All< / code > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > failurePolicy< / code > < br / >
< em >
< a href = "#kyverno.io/v1.FailurePolicyType" >
FailurePolicyType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > FailurePolicy defines how unexpected policy errors and webhook response timeout errors are handled.
Rules within the same policy share the same failure behavior.
Allowed values are Ignore or Fail. Defaults to Fail.< / p >
< / td >
< / tr >
< tr >
< td >
< code > validationFailureAction< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureAction" >
ValidationFailureAction
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.
2023-01-02 16:16:13 +01:00
Allowed values are audit or enforce. The default value is “ Audit” .< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > validationFailureActionOverrides< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureActionOverride" >
[]ValidationFailureActionOverride
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction
namespace-wise. It overrides ValidationFailureAction for the specified namespaces.< / p >
< / td >
< / tr >
< tr >
< td >
2023-06-28 14:54:27 +02:00
< code > admission< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Admission controls if rules are applied during admission.
Optional. Default value is “ true” .< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > schemaValidation< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-12-18 18:32:11 +02:00
< p > Deprecated.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > webhookTimeoutSeconds< / code > < br / >
< em >
int32
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > mutateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > MutateExistingOnPolicyUpdate controls if a mutateExisting policy is applied on policy events.
Default value is “ false” .< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-24 00:36:51 +08:00
< code > generateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Deprecated, use generateExisting instead< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-03 17:34:55 +08:00
< code > generateExisting< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-03-03 17:34:55 +08:00
< p > GenerateExisting controls whether to trigger generate rule in existing resources
2022-10-21 16:51:15 +02:00
If is set to “ true” generate rule will be triggered and applied to existing matched resources.
Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
2023-08-02 18:59:37 +01:00
< tr >
< td >
< code > useServerSideApply< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
2024-01-27 21:00:22 +08:00
< tr >
< td >
< code > webhookConfiguration< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.WebhookConfiguration" >
WebhookConfiguration
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > WebhookConfiguration specifies the custom configuration for Kubernetes admission webhookconfiguration.
Requires Kubernetes 1.27 or later.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PolicyStatus" >
PolicyStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Status contains policy runtime data.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2beta1.Policy" > Policy
< / h3 >
< p >
< p > Policy declares validation, mutation, and generation behaviors for matching resources.
See: < a href = "https://kyverno.io/docs/writing-policies/" > https://kyverno.io/docs/writing-policies/< / a > for more information.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2beta1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > Policy< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Spec" >
Spec
< / a >
< / em >
< / td >
< td >
< p > Spec defines policy behaviors and contains one or more rules.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > rules< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Rule" >
[]Rule
< / a >
< / em >
< / td >
< td >
< p > Rules is a list of Rule instances. A Policy contains multiple rules and
each rule can validate, mutate, or generate resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > applyRules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ApplyRulesType" >
ApplyRulesType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ApplyRules controls how rules in a policy are applied. Rule are processed in
the order of declaration. When set to < code > One< / code > processing stops after a rule has
been applied i.e. the rule matches and results in a pass, fail, or error. When
set to < code > All< / code > all rules in the policy are processed. The default is < code > All< / code > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > failurePolicy< / code > < br / >
< em >
< a href = "#kyverno.io/v1.FailurePolicyType" >
FailurePolicyType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > FailurePolicy defines how unexpected policy errors and webhook response timeout errors are handled.
Rules within the same policy share the same failure behavior.
Allowed values are Ignore or Fail. Defaults to Fail.< / p >
< / td >
< / tr >
< tr >
< td >
< code > validationFailureAction< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureAction" >
ValidationFailureAction
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.
2023-01-02 16:16:13 +01:00
Allowed values are audit or enforce. The default value is “ Audit” .< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > validationFailureActionOverrides< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureActionOverride" >
[]ValidationFailureActionOverride
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction
namespace-wise. It overrides ValidationFailureAction for the specified namespaces.< / p >
< / td >
< / tr >
< tr >
< td >
2023-06-28 14:54:27 +02:00
< code > admission< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Admission controls if rules are applied during admission.
Optional. Default value is “ true” .< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > schemaValidation< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-12-18 18:32:11 +02:00
< p > Deprecated.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > webhookTimeoutSeconds< / code > < br / >
< em >
int32
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > mutateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > MutateExistingOnPolicyUpdate controls if a mutateExisting policy is applied on policy events.
Default value is “ false” .< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-24 00:36:51 +08:00
< code > generateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Deprecated, use generateExisting instead< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-03 17:34:55 +08:00
< code > generateExisting< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-03-03 17:34:55 +08:00
< p > GenerateExisting controls whether to trigger generate rule in existing resources
2022-10-21 16:51:15 +02:00
If is set to “ true” generate rule will be triggered and applied to existing matched resources.
Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
2023-08-02 18:59:37 +01:00
< tr >
< td >
< code > useServerSideApply< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
2024-01-27 21:00:22 +08:00
< tr >
< td >
< code > webhookConfiguration< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.WebhookConfiguration" >
WebhookConfiguration
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > WebhookConfiguration specifies the custom configuration for Kubernetes admission webhookconfiguration.
Requires Kubernetes 1.27 or later.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PolicyStatus" >
PolicyStatus
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Status contains policy runtime data.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-09-14 17:23:51 +03:00
< h3 id = "kyverno.io/v2beta1.PolicyException" > PolicyException
< / h3 >
< p >
< p > PolicyException declares resources to be excluded from specified policies.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
kyverno.io/v2beta1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > PolicyException< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.PolicyExceptionSpec" >
PolicyExceptionSpec
< / a >
< / em >
< / td >
< td >
< p > Spec declares policy exception behaviors.< / p >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Background controls if exceptions are applied to existing policies 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > Match defines match clause used to check if a resource applies to the exception< / p >
< / td >
< / tr >
< tr >
< td >
2023-10-24 16:15:52 +05:30
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Conditions are used to determine if a resource applies to the exception by evaluating a
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements.< / p >
< / td >
< / tr >
< tr >
< td >
2023-09-14 17:23:51 +03:00
< code > exceptions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Exception" >
[]Exception
< / a >
< / em >
< / td >
< td >
< p > Exceptions is a list policy/rules to be excluded< / p >
< / td >
< / tr >
2024-01-26 20:43:07 +02:00
< tr >
< td >
< code > podSecurity< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PodSecurityStandard" >
[]PodSecurityStandard
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PodSecurity specifies the Pod Security Standard controls to be excluded.
Applicable only to policies that have validate.podSecurity subrule.< / p >
< / td >
< / tr >
2023-09-14 17:23:51 +03:00
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v2beta1.AnyAllConditions" > AnyAllConditions
< / h3 >
< p >
(< em > Appears on:< / em >
2023-12-19 12:43:39 +02:00
< a href = "#kyverno.io/v2.PolicyExceptionSpec" > PolicyExceptionSpec< / a > ,
2023-10-12 14:45:33 +03:00
< a href = "#kyverno.io/v2beta1.CleanupPolicySpec" > CleanupPolicySpec< / a > ,
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v2beta1.Deny" > Deny< / a > ,
2023-10-24 16:15:52 +05:30
< a href = "#kyverno.io/v2beta1.PolicyExceptionSpec" > PolicyExceptionSpec< / a > ,
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v2beta1.Rule" > Rule< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > any< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Condition" >
[]Condition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.
2023-01-04 17:03:56 +08:00
Here, at least one of the conditions need to pass.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > all< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Condition" >
[]Condition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.
2023-01-04 17:03:56 +08:00
Here, all of the conditions need to pass.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-10-12 14:45:33 +03:00
< h3 id = "kyverno.io/v2beta1.CleanupPolicySpec" > CleanupPolicySpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2alpha1.CleanupPolicy" > CleanupPolicy< / a > ,
< a href = "#kyverno.io/v2alpha1.ClusterCleanupPolicy" > ClusterCleanupPolicy< / a > ,
< a href = "#kyverno.io/v2beta1.CleanupPolicy" > CleanupPolicy< / a > ,
< a href = "#kyverno.io/v2beta1.ClusterCleanupPolicy" > ClusterCleanupPolicy< / a > )
< / p >
< p >
< p > CleanupPolicySpec stores specifications for selecting resources that the user needs to delete
and schedule when the matching resources needs deleted.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > MatchResources defines when cleanuppolicy 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > exclude< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ExcludeResources defines when cleanuppolicy 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > schedule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > The schedule in Cron format< / p >
< / td >
< / tr >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Conditions defines the conditions used to select the resources which will be cleaned up.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2beta1.CleanupPolicyStatus" > CleanupPolicyStatus
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2alpha1.CleanupPolicy" > CleanupPolicy< / a > ,
< a href = "#kyverno.io/v2alpha1.ClusterCleanupPolicy" > ClusterCleanupPolicy< / a > ,
< a href = "#kyverno.io/v2beta1.CleanupPolicy" > CleanupPolicy< / a > ,
< a href = "#kyverno.io/v2beta1.ClusterCleanupPolicy" > ClusterCleanupPolicy< / a > )
< / p >
< p >
< p > CleanupPolicyStatus stores the status of the policy.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#condition-v1-meta" >
[]Kubernetes meta/v1.Condition
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > lastExecutionTime< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#time-v1-meta" >
Kubernetes meta/v1.Time
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v2beta1.Condition" > Condition
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" > AnyAllConditions< / a > )
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > key< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< p > Key is the context entry (using JMESPath) for conditional rule evaluation.< / p >
< / td >
< / tr >
< tr >
< td >
< code > operator< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.ConditionOperator" >
ConditionOperator
< / a >
< / em >
< / td >
< td >
< p > 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< / p >
< / td >
< / tr >
< tr >
< td >
< code > value< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Value is the conditional value, or set of values. The values can be fixed set
or can be variables declared using JMESPath.< / p >
< / td >
< / tr >
2023-05-08 22:51:52 +08:00
< tr >
< td >
< code > message< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Message is an optional display message< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2beta1.ConditionOperator" > ConditionOperator
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.Condition" > Condition< / a > )
< / p >
< p >
< p > ConditionOperator is the operation performed on condition key and value.< / p >
< / p >
< h3 id = "kyverno.io/v2beta1.Deny" > Deny
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.Validation" > Validation< / a > )
< / p >
< p >
< p > Deny specifies a list of conditions used to pass or fail a validation rule.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
2023-08-25 10:49:24 +02:00
< p > Multiple conditions can be declared under an < code > any< / code > or < code > all< / code > statement.
2022-10-21 16:51:15 +02:00
See: < a href = "https://kyverno.io/docs/writing-policies/validate/#deny-rules" > https://kyverno.io/docs/writing-policies/validate/#deny-rules< / a > < / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-09-14 17:23:51 +03:00
< h3 id = "kyverno.io/v2beta1.Exception" > Exception
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.PolicyExceptionSpec" > PolicyExceptionSpec< / a > )
< / p >
< p >
< p > Exception stores infos about a policy and rules< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > policyName< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > PolicyName identifies the policy to which the exception is applied.
The policy name uses the format < namespace > /< name > unless it
references a ClusterPolicy.< / p >
< / td >
< / tr >
< tr >
< td >
< code > ruleNames< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< p > RuleNames identifies the rules to which the exception is applied.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v2beta1.ImageVerification" > ImageVerification
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.Rule" > Rule< / a > )
< / p >
< p >
< p > ImageVerification validates that images that match the specified pattern
are signed with the supplied public key. Once the image is verified it is
mutated to include the SHA digest retrieved during the registration.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2023-02-20 08:26:10 -08:00
< code > type< / code > < br / >
< em >
2023-06-16 19:07:08 +05:30
< a href = "#kyverno.io/v1.ImageVerificationType" >
2023-02-20 08:26:10 -08:00
ImageVerificationType
< / a >
< / em >
< / td >
< td >
< p > Type specifies the method of signature validation. The allowed options
2023-06-01 13:35:28 +05:30
are Cosign and Notary. By default Cosign is used if a type is not specified.< / p >
2023-02-20 08:26:10 -08:00
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > imageReferences< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< p > 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: < a href = "https://kubernetes.io/docs/concepts/containers/images" > https://kubernetes.io/docs/concepts/containers/images< / a > .< / p >
2024-01-23 17:57:39 +05:30
< / td >
< / tr >
< tr >
< td >
< code > skipImageReferences< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< p > 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: < a href = "https://kubernetes.io/docs/concepts/containers/images" > https://kubernetes.io/docs/concepts/containers/images< / a > .< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > attestors< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AttestorSet" >
[]AttestorSet
< / a >
< / em >
< / td >
< td >
< p > Attestors specified the required attestors (i.e. authorities)< / p >
< / td >
< / tr >
< tr >
< td >
< code > attestations< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Attestation" >
[]Attestation
< / a >
< / em >
< / td >
< td >
< p > Attestations are optional checks for signed in-toto Statements used to verify the image.
See < a href = "https://github.com/in-toto/attestation" > https://github.com/in-toto/attestation< / a > . Kyverno fetches signed attestations from the
OCI registry and decodes them into a list of Statement declarations.< / p >
< / td >
< / tr >
< tr >
< td >
< code > repository< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > mutateDigest< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > MutateDigest enables replacement of image tags with digests.
Defaults to true.< / p >
< / td >
< / tr >
< tr >
< td >
< code > verifyDigest< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > VerifyDigest validates that images have a digest.< / p >
< / td >
< / tr >
< tr >
< td >
< code > required< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Required validates that images are verified i.e. have matched passed a signature or attestation check.< / p >
< / td >
< / tr >
2023-06-16 19:07:08 +05:30
< tr >
< td >
< code > imageRegistryCredentials< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ImageRegistryCredentials" >
ImageRegistryCredentials
< / a >
< / em >
< / td >
< td >
< p > ImageRegistryCredentials provides credentials that will be used for authentication with registry< / p >
< / td >
< / tr >
2023-08-07 01:24:52 +05:30
< tr >
< td >
< code > useCache< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > UseCache enables caching of image verify responses for this rule< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2beta1.MatchResources" > MatchResources
< / h3 >
< p >
(< em > Appears on:< / em >
2023-12-19 12:43:39 +02:00
< a href = "#kyverno.io/v2.PolicyExceptionSpec" > PolicyExceptionSpec< / a > ,
2023-10-12 14:45:33 +03:00
< a href = "#kyverno.io/v2beta1.CleanupPolicySpec" > CleanupPolicySpec< / a > ,
2023-09-14 17:23:51 +03:00
< a href = "#kyverno.io/v2beta1.PolicyExceptionSpec" > PolicyExceptionSpec< / a > ,
2022-10-21 16:51:15 +02:00
< a href = "#kyverno.io/v2beta1.Rule" > Rule< / a > )
< / p >
< p >
< p > MatchResources is used to specify resource and admission review request data for
which a policy rule is applicable.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > any< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceFilters" >
ResourceFilters
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Any allows specifying resources which will be ORed< / p >
< / td >
< / tr >
< tr >
< td >
< code > all< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ResourceFilters" >
ResourceFilters
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > All allows specifying resources which will be ANDed< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2023-09-14 17:23:51 +03:00
< h3 id = "kyverno.io/v2beta1.PolicyExceptionSpec" > PolicyExceptionSpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2alpha1.PolicyException" > PolicyException< / a > ,
< a href = "#kyverno.io/v2beta1.PolicyException" > PolicyException< / a > )
< / p >
< p >
< p > PolicyExceptionSpec stores policy exception spec< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Background controls if exceptions are applied to existing policies 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > Match defines match clause used to check if a resource applies to the exception< / p >
< / td >
< / tr >
< tr >
< td >
2023-10-24 16:15:52 +05:30
< code > conditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Conditions are used to determine if a resource applies to the exception by evaluating a
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements.< / p >
< / td >
< / tr >
< tr >
< td >
2023-09-14 17:23:51 +03:00
< code > exceptions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Exception" >
[]Exception
< / a >
< / em >
< / td >
< td >
< p > Exceptions is a list policy/rules to be excluded< / p >
< / td >
< / tr >
2024-01-26 20:43:07 +02:00
< tr >
< td >
< code > podSecurity< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PodSecurityStandard" >
[]PodSecurityStandard
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PodSecurity specifies the Pod Security Standard controls to be excluded.
Applicable only to policies that have validate.podSecurity subrule.< / p >
< / td >
< / tr >
2023-09-14 17:23:51 +03:00
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h3 id = "kyverno.io/v2beta1.ResourceDescription" > ResourceDescription
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.ResourceFilter" > ResourceFilter< / a > )
< / p >
< p >
< p > ResourceDescription contains criteria used to match resources.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > kinds< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Kinds is a list of resource kinds.< / p >
< / td >
< / tr >
< tr >
< td >
< code > names< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Names are the names of the resources. Each name supports wildcard characters
“ *” (matches zero or many characters) and “ ?” (at least one character).< / p >
< / td >
< / tr >
< tr >
< td >
< code > namespaces< / code > < br / >
< em >
[]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Namespaces is a list of namespaces names. Each name supports wildcard characters
“ *” (matches zero or many characters) and “ ?” (at least one character).< / p >
< / td >
< / tr >
< tr >
< td >
< code > annotations< / code > < br / >
< em >
map[string]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > selector< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta" >
Kubernetes meta/v1.LabelSelector
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Selector is a label selector. Label keys and values in < code > matchLabels< / code > support the wildcard
characters < code > *< / code > (matches zero or many characters) and < code > ?< / code > (matches one character).
Wildcards allows writing label selectors like [“ storage.k8s.io/< em > ” : “ < / em > ” ]. Note that
using [” < em > ” : “ < / em > ” ] matches any key and value but does not match an empty label set.< / p >
< / td >
< / tr >
< tr >
< td >
< code > namespaceSelector< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta" >
Kubernetes meta/v1.LabelSelector
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > NamespaceSelector is a label selector for the resource namespace. Label keys and values
in < code > matchLabels< / code > support the wildcard characters < code > *< / code > (matches zero or many characters)
and < code > ?< / code > (matches one character).Wildcards allows writing label selectors like
[“ storage.k8s.io/< em > ” : “ < / em > ” ]. Note that using [” < em > ” : “ < / em > ” ] matches any key and value but
does not match an empty label set.< / p >
< / td >
< / tr >
2023-03-29 06:22:21 +02:00
< tr >
< td >
< code > operations< / code > < br / >
< em >
< a href = "#kyverno.io/v1.AdmissionOperation" >
[]AdmissionOperation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Operations can contain values [“ CREATE, “ UPDATE” , “ CONNECT” , “ DELETE” ], which are used to match a specific action.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2beta1.ResourceFilter" > ResourceFilter
< / h3 >
< p >
< p > ResourceFilter allow users to “ AND” or “ OR” between resources< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > UserInfo< / code > < br / >
< em >
< a href = "#kyverno.io/v1.UserInfo" >
UserInfo
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > UserInfo contains information about the user performing the operation.< / p >
< / td >
< / tr >
< tr >
< td >
< code > resources< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.ResourceDescription" >
ResourceDescription
< / a >
< / em >
< / td >
< td >
< p > ResourceDescription contains information about the resource being created or modified.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2beta1.ResourceFilters" > ResourceFilters
(< code > []github.com/kyverno/kyverno/api/kyverno/v2beta1.ResourceFilter< / code > alias)< / p > < / h3 >
< p >
< p > ResourceFilters is a slice of ResourceFilter< / p >
< / p >
< h3 id = "kyverno.io/v2beta1.Rule" > Rule
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.Spec" > Spec< / a > )
< / p >
< p >
< p > Rule defines a validation, mutation, or generation control for matching resources.
Each rules contains a match declaration to select resources, and an optional exclude
declaration to specify which resources to exclude.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > name< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Name is a label to identify the rule, It must be unique within the policy.< / p >
< / td >
< / tr >
< tr >
< td >
< code > context< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ContextEntry" >
[]ContextEntry
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Context defines variables and data sources that can be used during rule execution.< / p >
< / td >
< / tr >
< tr >
< td >
< code > match< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > exclude< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.MatchResources" >
MatchResources
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > imageExtractors< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ImageExtractorConfigs" >
ImageExtractorConfigs
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ImageExtractors defines a mapping from kinds to ImageExtractorConfigs.
This config is only valid for verifyImages rules.< / p >
< / td >
< / tr >
< tr >
< td >
< code > preconditions< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.AnyAllConditions" >
AnyAllConditions
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Preconditions are used to determine if a policy rule should be applied by evaluating a
2023-08-25 10:49:24 +02:00
set of conditions. The declaration can contain nested < code > any< / code > or < code > all< / code > statements.
2022-10-21 16:51:15 +02:00
See: < a href = "https://kyverno.io/docs/writing-policies/preconditions/" > https://kyverno.io/docs/writing-policies/preconditions/< / a > < / p >
< / td >
< / tr >
< tr >
< td >
2023-06-01 00:30:55 +03:00
< code > celPreconditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#matchcondition-v1-admissionregistration" >
[]Kubernetes admissionregistration/v1.MatchCondition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > mutate< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Mutation" >
Mutation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Mutation is used to modify matching resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > validate< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Validation" >
Validation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Validation is used to validate matching resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > generate< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Generation" >
Generation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Generation is used to create new resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > verifyImages< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.ImageVerification" >
[]ImageVerification
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > VerifyImages is used to verify image signatures and mutate them to add a digest< / p >
< / td >
< / tr >
2023-12-19 14:25:12 +08:00
< tr >
< td >
< code > skipBackgroundRequests< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2beta1.Spec" > Spec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.ClusterPolicy" > ClusterPolicy< / a > ,
< a href = "#kyverno.io/v2beta1.Policy" > Policy< / a > )
< / p >
< p >
< p > Spec contains a list of Rule instances and other policy controls.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > rules< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Rule" >
[]Rule
< / a >
< / em >
< / td >
< td >
< p > Rules is a list of Rule instances. A Policy contains multiple rules and
each rule can validate, mutate, or generate resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > applyRules< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ApplyRulesType" >
ApplyRulesType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ApplyRules controls how rules in a policy are applied. Rule are processed in
the order of declaration. When set to < code > One< / code > processing stops after a rule has
been applied i.e. the rule matches and results in a pass, fail, or error. When
set to < code > All< / code > all rules in the policy are processed. The default is < code > All< / code > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > failurePolicy< / code > < br / >
< em >
< a href = "#kyverno.io/v1.FailurePolicyType" >
FailurePolicyType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > FailurePolicy defines how unexpected policy errors and webhook response timeout errors are handled.
Rules within the same policy share the same failure behavior.
Allowed values are Ignore or Fail. Defaults to Fail.< / p >
< / td >
< / tr >
< tr >
< td >
< code > validationFailureAction< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureAction" >
ValidationFailureAction
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.
2023-01-02 16:16:13 +01:00
Allowed values are audit or enforce. The default value is “ Audit” .< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > validationFailureActionOverrides< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ValidationFailureActionOverride" >
[]ValidationFailureActionOverride
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction
namespace-wise. It overrides ValidationFailureAction for the specified namespaces.< / p >
< / td >
< / tr >
< tr >
< td >
2023-06-28 14:54:27 +02:00
< code > admission< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Admission controls if rules are applied during admission.
Optional. Default value is “ true” .< / p >
< / td >
< / tr >
< tr >
< td >
2022-10-21 16:51:15 +02:00
< code > background< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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).< / p >
< / td >
< / tr >
< tr >
< td >
< code > schemaValidation< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
2023-12-18 18:32:11 +02:00
< p > Deprecated.< / p >
2022-10-21 16:51:15 +02:00
< / td >
< / tr >
< tr >
< td >
< code > webhookTimeoutSeconds< / code > < br / >
< em >
int32
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > mutateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > MutateExistingOnPolicyUpdate controls if a mutateExisting policy is applied on policy events.
Default value is “ false” .< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-24 00:36:51 +08:00
< code > generateExistingOnPolicyUpdate< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Deprecated, use generateExisting instead< / p >
< / td >
< / tr >
< tr >
< td >
2023-03-03 17:34:55 +08:00
< code > generateExisting< / code > < br / >
2022-10-21 16:51:15 +02:00
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
2023-03-03 17:34:55 +08:00
< p > GenerateExisting controls whether to trigger generate rule in existing resources
2022-10-21 16:51:15 +02:00
If is set to “ true” generate rule will be triggered and applied to existing matched resources.
Defaults to “ false” if not specified.< / p >
< / td >
< / tr >
2023-08-02 18:59:37 +01:00
< tr >
< td >
< code > useServerSideApply< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
2024-01-27 21:00:22 +08:00
< tr >
< td >
< code > webhookConfiguration< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.WebhookConfiguration" >
WebhookConfiguration
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > WebhookConfiguration specifies the custom configuration for Kubernetes admission webhookconfiguration.
Requires Kubernetes 1.27 or later.< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
< h3 id = "kyverno.io/v2beta1.Validation" > Validation
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.Rule" > Rule< / a > )
< / p >
< p >
< p > Validation defines checks to be performed on matching resources.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > message< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Message specifies a custom message to be displayed on failure.< / p >
< / td >
< / tr >
< tr >
< td >
< code > manifests< / code > < br / >
< em >
< a href = "#kyverno.io/v1.Manifests" >
Manifests
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Manifest specifies conditions for manifest verification< / p >
< / td >
< / tr >
< tr >
< td >
< code > foreach< / code > < br / >
< em >
< a href = "#kyverno.io/v1.ForEachValidation" >
[]ForEachValidation
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > pattern< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Pattern specifies an overlay-style pattern used to check resources.< / p >
< / td >
< / tr >
< tr >
< td >
< code > anyPattern< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#json-v1-apiextensions" >
Kubernetes apiextensions/v1.JSON
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > AnyPattern specifies list of validation patterns. At least one of the patterns
must be satisfied for the validation rule to succeed.< / p >
< / td >
< / tr >
< tr >
< td >
< code > deny< / code > < br / >
< em >
< a href = "#kyverno.io/v2beta1.Deny" >
Deny
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Deny defines conditions used to pass or fail a validation rule.< / p >
< / td >
< / tr >
< tr >
< td >
< code > podSecurity< / code > < br / >
< em >
< a href = "#kyverno.io/v1.PodSecurity" >
PodSecurity
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PodSecurity applies exemptions for Kubernetes Pod Security admission
by specifying exclusions for Pod Security Standards controls.< / p >
< / td >
< / tr >
2023-06-01 00:30:55 +03:00
< tr >
< td >
< code > cel< / code > < br / >
< em >
< a href = "#kyverno.io/v1.CEL" >
CEL
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > CEL allows validation checks using the Common Expression Language (< a href = "https://kubernetes.io/docs/reference/using-api/cel/" > https://kubernetes.io/docs/reference/using-api/cel/< / a > ).< / p >
< / td >
< / tr >
2022-10-21 16:51:15 +02:00
< / tbody >
< / table >
< hr / >
2024-01-27 21:00:22 +08:00
< h3 id = "kyverno.io/v2beta1.WebhookConfiguration" > WebhookConfiguration
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#kyverno.io/v2beta1.Spec" > Spec< / a > )
< / p >
< p >
< p > WebhookConfiguration specifies the configuration for Kubernetes admission webhookconfiguration.< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > matchConditions< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#matchcondition-v1-admissionregistration" >
[]Kubernetes admissionregistration/v1.MatchCondition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > MatchCondition configures admission webhook matchConditions.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2024-01-26 19:10:29 +05:30
< h2 id = "reports.kyverno.io/v1" > reports.kyverno.io/v1< / h2 >
< p >
< / p >
Resource Types:
< ul > < li >
2024-01-28 00:30:04 +01:00
< a href = "#reports.kyverno.io/v1.ClusterEphemeralReport" > ClusterEphemeralReport< / a >
2024-01-26 19:10:29 +05:30
< / li > < li >
2024-01-28 00:30:04 +01:00
< a href = "#reports.kyverno.io/v1.EphemeralReport" > EphemeralReport< / a >
2024-01-26 19:10:29 +05:30
< / li > < / ul >
< hr / >
2024-01-28 00:30:04 +01:00
< h3 id = "reports.kyverno.io/v1.ClusterEphemeralReport" > ClusterEphemeralReport
2024-01-26 19:10:29 +05:30
< / h3 >
< p >
2024-01-28 00:30:04 +01:00
< p > ClusterEphemeralReport is the Schema for the ClusterEphemeralReports API< / p >
2024-01-26 19:10:29 +05:30
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
reports.kyverno.io/v1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
2024-01-28 00:30:04 +01:00
< td > < code > ClusterEphemeralReport< / code > < / td >
2024-01-26 19:10:29 +05:30
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2024-01-28 00:30:04 +01:00
< a href = "#reports.kyverno.io/v1.EphemeralReportSpec" >
EphemeralReportSpec
2024-01-26 19:10:29 +05:30
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > owner< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#ownerreference-v1-meta" >
Kubernetes meta/v1.OwnerReference
< / a >
< / em >
< / td >
< td >
< p > Owner is a reference to the report owner (e.g. a Deployment, Namespace, or Node)< / p >
< / td >
< / tr >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2024-01-28 00:30:04 +01:00
< h3 id = "reports.kyverno.io/v1.EphemeralReport" > EphemeralReport
2024-01-26 19:10:29 +05:30
< / h3 >
< p >
2024-01-28 00:30:04 +01:00
< p > EphemeralReport is the Schema for the EphemeralReports API< / p >
2024-01-26 19:10:29 +05:30
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
reports.kyverno.io/v1
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
2024-01-28 00:30:04 +01:00
< td > < code > EphemeralReport< / code > < / td >
2024-01-26 19:10:29 +05:30
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < br / >
< em >
2024-01-28 00:30:04 +01:00
< a href = "#reports.kyverno.io/v1.EphemeralReportSpec" >
EphemeralReportSpec
2024-01-26 19:10:29 +05:30
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table class = "table table-striped" >
< tr >
< td >
< code > owner< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#ownerreference-v1-meta" >
Kubernetes meta/v1.OwnerReference
< / a >
< / em >
< / td >
< td >
< p > Owner is a reference to the report owner (e.g. a Deployment, Namespace, or Node)< / p >
< / td >
< / tr >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2024-01-28 00:30:04 +01:00
< h3 id = "reports.kyverno.io/v1.EphemeralReportSpec" > EphemeralReportSpec
2024-01-26 19:10:29 +05:30
< / h3 >
< p >
(< em > Appears on:< / em >
2024-01-28 00:30:04 +01:00
< a href = "#reports.kyverno.io/v1.ClusterEphemeralReport" > ClusterEphemeralReport< / a > ,
< a href = "#reports.kyverno.io/v1.EphemeralReport" > EphemeralReport< / a > )
2024-01-26 19:10:29 +05:30
< / p >
< p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > owner< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#ownerreference-v1-meta" >
Kubernetes meta/v1.OwnerReference
< / a >
< / em >
< / td >
< td >
< p > Owner is a reference to the report owner (e.g. a Deployment, Namespace, or Node)< / p >
< / td >
< / tr >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
2022-10-21 16:51:15 +02:00
< h2 id = "wgpolicyk8s.io/v1alpha2" > wgpolicyk8s.io/v1alpha2< / h2 >
Resource Types:
< ul > < li >
< a href = "#wgpolicyk8s.io/v1alpha2.ClusterPolicyReport" > ClusterPolicyReport< / a >
< / li > < li >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReport" > PolicyReport< / a >
< / li > < / ul >
< hr / >
< h3 id = "wgpolicyk8s.io/v1alpha2.ClusterPolicyReport" > ClusterPolicyReport
< / h3 >
< p >
< p > ClusterPolicyReport is the Schema for the clusterpolicyreports API< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
wgpolicyk8s.io/v1alpha2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > ClusterPolicyReport< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > scope< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectreference-v1-core" >
Kubernetes core/v1.ObjectReference
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)< / p >
< / td >
< / tr >
< tr >
< td >
< code > scopeSelector< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta" >
Kubernetes meta/v1.LabelSelector
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "wgpolicyk8s.io/v1alpha2.PolicyReport" > PolicyReport
< / h3 >
< p >
< p > PolicyReport is the Schema for the policyreports API< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > apiVersion< / code > < br / >
string< / td >
< td >
< code >
wgpolicyk8s.io/v1alpha2
< / code >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < br / >
string
< / td >
< td > < code > PolicyReport< / code > < / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > scope< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectreference-v1-core" >
Kubernetes core/v1.ObjectReference
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)< / p >
< / td >
< / tr >
< tr >
< td >
< code > scopeSelector< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta" >
Kubernetes meta/v1.LabelSelector
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > summary< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportSummary" >
PolicyReportSummary
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportSummary provides a summary of results< / p >
< / td >
< / tr >
< tr >
< td >
< code > results< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" >
[]PolicyReportResult
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > PolicyReportResult provides result details< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "wgpolicyk8s.io/v1alpha2.PolicyReportResult" > PolicyReportResult
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#wgpolicyk8s.io/v1alpha2.ClusterPolicyReport" > ClusterPolicyReport< / a > ,
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReport" > PolicyReport< / a > ,
2023-12-22 16:09:00 +02:00
< a href = "#kyverno.io/v2.AdmissionReportSpec" > AdmissionReportSpec< / a > ,
2024-01-27 09:03:01 +01:00
< a href = "#kyverno.io/v2.BackgroundScanReportSpec" > BackgroundScanReportSpec< / a > ,
2024-01-28 00:30:04 +01:00
< a href = "#reports.kyverno.io/v1.EphemeralReportSpec" > EphemeralReportSpec< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
< p > PolicyReportResult provides the result for an individual policy< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > source< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Source is an identifier for the policy engine that manages this report< / p >
< / td >
< / tr >
< tr >
< td >
< code > policy< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Policy is the name or identifier of the policy< / p >
< / td >
< / tr >
< tr >
< td >
< code > rule< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Rule is the name or identifier of the rule within the policy< / p >
< / td >
< / tr >
< tr >
< td >
< code > resources< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectreference-v1-core" >
[]Kubernetes core/v1.ObjectReference
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Subjects is an optional reference to the checked Kubernetes resources< / p >
< / td >
< / tr >
< tr >
< td >
< code > resourceSelector< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta" >
Kubernetes meta/v1.LabelSelector
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > SubjectSelector is an optional label selector for checked Kubernetes resources.
For example, a policy result may apply to all pods that match a label.
Either a Subject or a SubjectSelector can be specified.
If neither are provided, the result is assumed to be for the policy report scope.< / p >
< / td >
< / tr >
< tr >
< td >
< code > message< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< p > Description is a short user friendly message for the policy rule< / p >
< / td >
< / tr >
< tr >
< td >
< code > result< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyResult" >
PolicyResult
< / a >
< / em >
< / td >
< td >
< p > Result indicates the outcome of the policy rule execution< / p >
< / td >
< / tr >
< tr >
< td >
< code > scored< / code > < br / >
< em >
bool
< / em >
< / td >
< td >
< p > Scored indicates if this result is scored< / p >
< / td >
< / tr >
< tr >
< td >
< code > properties< / code > < br / >
< em >
map[string]string
< / em >
< / td >
< td >
< p > Properties provides additional information for the policy rule< / p >
< / td >
< / tr >
< tr >
< td >
< code > timestamp< / code > < br / >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#timestamp-v1-meta" >
Kubernetes meta/v1.Timestamp
< / a >
< / em >
< / td >
< td >
< p > Timestamp indicates the time the result was found< / p >
< / td >
< / tr >
< tr >
< td >
< code > category< / code > < br / >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Category indicates policy category< / p >
< / td >
< / tr >
< tr >
< td >
< code > severity< / code > < br / >
< em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicySeverity" >
PolicySeverity
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Severity indicates policy check result criticality< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "wgpolicyk8s.io/v1alpha2.PolicyReportSummary" > PolicyReportSummary
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#wgpolicyk8s.io/v1alpha2.ClusterPolicyReport" > ClusterPolicyReport< / a > ,
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReport" > PolicyReport< / a > ,
2023-12-22 16:09:00 +02:00
< a href = "#kyverno.io/v2.AdmissionReportSpec" > AdmissionReportSpec< / a > ,
2024-01-27 09:03:01 +01:00
< a href = "#kyverno.io/v2.BackgroundScanReportSpec" > BackgroundScanReportSpec< / a > ,
2024-01-28 00:30:04 +01:00
< a href = "#reports.kyverno.io/v1.EphemeralReportSpec" > EphemeralReportSpec< / a > )
2022-10-21 16:51:15 +02:00
< / p >
< p >
< p > PolicyReportSummary provides a status count summary< / p >
< / p >
< table class = "table table-striped" >
< thead class = "thead-dark" >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > pass< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Pass provides the count of policies whose requirements were met< / p >
< / td >
< / tr >
< tr >
< td >
< code > fail< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Fail provides the count of policies whose requirements were not met< / p >
< / td >
< / tr >
< tr >
< td >
< code > warn< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Warn provides the count of non-scored policies whose requirements were not met< / p >
< / td >
< / tr >
< tr >
< td >
< code > error< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Error provides the count of policies that could not be evaluated< / p >
< / td >
< / tr >
< tr >
< td >
< code > skip< / code > < br / >
< em >
int
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Skip indicates the count of policies that were not selected for evaluation< / p >
< / td >
< / tr >
< / tbody >
< / table >
< hr / >
< h3 id = "wgpolicyk8s.io/v1alpha2.PolicyResult" > PolicyResult
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" > PolicyReportResult< / a > )
< / p >
< p >
< p > PolicyResult has one of the following values:
- pass: indicates that the policy requirements are met
- fail: indicates that the policy requirements are not met
- warn: indicates that the policy requirements and not met, and the policy is not scored
- error: indicates that the policy could not be evaluated
- skip: indicates that the policy was not selected based on user inputs or applicability< / p >
< / p >
< h3 id = "wgpolicyk8s.io/v1alpha2.PolicySeverity" > PolicySeverity
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#wgpolicyk8s.io/v1alpha2.PolicyReportResult" > PolicyReportResult< / a > )
< / p >
< p >
< p > PolicySeverity has one of the following values:
- critical
- high
- low
- medium
- info< / p >
< / p >
< / div >
< script src = "https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity = "sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin = "anonymous" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity = "sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin = "anonymous" > < / script >
< script src = "https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity = "sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin = "anonymous" > < / script >
< / body >
< / html >
