Merge pull request kubevirt#8726 from arnongilboa/dvsource_gc_doc

Add GC note to DataVolumeSource api doc
kubevirt-bot · Nov 10, 2022 · 24ec5ba · 24ec5ba
2 parents 50b0d64 + 06e62dd
commit 24ec5ba
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 18 deletions.
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -15706,7 +15706,7 @@
       "type": "boolean"
      },
      "name": {
-      "description": "Name represents the name of the DataVolume in the same namespace",
+      "description": "Name of both the DataVolume and the PVC in the same namespace. After PVC population the DataVolume is garbage collected by default.",
       "type": "string"
      }
     }

diff --git a/pkg/virt-operator/resource/generate/components/validations_generated.go b/pkg/virt-operator/resource/generate/components/validations_generated.go
@@ -6364,8 +6364,9 @@ var CRDsValidation map[string]string = map[string]string{
                               can be hotplugged and hotunplugged.
                             type: boolean
                           name:
-                            description: Name represents the name of the DataVolume
-                              in the same namespace
+                            description: Name of both the DataVolume and the PVC in
+                              the same namespace. After PVC population the DataVolume
+                              is garbage collected by default.
                             type: string
                         required:
                         - name
@@ -6903,8 +6904,9 @@ var CRDsValidation map[string]string = map[string]string{
                               can be hotplugged and hotunplugged.
                             type: boolean
                           name:
-                            description: Name represents the name of the DataVolume
-                              in the same namespace
+                            description: Name of both the DataVolume and the PVC in
+                              the same namespace. After PVC population the DataVolume
+                              is garbage collected by default.
                             type: string
                         required:
                         - name
@@ -10458,8 +10460,9 @@ var CRDsValidation map[string]string = map[string]string{
                       hotplugged and hotunplugged.
                     type: boolean
                   name:
-                    description: Name represents the name of the DataVolume in the
-                      same namespace
+                    description: Name of both the DataVolume and the PVC in the same
+                      namespace. After PVC population the DataVolume is garbage collected
+                      by default.
                     type: string
                 required:
                 - name
@@ -14967,8 +14970,9 @@ var CRDsValidation map[string]string = map[string]string{
                               can be hotplugged and hotunplugged.
                             type: boolean
                           name:
-                            description: Name represents the name of the DataVolume
-                              in the same namespace
+                            description: Name of both the DataVolume and the PVC in
+                              the same namespace. After PVC population the DataVolume
+                              is garbage collected by default.
                             type: string
                         required:
                         - name
@@ -18994,8 +18998,9 @@ var CRDsValidation map[string]string = map[string]string{
                                       volume can be hotplugged and hotunplugged.
                                     type: boolean
                                   name:
-                                    description: Name represents the name of the DataVolume
-                                      in the same namespace
+                                    description: Name of both the DataVolume and the
+                                      PVC in the same namespace. After PVC population
+                                      the DataVolume is garbage collected by default.
                                     type: string
                                 required:
                                 - name
@@ -23697,8 +23702,10 @@ var CRDsValidation map[string]string = map[string]string{
                                           the volume can be hotplugged and hotunplugged.
                                         type: boolean
                                       name:
-                                        description: Name represents the name of the
-                                          DataVolume in the same namespace
+                                        description: Name of both the DataVolume and
+                                          the PVC in the same namespace. After PVC
+                                          population the DataVolume is garbage collected
+                                          by default.
                                         type: string
                                     required:
                                     - name
@@ -24288,8 +24295,10 @@ var CRDsValidation map[string]string = map[string]string{
                                           the volume can be hotplugged and hotunplugged.
                                         type: boolean
                                       name:
-                                        description: Name represents the name of the
-                                          DataVolume in the same namespace
+                                        description: Name of both the DataVolume and
+                                          the PVC in the same namespace. After PVC
+                                          population the DataVolume is garbage collected
+                                          by default.
                                         type: string
                                     required:
                                     - name

diff --git a/staging/src/kubevirt.io/api/core/v1/schema.go b/staging/src/kubevirt.io/api/core/v1/schema.go
@@ -777,7 +777,8 @@ type HotplugVolumeSource struct {
 }
 
 type DataVolumeSource struct {
-	// Name represents the name of the DataVolume in the same namespace
+	// Name of both the DataVolume and the PVC in the same namespace.
+	// After PVC population the DataVolume is garbage collected by default.
 	Name string `json:"name"`
 	// Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.
 	// +optional

diff --git a/staging/src/kubevirt.io/api/core/v1/schema_swagger_generated.go b/staging/src/kubevirt.io/api/core/v1/schema_swagger_generated.go
diff --git a/staging/src/kubevirt.io/client-go/api/openapi_generated.go b/staging/src/kubevirt.io/client-go/api/openapi_generated.go