PolicyException (kyverno.io/v2beta1)

Type: object

PolicyException declares resources to be excluded from specified policies.

Type: string

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

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

No Additional Items

Each item of this array must be:

Type: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Manager is an identifier of the workflow managing these fields.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: boolean

If true, this reference points to the managing controller.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

Spec declares policy exception behaviors.

Type: boolean

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

Type: object

Conditions are used to determine if a resource applies to the exception by evaluating a
set of conditions. The declaration can contain nested any or all statements.

Type: array of object

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.

No Additional Items

Each item of this array must be:

Type: object

Type: object

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

Type: string

Message is an optional display message

Type: enum (of string)

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

Must be one of:

  • "Equals"
  • "NotEquals"
  • "AnyIn"
  • "AllIn"
  • "AnyNotIn"
  • "AllNotIn"
  • "GreaterThanOrEquals"
  • "GreaterThan"
  • "LessThanOrEquals"
  • "LessThan"
  • "DurationGreaterThanOrEquals"
  • "DurationGreaterThan"
  • "DurationLessThanOrEquals"
  • "DurationLessThan"

Type: object

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

Type: array of object

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.

No Additional Items

Each item of this array must be:

Type: object

Type: object

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

Type: string

Message is an optional display message

Type: enum (of string)

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

Must be one of:

  • "Equals"
  • "NotEquals"
  • "AnyIn"
  • "AllIn"
  • "AnyNotIn"
  • "AllNotIn"
  • "GreaterThanOrEquals"
  • "GreaterThan"
  • "LessThanOrEquals"
  • "LessThan"
  • "DurationGreaterThanOrEquals"
  • "DurationGreaterThan"
  • "DurationLessThanOrEquals"
  • "DurationLessThan"

Type: object

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

Type: array of object

Exceptions is a list policy/rules to be excluded

No Additional Items

Each item of this array must be:

Type: object

Exception stores infos about a policy and rules

Type: string

PolicyName identifies the policy to which the exception is applied.
The policy name uses the format <namespace>/<name> unless it
references a ClusterPolicy.

Type: array of string

RuleNames identifies the rules to which the exception is applied.

No Additional Items

Each item of this array must be:

Type: object

Match defines match clause used to check if a resource applies to the exception

Type: array of object

All allows specifying resources which will be ANDed

No Additional Items

Each item of this array must be:

Type: object

ResourceFilter allow users to "AND" or "OR" between resources

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: object

ResourceDescription contains information about the resource being created or modified.

Type: object

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

Each additional property must conform to the following schema

Type: string

Type: array of string

Kinds is a list of resource kinds.

No Additional Items

Each item of this array must be:

Type: string

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

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: object

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.

Type: array of object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

No Additional Items

Each item of this array must be:

Type: object

A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

Type: string

key is the label key that the selector applies to.

Type: string

operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

Type: array of string

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.

No Additional Items

Each item of this array must be:

Type: object

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.

Each additional property must conform to the following schema

Type: string

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: array of enum (of string)

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

No Additional Items

Each item of this array must be:

Type: enum (of string)

AdmissionOperation can have one of the values CREATE, UPDATE, CONNECT, DELETE, which are used to match a specific action.

Must be one of:

  • "CREATE"
  • "CONNECT"
  • "UPDATE"
  • "DELETE"

Type: object

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.

Type: array of object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

No Additional Items

Each item of this array must be:

Type: object

A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

Type: string

key is the label key that the selector applies to.

Type: string

operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

Type: array of string

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.

No Additional Items

Each item of this array must be:

Type: object

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.

Each additional property must conform to the following schema

Type: string

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

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.

Type: string

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 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 of the object being referenced.

Type: string

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: array of object

Any allows specifying resources which will be ORed

No Additional Items

Each item of this array must be:

Type: object

ResourceFilter allow users to "AND" or "OR" between resources

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: object

ResourceDescription contains information about the resource being created or modified.

Type: object

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

Each additional property must conform to the following schema

Type: string

Type: array of string

Kinds is a list of resource kinds.

No Additional Items

Each item of this array must be:

Type: string

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

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: object

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.

Type: array of object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

No Additional Items

Each item of this array must be:

Type: object

A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

Type: string

key is the label key that the selector applies to.

Type: string

operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

Type: array of string

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.

No Additional Items

Each item of this array must be:

Type: object

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.

Each additional property must conform to the following schema

Type: string

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: array of enum (of string)

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

No Additional Items

Each item of this array must be:

Type: enum (of string)

AdmissionOperation can have one of the values CREATE, UPDATE, CONNECT, DELETE, which are used to match a specific action.

Must be one of:

  • "CREATE"
  • "CONNECT"
  • "UPDATE"
  • "DELETE"

Type: object

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.

Type: array of object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

No Additional Items

Each item of this array must be:

Type: object

A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

Type: string

key is the label key that the selector applies to.

Type: string

operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

Type: array of string

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.

No Additional Items

Each item of this array must be:

Type: object

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.

Each additional property must conform to the following schema

Type: string

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

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.

Type: string

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 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 of the object being referenced.

Type: string

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: array of object

PodSecurity specifies the Pod Security Standard controls to be excluded.
Applicable only to policies that have validate.podSecurity subrule.

No Additional Items

Each item of this array must be:

Type: object

PodSecurityStandard specifies the Pod Security Standard controls to be excluded.

Type: enum (of string)

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

Must be one of:

  • "HostProcess"
  • "Host Namespaces"
  • "Privileged Containers"
  • "Capabilities"
  • "HostPath Volumes"
  • "Host Ports"
  • "AppArmor"
  • "SELinux"
  • "/proc Mount Type"
  • "Seccomp"
  • "Sysctls"
  • "Volume Types"
  • "Privilege Escalation"
  • "Running as Non-root"
  • "Running as Non-root user"

Type: array of string

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

No Additional Items

Each item of this array must be:

Type: string

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

Type: array of string

Values defines the allowed values that can be excluded.

No Additional Items

Each item of this array must be: