Merge pull request #5807 from shubham-pampattiwar/update-crd-desc

Update CRD descriptions for SnapshotVolumes and restorePVs
vmware-tanzu · Feb 6, 2023 · 53f3d13 · 53f3d13
2 parents 218fd76 + 428415c
commit 53f3d13
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 14 deletions.
diff --git a/changelogs/unreleased/5807-shubham-pampattiwar b/changelogs/unreleased/5807-shubham-pampattiwar
@@ -0,0 +1 @@
+Update CRD descriptions for SnapshotVolumes and restorePVs
diff --git a/config/crd/v1/bases/velero.io_backups.yaml b/config/crd/v1/bases/velero.io_backups.yaml
@@ -393,8 +393,8 @@ spec:
                 nullable: true
                 type: object
               snapshotVolumes:
-                description: SnapshotVolumes specifies whether to take cloud snapshots
-                  of any PV's referenced in the set of objects included in the Backup.
+                description: SnapshotVolumes specifies whether to take snapshots of
+                  any PV's referenced in the set of objects included in the Backup.
                 nullable: true
                 type: boolean
               storageLocation:

diff --git a/config/crd/v1/bases/velero.io_restores.yaml b/config/crd/v1/bases/velero.io_restores.yaml
@@ -355,7 +355,7 @@ spec:
                 type: boolean
               restorePVs:
                 description: RestorePVs specifies whether to restore all included
-                  PVs from snapshot (via the cloudprovider).
+                  PVs from snapshot
                 nullable: true
                 type: boolean
               restoreStatus:

diff --git a/config/crd/v1/bases/velero.io_schedules.yaml b/config/crd/v1/bases/velero.io_schedules.yaml
@@ -428,7 +428,7 @@ spec:
                     nullable: true
                     type: object
                   snapshotVolumes:
-                    description: SnapshotVolumes specifies whether to take cloud snapshots
+                    description: SnapshotVolumes specifies whether to take snapshots
                       of any PV's referenced in the set of objects included in the
                       Backup.
                     nullable: true

diff --git a/config/crd/v1/crds/crds.go b/config/crd/v1/crds/crds.go
diff --git a/pkg/apis/velero/v1/backup.go b/pkg/apis/velero/v1/backup.go
@@ -68,7 +68,7 @@ type BackupSpec struct {
 	// +nullable
 	OrLabelSelectors []*metav1.LabelSelector `json:"orLabelSelectors,omitempty"`
 
-	// SnapshotVolumes specifies whether to take cloud snapshots
+	// SnapshotVolumes specifies whether to take snapshots
 	// of any PV's referenced in the set of objects included
 	// in the Backup.
 	// +optional

diff --git a/pkg/apis/velero/v1/restore.go b/pkg/apis/velero/v1/restore.go
@@ -81,7 +81,7 @@ type RestoreSpec struct {
 	OrLabelSelectors []*metav1.LabelSelector `json:"orLabelSelectors,omitempty"`
 
 	// RestorePVs specifies whether to restore all included
-	// PVs from snapshot (via the cloudprovider).
+	// PVs from snapshot
 	// +optional
 	// +nullable
 	RestorePVs *bool `json:"restorePVs,omitempty"`

diff --git a/site/content/docs/main/api-types/backup.md b/site/content/docs/main/api-types/backup.md
@@ -76,8 +76,7 @@ spec:
       app: velero
   - matchLabels:
       app: data-protection
-  # Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and
-  # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as
+  # Whether or not to snapshot volumes. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as
   # a persistent volume provider is configured for Velero.
   snapshotVolumes: null
   # Where to store the tarball and logs.

diff --git a/site/content/docs/main/api-types/restore.md b/site/content/docs/main/api-types/restore.md
@@ -93,7 +93,7 @@ spec:
   namespaceMapping:
     namespace-backup-from: namespace-to-restore-to
   # restorePVs specifies whether to restore all included PVs
-  # from snapshot (via the cloudprovider). Optional
+  # from snapshot. Optional
   restorePVs: true
   # preserveNodePorts specifies whether to restore old nodePorts from backup,
   # so that the exposed port numbers on the node will remain the same after restore. Optional

diff --git a/site/content/docs/main/api-types/schedule.md b/site/content/docs/main/api-types/schedule.md
@@ -74,8 +74,7 @@ spec:
       matchLabels:
         app: velero
         component: server
-    # Whether to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and
-    # AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as
+    # Whether to snapshot volumes. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as
     # a persistent volume provider is configured for Velero.
     snapshotVolumes: null
     # Where to store the tarball and logs.