From d0ada5529cebe9f674b9e7505852529cd46e487a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Thu, 28 Apr 2022 14:51:44 +0200 Subject: [PATCH] fix: generated api reference docs (#3711) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- api/kyverno/v1/clusterpolicy_types.go | 6 +- api/kyverno/v1/policy_types.go | 8 +- .../clusterreportchangerequest_types.go | 9 +- .../v1alpha2/reportchangerequest_types.go | 6 +- api/kyverno/v1beta1/updaterequest_types.go | 6 +- docs/config.json | 5 +- docs/crd/v1/index.html | 748 ++++++++++-------- docs/crd/v1alpha2/index.html | 40 +- docs/crd/v1beta1/index.html | 239 +++--- 9 files changed, 597 insertions(+), 470 deletions(-) diff --git a/api/kyverno/v1/clusterpolicy_types.go b/api/kyverno/v1/clusterpolicy_types.go index c1fe75dd50..4e265488d6 100644 --- a/api/kyverno/v1/clusterpolicy_types.go +++ b/api/kyverno/v1/clusterpolicy_types.go @@ -8,7 +8,6 @@ import ( "k8s.io/apimachinery/pkg/util/validation/field" ) -// ClusterPolicy declares validation, mutation, and generation behaviors for matching resources. // +genclient // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object @@ -19,6 +18,8 @@ import ( // +kubebuilder:printcolumn:name="Action",type="string",JSONPath=".spec.validationFailureAction" // +kubebuilder:printcolumn:name="Failure Policy",type="string",JSONPath=".spec.failurePolicy",priority=1 // +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.ready` + +// ClusterPolicy declares validation, mutation, and generation behaviors for matching resources. type ClusterPolicy struct { metav1.TypeMeta `json:",inline,omitempty" yaml:",inline,omitempty"` metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"` @@ -109,8 +110,9 @@ func (p *ClusterPolicy) CreateDeepCopy() PolicyInterface { return p.DeepCopy() } -// ClusterPolicyList is a list of ClusterPolicy instances. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object + +// ClusterPolicyList is a list of ClusterPolicy instances. type ClusterPolicyList struct { metav1.TypeMeta `json:",inline" yaml:",inline"` metav1.ListMeta `json:"metadata" yaml:"metadata"` diff --git a/api/kyverno/v1/policy_types.go b/api/kyverno/v1/policy_types.go index a8700503f2..b413f3b81d 100755 --- a/api/kyverno/v1/policy_types.go +++ b/api/kyverno/v1/policy_types.go @@ -8,8 +8,6 @@ import ( "k8s.io/apimachinery/pkg/util/validation/field" ) -// Policy declares validation, mutation, and generation behaviors for matching resources. -// See: https://kyverno.io/docs/writing-policies/ for more information. // +genclient // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object // +kubebuilder:object:root=true @@ -19,6 +17,9 @@ import ( // +kubebuilder:printcolumn:name="Failure Policy",type="string",JSONPath=".spec.failurePolicy",priority=1 // +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.ready` // +kubebuilder:resource:shortName=pol + +// Policy declares validation, mutation, and generation behaviors for matching resources. +// See: https://kyverno.io/docs/writing-policies/ for more information. type Policy struct { metav1.TypeMeta `json:",inline,omitempty" yaml:",inline,omitempty"` metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"` @@ -110,8 +111,9 @@ func (p *Policy) CreateDeepCopy() PolicyInterface { return p.DeepCopy() } -// PolicyList is a list of Policy instances. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object + +// PolicyList is a list of Policy instances. type PolicyList struct { metav1.TypeMeta `json:",inline" yaml:",inline"` metav1.ListMeta `json:"metadata" yaml:"metadata"` diff --git a/api/kyverno/v1alpha2/clusterreportchangerequest_types.go b/api/kyverno/v1alpha2/clusterreportchangerequest_types.go index 46374ac166..b226dd6328 100644 --- a/api/kyverno/v1alpha2/clusterreportchangerequest_types.go +++ b/api/kyverno/v1alpha2/clusterreportchangerequest_types.go @@ -22,10 +22,6 @@ import ( metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" ) -// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN! -// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized. - -// ClusterReportChangeRequest is the Schema for the ClusterReportChangeRequests API // +genclient // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object // +genclient:nonNamespaced @@ -40,6 +36,8 @@ import ( // +kubebuilder:printcolumn:name="Error",type=integer,JSONPath=`.summary.error` // +kubebuilder:printcolumn:name="Skip",type=integer,JSONPath=`.summary.skip` // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" + +// ClusterReportChangeRequest is the Schema for the ClusterReportChangeRequests API type ClusterReportChangeRequest struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` @@ -62,9 +60,10 @@ type ClusterReportChangeRequest struct { Results []report.PolicyReportResult `json:"results,omitempty"` } -// ClusterReportChangeRequestList contains a list of ClusterReportChangeRequest // +kubebuilder:object:root=true // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object + +// ClusterReportChangeRequestList contains a list of ClusterReportChangeRequest type ClusterReportChangeRequestList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` diff --git a/api/kyverno/v1alpha2/reportchangerequest_types.go b/api/kyverno/v1alpha2/reportchangerequest_types.go index 8f3bdc62bb..a77bd658b3 100644 --- a/api/kyverno/v1alpha2/reportchangerequest_types.go +++ b/api/kyverno/v1alpha2/reportchangerequest_types.go @@ -25,7 +25,6 @@ import ( // EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN! // NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized. -// ReportChangeRequest is the Schema for the ReportChangeRequests API // +genclient // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object // +kubebuilder:object:root=true @@ -39,6 +38,8 @@ import ( // +kubebuilder:printcolumn:name="Skip",type=integer,JSONPath=`.summary.skip` // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" // +kubebuilder:resource:shortName=rcr + +// ReportChangeRequest is the Schema for the ReportChangeRequests API type ReportChangeRequest struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` @@ -61,9 +62,10 @@ type ReportChangeRequest struct { Results []report.PolicyReportResult `json:"results,omitempty"` } -// ReportChangeRequestList contains a list of ReportChangeRequest // +kubebuilder:object:root=true // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object + +// ReportChangeRequestList contains a list of ReportChangeRequest type ReportChangeRequestList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` diff --git a/api/kyverno/v1beta1/updaterequest_types.go b/api/kyverno/v1beta1/updaterequest_types.go index ed624b5860..cadf7b86e5 100644 --- a/api/kyverno/v1beta1/updaterequest_types.go +++ b/api/kyverno/v1beta1/updaterequest_types.go @@ -23,9 +23,6 @@ import ( metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" ) -// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN! -// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized. - // UpdateRequestStatus defines the observed state of UpdateRequest type UpdateRequestStatus struct { @@ -41,7 +38,6 @@ type UpdateRequestStatus struct { GeneratedResources []v1.ResourceSpec `json:"generatedResources,omitempty" yaml:"generatedResources,omitempty"` } -// UpdateRequestStatus is a request to process mutate and generate rules in background. // +genclient // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object // +kubebuilder:object:root=true @@ -53,6 +49,8 @@ type UpdateRequestStatus struct { // +kubebuilder:printcolumn:name="status",type="string",JSONPath=".status.state" // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" // +kubebuilder:resource:shortName=ur + +// UpdateRequestStatus is a request to process mutate and generate rules in background. type UpdateRequest struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` diff --git a/docs/config.json b/docs/config.json index 1bab97171f..f98275bfc6 100644 --- a/docs/config.json +++ b/docs/config.json @@ -12,7 +12,7 @@ "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" }, { - "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", + "typeMatchPrefix": "^k8s\\.io/(api|apimachinery|apiextensions-apiserver/pkg/apis)/", "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" }, { @@ -22,7 +22,8 @@ ], "typeDisplayNamePrefixOverrides": { "k8s.io/api/": "Kubernetes ", - "k8s.io/apimachinery/pkg/apis/": "Kubernetes " + "k8s.io/apimachinery/pkg/apis/": "Kubernetes ", + "k8s.io/apiextensions-apiserver/pkg/apis/": "Kubernetes " }, "markdownDisabled": false } diff --git a/docs/crd/v1/index.html b/docs/crd/v1/index.html index c4699b41b8..1d99087396 100644 --- a/docs/crd/v1/index.html +++ b/docs/crd/v1/index.html @@ -24,7 +24,371 @@ background-color: #1589dd;

kyverno.io/v1

Resource Types: - + +
+

ClusterPolicy +

+

+

ClusterPolicy declares validation, mutation, and generation behaviors for matching resources.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string
+ +kyverno.io/v1 + +
+kind
+string +
ClusterPolicy
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +Spec + + +
+

Spec declares policy behaviors.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+rules
+ + +[]Rule + + +
+

Rules is a list of Rule instances. A Policy contains multiple rules and +each rule can validate, mutate, or generate resources.

+
+failurePolicy
+ + +FailurePolicyType + + +
+(Optional) +

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.

+
+validationFailureAction
+ + +ValidationFailureAction + + +
+(Optional) +

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

+
+validationFailureActionOverrides
+ + +[]ValidationFailureActionOverride + + +
+(Optional) +

ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction +namespace-wise. It overrides ValidationFailureAction for the specified namespaces.

+
+background
+ +bool + +
+(Optional) +

Background controls if rules are applied to existing 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).

+
+schemaValidation
+ +bool + +
+(Optional) +

SchemaValidation skips policy validation checks. +Optional. The default value is set to “true”, it must be set to “false” to disable the validation checks.

+
+webhookTimeoutSeconds
+ +int32 + +
+

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.

+
+
+status
+ + +PolicyStatus + + +
+(Optional) +

Status contains policy runtime data.

+
+
+

Policy +

+

+

Policy declares validation, mutation, and generation behaviors for matching resources. +See: https://kyverno.io/docs/writing-policies/ for more information.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string
+ +kyverno.io/v1 + +
+kind
+string +
Policy
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +Spec + + +
+

Spec defines policy behaviors and contains one or more rules.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+rules
+ + +[]Rule + + +
+

Rules is a list of Rule instances. A Policy contains multiple rules and +each rule can validate, mutate, or generate resources.

+
+failurePolicy
+ + +FailurePolicyType + + +
+(Optional) +

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.

+
+validationFailureAction
+ + +ValidationFailureAction + + +
+(Optional) +

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

+
+validationFailureActionOverrides
+ + +[]ValidationFailureActionOverride + + +
+(Optional) +

ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction +namespace-wise. It overrides ValidationFailureAction for the specified namespaces.

+
+background
+ +bool + +
+(Optional) +

Background controls if rules are applied to existing 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).

+
+schemaValidation
+ +bool + +
+(Optional) +

SchemaValidation skips policy validation checks. +Optional. The default value is set to “true”, it must be set to “false” to disable the validation checks.

+
+webhookTimeoutSeconds
+ +int32 + +
+

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.

+
+
+status
+ + +PolicyStatus + + +
+(Optional) +

Status contains policy runtime information. +Deprecated. Policy metrics are available via the metrics endpoint

+

APICall

@@ -275,7 +639,9 @@ See https://gi attestor
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON +
+Kubernetes apiextensions/v1.JSON + @@ -485,168 +851,6 @@ string
-

ClusterPolicy -

-

-

ClusterPolicy declares validation, mutation, and generation behaviors for matching resources.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -Spec - - -
-

Spec declares policy behaviors.

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-rules
- - -[]Rule - - -
-

Rules is a list of Rule instances. A Policy contains multiple rules and -each rule can validate, mutate, or generate resources.

-
-failurePolicy
- - -FailurePolicyType - - -
-(Optional) -

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.

-
-validationFailureAction
- - -ValidationFailureAction - - -
-(Optional) -

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

-
-validationFailureActionOverrides
- - -[]ValidationFailureActionOverride - - -
-(Optional) -

ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction -namespace-wise. It overrides ValidationFailureAction for the specified namespaces.

-
-background
- -bool - -
-(Optional) -

Background controls if rules are applied to existing 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).

-
-schemaValidation
- -bool - -
-(Optional) -

SchemaValidation skips policy validation checks. -Optional. The default value is set to “true”, it must be set to “false” to disable the validation checks.

-
-webhookTimeoutSeconds
- -int32 - -
-

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.

-
-
-status
- - -PolicyStatus - - -
-(Optional) -

Status contains policy runtime data.

-
-

Condition

@@ -668,7 +872,9 @@ PolicyStatus key
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -695,7 +901,9 @@ DurationLessThanOrEquals, DurationLessThan

value
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -868,7 +1076,9 @@ Variable conditions
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -953,7 +1163,9 @@ See: https://k patchStrategicMerge
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON +
+Kubernetes apiextensions/v1.JSON + @@ -1056,7 +1268,9 @@ See: https://k pattern
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON +
+Kubernetes apiextensions/v1.JSON + @@ -1068,7 +1282,9 @@ k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON anyPattern
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -1412,7 +1628,9 @@ Optional. Defaults to “false” if not specified.

data
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -1906,7 +2124,9 @@ Optional. Defaults to “false” if not specified.

patchStrategicMerge
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -1946,170 +2166,6 @@ See https://tools.ietf.org/html/rf
-

Policy -

-

-

Policy declares validation, mutation, and generation behaviors for matching resources. -See: https://kyverno.io/docs/writing-policies/ for more information.

-

- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -Spec - - -
-

Spec defines policy behaviors and contains one or more rules.

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-rules
- - -[]Rule - - -
-

Rules is a list of Rule instances. A Policy contains multiple rules and -each rule can validate, mutate, or generate resources.

-
-failurePolicy
- - -FailurePolicyType - - -
-(Optional) -

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.

-
-validationFailureAction
- - -ValidationFailureAction - - -
-(Optional) -

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

-
-validationFailureActionOverrides
- - -[]ValidationFailureActionOverride - - -
-(Optional) -

ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction -namespace-wise. It overrides ValidationFailureAction for the specified namespaces.

-
-background
- -bool - -
-(Optional) -

Background controls if rules are applied to existing 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).

-
-schemaValidation
- -bool - -
-(Optional) -

SchemaValidation skips policy validation checks. -Optional. The default value is set to “true”, it must be set to “false” to disable the validation checks.

-
-webhookTimeoutSeconds
- -int32 - -
-

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.

-
-
-status
- - -PolicyStatus - - -
-(Optional) -

Status contains policy runtime information. -Deprecated. Policy metrics are available via the metrics endpoint

-
-

PolicyInterface

@@ -2587,7 +2643,9 @@ This config is only valid for verifyImages rules.

preconditions
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -2945,7 +3003,9 @@ string pattern
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -2957,7 +3017,9 @@ k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON anyPattern
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -3055,7 +3117,9 @@ ValidationFailureAction value
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + @@ -3080,7 +3144,9 @@ transform the variable.

default
-k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +Kubernetes apiextensions/v1.JSON + diff --git a/docs/crd/v1alpha2/index.html b/docs/crd/v1alpha2/index.html index 9e0d02d7dd..c9f2fefd97 100644 --- a/docs/crd/v1alpha2/index.html +++ b/docs/crd/v1alpha2/index.html @@ -27,7 +27,11 @@ background-color: #1589dd;

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

Resource Types: - +

ClusterReportChangeRequest

@@ -44,6 +48,23 @@ Resource Types: +apiVersion
+string + + +kyverno.io/v1alpha2 + + + + + +kind
+string + +ClusterReportChangeRequest + + + metadata
@@ -127,6 +148,23 @@ github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportSummary +apiVersion
+string + + +kyverno.io/v1alpha2 + + + + + +kind
+string + +ReportChangeRequest + + + metadata
diff --git a/docs/crd/v1beta1/index.html b/docs/crd/v1beta1/index.html index 3eab1bc497..d091c0d2b5 100644 --- a/docs/crd/v1beta1/index.html +++ b/docs/crd/v1beta1/index.html @@ -27,7 +27,135 @@ background-color: #1589dd;

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

Resource Types: -
    +
    +
    +

    UpdateRequest +

    +

    +

    UpdateRequestStatus is a request to process mutate and generate rules in background.

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +apiVersion
    +string
    + +kyverno.io/v1beta1 + +
    +kind
    +string +
    UpdateRequest
    +metadata
    + + +Kubernetes meta/v1.ObjectMeta + + +
    +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
    +spec
    + + +UpdateRequestSpec + + +
    +

    Spec is the information to identify the update request.

    +
    +
    + + + + + + + + + + + + + + + + + +
    +requestType
    + + +RequestType + + +
    +

    Type represents request type for background processing

    +
    +policy
    + +string + +
    +

    Specifies the name of the policy.

    +
    +resource
    + +github.com/kyverno/kyverno/api/kyverno/v1.ResourceSpec + +
    +

    ResourceSpec is the information to identify the update request.

    +
    +context
    + + +UpdateRequestSpecContext + + +
    +

    Context …

    +
    +
    +status
    + + +UpdateRequestStatus + + +
    +(Optional) +

    Status contains statistics related to update request.

    +

    AdmissionRequestInfoObject

    @@ -139,115 +267,6 @@ Kubernetes authentication/v1.UserInfo

    -

    UpdateRequest -

    -

    -

    UpdateRequestStatus is a request to process mutate and generate rules in background.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -
    -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -UpdateRequestSpec - - -
    -

    Spec is the information to identify the update request.

    -
    -
    - - - - - - - - - - - - - - - - - -
    -requestType
    - - -RequestType - - -
    -

    Type represents request type for background processing

    -
    -policy
    - -string - -
    -

    Specifies the name of the policy.

    -
    -resource
    - -github.com/kyverno/kyverno/api/kyverno/v1.ResourceSpec - -
    -

    ResourceSpec is the information to identify the update request.

    -
    -context
    - - -UpdateRequestSpecContext - - -
    -

    Context …

    -
    -
    -status
    - - -UpdateRequestStatus - - -
    -(Optional) -

    Status contains statistics related to update request.

    -
    -

    UpdateRequestSpec