2020-11-12 19:48:39 -08:00
---
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
controller-gen.kubebuilder.io/version : v0.4.0
creationTimestamp : null
name : clusterpolicies.kyverno.io
spec :
group : kyverno.io
names :
kind : ClusterPolicy
listKind : ClusterPolicyList
plural : clusterpolicies
shortNames :
- cpol
singular : clusterpolicy
scope : Cluster
versions :
- additionalPrinterColumns :
- jsonPath : .spec.background
name : Background
type : string
- jsonPath : .spec.validationFailureAction
2020-11-30 11:22:20 -08: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
schema :
openAPIV3Schema :
2020-11-16 11:47:16 -08:00
description : ClusterPolicy declares validation, mutation, and generation behaviors
for matching resources.
2020-11-12 19:48:39 -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 :
2020-11-16 11:47:16 -08:00
description : Spec declares policy behaviors.
2020-11-12 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -08:00
configMap :
2021-02-01 12:59:13 -08:00
description : ConfigMap is the ConfigMap reference.
2020-11-12 19:48:39 -08:00
properties :
name :
2021-02-01 12:59:13 -08:00
description : Name is the ConfigMap name.
2020-11-12 19:48:39 -08:00
type : string
namespace :
2021-02-01 12:59:13 -08:00
description : Namespace is the ConfigMap namespace.
2020-11-12 19:48:39 -08:00
type : string
2021-02-01 12:59:13 -08:00
required :
- name
2020-11-12 19:48:39 -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 19:48:39 -08:00
name :
2021-02-01 12:59:13 -08:00
description : Name is the variable name.
2020-11-12 19:48:39 -08:00
type : string
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 19:48:39 -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 :
description : Name is the name of the resource.
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
character).
type : string
names :
description : 'Names are the names of the resources.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
character). NOTE : "Name" is being deprecated
in favor of "Names".'
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 :
description : Name is the name of the resource.
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
character).
type : string
names :
description : 'Names are the names of the resources.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
character). NOTE : "Name" is being deprecated
in favor of "Names".'
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 19:48:39 -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 19:48:39 -08:00
items :
type : string
type : array
resources :
2020-11-15 22:47:55 -08:00
description : ResourceDescription contains information about
2021-10-05 00:27:39 +05:30
the resource being created or modified. Specifying ResourceDescription
directly under exclude is being deprecated. Please specify
under "any" or "all" instead.
2020-11-12 19:48:39 -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 19:48:39 -08:00
type : object
kinds :
2020-11-15 22:47:55 -08:00
description : Kinds is a list of resource kinds.
2020-11-12 19:48:39 -08:00
items :
type : string
type : array
name :
2020-11-15 22:47:55 -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).
2020-11-12 19:48:39 -08:00
type : string
2021-06-29 11:01:22 +05:30
names :
2021-07-07 00:04:06 +05:30
description : 'Names are the names of the resources.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one character).
NOTE : "Name" is being deprecated in favor of "Names".'
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 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -08:00
properties :
apiVersion :
2020-11-15 22:47:55 -08:00
description : APIVersion specifies resource apiVersion.
2020-11-12 19:48:39 -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 19:48:39 -08:00
properties :
name :
2020-11-15 22:47:55 -08:00
description : Name specifies name of the resource.
2020-11-12 19:48:39 -08:00
type : string
namespace :
2020-11-15 22:47:55 -08:00
description : Namespace specifies source resource namespace.
2020-11-12 19:48:39 -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 19:48:39 -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 19:48:39 -08:00
type : string
name :
2020-11-15 22:47:55 -08:00
description : Name specifies the resource name.
2020-11-12 19:48:39 -08:00
type : string
namespace :
2020-11-15 22:47:55 -08:00
description : Namespace specifies resource namespace.
2020-11-12 19:48:39 -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 19:48:39 -08:00
type : boolean
type : object
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 19:48:39 -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 :
description : Name is the name of the resource.
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
character).
type : string
names :
description : 'Names are the names of the resources.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
character). NOTE : "Name" is being deprecated
in favor of "Names".'
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 :
description : Name is the name of the resource.
The name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
character).
type : string
names :
description : 'Names are the names of the resources.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one
character). NOTE : "Name" is being deprecated
in favor of "Names".'
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 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -08:00
type : object
kinds :
2020-11-15 22:47:55 -08:00
description : Kinds is a list of resource kinds.
2020-11-12 19:48:39 -08:00
items :
type : string
type : array
name :
2020-11-15 22:47:55 -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).
2020-11-12 19:48:39 -08:00
type : string
2021-06-29 11:01:22 +05:30
names :
2021-07-07 00:04:06 +05:30
description : 'Names are the names of the resources.
Each name supports wildcard characters "*" (matches
zero or many characters) and "?" (at least one character).
NOTE : "Name" is being deprecated in favor of "Names".'
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 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -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
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
using JMESPath.
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
using JMESPath.
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 19:48:39 -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 19:48:39 -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 19:48:39 -08:00
type : string
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 19:48:39 -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 19:48:39 -08:00
validate :
2020-12-01 23:19:08 -08:00
description : Validation is used to validate matching resources.
2020-11-12 19:48:39 -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 19:48:39 -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 19:48:39 -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 19:48:39 -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
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
using JMESPath.
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
using JMESPath.
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 19:48:39 -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 19:48:39 -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 19:48:39 -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 :
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
key-value pairs.
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
declared using using JMESPath.
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
declared using using JMESPath.
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
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
(''*'' and ''?'') are allowed. See : https://kubernetes.io/docs/concepts/containers/images.'
type : string
2021-12-16 11:49:44 +05:30
issuer :
description : Issuer is the certificate issuer used for
keyless signing.
type : string
2021-07-09 18:01:46 -07:00
key :
description : Key is the PEM encoded public key that the
2021-10-06 00:58:45 -07:00
image or attestation is signed with.
2021-07-09 18:01:46 -07:00
type : string
2021-09-16 16:11:38 -07:00
repository :
description : Repository is an optional alternate OCI repository
to use for image signatures that match this rule. If
specified Repository will override the default OCI image
repository configured for the installation.
type : string
2021-11-04 23:26:22 -07:00
roots :
description : Roots is the PEM encoded Root certificate
chain used for keyless signing
type : string
subject :
description : Subject is the verified identity used for
keyless signing, for example the email address
type : string
2021-07-09 18:01:46 -07:00
type : object
type : array
2020-11-12 19:48:39 -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 19:48:39 -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 19:48:39 -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 :
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 19:48:39 -08:00
type : object
status :
2020-11-16 11:47:16 -08:00
description : Status contains policy runtime data.
2020-11-12 19:48:39 -08:00
properties :
2021-09-23 16:13:27 -07:00
ready :
description : Ready indicates if the policy is ready to serve the admission
request
type : boolean
required :
- ready
2020-11-12 19:48:39 -08:00
type : object
required :
- spec
type : object
served : true
storage : true
subresources :
status : {}
status :
acceptedNames :
kind : ""
plural : ""
conditions : [ ]
storedVersions : [ ]
