update description

2025-03-29 02:45:06 +00:00 · 2020-11-03 16:57:47 -08:00 · 2020-11-03 16:57:47 -08:00 · 97e6382aaf
commit 97e6382aaf
parent d19a44d34c
5 changed files with 37 additions and 30 deletions
--- a/charts/kyverno/crds/crds.yaml
+++ b/charts/kyverno/crds/crds.yaml
@ -5,13 +5,14 @@ metadata:
 spec:
  additionalPrinterColumns:
  - JSONPath: .spec.background
-    description: Background provides choice for applying rules to existing resources.
+    description: Background controls if rules are applied to existing resources during
+      a background scan.
    name: Background
    type: string
  - JSONPath: .spec.validationFailureAction
    description: ValidationFailureAction provides choice to enforce rules to resources
      during policy application.
-    name: Validation FailureAction
+    name: Validation Failure Action
    type: string
  group: kyverno.io
  names:
@ -426,13 +427,14 @@ metadata:
 spec:
  additionalPrinterColumns:
  - JSONPath: .spec.background
-    description: Background provides choice for applying rules to existing resources.
+    description: Background controls if rules are applied to existing resources during
+      a background scan.
    name: Background
    type: string
  - JSONPath: .spec.validationFailureAction
-    description: ValidationFailureAction provides choice to enforce rules to resources
-      during policy application.
-    name: Validation FailureAction
+    description: ValidationFailureAction controls if a policy failure should not disallow
+      an admission review request (enforce), or allow (audit) and report an error.
+    name: Validation Failure Action
    type: string
  group: kyverno.io
  names:
--- a/definitions/crds/crds.yaml
+++ b/definitions/crds/crds.yaml
@ -5,12 +5,12 @@ metadata:
 spec:
  additionalPrinterColumns:
  - JSONPath: .spec.background
-    description: Background provides choice for applying rules to existing resources.
+    description: Background controls if rules are applied to existing resources during a background scan.
    name: Background
    type: string
  - JSONPath: .spec.validationFailureAction
    description: ValidationFailureAction provides choice to enforce rules to resources during policy application.
-    name: Validation FailureAction
+    name: Validation Failure Action
    type: string
  group: kyverno.io
  versions:
@ -288,12 +288,12 @@ metadata:
 spec:
  additionalPrinterColumns:
  - JSONPath: .spec.background
-    description: Background provides choice for applying rules to existing resources.
+    description: Background controls if rules are applied to existing resources during a background scan.
    name: Background
    type: string
  - JSONPath: .spec.validationFailureAction
-    description: ValidationFailureAction provides choice to enforce rules to resources during policy application.
-    name: Validation FailureAction
+    description: ValidationFailureAction controls if a policy failure should not disallow an admission review request (enforce), or allow (audit) and report an error.
+    name: Validation Failure Action
    type: string
  group: kyverno.io
  versions:
--- a/definitions/install.yaml
+++ b/definitions/install.yaml
@ -9,14 +9,15 @@ metadata:
  name: clusterpolicies.kyverno.io
 spec:
  additionalPrinterColumns:
+  - JSONPath: .spec.background
+    description: Background controls if rules are applied to existing resources during
+      a background scan.
+    name: Background
+    type: string
  - JSONPath: .spec.validationFailureAction
    description: ValidationFailureAction provides choice to enforce rules to resources
      during policy application.
-    name: Validation FailureAction
-    type: string
-  - JSONPath: .spec.background
-    description: Background provides choice for applying rules to existing resources.
-    name: Background
+    name: Validation Failure Action
    type: string
  group: kyverno.io
  names:
@ -430,15 +431,16 @@ metadata:
  name: policies.kyverno.io
 spec:
  additionalPrinterColumns:
-  - JSONPath: .spec.validationFailureAction
-    description: ValidationFailureAction provides choice to enforce rules to resources
-      during policy application.
-    name: Validation FailureAction
-    type: string
  - JSONPath: .spec.background
-    description: Background provides choice for applying rules to existing resources.
+    description: Background controls if rules are applied to existing resources during
+      a background scan.
    name: Background
    type: string
+  - JSONPath: .spec.validationFailureAction
+    description: ValidationFailureAction controls if a policy failure should not disallow
+      an admission review request (enforce), or allow (audit) and report an error.
+    name: Validation Failure Action
+    type: string
  group: kyverno.io
  names:
    kind: Policy
--- a/definitions/install_debug.yaml
+++ b/definitions/install_debug.yaml
@ -10,13 +10,14 @@ metadata:
 spec:
  additionalPrinterColumns:
  - JSONPath: .spec.background
-    description: Background provides choice for applying rules to existing resources.
+    description: Background controls if rules are applied to existing resources during
+      a background scan.
    name: Background
    type: string
  - JSONPath: .spec.validationFailureAction
    description: ValidationFailureAction provides choice to enforce rules to resources
      during policy application.
-    name: Validation FailureAction
+    name: Validation Failure Action
    type: string
  group: kyverno.io
  names:
@ -431,13 +432,14 @@ metadata:
 spec:
  additionalPrinterColumns:
  - JSONPath: .spec.background
-    description: Background provides choice for applying rules to existing resources.
+    description: Background controls if rules are applied to existing resources during
+      a background scan.
    name: Background
    type: string
  - JSONPath: .spec.validationFailureAction
-    description: ValidationFailureAction provides choice to enforce rules to resources
-      during policy application.
-    name: Validation FailureAction
+    description: ValidationFailureAction controls if a policy failure should not disallow
+      an admission review request (enforce), or allow (audit) and report an error.
+    name: Validation Failure Action
    type: string
  group: kyverno.io
  names:
--- a/pkg/api/kyverno/v1/types.go
+++ b/pkg/api/kyverno/v1/types.go
@ -148,10 +148,11 @@ type Policy struct {
 type Spec struct {
 	// Rules contains the list of rules to be applied to resources
 	Rules []Rule `json:"rules,omitempty" yaml:"rules,omitempty"`
-	// ValidationFailureAction provides choice to enforce rules to resources during policy application.
+	// ValidationFailureAction controls if a policy failure should not disallow
+	// an admission review request (enforce), or allow (audit) and report an error.
 	// Default value is "audit".
 	ValidationFailureAction string `json:"validationFailureAction,omitempty" yaml:"validationFailureAction,omitempty"`
-	// Background provides choice for applying rules to existing resources.
+	// Background controls if rules are applied to existing resources during a background scan.
 	// Default value is "true".
 	Background *bool `json:"background,omitempty" yaml:"background,omitempty"`
 }