Skip to content

v1alpha1

Package v1alpha1 contains API Schema definitions for the policy v1alpha1 API group

Resource Types

ValidatingPolicy

Appears in:

ValidatingPolicy is the resource that contains the policy definition.

Field Type Required Inline Description
apiVersion string ✅ json.kyverno.io/v1alpha1
kind string ✅ ValidatingPolicy
metadata meta/v1.ObjectMeta

Standard object's metadata.

spec ValidatingPolicySpec ✅

Policy spec.

ValidatingPolicyList

ValidatingPolicyList is a list of ValidatingPolicy instances.

Field Type Required Inline Description
apiVersion string ✅ json.kyverno.io/v1alpha1
kind string ✅ ValidatingPolicyList
metadata meta/v1.ListMeta ✅ No description provided.
items []ValidatingPolicy ✅ No description provided.

Any

Appears in:

Any can be any type.

Field Type Required Inline Description

Assert

Appears in:

Assert defines collections of assertions.

Field Type Required Inline Description
compiler Compiler

Compiler defines the default compiler to use when evaluating expressions.

any []Assertion

Any allows specifying assertions which will be ORed.

all []Assertion

All allows specifying assertions which will be ANDed.

Assertion

Appears in:

Assertion contains an assertion tree associated with a message.

Field Type Required Inline Description
compiler Compiler

Compiler defines the default compiler to use when evaluating expressions.

message Message

Message is the message associated message.

check AssertionTree ✅

Check is the assertion check definition.

AssertionTree

Appears in:

AssertionTree represents an assertion tree.

Field Type Required Inline Description

Compiler

(Alias of string)

Appears in:

Compiler defines the compiler to use when evaluating expressions.

ContextEntry

Appears in:

ContextEntry adds variables and data sources to a rule context.

Field Type Required Inline Description
compiler Compiler

Compiler defines the default compiler to use when evaluating expressions.

name string ✅

Name is the entry name.

variable Any

Variable defines an arbitrary variable.

Feedback

Appears in:

Feedback contains a feedback entry.

Field Type Required Inline Description
compiler Compiler

Compiler defines the default compiler to use when evaluating expressions.

name string ✅

Name is the feedback entry name.

value Any

Value is the feedback entry value (a JMESPath expression).

Match

Appears in:

Match defines collections of assertion trees.

Field Type Required Inline Description
compiler Compiler

Compiler defines the default compiler to use when evaluating expressions.

any []AssertionTree

Any allows specifying assertion trees which will be ORed.

all []AssertionTree

All allows specifying assertion trees which will be ANDed.

Message

Appears in:

Message stores a message template.

Field Type Required Inline Description

ValidatingPolicySpec

Appears in:

ValidatingPolicySpec contains the policy spec.

Field Type Required Inline Description
compiler Compiler

Compiler defines the default compiler to use when evaluating expressions.

rules []ValidatingRule ✅

Rules is a list of ValidatingRule instances.

ValidatingRule

Appears in:

ValidatingRule defines a validating rule.

Field Type Required Inline Description
name string ✅

Name is a label to identify the rule, It must be unique within the policy.

compiler Compiler

Compiler defines the default compiler to use when evaluating expressions.

context []ContextEntry

Context defines variables and data sources that can be used during rule execution.

match Match

Match defines when this policy rule should be applied.

exclude Match

Exclude defines when this policy rule should not be applied.

identifier string

Identifier declares a JMESPath expression to extract a name from the payload.

feedback []Feedback

Feedback declares rule feedback entries.

assert Assert ✅

Assert is used to validate matching resources.