Custom Resource Definitions (CRD)
You can find the definitions for the Kubewarden Custom Resources both on this page and here at docs.crds.dev.
API Reference
policies.kubewarden.io/v1
Package v1 contains API Schema definitions for the policies v1 API group
AdmissionPolicy
AdmissionPolicy is the Schema for the admissionpolicies API
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
AdmissionPolicyGroup
AdmissionPolicyGroup is the Schema for the AdmissionPolicyGroups API
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
AdmissionPolicyGroupList
AdmissionPolicyGroupList contains a list of AdmissionPolicyGroup.
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
AdmissionPolicyGroupSpec
AdmissionPolicyGroupSpec defines the desired state of AdmissionPolicyGroup.
Field | Description | Default | Validation |
---|---|---|---|
|
AdmissionPolicyList
AdmissionPolicyList contains a list of AdmissionPolicy.
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
AdmissionPolicySpec
AdmissionPolicySpec defines the desired state of AdmissionPolicy.
Field | Description | Default | Validation |
---|---|---|---|
|
ClusterAdmissionPolicy
ClusterAdmissionPolicy is the Schema for the clusteradmissionpolicies API
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
ClusterAdmissionPolicyGroup
ClusterAdmissionPolicyGroup is the Schema for the clusteradmissionpolicies API
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
ClusterAdmissionPolicyGroupList
ClusterAdmissionPolicyGroupList contains a list of ClusterAdmissionPolicyGroup
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
ClusterAdmissionPolicyGroupSpec
ClusterAdmissionPolicyGroupSpec defines the desired state of ClusterAdmissionPolicyGroup.
Field | Description | Default | Validation |
---|---|---|---|
|
|||
|
NamespaceSelector decides whether to run the webhook on an object based |
ClusterAdmissionPolicyList
ClusterAdmissionPolicyList contains a list of ClusterAdmissionPolicy
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
ClusterAdmissionPolicySpec
ClusterAdmissionPolicySpec defines the desired state of ClusterAdmissionPolicy.
Field | Description | Default | Validation |
---|---|---|---|
|
|||
|
NamespaceSelector decides whether to run the webhook on an object based |
||
|
List of Kubernetes resources the policy is allowed to access at evaluation time. |
ContextAwareResource
ContextAwareResource identifies a Kubernetes resource.
Field | Description | Default | Validation |
---|---|---|---|
|
apiVersion of the resource (v1 for core group, groupName/groupVersions for other). |
||
|
Singular PascalCase name of the resource |
PolicyGroupMember
Field | Description | Default | Validation |
---|---|---|---|
|
Module is the location of the WASM module to be loaded. Can be a |
Required: {} |
|
|
Settings is a free-form object that contains the policy configuration |
||
|
List of Kubernetes resources the policy is allowed to access at evaluation time. |
PolicyGroupMembers
Underlying type: map[string]PolicyGroupMember
PolicyGroupSpec
Field | Description | Default | Validation |
---|---|---|---|
|
PolicyServer identifies an existing PolicyServer resource. |
default |
|
|
Mode defines the execution mode of this policy. Can be set to |
protect |
Enum: [protect monitor] |
|
Rules describes what operations on what resources/subresources the webhook cares about. |
||
|
FailurePolicy defines how unrecognized errors and timeout errors from the |
||
|
BackgroundAudit indicates whether a policy should be used or skipped when |
true |
|
|
matchPolicy defines how the "rules" list is used to match incoming requests. |
||
|
MatchConditions are a list of conditions that must be met for a request to be |
||
|
ObjectSelector decides whether to run the webhook based on if the |
||
|
SideEffects states whether this webhook has side effects. |
||
|
TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, |
10 |
|
|
Expression is the evaluation expression to accept or reject the |
Required: {} |
|
|
Message is used to specify the message that will be returned when |
Required: {} |
|
|
Policies is a list of policies that are part of the group that will |
Required: {} |
PolicyServer
PolicyServer is the Schema for the policyservers API.
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
PolicyServerList
PolicyServerList contains a list of PolicyServer.
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
PolicyServerSecurity
PolicyServerSecurity defines securityContext configuration to be used in the Policy Server workload.
Field | Description | Default | Validation |
---|---|---|---|
|
securityContext definition to be used in the policy server container |
||
podSecurityContext definition to be used in the policy server Pod |
PolicyServerSpec
PolicyServerSpec defines the desired state of PolicyServer.
Field | Description | Default | Validation |
---|---|---|---|
|
Docker image name. |
||
|
Replicas is the number of desired replicas. |
||
|
Number of policy server replicas that must be still available after the |
||
|
Number of policy server replicas that can be unavailable after the |
||
|
Annotations is an unstructured key value map stored with a resource that may be |
||
|
List of environment variables to set in the container. |
||
|
Name of the service account associated with the policy server. |
||
|
Name of ImagePullSecret secret in the same namespace, used for pulling |
||
|
List of insecure URIs to policy repositories. The |
||
|
Key value map of registry URIs endpoints to a list of their associated |
||
|
Name of VerificationConfig configmap in the same namespace, containing |
||
|
Security configuration to be used in the Policy Server workload. |
||
|
Affinity rules for the associated Policy Server pods. |
||
|
Limits describes the maximum amount of compute resources allowed. |
||
|
Requests describes the minimum amount of compute resources required. |
||
|
Tolerations describe the policy server pod’s tolerations. It can be |
PolicySpec
Field | Description | Default | Validation |
---|---|---|---|
|
PolicyServer identifies an existing PolicyServer resource. |
default |
|
|
Mode defines the execution mode of this policy. Can be set to |
protect |
Enum: [protect monitor] |
|
Module is the location of the WASM module to be loaded. Can be a |
Required: {} |
|
|
Settings is a free-form object that contains the policy configuration |
||
|
Rules describes what operations on what resources/subresources the webhook cares about. |
||
|
FailurePolicy defines how unrecognized errors and timeout errors from the |
||
|
Mutating indicates whether a policy has the ability to mutate |
||
|
BackgroundAudit indicates whether a policy should be used or skipped when |
true |
|
|
matchPolicy defines how the "rules" list is used to match incoming requests. |
||
|
MatchConditions are a list of conditions that must be met for a request to be |
||
|
ObjectSelector decides whether to run the webhook based on if the |
||
|
SideEffects states whether this webhook has side effects. |
||
|
TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, |
10 |
policies.kubewarden.io/v1alpha2
Package v1alpha2 contains API Schema definitions for the policies v1alpha2 API group
AdmissionPolicy
AdmissionPolicy is the Schema for the admissionpolicies API
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
AdmissionPolicyList
AdmissionPolicyList contains a list of AdmissionPolicy.
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
AdmissionPolicySpec
AdmissionPolicySpec defines the desired state of AdmissionPolicy.
Field | Description | Default | Validation |
---|---|---|---|
|
ClusterAdmissionPolicy
ClusterAdmissionPolicy is the Schema for the clusteradmissionpolicies API
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
ClusterAdmissionPolicyList
ClusterAdmissionPolicyList contains a list of ClusterAdmissionPolicy
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
ClusterAdmissionPolicySpec
ClusterAdmissionPolicySpec defines the desired state of ClusterAdmissionPolicy.
Field | Description | Default | Validation |
---|---|---|---|
|
|||
|
NamespaceSelector decides whether to run the webhook on an object based |
PolicyServer
PolicyServer is the Schema for the policyservers API.
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
PolicyServerList
PolicyServerList contains a list of PolicyServer.
Field | Description | Default | Validation |
---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
PolicyServerSpec
PolicyServerSpec defines the desired state of PolicyServer.
Field | Description | Default | Validation |
---|---|---|---|
|
Docker image name. |
||
|
Replicas is the number of desired replicas. |
||
|
Annotations is an unstructured key value map stored with a resource that may be |
||
|
List of environment variables to set in the container. |
||
|
Name of the service account associated with the policy server. |
||
|
Name of ImagePullSecret secret in the same namespace, used for pulling |
||
|
List of insecure URIs to policy repositories. The |
||
|
Key value map of registry URIs endpoints to a list of their associated |
||
|
Name of VerificationConfig configmap in the same namespace, containing |
PolicySpec
Field | Description | Default | Validation |
---|---|---|---|
|
PolicyServer identifies an existing PolicyServer resource. |
default |
|
|
Module is the location of the WASM module to be loaded. Can be a |
Required: {} |
|
|
Mode defines the execution mode of this policy. Can be set to |
protect |
Enum: [protect monitor] |
|
Settings is a free-form object that contains the policy configuration |
||
|
Rules describes what operations on what resources/subresources the webhook cares about. |
||
|
FailurePolicy defines how unrecognized errors and timeout errors from the |
||
|
Mutating indicates whether a policy has the ability to mutate |
||
|
matchPolicy defines how the "rules" list is used to match incoming requests. |
||
|
ObjectSelector decides whether to run the webhook based on if the |
||
|
SideEffects states whether this webhook has side effects. |
||
|
TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, |
10 |