2020-11-12 16:44:14 -08:00
---
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2022-04-14 17:08:30 +01:00
controller-gen.kubebuilder.io/version : v0.8.0
2020-11-12 16:44:14 -08:00
creationTimestamp : null
name : policies.kyverno.io
spec :
group : kyverno.io
names :
kind : Policy
listKind : PolicyList
plural : policies
2020-11-12 19:48:39 -08:00
shortNames :
- pol
2020-11-12 16:44:14 -08:00
singular : policy
scope : Namespaced
versions :
2020-11-12 19:48:39 -08:00
- additionalPrinterColumns :
- jsonPath : .spec.background
name : Background
type : string
- jsonPath : .spec.validationFailureAction
2021-04-08 12:10:30 -07:00
name : Action
2020-11-12 19:48:39 -08:00
type : string
2021-09-29 20:53:34 -07:00
- jsonPath : .spec.failurePolicy
name : Failure Policy
2021-10-05 00:15:09 -07:00
priority : 1
2021-09-29 20:53:34 -07:00
type : string
2021-09-23 16:13:27 -07:00
- jsonPath : .status.ready
name : Ready
type : string
2020-11-12 19:48:39 -08:00
name : v1
2020-11-12 16:44:14 -08:00
schema :
openAPIV3Schema :
2020-11-15 22:47:55 -08:00
description : 'Policy declares validation, mutation, and generation behaviors
for matching resources. See : https://kyverno.io/docs/writing-policies/ for
more information.'
2020-11-12 16:44:14 -08:00
properties :
apiVersion :
description : 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type : string
kind :
description : 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type : string
metadata :
type : object
spec :
2021-06-22 22:33:15 +05:30
description : Spec defines policy behaviors and contains one or more rules.
2020-11-12 16:44:14 -08:00
properties :
background :
description : Background controls if rules are applied to existing
2020-11-15 22:47:55 -08:00
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).
2020-11-12 16:44:14 -08:00
type : boolean
2021-09-29 20:53:34 -07:00
failurePolicy :
description : FailurePolicy defines how unrecognized errors from the
admission endpoint are handled. Rules within the same policy share
the same failure behavior. Allowed values are Ignore or Fail. Defaults
to Fail.
enum :
- Ignore
- Fail
type : string
2020-11-12 16:44:14 -08:00
rules :
2020-12-01 23:19:08 -08:00
description : Rules is a list of Rule instances. A Policy contains
multiple rules and each rule can validate, mutate, or generate resources.
2020-11-12 16:44:14 -08:00
items :
2020-11-15 22:47:55 -08:00
description : Rule defines a validation, mutation, or generation
2020-12-01 23:19:08 -08:00
control for matching resources. Each rules contains a match declaration
to select resources, and an optional exclude declaration to specify
which resources to exclude.
2020-11-12 16:44:14 -08:00
properties :
context :
2020-12-01 23:19:08 -08:00
description : Context defines variables and data sources that
2020-11-15 22:47:55 -08:00
can be used during rule execution.
2020-11-12 16:44:14 -08:00
items :
2020-11-15 22:47:55 -08:00
description : ContextEntry adds variables and data sources
2021-02-01 12:59:13 -08:00
to a rule Context. Either a ConfigMap reference or a APILookup
must be provided.
2020-11-12 16:44:14 -08:00
properties :
2021-02-01 12:59:13 -08:00
apiCall :
2021-02-03 13:10:02 -08:00
description : APICall defines an HTTP request to the Kubernetes
API server. The JSON data retrieved is stored in the
context.
2021-02-01 12:59:13 -08:00
properties :
jmesPath :
description : JMESPath is an optional JSON Match Expression
that can be used to transform the JSON response
2021-02-03 13:10:02 -08:00
returned from the API server. For example a JMESPath
of "items | length(@)" applied to the API server
response to the URLPath "/apis/apps/v1/deployments"
will return the total count of deployments across
all namespaces.
2021-02-01 12:59:13 -08:00
type : string
urlPath :
description : URLPath is the URL path to be used in
2021-02-03 13:10:02 -08:00
the HTTP GET request to the Kubernetes API server
(e.g. "/api/v1/namespaces" or "/apis/apps/v1/deployments").
The format required is the same format used by the
`kubectl get --raw` command.
2021-02-01 12:59:13 -08:00
type : string
required :
- urlPath
type : object
2020-11-12 16:44:14 -08:00
configMap :
2021-02-01 12:59:13 -08:00
description : ConfigMap is the ConfigMap reference.
2020-11-12 16:44:14 -08:00
properties :
name :
2021-02-01 12:59:13 -08:00
description : Name is the ConfigMap name.
2020-11-12 16:44:14 -08:00
type : string
namespace :
2021-02-01 12:59:13 -08:00
description : Namespace is the ConfigMap namespace.
2020-11-12 16:44:14 -08:00
type : string
2021-02-01 12:59:13 -08:00
required :
- name
2020-11-12 16:44:14 -08:00
type : object
2022-01-17 04:06:44 +00:00
imageRegistry :
description : ImageRegistry defines requests to an OCI/Docker
V2 registry to fetch image details.
properties :
jmesPath :
description : 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.
type : string
reference :
description : 'Reference is image reference to a container
image in the registry. Example : ghcr.io/kyverno/kyverno:latest'
type : string
required :
- reference
type : object
2020-11-12 16:44:14 -08:00
name :
2021-02-01 12:59:13 -08:00
description : Name is the variable name.
2020-11-12 16:44:14 -08:00
type : string
2022-04-25 12:06:07 +01:00
variable :
description : Variable defines an arbitrary JMESPath context
variable that can be defined inline.
properties :
default :
description : Default is an optional arbitrary JSON
object that the variable may take if the JMESPath
expression evaluates to nil
x-kubernetes-preserve-unknown-fields : true
jmesPath :
description : JMESPath is an optional JMESPath Expression
that can be used to transform the variable.
type : string
value :
description : Value is any arbitrary JSON object representable
in YAML or JSON form.
x-kubernetes-preserve-unknown-fields : true
type : object
2020-11-12 16:44:14 -08:00
type : object
type : array
exclude :
2020-12-01 23:19:08 -08:00
description : 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.
2020-11-12 16:44:14 -08:00
properties :
2021-07-29 01:29:53 +05:30
all :
description : All allows specifying resources which will
be ANDed
items :
2021-11-04 23:26:22 -07:00
description : ResourceFilter allow users to "AND" or "OR"
2021-07-29 01:29:53 +05:30
between resources
properties :
clusterRoles :
description : ClusterRoles is the list of cluster-wide
role names for the user.
items :
type : string
type : array
resources :
description : ResourceDescription contains information
about the resource being created or modified.
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : 'Name is the name of the resource.
2021-07-29 01:29:53 +05:30
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character). NOTE : "Name" is being deprecated
in favor of "Names".'
2021-07-29 01:29:53 +05:30
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources.
2021-07-29 01:29:53 +05:30
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character).
2021-07-29 01:29:53 +05:30
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?`
(matches one character).Wildcards allows writing
label selectors like ["storage.k8s.io/*": "*"].
Note that using ["*" : "*"] matches any key
and value but does not match an empty label
set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces
names. Each name supports wildcard characters
"*" (matches zero or many characters) and "?"
(at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label
keys and values in `matchLabels` support the
wildcard characters `*` (matches zero or many
characters) and `?` (matches one character).
Wildcards allows writing label selectors like
[ "storage.k8s.io/*": "*" ] . Note that using ["*"
: "*" ] matches any key and value but does not
match an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role
names for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names
like users, user groups, and service accounts.
items :
description : Subject contains a reference to the
object or user identities a role binding applies
to. This can either hold a direct API object
reference, or a value for non-objects such as
user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of
the referenced subject. Defaults to "" for
ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
for User and Group subjects.
type : string
kind :
description : Kind of object being referenced.
Values defined by this API group are "User",
"Group" , and "ServiceAccount". If the Authorizer
does not recognized the kind value, the Authorizer
should report an error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as
"User" or "Group", and this value is not empty
the Authorizer should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
type : array
any :
description : Any allows specifying resources which will
be ORed
items :
2021-11-04 23:26:22 -07:00
description : ResourceFilter allow users to "AND" or "OR"
2021-07-29 01:29:53 +05:30
between resources
properties :
clusterRoles :
description : ClusterRoles is the list of cluster-wide
role names for the user.
items :
type : string
type : array
resources :
description : ResourceDescription contains information
about the resource being created or modified.
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : 'Name is the name of the resource.
2021-07-29 01:29:53 +05:30
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character). NOTE : "Name" is being deprecated
in favor of "Names".'
2021-07-29 01:29:53 +05:30
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources.
2021-07-29 01:29:53 +05:30
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character).
2021-07-29 01:29:53 +05:30
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?`
(matches one character).Wildcards allows writing
label selectors like ["storage.k8s.io/*": "*"].
Note that using ["*" : "*"] matches any key
and value but does not match an empty label
set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces
names. Each name supports wildcard characters
"*" (matches zero or many characters) and "?"
(at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label
keys and values in `matchLabels` support the
wildcard characters `*` (matches zero or many
characters) and `?` (matches one character).
Wildcards allows writing label selectors like
[ "storage.k8s.io/*": "*" ] . Note that using ["*"
: "*" ] matches any key and value but does not
match an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role
names for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names
like users, user groups, and service accounts.
items :
description : Subject contains a reference to the
object or user identities a role binding applies
to. This can either hold a direct API object
reference, or a value for non-objects such as
user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of
the referenced subject. Defaults to "" for
ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
for User and Group subjects.
type : string
kind :
description : Kind of object being referenced.
Values defined by this API group are "User",
"Group" , and "ServiceAccount". If the Authorizer
does not recognized the kind value, the Authorizer
should report an error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as
"User" or "Group", and this value is not empty
the Authorizer should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
type : array
2020-11-12 16:44:14 -08:00
clusterRoles :
2020-11-15 22:47:55 -08:00
description : ClusterRoles is the list of cluster-wide role
names for the user.
2020-11-12 16:44:14 -08:00
items :
type : string
type : array
resources :
2020-11-15 22:47:55 -08:00
description : ResourceDescription contains information about
2022-03-22 15:24:40 +01:00
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.
2020-11-12 16:44:14 -08:00
properties :
annotations :
additionalProperties :
type : string
2020-12-02 12:26:59 -08:00
description : 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).
2020-11-12 16:44:14 -08:00
type : object
kinds :
2020-11-15 22:47:55 -08:00
description : Kinds is a list of resource kinds.
2020-11-12 16:44:14 -08:00
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : '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".'
2020-11-12 16:44:14 -08:00
type : string
2021-06-29 11:01:22 +05:30
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources. Each
name supports wildcard characters "*" (matches zero
or many characters) and "?" (at least one character).
2021-06-29 11:01:22 +05:30
items :
type : string
type : array
2021-02-19 09:09:41 -08:00
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters `*`
(matches zero or many characters) and `?` (matches
one character).Wildcards allows writing label selectors
2020-12-02 12:26:59 -08:00
like ["storage.k8s.io/*": "*"]. Note that using ["*"
: "*" ] matches any key and value but does not match
an empty label set.'
2020-11-12 16:44:14 -08:00
properties :
matchExpressions :
description : matchExpressions is a list of label
selector requirements. The requirements are ANDed.
items :
description : A label selector requirement is a
selector that contains values, a key, and an
operator that relates the key and values.
properties :
key :
description : key is the label key that the
selector applies to.
type : string
operator :
description : operator represents a key's relationship
to a set of values. Valid operators are
In, NotIn, Exists and DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty. If the
operator is Exists or DoesNotExist, the
values array must be empty. This array is
replaced during a strategic merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In",
and the values array contains only "value". The
requirements are ANDed.
type : object
type : object
2021-02-19 09:09:41 -08:00
namespaces :
description : Namespaces is a list of namespaces names.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label keys
and values in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?` (matches
one character). Wildcards allows writing label selectors
like ["storage.k8s.io/*": "*"]. Note that using ["*"
: "*" ] matches any key and value but does not match
2021-02-04 02:39:42 +05:30
an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of label
selector requirements. The requirements are ANDed.
items :
description : A label selector requirement is a
selector that contains values, a key, and an
operator that relates the key and values.
properties :
key :
description : key is the label key that the
selector applies to.
type : string
operator :
description : operator represents a key's relationship
to a set of values. Valid operators are
In, NotIn, Exists and DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty. If the
operator is Exists or DoesNotExist, the
values array must be empty. This array is
replaced during a strategic merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In",
and the values array contains only "value". The
requirements are ANDed.
type : object
type : object
2020-11-12 16:44:14 -08:00
type : object
roles :
2020-11-15 22:47:55 -08:00
description : Roles is the list of namespaced role names
for the user.
2020-11-12 16:44:14 -08:00
items :
type : string
type : array
subjects :
2020-11-15 22:47:55 -08:00
description : Subjects is the list of subject names like
users, user groups, and service accounts.
2020-11-12 16:44:14 -08:00
items :
description : Subject contains a reference to the object
or user identities a role binding applies to. This
can either hold a direct API object reference, or a
value for non-objects such as user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of the referenced
subject. Defaults to "" for ServiceAccount subjects.
Defaults to "rbac.authorization.k8s.io" for User
and Group subjects.
type : string
kind :
description : Kind of object being referenced. Values
defined by this API group are "User", "Group", and
"ServiceAccount" . If the Authorizer does not recognized
the kind value, the Authorizer should report an
error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as "User"
or "Group", and this value is not empty the Authorizer
should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
generate :
2020-12-01 23:19:08 -08:00
description : Generation is used to create new resources.
2020-11-12 16:44:14 -08:00
properties :
apiVersion :
2020-11-15 22:47:55 -08:00
description : APIVersion specifies resource apiVersion.
2020-11-12 16:44:14 -08:00
type : string
clone :
2020-12-21 11:04:19 -08:00
description : 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.
2020-11-12 16:44:14 -08:00
properties :
name :
2020-11-15 22:47:55 -08:00
description : Name specifies name of the resource.
2020-11-12 16:44:14 -08:00
type : string
namespace :
2020-11-15 22:47:55 -08:00
description : Namespace specifies source resource namespace.
2020-11-12 16:44:14 -08:00
type : string
type : object
data :
2020-12-21 11:04:19 -08:00
description : 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.
2020-11-12 16:44:14 -08:00
x-kubernetes-preserve-unknown-fields : true
kind :
2020-11-15 22:47:55 -08:00
description : Kind specifies resource kind.
2020-11-12 16:44:14 -08:00
type : string
name :
2020-11-15 22:47:55 -08:00
description : Name specifies the resource name.
2022-04-25 14:53:16 +05:30
maxLength : 63
2020-11-12 16:44:14 -08:00
type : string
namespace :
2020-11-15 22:47:55 -08:00
description : Namespace specifies resource namespace.
2020-11-12 16:44:14 -08:00
type : string
synchronize :
2020-11-15 22:47:55 -08:00
description : Synchronize controls if generated resources
2020-12-21 11:04:19 -08:00
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.
2020-11-15 22:47:55 -08:00
Defaults to "false" if not specified.
2020-11-12 16:44:14 -08:00
type : boolean
type : object
2022-04-14 17:08:30 +01:00
imageExtractors :
additionalProperties :
items :
properties :
key :
description : 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.
type : string
name :
description : 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'.
type : string
path :
description : Path is the path to the object containing
the image field in a custom resource. It should be
2022-05-01 16:44:51 -07:00
slash-separated. Each slash-separated key must be
2022-04-14 17:08:30 +01:00
a valid YAML key or a wildcard '*'. Wildcard keys
are expanded in case of arrays or objects.
type : string
value :
description : 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.
type : string
required :
- path
type : object
type : array
description : ImageExtractors defines a mapping from kinds to
ImageExtractorConfigs. This config is only valid for verifyImages
rules.
type : object
2020-11-12 16:44:14 -08:00
match :
2020-12-01 23:19:08 -08:00
description : 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.
2020-11-12 16:44:14 -08:00
properties :
2021-07-29 01:29:53 +05:30
all :
description : All allows specifying resources which will
be ANDed
items :
2021-11-04 23:26:22 -07:00
description : ResourceFilter allow users to "AND" or "OR"
2021-07-29 01:29:53 +05:30
between resources
properties :
clusterRoles :
description : ClusterRoles is the list of cluster-wide
role names for the user.
items :
type : string
type : array
resources :
description : ResourceDescription contains information
about the resource being created or modified.
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : 'Name is the name of the resource.
2021-07-29 01:29:53 +05:30
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character). NOTE : "Name" is being deprecated
in favor of "Names".'
2021-07-29 01:29:53 +05:30
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources.
2021-07-29 01:29:53 +05:30
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character).
2021-07-29 01:29:53 +05:30
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?`
(matches one character).Wildcards allows writing
label selectors like ["storage.k8s.io/*": "*"].
Note that using ["*" : "*"] matches any key
and value but does not match an empty label
set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces
names. Each name supports wildcard characters
"*" (matches zero or many characters) and "?"
(at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label
keys and values in `matchLabels` support the
wildcard characters `*` (matches zero or many
characters) and `?` (matches one character).
Wildcards allows writing label selectors like
[ "storage.k8s.io/*": "*" ] . Note that using ["*"
: "*" ] matches any key and value but does not
match an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role
names for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names
like users, user groups, and service accounts.
items :
description : Subject contains a reference to the
object or user identities a role binding applies
to. This can either hold a direct API object
reference, or a value for non-objects such as
user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of
the referenced subject. Defaults to "" for
ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
for User and Group subjects.
type : string
kind :
description : Kind of object being referenced.
Values defined by this API group are "User",
"Group" , and "ServiceAccount". If the Authorizer
does not recognized the kind value, the Authorizer
should report an error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as
"User" or "Group", and this value is not empty
the Authorizer should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
type : array
any :
description : Any allows specifying resources which will
be ORed
items :
2021-11-04 23:26:22 -07:00
description : ResourceFilter allow users to "AND" or "OR"
2021-07-29 01:29:53 +05:30
between resources
properties :
clusterRoles :
description : ClusterRoles is the list of cluster-wide
role names for the user.
items :
type : string
type : array
resources :
description : ResourceDescription contains information
about the resource being created or modified.
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : 'Name is the name of the resource.
2021-07-29 01:29:53 +05:30
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character). NOTE : "Name" is being deprecated
in favor of "Names".'
2021-07-29 01:29:53 +05:30
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources.
2021-07-29 01:29:53 +05:30
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character).
2021-07-29 01:29:53 +05:30
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?`
(matches one character).Wildcards allows writing
label selectors like ["storage.k8s.io/*": "*"].
Note that using ["*" : "*"] matches any key
and value but does not match an empty label
set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces
names. Each name supports wildcard characters
"*" (matches zero or many characters) and "?"
(at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label
keys and values in `matchLabels` support the
wildcard characters `*` (matches zero or many
characters) and `?` (matches one character).
Wildcards allows writing label selectors like
[ "storage.k8s.io/*": "*" ] . Note that using ["*"
: "*" ] matches any key and value but does not
match an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role
names for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names
like users, user groups, and service accounts.
items :
description : Subject contains a reference to the
object or user identities a role binding applies
to. This can either hold a direct API object
reference, or a value for non-objects such as
user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of
the referenced subject. Defaults to "" for
ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
for User and Group subjects.
type : string
kind :
description : Kind of object being referenced.
Values defined by this API group are "User",
"Group" , and "ServiceAccount". If the Authorizer
does not recognized the kind value, the Authorizer
should report an error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as
"User" or "Group", and this value is not empty
the Authorizer should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
type : array
2020-11-12 16:44:14 -08:00
clusterRoles :
2020-11-15 22:47:55 -08:00
description : ClusterRoles is the list of cluster-wide role
names for the user.
2020-11-12 16:44:14 -08:00
items :
type : string
type : array
resources :
2020-11-15 22:47:55 -08:00
description : ResourceDescription contains information about
2021-03-04 00:52:45 +05:30
the resource being created or modified. Requires at least
2021-10-05 00:27:39 +05:30
one tag to be specified when under MatchResources. Specifying
ResourceDescription directly under match is being deprecated.
Please specify under "any" or "all" instead.
2020-11-12 16:44:14 -08:00
properties :
annotations :
additionalProperties :
type : string
2020-12-02 12:26:59 -08:00
description : 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).
2020-11-12 16:44:14 -08:00
type : object
kinds :
2020-11-15 22:47:55 -08:00
description : Kinds is a list of resource kinds.
2020-11-12 16:44:14 -08:00
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : '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".'
2020-11-12 16:44:14 -08:00
type : string
2021-06-29 11:01:22 +05:30
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources. Each
name supports wildcard characters "*" (matches zero
or many characters) and "?" (at least one character).
2021-06-29 11:01:22 +05:30
items :
type : string
type : array
2021-02-19 09:09:41 -08:00
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters `*`
(matches zero or many characters) and `?` (matches
one character).Wildcards allows writing label selectors
2020-12-02 12:26:59 -08:00
like ["storage.k8s.io/*": "*"]. Note that using ["*"
: "*" ] matches any key and value but does not match
an empty label set.'
2020-11-12 16:44:14 -08:00
properties :
matchExpressions :
description : matchExpressions is a list of label
selector requirements. The requirements are ANDed.
2021-02-04 02:39:42 +05:30
items :
description : A label selector requirement is a
selector that contains values, a key, and an
operator that relates the key and values.
properties :
key :
description : key is the label key that the
selector applies to.
type : string
operator :
description : operator represents a key's relationship
to a set of values. Valid operators are
In, NotIn, Exists and DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty. If the
operator is Exists or DoesNotExist, the
values array must be empty. This array is
replaced during a strategic merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In",
and the values array contains only "value". The
requirements are ANDed.
type : object
type : object
2021-02-19 09:09:41 -08:00
namespaces :
description : Namespaces is a list of namespaces names.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label keys
and values in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?` (matches
one character). Wildcards allows writing label selectors
like ["storage.k8s.io/*": "*"]. Note that using ["*"
: "*" ] matches any key and value but does not match
2021-02-04 02:39:42 +05:30
an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of label
selector requirements. The requirements are ANDed.
2020-11-12 16:44:14 -08:00
items :
description : A label selector requirement is a
selector that contains values, a key, and an
operator that relates the key and values.
properties :
key :
description : key is the label key that the
selector applies to.
type : string
operator :
description : operator represents a key's relationship
to a set of values. Valid operators are
In, NotIn, Exists and DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty. If the
operator is Exists or DoesNotExist, the
values array must be empty. This array is
replaced during a strategic merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In",
and the values array contains only "value". The
requirements are ANDed.
type : object
type : object
type : object
roles :
2020-11-15 22:47:55 -08:00
description : Roles is the list of namespaced role names
for the user.
2020-11-12 16:44:14 -08:00
items :
type : string
type : array
subjects :
2020-11-15 22:47:55 -08:00
description : Subjects is the list of subject names like
users, user groups, and service accounts.
2020-11-12 16:44:14 -08:00
items :
description : Subject contains a reference to the object
or user identities a role binding applies to. This
can either hold a direct API object reference, or a
value for non-objects such as user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of the referenced
subject. Defaults to "" for ServiceAccount subjects.
Defaults to "rbac.authorization.k8s.io" for User
and Group subjects.
type : string
kind :
description : Kind of object being referenced. Values
defined by this API group are "User", "Group", and
"ServiceAccount" . If the Authorizer does not recognized
the kind value, the Authorizer should report an
error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as "User"
or "Group", and this value is not empty the Authorizer
should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
mutate :
2020-12-01 23:19:08 -08:00
description : Mutation is used to modify matching resources.
2020-11-12 16:44:14 -08:00
properties :
2021-10-07 16:12:34 +05:30
foreach :
2022-03-07 19:26:19 +05:30
description : 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.
2021-10-14 12:50:52 +05:30
items :
2022-03-07 19:26:19 +05:30
description : 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.
2021-10-14 12:50:52 +05:30
properties :
context :
description : Context defines variables and data sources
that can be used during rule execution.
items :
description : ContextEntry adds variables and data
sources to a rule Context. Either a ConfigMap
reference or a APILookup must be provided.
properties :
apiCall :
description : APICall defines an HTTP request
to the Kubernetes API server. The JSON data
retrieved is stored in the context.
properties :
jmesPath :
description : JMESPath is an optional JSON
Match Expression that can be used to transform
the JSON response returned from the API
server. For example a JMESPath of "items
| length(@)" applied to the API server
response to the URLPath "/apis/apps/v1/deployments"
will return the total count of deployments
across all namespaces.
type : string
urlPath :
description : URLPath is the URL path to
be used in the HTTP GET request to the
Kubernetes API server (e.g. "/api/v1/namespaces"
or "/apis/apps/v1/deployments"). The
format required is the same format used
by the `kubectl get --raw` command.
type : string
required :
- urlPath
type : object
configMap :
description : ConfigMap is the ConfigMap reference.
properties :
name :
description : Name is the ConfigMap name.
type : string
namespace :
description : Namespace is the ConfigMap
namespace.
type : string
required :
- name
type : object
2022-01-17 04:06:44 +00:00
imageRegistry :
description : ImageRegistry defines requests
to an OCI/Docker V2 registry to fetch image
details.
properties :
jmesPath :
description : 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.
type : string
reference :
description : 'Reference is image reference
to a container image in the registry.
Example : ghcr.io/kyverno/kyverno:latest'
type : string
required :
- reference
type : object
2021-10-14 12:50:52 +05:30
name :
description : Name is the variable name.
type : string
2022-04-25 12:06:07 +01:00
variable :
description : Variable defines an arbitrary JMESPath
context variable that can be defined inline.
properties :
default :
description : Default is an optional arbitrary
JSON object that the variable may take
if the JMESPath expression evaluates to
nil
x-kubernetes-preserve-unknown-fields : true
jmesPath :
description : JMESPath is an optional JMESPath
Expression that can be used to transform
the variable.
type : string
value :
description : Value is any arbitrary JSON
object representable in YAML or JSON form.
x-kubernetes-preserve-unknown-fields : true
type : object
2021-10-14 12:50:52 +05:30
type : object
type : array
list :
description : List specifies a JMESPath expression
that results in one or more elements to which the
validation logic is applied.
type : string
patchStrategicMerge :
description : PatchStrategicMerge is a strategic merge
patch used to modify resources. See https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
and https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/.
x-kubernetes-preserve-unknown-fields : true
2022-01-04 17:36:33 -08:00
patchesJson6902 :
description : PatchesJSON6902 is a list of RFC 6902
JSON Patch declarations used to modify resources.
See https://tools.ietf.org/html/rfc6902 and https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/.
type : string
2021-10-14 12:50:52 +05:30
preconditions :
2021-11-04 23:26:22 -07:00
description : 'AnyAllConditions are used to determine
2021-10-14 12:50:52 +05:30
if a policy rule should be applied by evaluating
a set of conditions. The declaration can contain
nested `any` or `all` statements. See : https://kyverno.io/docs/writing-policies/preconditions/'
2021-10-07 16:12:34 +05:30
properties :
2021-10-14 12:50:52 +05:30
all :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry (using
JMESPath) for conditional rule evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
2022-01-04 17:36:33 -08:00
description : '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'
2021-10-14 12:50:52 +05:30
enum :
- Equals
- NotEquals
- In
2021-10-27 05:59:42 +05:30
- AnyIn
- AllIn
2021-10-14 12:50:52 +05:30
- NotIn
2021-10-27 05:59:42 +05:30
- AnyNotIn
- AllNotIn
2021-10-14 12:50:52 +05:30
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional value,
or set of values. The values can be fixed
set or can be variables declared using
2022-04-11 08:47:27 -07:00
JMESPath.
2021-10-14 12:50:52 +05:30
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
any :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry (using
JMESPath) for conditional rule evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
2022-01-04 17:36:33 -08:00
description : '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'
2021-10-14 12:50:52 +05:30
enum :
- Equals
- NotEquals
- In
2021-10-27 05:59:42 +05:30
- AnyIn
- AllIn
2021-10-14 12:50:52 +05:30
- NotIn
2021-10-27 05:59:42 +05:30
- AnyNotIn
- AllNotIn
2021-10-14 12:50:52 +05:30
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional value,
or set of values. The values can be fixed
set or can be variables declared using
2022-04-11 08:47:27 -07:00
JMESPath.
2021-10-14 12:50:52 +05:30
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
2021-10-07 16:12:34 +05:30
type : object
2021-10-14 12:50:52 +05:30
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
2020-11-12 16:44:14 -08:00
patchStrategicMerge :
2020-11-15 22:47:55 -08:00
description : PatchStrategicMerge is a strategic merge patch
used to modify resources. See https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
and https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/.
2020-11-18 17:36:06 -08:00
x-kubernetes-preserve-unknown-fields : true
2020-11-12 16:44:14 -08:00
patchesJson6902 :
2020-11-15 22:47:55 -08:00
description : PatchesJSON6902 is a list of RFC 6902 JSON
Patch declarations used to modify resources. See https://tools.ietf.org/html/rfc6902
and https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/.
2020-11-12 16:44:14 -08:00
type : string
2022-04-25 20:20:40 +08:00
targets :
description : Targets defines the target resources to be
mutated.
items :
properties :
apiVersion :
description : APIVersion specifies resource apiVersion.
type : string
kind :
description : Kind specifies resource kind.
type : string
name :
description : Name specifies the resource name.
maxLength : 63
type : string
namespace :
description : Namespace specifies resource namespace.
type : string
type : object
type : array
2020-11-12 16:44:14 -08:00
type : object
name :
2020-12-01 23:19:08 -08:00
description : Name is a label to identify the rule, It must be
unique within the policy.
2021-02-19 09:09:41 -08:00
maxLength : 63
2020-11-12 16:44:14 -08:00
type : string
preconditions :
2021-07-09 18:01:46 -07:00
description : 'Preconditions are used to determine if a policy
rule should be applied by evaluating a set of conditions.
The declaration can contain nested `any` or `all` statements.
A direct list of conditions (without `any` or `all` statements
is supported for backwards compatibility but will be deprecated
in the next major release. See : https://kyverno.io/docs/writing-policies/preconditions/'
2021-03-02 10:01:06 +05:30
x-kubernetes-preserve-unknown-fields : true
2020-11-12 16:44:14 -08:00
validate :
2020-12-01 23:19:08 -08:00
description : Validation is used to validate matching resources.
2020-11-12 16:44:14 -08:00
properties :
anyPattern :
2020-11-15 22:47:55 -08:00
description : AnyPattern specifies list of validation patterns.
At least one of the patterns must be satisfied for the
validation rule to succeed.
2020-11-18 17:36:06 -08:00
x-kubernetes-preserve-unknown-fields : true
2020-11-12 16:44:14 -08:00
deny :
2021-07-09 18:01:46 -07:00
description : Deny defines conditions used to pass or fail
a validation rule.
2020-11-12 16:44:14 -08:00
properties :
conditions :
2021-07-09 18:01:46 -07:00
description : 'Multiple conditions can be declared under
an `any` or `all` statement. A direct list of conditions
(without `any` or `all` statements) is also supported
for backwards compatibility but will be deprecated
in the next major release. See : https://kyverno.io/docs/writing-policies/validate/#deny-rules'
2021-03-02 10:01:06 +05:30
x-kubernetes-preserve-unknown-fields : true
2020-11-12 16:44:14 -08:00
type : object
2021-10-02 18:29:25 -07:00
foreach :
2022-03-07 19:26:19 +05:30
description : 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.
2021-10-14 12:50:52 +05:30
items :
2022-03-07 19:26:19 +05:30
description : 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.
2021-10-14 12:50:52 +05:30
properties :
anyPattern :
description : AnyPattern specifies list of validation
patterns. At least one of the patterns must be satisfied
for the validation rule to succeed.
x-kubernetes-preserve-unknown-fields : true
context :
description : Context defines variables and data sources
that can be used during rule execution.
items :
description : ContextEntry adds variables and data
sources to a rule Context. Either a ConfigMap
reference or a APILookup must be provided.
properties :
apiCall :
description : APICall defines an HTTP request
to the Kubernetes API server. The JSON data
retrieved is stored in the context.
properties :
jmesPath :
description : JMESPath is an optional JSON
Match Expression that can be used to transform
the JSON response returned from the API
server. For example a JMESPath of "items
| length(@)" applied to the API server
response to the URLPath "/apis/apps/v1/deployments"
will return the total count of deployments
across all namespaces.
type : string
urlPath :
description : URLPath is the URL path to
be used in the HTTP GET request to the
Kubernetes API server (e.g. "/api/v1/namespaces"
or "/apis/apps/v1/deployments"). The
format required is the same format used
by the `kubectl get --raw` command.
type : string
required :
- urlPath
type : object
configMap :
description : ConfigMap is the ConfigMap reference.
properties :
name :
description : Name is the ConfigMap name.
type : string
namespace :
description : Namespace is the ConfigMap
namespace.
type : string
required :
- name
type : object
2022-01-17 04:06:44 +00:00
imageRegistry :
description : ImageRegistry defines requests
to an OCI/Docker V2 registry to fetch image
details.
properties :
jmesPath :
description : 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.
type : string
reference :
description : 'Reference is image reference
to a container image in the registry.
Example : ghcr.io/kyverno/kyverno:latest'
type : string
required :
- reference
type : object
2021-10-14 12:50:52 +05:30
name :
description : Name is the variable name.
type : string
2022-04-25 12:06:07 +01:00
variable :
description : Variable defines an arbitrary JMESPath
context variable that can be defined inline.
properties :
default :
description : Default is an optional arbitrary
JSON object that the variable may take
if the JMESPath expression evaluates to
nil
x-kubernetes-preserve-unknown-fields : true
jmesPath :
description : JMESPath is an optional JMESPath
Expression that can be used to transform
the variable.
type : string
value :
description : Value is any arbitrary JSON
object representable in YAML or JSON form.
x-kubernetes-preserve-unknown-fields : true
type : object
2021-10-14 12:50:52 +05:30
type : object
type : array
deny :
description : Deny defines conditions used to pass
or fail a validation rule.
2021-10-02 18:29:25 -07:00
properties :
2021-10-14 12:50:52 +05:30
conditions :
description : 'Multiple conditions can be declared
under an `any` or `all` statement. A direct
list of conditions (without `any` or `all` statements)
is also supported for backwards compatibility
but will be deprecated in the next major release.
See : https://kyverno.io/docs/writing-policies/validate/#deny-rules'
x-kubernetes-preserve-unknown-fields : true
2021-10-02 18:29:25 -07:00
type : object
2022-01-04 17:36:33 -08:00
elementScope :
2022-01-17 04:06:44 +00:00
description : 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.
2022-01-04 17:36:33 -08:00
type : boolean
2021-10-14 12:50:52 +05:30
list :
description : List specifies a JMESPath expression
that results in one or more elements to which the
validation logic is applied.
type : string
pattern :
description : Pattern specifies an overlay-style pattern
used to check resources.
x-kubernetes-preserve-unknown-fields : true
preconditions :
2021-11-04 23:26:22 -07:00
description : 'AnyAllConditions are used to determine
2021-10-14 12:50:52 +05:30
if a policy rule should be applied by evaluating
a set of conditions. The declaration can contain
nested `any` or `all` statements. See : https://kyverno.io/docs/writing-policies/preconditions/'
properties :
all :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry (using
JMESPath) for conditional rule evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
2022-01-04 17:36:33 -08:00
description : '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'
2021-10-14 12:50:52 +05:30
enum :
- Equals
- NotEquals
- In
2021-10-27 05:59:42 +05:30
- AnyIn
- AllIn
2021-10-14 12:50:52 +05:30
- NotIn
2021-10-27 05:59:42 +05:30
- AnyNotIn
- AllNotIn
2021-10-14 12:50:52 +05:30
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional value,
or set of values. The values can be fixed
set or can be variables declared using
2022-04-11 08:47:27 -07:00
JMESPath.
2021-10-14 12:50:52 +05:30
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
any :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry (using
JMESPath) for conditional rule evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
2022-01-04 17:36:33 -08:00
description : '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'
2021-10-14 12:50:52 +05:30
enum :
- Equals
- NotEquals
- In
2021-10-27 05:59:42 +05:30
- AnyIn
- AllIn
2021-10-14 12:50:52 +05:30
- NotIn
2021-10-27 05:59:42 +05:30
- AnyNotIn
- AllNotIn
2021-10-14 12:50:52 +05:30
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional value,
or set of values. The values can be fixed
set or can be variables declared using
2022-04-11 08:47:27 -07:00
JMESPath.
2021-10-14 12:50:52 +05:30
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
type : object
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
2020-11-12 16:44:14 -08:00
message :
2020-11-15 22:47:55 -08:00
description : Message specifies a custom message to be displayed
on failure.
2020-11-12 16:44:14 -08:00
type : string
pattern :
2020-11-15 22:47:55 -08:00
description : Pattern specifies an overlay-style pattern
used to check resources.
2020-11-18 17:36:06 -08:00
x-kubernetes-preserve-unknown-fields : true
2020-11-12 16:44:14 -08:00
type : object
2021-07-09 18:01:46 -07:00
verifyImages :
description : VerifyImages is used to verify image signatures
and mutate them to add a digest
items :
description : 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.
properties :
2022-03-17 09:42:12 +01:00
additionalExtensions :
additionalProperties :
type : string
description : AdditionalExtensions are certificate-extensions
2022-04-11 08:47:27 -07:00
used for keyless signing. Deprecated.
2022-03-17 09:42:12 +01:00
type : object
2021-12-16 11:49:44 +05:30
annotations :
additionalProperties :
type : string
description : Annotations are used for image verification.
Every specified key-value pair must exist and match
in the verified payload. The payload may contain other
2022-04-19 08:35:12 -07:00
key-value pairs. Deprecated. Use annotations per Attestor
instead.
2021-12-16 11:49:44 +05:30
type : object
2021-10-06 00:58:45 -07:00
attestations :
description : Attestations are optional checks for signed
in-toto Statements used to verify the image. See https://github.com/in-toto/attestation.
Kyverno fetches signed attestations from the OCI registry
and decodes them into a list of Statement declarations.
items :
description : Attestation are checks for signed in-toto
Statements that are used to verify the image. See
https://github.com/in-toto/attestation. Kyverno fetches
signed attestations from the OCI registry and decodes
them into a list of Statements.
properties :
conditions :
description : 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.
items :
2021-11-04 23:26:22 -07:00
description : AnyAllConditions consists of conditions
2021-10-06 00:58:45 -07:00
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.
properties :
all :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry
(using JMESPath) for conditional rule
evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
2022-01-04 17:36:33 -08:00
description : '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'
2021-10-06 00:58:45 -07:00
enum :
- Equals
- NotEquals
- In
2021-10-27 05:59:42 +05:30
- AnyIn
- AllIn
2021-10-06 00:58:45 -07:00
- NotIn
2021-10-27 05:59:42 +05:30
- AnyNotIn
- AllNotIn
2021-10-07 13:50:30 -07:00
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
2021-10-06 00:58:45 -07:00
type : string
value :
description : Value is the conditional
value, or set of values. The values
can be fixed set or can be variables
2022-04-11 08:47:27 -07:00
declared using JMESPath.
2021-10-06 00:58:45 -07:00
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
any :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry
(using JMESPath) for conditional rule
evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
2022-01-04 17:36:33 -08:00
description : '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'
2021-10-06 00:58:45 -07:00
enum :
- Equals
- NotEquals
- In
2021-10-27 05:59:42 +05:30
- AnyIn
- AllIn
2021-10-06 00:58:45 -07:00
- NotIn
2021-10-27 05:59:42 +05:30
- AnyNotIn
- AllNotIn
2021-10-07 13:50:30 -07:00
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
2021-10-06 00:58:45 -07:00
type : string
value :
description : Value is the conditional
value, or set of values. The values
can be fixed set or can be variables
2022-04-11 08:47:27 -07:00
declared using JMESPath.
2021-10-06 00:58:45 -07:00
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
type : object
type : array
predicateType :
description : PredicateType defines the type of Predicate
contained within the Statement.
type : string
type : object
type : array
2022-04-11 08:47:27 -07:00
attestors :
description : Attestors specified the required attestors
(i.e. authorities)
items :
properties :
count :
description : Count specifies the required number
of entries that must match. If the count is null,
all entries must match (a logical AND). If the
count is 1, at least one entry must match (a logical
OR). If the count contains a value N, then N must
be less than or equal to the size of entries,
and at least N entries must match.
minimum : 1
type : integer
entries :
description : Entries contains the available attestors.
An attestor can be a static key, attributes for
keyless verification, or a nested attestor declaration.
items :
properties :
2022-04-19 08:35:12 -07:00
annotations :
additionalProperties :
type : string
description : 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.
type : object
attestor :
description : Attestor is a nested AttestorSet
2022-04-11 08:47:27 -07:00
used to specify a more complex set of match
2022-04-19 08:35:12 -07:00
authorities
x-kubernetes-preserve-unknown-fields : true
2022-04-11 08:47:27 -07:00
keyless :
description : Keyless is a set of attribute
used to verify a Sigstore keyless attestor.
See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.
properties :
additionalExtensions :
additionalProperties :
type : string
description : AdditionalExtensions are
certificate-extensions used for keyless
signing.
type : object
2022-04-19 08:35:12 -07:00
intermediates :
description : Intermediates is an optional
PEM encoded set of certificates that
are not trust anchors, but can be used
to form a chain from the leaf certificate
to a root certificate.
type : string
2022-04-11 08:47:27 -07:00
issuer :
description : Issuer is the certificate
issuer used for keyless signing.
type : string
2022-04-22 00:10:02 -07:00
rekor :
description : Rekor provides information
of the Rekor transparency log service.
If the value is nil, Rekor is not checked
and a root certificate chain is expected
instead. If an empty object is provided
the public instance of Rekor (https://rekor.sigstore.dev)
is used.
properties :
url :
description : URL is the address of
the transparency log. Defaults to
the public log https://rekor.sigstore.dev.
type : string
required :
- url
type : object
2022-04-11 08:47:27 -07:00
roots :
2022-04-19 08:35:12 -07:00
description : Roots is an optional set
of PEM encoded trusted root certificates.
If not provided, the system roots are
used.
2022-04-11 08:47:27 -07:00
type : string
subject :
description : Subject is the verified identity
used for keyless signing, for example
the email address
type : string
type : object
2022-04-19 08:35:12 -07:00
repository :
description : 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.
type : string
2022-04-11 08:47:27 -07:00
staticKey :
description : StaticKey is a set of attributes
used to verify an X.509 public key
properties :
2022-04-19 08:35:12 -07:00
intermediates :
description : Intermediates is an optional
PEM encoded set of certificates that
are not trust anchors, but can be used
to form a chain from the leaf certificate
to a root certificate.
type : string
2022-04-11 08:47:27 -07:00
key :
2022-04-22 00:10:02 -07:00
description : Keys is a set of X.509 public
keys used to verify image signatures.
The keys can be directly specified or
can be a variable reference to a key
specified in a ConfigMap (see https://kyverno.io/docs/writing-policies/variables/).
When multiple keys are specified each
key is processed as a separate staticKey
entry (.attestors[*].entries.staticKey)
within the set of attestors and the
count is applied across the keys.
2022-04-11 08:47:27 -07:00
type : string
2022-04-19 08:35:12 -07:00
roots :
description : Roots is an optional set
of PEM encoded trusted root certificates.
If not provided, the system roots are
used.
type : string
2022-04-11 08:47:27 -07:00
type : object
type : object
type : array
type : object
type : array
2021-07-09 18:01:46 -07:00
image :
description : 'Image is the image name consisting of the
registry address, repository, image, and tag. Wildcards
2022-04-11 08:47:27 -07:00
(''*'' and ''?'') are allowed. See : https://kubernetes.io/docs/concepts/containers/images.
Deprecated. Use ImageReferences instead.'
2021-07-09 18:01:46 -07:00
type : string
2022-04-11 08:47:27 -07:00
imageReferences :
description : 'ImageReferences is a list of matching image
reference patterns. At least one pattern in the list
must match the image for the rule to apply. Each image
reference consists of a registry address (defaults to
docker.io), repository, image, and tag (defaults to
latest). Wildcards (''*'' and ''?'') are allowed. See :
https://kubernetes.io/docs/concepts/containers/images.'
items :
type : string
type : array
2021-12-16 11:49:44 +05:30
issuer :
description : Issuer is the certificate issuer used for
2022-04-11 08:47:27 -07:00
keyless signing. Deprecated. Use KeylessAttestor instead.
2021-12-16 11:49:44 +05:30
type : string
2021-07-09 18:01:46 -07:00
key :
description : Key is the PEM encoded public key that the
2022-04-11 08:47:27 -07:00
image or attestation is signed with. Deprecated. Use
StaticKeyAttestor instead.
2021-07-09 18:01:46 -07:00
type : string
2022-04-22 13:38:49 +05:30
mutateDigest :
default : true
2022-04-27 08:09:52 -07:00
description : MutateDigest enables replacement of image
tags with digests. Defaults to true.
2022-04-22 13:38:49 +05:30
type : boolean
2021-09-16 16:11:38 -07:00
repository :
description : Repository is an optional alternate OCI repository
2022-04-19 08:35:12 -07:00
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.
2021-09-16 16:11:38 -07:00
type : string
2022-04-27 08:09:52 -07:00
required :
default : true
description : Required validates that images are verified
i.e. have matched passed a signature or attestation
check.
type : boolean
2021-11-04 23:26:22 -07:00
roots :
description : Roots is the PEM encoded Root certificate
2022-04-11 08:47:27 -07:00
chain used for keyless signing Deprecated. Use KeylessAttestor
instead.
2021-11-04 23:26:22 -07:00
type : string
subject :
2022-04-11 08:47:27 -07:00
description : Subject is the identity used for keyless
signing, for example an email address Deprecated. Use
KeylessAttestor instead.
2021-11-04 23:26:22 -07:00
type : string
2022-04-27 08:09:52 -07:00
verifyDigest :
default : true
description : VerifyDigest validates that images have a
digest.
type : boolean
2021-07-09 18:01:46 -07:00
type : object
type : array
2020-11-12 16:44:14 -08:00
type : object
type : array
2021-09-08 10:42:44 +05:30
schemaValidation :
description : SchemaValidation skips policy validation checks. Optional.
The default value is set to "true", it must be set to "false" to
disable the validation checks.
type : boolean
2020-11-12 16:44:14 -08:00
validationFailureAction :
2020-11-15 22:47:55 -08:00
description : ValidationFailureAction controls if a validation policy
rule failure should disallow the admission review request (enforce),
or allow (audit) the admission review request and report an error
in a policy report. Optional. The default value is "audit".
2022-01-21 18:06:44 +05:30
enum :
- audit
- enforce
2020-11-12 16:44:14 -08:00
type : string
2022-01-21 18:06:44 +05:30
validationFailureActionOverrides :
2022-03-02 17:49:21 +01:00
description : ValidationFailureActionOverrides is a Cluster Policy
attribute that specifies ValidationFailureAction namespace-wise.
It overrides ValidationFailureAction for the specified namespaces.
2022-01-21 18:06:44 +05:30
items :
properties :
action :
2022-03-23 09:59:41 +01:00
description : ValidationFailureAction defines the policy validation
failure action
2022-01-21 18:06:44 +05:30
enum :
- audit
- enforce
type : string
namespaces :
items :
type : string
type : array
type : object
type : array
2021-09-29 20:53:34 -07:00
webhookTimeoutSeconds :
2021-10-05 00:15:09 -07:00
description : 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.
2021-09-29 20:53:34 -07:00
format : int32
type : integer
2020-11-12 16:44:14 -08:00
type : object
status :
2021-07-29 01:29:53 +05:30
description : Status contains policy runtime information. Deprecated. Policy
metrics are available via the metrics endpoint
2020-11-12 16:44:14 -08:00
properties :
2022-03-10 16:51:29 +01:00
autogen :
description : Autogen contains autogen status information
properties :
activated :
description : Activated indicates the autogen activated controllers
items :
type : string
type : array
requested :
description : Requested indicates the autogen requested controllers
items :
type : string
type : array
type : object
2022-03-18 15:00:01 +01:00
conditions :
description : Conditions is a list of conditions that apply to the
policy
items :
description : "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct
use as an array at the field path .status.conditions. For example,
2022-04-14 17:08:30 +01:00
type FooStatus struct{ // Represents the observations of a foo's
current state. // Known .status.conditions.type are : \"Available\",
\"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
// +listType=map // +listMapKey=type Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }"
2022-03-18 15:00:01 +01:00
properties :
lastTransitionTime :
description : lastTransitionTime is the last time the condition
transitioned from one status to another. This should be when
the underlying condition changed. If that is not known, then
using the time when the API field changed is acceptable.
format : date-time
type : string
message :
description : message is a human readable message indicating
details about the transition. This may be an empty string.
maxLength : 32768
type : string
observedGeneration :
description : observedGeneration represents the .metadata.generation
that the condition was set based upon. For instance, if .metadata.generation
is currently 12, but the .status.conditions[x].observedGeneration
is 9, the condition is out of date with respect to the current
state of the instance.
format : int64
minimum : 0
type : integer
reason :
description : reason contains a programmatic identifier indicating
the reason for the condition's last transition. Producers
of specific condition types may define expected values and
meanings for this field, and whether the values are considered
a guaranteed API. The value should be a CamelCase string.
This field may not be empty.
maxLength : 1024
minLength : 1
pattern : ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type : string
status :
description : status of the condition, one of True, False, Unknown.
enum :
- "True"
- "False"
- Unknown
type : string
type :
description : type of condition in CamelCase or in foo.example.com/CamelCase.
--- Many .condition.type values are consistent across resources
like Available, but because arbitrary conditions can be useful
(see .node.status.conditions), the ability to deconflict is
important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength : 316
pattern : ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type : string
required :
- lastTransitionTime
- message
- reason
- status
- type
type : object
type : array
2021-09-23 16:13:27 -07:00
ready :
description : Ready indicates if the policy is ready to serve the admission
2022-03-18 15:00:01 +01:00
request. Deprecated in favor of Conditions
2021-09-23 16:13:27 -07:00
type : boolean
2022-03-15 15:49:16 +01:00
rules :
description : Rules is a list of Rule instances. It contains original
rules defined in the spec auto generated rules added for pod controllers
items :
description : 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.
properties :
context :
description : Context defines variables and data sources that
can be used during rule execution.
items :
description : ContextEntry adds variables and data sources
to a rule Context. Either a ConfigMap reference or a APILookup
must be provided.
properties :
apiCall :
description : APICall defines an HTTP request to the Kubernetes
API server. The JSON data retrieved is stored in the
context.
properties :
jmesPath :
description : JMESPath is an optional JSON Match Expression
that can be used to transform the JSON response
returned from the API server. For example a JMESPath
of "items | length(@)" applied to the API server
response to the URLPath "/apis/apps/v1/deployments"
will return the total count of deployments across
all namespaces.
type : string
urlPath :
description : URLPath is the URL path to be used in
the HTTP GET request to the Kubernetes API server
(e.g. "/api/v1/namespaces" or "/apis/apps/v1/deployments").
The format required is the same format used by the
`kubectl get --raw` command.
type : string
required :
- urlPath
type : object
configMap :
description : ConfigMap is the ConfigMap reference.
properties :
name :
description : Name is the ConfigMap name.
type : string
namespace :
description : Namespace is the ConfigMap namespace.
type : string
required :
- name
type : object
imageRegistry :
description : ImageRegistry defines requests to an OCI/Docker
V2 registry to fetch image details.
properties :
jmesPath :
description : 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.
type : string
reference :
description : 'Reference is image reference to a container
image in the registry. Example : ghcr.io/kyverno/kyverno:latest'
type : string
required :
- reference
type : object
name :
description : Name is the variable name.
type : string
2022-04-25 12:06:07 +01:00
variable :
description : Variable defines an arbitrary JMESPath context
variable that can be defined inline.
properties :
default :
description : Default is an optional arbitrary JSON
object that the variable may take if the JMESPath
expression evaluates to nil
x-kubernetes-preserve-unknown-fields : true
jmesPath :
description : JMESPath is an optional JMESPath Expression
that can be used to transform the variable.
type : string
value :
description : Value is any arbitrary JSON object representable
in YAML or JSON form.
x-kubernetes-preserve-unknown-fields : true
type : object
2022-03-15 15:49:16 +01:00
type : object
type : array
exclude :
description : 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.
properties :
all :
description : All allows specifying resources which will
be ANDed
items :
description : ResourceFilter allow users to "AND" or "OR"
between resources
properties :
clusterRoles :
description : ClusterRoles is the list of cluster-wide
role names for the user.
items :
type : string
type : array
resources :
description : ResourceDescription contains information
about the resource being created or modified.
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : 'Name is the name of the resource.
2022-03-15 15:49:16 +01:00
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character). NOTE : "Name" is being deprecated
in favor of "Names".'
2022-03-15 15:49:16 +01:00
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources.
2022-03-15 15:49:16 +01:00
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character).
2022-03-15 15:49:16 +01:00
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?`
(matches one character).Wildcards allows writing
label selectors like ["storage.k8s.io/*": "*"].
Note that using ["*" : "*"] matches any key
and value but does not match an empty label
set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces
names. Each name supports wildcard characters
"*" (matches zero or many characters) and "?"
(at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label
keys and values in `matchLabels` support the
wildcard characters `*` (matches zero or many
characters) and `?` (matches one character).
Wildcards allows writing label selectors like
[ "storage.k8s.io/*": "*" ] . Note that using ["*"
: "*" ] matches any key and value but does not
match an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role
names for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names
like users, user groups, and service accounts.
items :
description : Subject contains a reference to the
object or user identities a role binding applies
to. This can either hold a direct API object
reference, or a value for non-objects such as
user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of
the referenced subject. Defaults to "" for
ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
for User and Group subjects.
type : string
kind :
description : Kind of object being referenced.
Values defined by this API group are "User",
"Group" , and "ServiceAccount". If the Authorizer
does not recognized the kind value, the Authorizer
should report an error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as
"User" or "Group", and this value is not empty
the Authorizer should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
type : array
any :
description : Any allows specifying resources which will
be ORed
items :
description : ResourceFilter allow users to "AND" or "OR"
between resources
properties :
clusterRoles :
description : ClusterRoles is the list of cluster-wide
role names for the user.
items :
type : string
type : array
resources :
description : ResourceDescription contains information
about the resource being created or modified.
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : 'Name is the name of the resource.
2022-03-15 15:49:16 +01:00
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character). NOTE : "Name" is being deprecated
in favor of "Names".'
2022-03-15 15:49:16 +01:00
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources.
2022-03-15 15:49:16 +01:00
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character).
2022-03-15 15:49:16 +01:00
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?`
(matches one character).Wildcards allows writing
label selectors like ["storage.k8s.io/*": "*"].
Note that using ["*" : "*"] matches any key
and value but does not match an empty label
set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces
names. Each name supports wildcard characters
"*" (matches zero or many characters) and "?"
(at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label
keys and values in `matchLabels` support the
wildcard characters `*` (matches zero or many
characters) and `?` (matches one character).
Wildcards allows writing label selectors like
[ "storage.k8s.io/*": "*" ] . Note that using ["*"
: "*" ] matches any key and value but does not
match an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role
names for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names
like users, user groups, and service accounts.
items :
description : Subject contains a reference to the
object or user identities a role binding applies
to. This can either hold a direct API object
reference, or a value for non-objects such as
user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of
the referenced subject. Defaults to "" for
ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
for User and Group subjects.
type : string
kind :
description : Kind of object being referenced.
Values defined by this API group are "User",
"Group" , and "ServiceAccount". If the Authorizer
does not recognized the kind value, the Authorizer
should report an error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as
"User" or "Group", and this value is not empty
the Authorizer should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
type : array
clusterRoles :
description : ClusterRoles is the list of cluster-wide role
names for the user.
items :
type : string
type : array
resources :
description : ResourceDescription contains information about
2022-03-22 15:24:40 +01:00
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.
2022-03-15 15:49:16 +01:00
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : '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".'
2022-03-15 15:49:16 +01:00
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources. Each
name supports wildcard characters "*" (matches zero
or many characters) and "?" (at least one character).
2022-03-15 15:49:16 +01:00
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters `*`
(matches zero or many characters) and `?` (matches
one character).Wildcards allows writing label selectors
like ["storage.k8s.io/*": "*"]. Note that using ["*"
: "*" ] matches any key and value but does not match
an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of label
selector requirements. The requirements are ANDed.
items :
description : A label selector requirement is a
selector that contains values, a key, and an
operator that relates the key and values.
properties :
key :
description : key is the label key that the
selector applies to.
type : string
operator :
description : operator represents a key's relationship
to a set of values. Valid operators are
In, NotIn, Exists and DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty. If the
operator is Exists or DoesNotExist, the
values array must be empty. This array is
replaced during a strategic merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In",
and the values array contains only "value". The
requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces names.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label keys
and values in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?` (matches
one character). Wildcards allows writing label selectors
like ["storage.k8s.io/*": "*"]. Note that using ["*"
: "*" ] matches any key and value but does not match
an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of label
selector requirements. The requirements are ANDed.
items :
description : A label selector requirement is a
selector that contains values, a key, and an
operator that relates the key and values.
properties :
key :
description : key is the label key that the
selector applies to.
type : string
operator :
description : operator represents a key's relationship
to a set of values. Valid operators are
In, NotIn, Exists and DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty. If the
operator is Exists or DoesNotExist, the
values array must be empty. This array is
replaced during a strategic merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In",
and the values array contains only "value". The
requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role names
for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names like
users, user groups, and service accounts.
items :
description : Subject contains a reference to the object
or user identities a role binding applies to. This
can either hold a direct API object reference, or a
value for non-objects such as user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of the referenced
subject. Defaults to "" for ServiceAccount subjects.
Defaults to "rbac.authorization.k8s.io" for User
and Group subjects.
type : string
kind :
description : Kind of object being referenced. Values
defined by this API group are "User", "Group", and
"ServiceAccount" . If the Authorizer does not recognized
the kind value, the Authorizer should report an
error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as "User"
or "Group", and this value is not empty the Authorizer
should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
generate :
description : Generation is used to create new resources.
properties :
apiVersion :
description : APIVersion specifies resource apiVersion.
type : string
clone :
description : 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.
properties :
name :
description : Name specifies name of the resource.
type : string
namespace :
description : Namespace specifies source resource namespace.
type : string
type : object
data :
description : 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.
x-kubernetes-preserve-unknown-fields : true
kind :
description : Kind specifies resource kind.
type : string
name :
description : Name specifies the resource name.
2022-04-25 14:53:16 +05:30
maxLength : 63
2022-03-15 15:49:16 +01:00
type : string
namespace :
description : Namespace specifies resource namespace.
type : string
synchronize :
description : 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.
type : boolean
type : object
2022-04-14 17:08:30 +01:00
imageExtractors :
additionalProperties :
items :
properties :
key :
description : 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.
type : string
name :
description : 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'.
type : string
path :
description : Path is the path to the object containing
the image field in a custom resource. It should be
2022-05-01 16:44:51 -07:00
slash-separated. Each slash-separated key must be
2022-04-14 17:08:30 +01:00
a valid YAML key or a wildcard '*'. Wildcard keys
are expanded in case of arrays or objects.
type : string
value :
description : 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.
type : string
required :
- path
type : object
type : array
description : ImageExtractors defines a mapping from kinds to
ImageExtractorConfigs. This config is only valid for verifyImages
rules.
type : object
2022-03-15 15:49:16 +01:00
match :
description : 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.
properties :
all :
description : All allows specifying resources which will
be ANDed
items :
description : ResourceFilter allow users to "AND" or "OR"
between resources
properties :
clusterRoles :
description : ClusterRoles is the list of cluster-wide
role names for the user.
items :
type : string
type : array
resources :
description : ResourceDescription contains information
about the resource being created or modified.
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : 'Name is the name of the resource.
2022-03-15 15:49:16 +01:00
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character). NOTE : "Name" is being deprecated
in favor of "Names".'
2022-03-15 15:49:16 +01:00
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources.
2022-03-15 15:49:16 +01:00
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character).
2022-03-15 15:49:16 +01:00
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?`
(matches one character).Wildcards allows writing
label selectors like ["storage.k8s.io/*": "*"].
Note that using ["*" : "*"] matches any key
and value but does not match an empty label
set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces
names. Each name supports wildcard characters
"*" (matches zero or many characters) and "?"
(at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label
keys and values in `matchLabels` support the
wildcard characters `*` (matches zero or many
characters) and `?` (matches one character).
Wildcards allows writing label selectors like
[ "storage.k8s.io/*": "*" ] . Note that using ["*"
: "*" ] matches any key and value but does not
match an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role
names for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names
like users, user groups, and service accounts.
items :
description : Subject contains a reference to the
object or user identities a role binding applies
to. This can either hold a direct API object
reference, or a value for non-objects such as
user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of
the referenced subject. Defaults to "" for
ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
for User and Group subjects.
type : string
kind :
description : Kind of object being referenced.
Values defined by this API group are "User",
"Group" , and "ServiceAccount". If the Authorizer
does not recognized the kind value, the Authorizer
should report an error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as
"User" or "Group", and this value is not empty
the Authorizer should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
type : array
any :
description : Any allows specifying resources which will
be ORed
items :
description : ResourceFilter allow users to "AND" or "OR"
between resources
properties :
clusterRoles :
description : ClusterRoles is the list of cluster-wide
role names for the user.
items :
type : string
type : array
resources :
description : ResourceDescription contains information
about the resource being created or modified.
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : 'Name is the name of the resource.
2022-03-15 15:49:16 +01:00
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character). NOTE : "Name" is being deprecated
in favor of "Names".'
2022-03-15 15:49:16 +01:00
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources.
2022-03-15 15:49:16 +01:00
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
2022-04-25 20:20:40 +08:00
character).
2022-03-15 15:49:16 +01:00
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?`
(matches one character).Wildcards allows writing
label selectors like ["storage.k8s.io/*": "*"].
Note that using ["*" : "*"] matches any key
and value but does not match an empty label
set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces
names. Each name supports wildcard characters
"*" (matches zero or many characters) and "?"
(at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label
keys and values in `matchLabels` support the
wildcard characters `*` (matches zero or many
characters) and `?` (matches one character).
Wildcards allows writing label selectors like
[ "storage.k8s.io/*": "*" ] . Note that using ["*"
: "*" ] matches any key and value but does not
match an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of
label selector requirements. The requirements
are ANDed.
items :
description : A label selector requirement
is a selector that contains values, a
key, and an operator that relates the
key and values.
properties :
key :
description : key is the label key that
the selector applies to.
type : string
operator :
description : operator represents a key's
relationship to a set of values. Valid
operators are In, NotIn, Exists and
DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty.
If the operator is Exists or DoesNotExist,
the values array must be empty. This
array is replaced during a strategic
merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is
"In" , and the values array contains only
"value" . The requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role
names for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names
like users, user groups, and service accounts.
items :
description : Subject contains a reference to the
object or user identities a role binding applies
to. This can either hold a direct API object
reference, or a value for non-objects such as
user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of
the referenced subject. Defaults to "" for
ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
for User and Group subjects.
type : string
kind :
description : Kind of object being referenced.
Values defined by this API group are "User",
"Group" , and "ServiceAccount". If the Authorizer
does not recognized the kind value, the Authorizer
should report an error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as
"User" or "Group", and this value is not empty
the Authorizer should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
type : array
clusterRoles :
description : ClusterRoles is the list of cluster-wide role
names for the user.
items :
type : string
type : array
resources :
description : 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.
properties :
annotations :
additionalProperties :
type : string
description : 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).
type : object
kinds :
description : Kinds is a list of resource kinds.
items :
type : string
type : array
name :
2022-04-25 20:20:40 +08:00
description : '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".'
2022-03-15 15:49:16 +01:00
type : string
names :
2022-04-25 20:20:40 +08:00
description : Names are the names of the resources. Each
name supports wildcard characters "*" (matches zero
or many characters) and "?" (at least one character).
2022-03-15 15:49:16 +01:00
items :
type : string
type : array
namespaceSelector :
description : 'NamespaceSelector is a label selector
for the resource namespace. Label keys and values
in `matchLabels` support the wildcard characters `*`
(matches zero or many characters) and `?` (matches
one character).Wildcards allows writing label selectors
like ["storage.k8s.io/*": "*"]. Note that using ["*"
: "*" ] matches any key and value but does not match
an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of label
selector requirements. The requirements are ANDed.
items :
description : A label selector requirement is a
selector that contains values, a key, and an
operator that relates the key and values.
properties :
key :
description : key is the label key that the
selector applies to.
type : string
operator :
description : operator represents a key's relationship
to a set of values. Valid operators are
In, NotIn, Exists and DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty. If the
operator is Exists or DoesNotExist, the
values array must be empty. This array is
replaced during a strategic merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In",
and the values array contains only "value". The
requirements are ANDed.
type : object
type : object
namespaces :
description : Namespaces is a list of namespaces names.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one character).
items :
type : string
type : array
selector :
description : 'Selector is a label selector. Label keys
and values in `matchLabels` support the wildcard characters
`*` (matches zero or many characters) and `?` (matches
one character). Wildcards allows writing label selectors
like ["storage.k8s.io/*": "*"]. Note that using ["*"
: "*" ] matches any key and value but does not match
an empty label set.'
properties :
matchExpressions :
description : matchExpressions is a list of label
selector requirements. The requirements are ANDed.
items :
description : A label selector requirement is a
selector that contains values, a key, and an
operator that relates the key and values.
properties :
key :
description : key is the label key that the
selector applies to.
type : string
operator :
description : operator represents a key's relationship
to a set of values. Valid operators are
In, NotIn, Exists and DoesNotExist.
type : string
values :
description : values is an array of string
values. If the operator is In or NotIn,
the values array must be non-empty. If the
operator is Exists or DoesNotExist, the
values array must be empty. This array is
replaced during a strategic merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value}
pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions,
whose key field is "key", the operator is "In",
and the values array contains only "value". The
requirements are ANDed.
type : object
type : object
type : object
roles :
description : Roles is the list of namespaced role names
for the user.
items :
type : string
type : array
subjects :
description : Subjects is the list of subject names like
users, user groups, and service accounts.
items :
description : Subject contains a reference to the object
or user identities a role binding applies to. This
can either hold a direct API object reference, or a
value for non-objects such as user and group names.
properties :
apiGroup :
description : APIGroup holds the API group of the referenced
subject. Defaults to "" for ServiceAccount subjects.
Defaults to "rbac.authorization.k8s.io" for User
and Group subjects.
type : string
kind :
description : Kind of object being referenced. Values
defined by this API group are "User", "Group", and
"ServiceAccount" . If the Authorizer does not recognized
the kind value, the Authorizer should report an
error.
type : string
name :
description : Name of the object being referenced.
type : string
namespace :
description : Namespace of the referenced object. If
the object kind is non-namespace, such as "User"
or "Group", and this value is not empty the Authorizer
should report an error.
type : string
required :
- kind
- name
type : object
type : array
type : object
mutate :
description : Mutation is used to modify matching resources.
properties :
foreach :
description : 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.
items :
description : 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.
properties :
context :
description : Context defines variables and data sources
that can be used during rule execution.
items :
description : ContextEntry adds variables and data
sources to a rule Context. Either a ConfigMap
reference or a APILookup must be provided.
properties :
apiCall :
description : APICall defines an HTTP request
to the Kubernetes API server. The JSON data
retrieved is stored in the context.
properties :
jmesPath :
description : JMESPath is an optional JSON
Match Expression that can be used to transform
the JSON response returned from the API
server. For example a JMESPath of "items
| length(@)" applied to the API server
response to the URLPath "/apis/apps/v1/deployments"
will return the total count of deployments
across all namespaces.
type : string
urlPath :
description : URLPath is the URL path to
be used in the HTTP GET request to the
Kubernetes API server (e.g. "/api/v1/namespaces"
or "/apis/apps/v1/deployments"). The
format required is the same format used
by the `kubectl get --raw` command.
type : string
required :
- urlPath
type : object
configMap :
description : ConfigMap is the ConfigMap reference.
properties :
name :
description : Name is the ConfigMap name.
type : string
namespace :
description : Namespace is the ConfigMap
namespace.
type : string
required :
- name
type : object
imageRegistry :
description : ImageRegistry defines requests
to an OCI/Docker V2 registry to fetch image
details.
properties :
jmesPath :
description : 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.
type : string
reference :
description : 'Reference is image reference
to a container image in the registry.
Example : ghcr.io/kyverno/kyverno:latest'
type : string
required :
- reference
type : object
name :
description : Name is the variable name.
type : string
2022-04-25 12:06:07 +01:00
variable :
description : Variable defines an arbitrary JMESPath
context variable that can be defined inline.
properties :
default :
description : Default is an optional arbitrary
JSON object that the variable may take
if the JMESPath expression evaluates to
nil
x-kubernetes-preserve-unknown-fields : true
jmesPath :
description : JMESPath is an optional JMESPath
Expression that can be used to transform
the variable.
type : string
value :
description : Value is any arbitrary JSON
object representable in YAML or JSON form.
x-kubernetes-preserve-unknown-fields : true
type : object
2022-03-15 15:49:16 +01:00
type : object
type : array
list :
description : List specifies a JMESPath expression
that results in one or more elements to which the
validation logic is applied.
type : string
patchStrategicMerge :
description : PatchStrategicMerge is a strategic merge
patch used to modify resources. See https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
and https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/.
x-kubernetes-preserve-unknown-fields : true
patchesJson6902 :
description : PatchesJSON6902 is a list of RFC 6902
JSON Patch declarations used to modify resources.
See https://tools.ietf.org/html/rfc6902 and https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/.
type : string
preconditions :
description : 'AnyAllConditions are used to determine
if a policy rule should be applied by evaluating
a set of conditions. The declaration can contain
nested `any` or `all` statements. See : https://kyverno.io/docs/writing-policies/preconditions/'
properties :
all :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry (using
JMESPath) for conditional rule evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
description : 'Operator is the conditional
operation to perform. Valid operators
are : Equals, NotEquals, In, AnyIn, AllIn,
NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals,
GreaterThan, LessThanOrEquals, LessThan,
DurationGreaterThanOrEquals, DurationGreaterThan,
DurationLessThanOrEquals, DurationLessThan'
enum :
- Equals
- NotEquals
- In
- AnyIn
- AllIn
- NotIn
- AnyNotIn
- AllNotIn
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional value,
or set of values. The values can be fixed
set or can be variables declared using
2022-04-11 08:47:27 -07:00
JMESPath.
2022-03-15 15:49:16 +01:00
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
any :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry (using
JMESPath) for conditional rule evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
description : 'Operator is the conditional
operation to perform. Valid operators
are : Equals, NotEquals, In, AnyIn, AllIn,
NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals,
GreaterThan, LessThanOrEquals, LessThan,
DurationGreaterThanOrEquals, DurationGreaterThan,
DurationLessThanOrEquals, DurationLessThan'
enum :
- Equals
- NotEquals
- In
- AnyIn
- AllIn
- NotIn
- AnyNotIn
- AllNotIn
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional value,
or set of values. The values can be fixed
set or can be variables declared using
2022-04-11 08:47:27 -07:00
JMESPath.
2022-03-15 15:49:16 +01:00
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
type : object
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
patchStrategicMerge :
description : PatchStrategicMerge is a strategic merge patch
used to modify resources. See https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
and https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/.
x-kubernetes-preserve-unknown-fields : true
patchesJson6902 :
description : PatchesJSON6902 is a list of RFC 6902 JSON
Patch declarations used to modify resources. See https://tools.ietf.org/html/rfc6902
and https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/.
type : string
2022-04-25 20:20:40 +08:00
targets :
description : Targets defines the target resources to be
mutated.
items :
properties :
apiVersion :
description : APIVersion specifies resource apiVersion.
type : string
kind :
description : Kind specifies resource kind.
type : string
name :
description : Name specifies the resource name.
maxLength : 63
type : string
namespace :
description : Namespace specifies resource namespace.
type : string
type : object
type : array
2022-03-15 15:49:16 +01:00
type : object
name :
description : Name is a label to identify the rule, It must be
unique within the policy.
maxLength : 63
type : string
preconditions :
description : 'Preconditions are used to determine if a policy
rule should be applied by evaluating a set of conditions.
The declaration can contain nested `any` or `all` statements.
A direct list of conditions (without `any` or `all` statements
is supported for backwards compatibility but will be deprecated
in the next major release. See : https://kyverno.io/docs/writing-policies/preconditions/'
x-kubernetes-preserve-unknown-fields : true
validate :
description : Validation is used to validate matching resources.
properties :
anyPattern :
description : AnyPattern specifies list of validation patterns.
At least one of the patterns must be satisfied for the
validation rule to succeed.
x-kubernetes-preserve-unknown-fields : true
deny :
description : Deny defines conditions used to pass or fail
a validation rule.
properties :
conditions :
description : 'Multiple conditions can be declared under
an `any` or `all` statement. A direct list of conditions
(without `any` or `all` statements) is also supported
for backwards compatibility but will be deprecated
in the next major release. See : https://kyverno.io/docs/writing-policies/validate/#deny-rules'
x-kubernetes-preserve-unknown-fields : true
type : object
foreach :
description : 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.
items :
description : 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.
properties :
anyPattern :
description : AnyPattern specifies list of validation
patterns. At least one of the patterns must be satisfied
for the validation rule to succeed.
x-kubernetes-preserve-unknown-fields : true
context :
description : Context defines variables and data sources
that can be used during rule execution.
items :
description : ContextEntry adds variables and data
sources to a rule Context. Either a ConfigMap
reference or a APILookup must be provided.
properties :
apiCall :
description : APICall defines an HTTP request
to the Kubernetes API server. The JSON data
retrieved is stored in the context.
properties :
jmesPath :
description : JMESPath is an optional JSON
Match Expression that can be used to transform
the JSON response returned from the API
server. For example a JMESPath of "items
| length(@)" applied to the API server
response to the URLPath "/apis/apps/v1/deployments"
will return the total count of deployments
across all namespaces.
type : string
urlPath :
description : URLPath is the URL path to
be used in the HTTP GET request to the
Kubernetes API server (e.g. "/api/v1/namespaces"
or "/apis/apps/v1/deployments"). The
format required is the same format used
by the `kubectl get --raw` command.
type : string
required :
- urlPath
type : object
configMap :
description : ConfigMap is the ConfigMap reference.
properties :
name :
description : Name is the ConfigMap name.
type : string
namespace :
description : Namespace is the ConfigMap
namespace.
type : string
required :
- name
type : object
imageRegistry :
description : ImageRegistry defines requests
to an OCI/Docker V2 registry to fetch image
details.
properties :
jmesPath :
description : 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.
type : string
reference :
description : 'Reference is image reference
to a container image in the registry.
Example : ghcr.io/kyverno/kyverno:latest'
type : string
required :
- reference
type : object
name :
description : Name is the variable name.
type : string
2022-04-25 12:06:07 +01:00
variable :
description : Variable defines an arbitrary JMESPath
context variable that can be defined inline.
properties :
default :
description : Default is an optional arbitrary
JSON object that the variable may take
if the JMESPath expression evaluates to
nil
x-kubernetes-preserve-unknown-fields : true
jmesPath :
description : JMESPath is an optional JMESPath
Expression that can be used to transform
the variable.
type : string
value :
description : Value is any arbitrary JSON
object representable in YAML or JSON form.
x-kubernetes-preserve-unknown-fields : true
type : object
2022-03-15 15:49:16 +01:00
type : object
type : array
deny :
description : Deny defines conditions used to pass
or fail a validation rule.
properties :
conditions :
description : 'Multiple conditions can be declared
under an `any` or `all` statement. A direct
list of conditions (without `any` or `all` statements)
is also supported for backwards compatibility
but will be deprecated in the next major release.
See : https://kyverno.io/docs/writing-policies/validate/#deny-rules'
x-kubernetes-preserve-unknown-fields : true
type : object
elementScope :
description : 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.
type : boolean
list :
description : List specifies a JMESPath expression
that results in one or more elements to which the
validation logic is applied.
type : string
pattern :
description : Pattern specifies an overlay-style pattern
used to check resources.
x-kubernetes-preserve-unknown-fields : true
preconditions :
description : 'AnyAllConditions are used to determine
if a policy rule should be applied by evaluating
a set of conditions. The declaration can contain
nested `any` or `all` statements. See : https://kyverno.io/docs/writing-policies/preconditions/'
properties :
all :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry (using
JMESPath) for conditional rule evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
description : 'Operator is the conditional
operation to perform. Valid operators
are : Equals, NotEquals, In, AnyIn, AllIn,
NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals,
GreaterThan, LessThanOrEquals, LessThan,
DurationGreaterThanOrEquals, DurationGreaterThan,
DurationLessThanOrEquals, DurationLessThan'
enum :
- Equals
- NotEquals
- In
- AnyIn
- AllIn
- NotIn
- AnyNotIn
- AllNotIn
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional value,
or set of values. The values can be fixed
set or can be variables declared using
2022-04-11 08:47:27 -07:00
JMESPath.
2022-03-15 15:49:16 +01:00
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
any :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry (using
JMESPath) for conditional rule evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
description : 'Operator is the conditional
operation to perform. Valid operators
are : Equals, NotEquals, In, AnyIn, AllIn,
NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals,
GreaterThan, LessThanOrEquals, LessThan,
DurationGreaterThanOrEquals, DurationGreaterThan,
DurationLessThanOrEquals, DurationLessThan'
enum :
- Equals
- NotEquals
- In
- AnyIn
- AllIn
- NotIn
- AnyNotIn
- AllNotIn
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional value,
or set of values. The values can be fixed
set or can be variables declared using
2022-04-11 08:47:27 -07:00
JMESPath.
2022-03-15 15:49:16 +01:00
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
type : object
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
message :
description : Message specifies a custom message to be displayed
on failure.
type : string
pattern :
description : Pattern specifies an overlay-style pattern
used to check resources.
x-kubernetes-preserve-unknown-fields : true
type : object
verifyImages :
description : VerifyImages is used to verify image signatures
and mutate them to add a digest
items :
description : 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.
properties :
2022-03-17 09:42:12 +01:00
additionalExtensions :
additionalProperties :
type : string
description : AdditionalExtensions are certificate-extensions
2022-04-11 08:47:27 -07:00
used for keyless signing. Deprecated.
2022-03-17 09:42:12 +01:00
type : object
2022-03-15 15:49:16 +01:00
annotations :
additionalProperties :
type : string
description : Annotations are used for image verification.
Every specified key-value pair must exist and match
in the verified payload. The payload may contain other
2022-04-19 08:35:12 -07:00
key-value pairs. Deprecated. Use annotations per Attestor
instead.
2022-03-15 15:49:16 +01:00
type : object
attestations :
description : Attestations are optional checks for signed
in-toto Statements used to verify the image. See https://github.com/in-toto/attestation.
Kyverno fetches signed attestations from the OCI registry
and decodes them into a list of Statement declarations.
items :
description : Attestation are checks for signed in-toto
Statements that are used to verify the image. See
https://github.com/in-toto/attestation. Kyverno fetches
signed attestations from the OCI registry and decodes
them into a list of Statements.
properties :
conditions :
description : 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.
items :
description : 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.
properties :
all :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry
(using JMESPath) for conditional rule
evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
description : 'Operator is the conditional
operation to perform. Valid operators
are : Equals, NotEquals, In, AnyIn,
AllIn, NotIn, AnyNotIn, AllNotIn,
GreaterThanOrEquals, GreaterThan,
LessThanOrEquals, LessThan, DurationGreaterThanOrEquals,
DurationGreaterThan, DurationLessThanOrEquals,
DurationLessThan'
enum :
- Equals
- NotEquals
- In
- AnyIn
- AllIn
- NotIn
- AnyNotIn
- AllNotIn
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional
value, or set of values. The values
can be fixed set or can be variables
2022-04-11 08:47:27 -07:00
declared using JMESPath.
2022-03-15 15:49:16 +01:00
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
any :
description : 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
items :
description : Condition defines variable-based
conditional criteria for rule execution.
properties :
key :
description : Key is the context entry
(using JMESPath) for conditional rule
evaluation.
x-kubernetes-preserve-unknown-fields : true
operator :
description : 'Operator is the conditional
operation to perform. Valid operators
are : Equals, NotEquals, In, AnyIn,
AllIn, NotIn, AnyNotIn, AllNotIn,
GreaterThanOrEquals, GreaterThan,
LessThanOrEquals, LessThan, DurationGreaterThanOrEquals,
DurationGreaterThan, DurationLessThanOrEquals,
DurationLessThan'
enum :
- Equals
- NotEquals
- In
- AnyIn
- AllIn
- NotIn
- AnyNotIn
- AllNotIn
- GreaterThanOrEquals
- GreaterThan
- LessThanOrEquals
- LessThan
- DurationGreaterThanOrEquals
- DurationGreaterThan
- DurationLessThanOrEquals
- DurationLessThan
type : string
value :
description : Value is the conditional
value, or set of values. The values
can be fixed set or can be variables
2022-04-11 08:47:27 -07:00
declared using JMESPath.
2022-03-15 15:49:16 +01:00
x-kubernetes-preserve-unknown-fields : true
type : object
type : array
type : object
type : array
predicateType :
description : PredicateType defines the type of Predicate
contained within the Statement.
type : string
type : object
type : array
2022-04-11 08:47:27 -07:00
attestors :
description : Attestors specified the required attestors
(i.e. authorities)
items :
properties :
count :
description : Count specifies the required number
of entries that must match. If the count is null,
all entries must match (a logical AND). If the
count is 1, at least one entry must match (a logical
OR). If the count contains a value N, then N must
be less than or equal to the size of entries,
and at least N entries must match.
minimum : 1
type : integer
entries :
description : Entries contains the available attestors.
An attestor can be a static key, attributes for
keyless verification, or a nested attestor declaration.
items :
properties :
2022-04-19 08:35:12 -07:00
annotations :
additionalProperties :
type : string
description : 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.
type : object
attestor :
description : Attestor is a nested AttestorSet
2022-04-11 08:47:27 -07:00
used to specify a more complex set of match
2022-04-19 08:35:12 -07:00
authorities
x-kubernetes-preserve-unknown-fields : true
2022-04-11 08:47:27 -07:00
keyless :
description : Keyless is a set of attribute
used to verify a Sigstore keyless attestor.
See https://github.com/sigstore/cosign/blob/main/KEYLESS.md.
properties :
additionalExtensions :
additionalProperties :
type : string
description : AdditionalExtensions are
certificate-extensions used for keyless
signing.
type : object
2022-04-19 08:35:12 -07:00
intermediates :
description : Intermediates is an optional
PEM encoded set of certificates that
are not trust anchors, but can be used
to form a chain from the leaf certificate
to a root certificate.
type : string
2022-04-11 08:47:27 -07:00
issuer :
description : Issuer is the certificate
issuer used for keyless signing.
type : string
2022-04-22 00:10:02 -07:00
rekor :
description : Rekor provides information
of the Rekor transparency log service.
If the value is nil, Rekor is not checked
and a root certificate chain is expected
instead. If an empty object is provided
the public instance of Rekor (https://rekor.sigstore.dev)
is used.
properties :
url :
description : URL is the address of
the transparency log. Defaults to
the public log https://rekor.sigstore.dev.
type : string
required :
- url
type : object
2022-04-11 08:47:27 -07:00
roots :
2022-04-19 08:35:12 -07:00
description : Roots is an optional set
of PEM encoded trusted root certificates.
If not provided, the system roots are
used.
2022-04-11 08:47:27 -07:00
type : string
subject :
description : Subject is the verified identity
used for keyless signing, for example
the email address
type : string
type : object
2022-04-19 08:35:12 -07:00
repository :
description : 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.
type : string
2022-04-11 08:47:27 -07:00
staticKey :
description : StaticKey is a set of attributes
used to verify an X.509 public key
properties :
2022-04-19 08:35:12 -07:00
intermediates :
description : Intermediates is an optional
PEM encoded set of certificates that
are not trust anchors, but can be used
to form a chain from the leaf certificate
to a root certificate.
type : string
2022-04-11 08:47:27 -07:00
key :
2022-04-22 00:10:02 -07:00
description : Keys is a set of X.509 public
keys used to verify image signatures.
The keys can be directly specified or
can be a variable reference to a key
specified in a ConfigMap (see https://kyverno.io/docs/writing-policies/variables/).
When multiple keys are specified each
key is processed as a separate staticKey
entry (.attestors[*].entries.staticKey)
within the set of attestors and the
count is applied across the keys.
2022-04-11 08:47:27 -07:00
type : string
2022-04-19 08:35:12 -07:00
roots :
description : Roots is an optional set
of PEM encoded trusted root certificates.
If not provided, the system roots are
used.
type : string
2022-04-11 08:47:27 -07:00
type : object
type : object
type : array
type : object
type : array
2022-03-15 15:49:16 +01:00
image :
description : 'Image is the image name consisting of the
registry address, repository, image, and tag. Wildcards
2022-04-11 08:47:27 -07:00
(''*'' and ''?'') are allowed. See : https://kubernetes.io/docs/concepts/containers/images.
Deprecated. Use ImageReferences instead.'
2022-03-15 15:49:16 +01:00
type : string
2022-04-11 08:47:27 -07:00
imageReferences :
description : 'ImageReferences is a list of matching image
reference patterns. At least one pattern in the list
must match the image for the rule to apply. Each image
reference consists of a registry address (defaults to
docker.io), repository, image, and tag (defaults to
latest). Wildcards (''*'' and ''?'') are allowed. See :
https://kubernetes.io/docs/concepts/containers/images.'
items :
type : string
type : array
2022-03-15 15:49:16 +01:00
issuer :
description : Issuer is the certificate issuer used for
2022-04-11 08:47:27 -07:00
keyless signing. Deprecated. Use KeylessAttestor instead.
2022-03-15 15:49:16 +01:00
type : string
key :
description : Key is the PEM encoded public key that the
2022-04-11 08:47:27 -07:00
image or attestation is signed with. Deprecated. Use
StaticKeyAttestor instead.
2022-03-15 15:49:16 +01:00
type : string
2022-04-22 13:38:49 +05:30
mutateDigest :
default : true
2022-04-27 08:09:52 -07:00
description : MutateDigest enables replacement of image
tags with digests. Defaults to true.
2022-04-22 13:38:49 +05:30
type : boolean
2022-03-15 15:49:16 +01:00
repository :
description : Repository is an optional alternate OCI repository
2022-04-19 08:35:12 -07:00
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.
2022-03-15 15:49:16 +01:00
type : string
2022-04-27 08:09:52 -07:00
required :
default : true
description : Required validates that images are verified
i.e. have matched passed a signature or attestation
check.
type : boolean
2022-03-15 15:49:16 +01:00
roots :
description : Roots is the PEM encoded Root certificate
2022-04-11 08:47:27 -07:00
chain used for keyless signing Deprecated. Use KeylessAttestor
instead.
2022-03-15 15:49:16 +01:00
type : string
subject :
2022-04-11 08:47:27 -07:00
description : Subject is the identity used for keyless
signing, for example an email address Deprecated. Use
KeylessAttestor instead.
2022-03-15 15:49:16 +01:00
type : string
2022-04-27 08:09:52 -07:00
verifyDigest :
default : true
description : VerifyDigest validates that images have a
digest.
type : boolean
2022-03-15 15:49:16 +01:00
type : object
type : array
type : object
type : array
2021-09-23 16:13:27 -07:00
required :
- ready
2020-11-12 16:44:14 -08:00
type : object
required :
- spec
type : object
served : true
storage : true
2020-11-12 19:48:39 -08:00
subresources :
status : {}
2020-11-12 16:44:14 -08:00
status :
acceptedNames :
kind : ""
plural : ""
conditions : [ ]
storedVersions : [ ]
