Add disabled PV re-provisioning by StorageClasses option on restore

Signed-off-by: Clément Rostagni <[email protected]>

config/crd/v1/bases/velero.io_restores.yaml

@@ -46,6 +46,15 @@ spec:
  BackupName is the unique name of the Velero backup to restore
  from.
  type: string
+ disabledPVReprovisioningStorageClasses:
+ description: |-
+ DisabledPVReprovisioningStorageClasses is a slice of StorageClasses names.
+ PV without snaptshot and having one of these StorageClass will not be
+ re-provisionned (even when ReclaimPolicy is Delete).
+ items:
+ type: string
+ nullable: true
+ type: array
  excludedNamespaces:
  description: |-
  ExcludedNamespaces contains a list of namespaces that are not

pkg/apis/velero/v1/restore_types.go

@@ -129,6 +129,13 @@ type RestoreSpec struct {
  // +optional
  // +nullable
  UploaderConfig *UploaderConfigForRestore `json:"uploaderConfig,omitempty"`
+
+ // DisabledPVReprovisioningStorageClasses is a slice of StorageClasses names.
+ // PV without snaptshot and having one of these StorageClass will not be
+ // re-provisionned (even when ReclaimPolicy is Delete).
+ // +optional
+ // +nullable
+ DisabledPVReprovisioningStorageClasses []string `json:"disabledPVReprovisioningStorageClasses,omitempty"`
 }
 
 // UploaderConfigForRestore defines the configuration for the restore.

pkg/builder/restore_builder.go

@@ -171,3 +171,9 @@ func (b *RestoreBuilder) ItemOperationTimeout(timeout time.Duration) *RestoreBui
  b.object.Spec.ItemOperationTimeout.Duration = timeout
  return b
 }
+
+// DisabledPVReprovisioningStorageClasses appends to the Restore's disabled PV re-rpovisioning StorageClasses.
+func (b *RestoreBuilder) DisabledPVReprovisioningStorageClasses(storageClasses ...string) *RestoreBuilder {
+ b.object.Spec.DisabledPVReprovisioningStorageClasses = append(b.object.Spec.DisabledPVReprovisioningStorageClasses, storageClasses...)
+ return b
+}

pkg/cmd/cli/restore/create.go

@@ -78,30 +78,31 @@ func NewCreateCommand(f client.Factory, use string) *cobra.Command {
 }
 
 type CreateOptions struct {
- BackupName string
- ScheduleName string
- RestoreName string
- RestoreVolumes flag.OptionalBool
- PreserveNodePorts flag.OptionalBool
- Labels flag.Map
- IncludeNamespaces flag.StringArray
- ExcludeNamespaces flag.StringArray
- ExistingResourcePolicy string
- IncludeResources flag.StringArray
- ExcludeResources flag.StringArray
- StatusIncludeResources flag.StringArray
- StatusExcludeResources flag.StringArray
- NamespaceMappings flag.Map
- Selector flag.LabelSelector
- OrSelector flag.OrLabelSelector
- IncludeClusterResources flag.OptionalBool
- Wait bool
- AllowPartiallyFailed flag.OptionalBool
- ItemOperationTimeout time.Duration
- ResourceModifierConfigMap string
- WriteSparseFiles flag.OptionalBool
- ParallelFilesDownload int
- client kbclient.WithWatch
+ BackupName string
+ ScheduleName string
+ RestoreName string
+ RestoreVolumes flag.OptionalBool
+ PreserveNodePorts flag.OptionalBool
+ Labels flag.Map
+ IncludeNamespaces flag.StringArray
+ ExcludeNamespaces flag.StringArray
+ ExistingResourcePolicy string
+ IncludeResources flag.StringArray
+ ExcludeResources flag.StringArray
+ StatusIncludeResources flag.StringArray
+ StatusExcludeResources flag.StringArray
+ NamespaceMappings flag.Map
+ Selector flag.LabelSelector
+ OrSelector flag.OrLabelSelector
+ IncludeClusterResources flag.OptionalBool
+ Wait bool
+ AllowPartiallyFailed flag.OptionalBool
+ ItemOperationTimeout time.Duration
+ ResourceModifierConfigMap string
+ WriteSparseFiles flag.OptionalBool
+ ParallelFilesDownload int
+ client kbclient.WithWatch
+ DisabledPVReprovisioningStorageClasses flag.StringArray
 }
 
 func NewCreateOptions() *CreateOptions {
@@ -155,6 +156,8 @@ func (o *CreateOptions) BindFlags(flags *pflag.FlagSet) {
  f.NoOptDefVal = cmd.TRUE
 
  flags.IntVar(&o.ParallelFilesDownload, "parallel-files-download", 0, "The number of restore operations to run in parallel. If set to 0, the default parallelism will be the number of CPUs for the node that node agent pod is running.")
+
+ flags.Var(&o.DisabledPVReprovisioningStorageClasses, "disable-pv-reprovisioning-storageclasses", "PV with no snaptshot that has a StorageClass specified by this flag will not be re-provisionned.")
 }
 
 func (o *CreateOptions) Complete(args []string, f client.Factory) error {
@@ -335,6 +338,7 @@ func (o *CreateOptions) Run(c *cobra.Command, f client.Factory) error {
  WriteSparseFiles: o.WriteSparseFiles.Value,
  ParallelFilesDownload: o.ParallelFilesDownload,
  },
+ DisabledPVReprovisioningStorageClasses: o.DisabledPVReprovisioningStorageClasses,
  },
  }
 

pkg/cmd/cli/restore/create_test.go

@@ -79,6 +79,7 @@ func TestCreateCommand(t *testing.T) {
  itemOperationTimeout := "10m0s"
  writeSparseFiles := "true"
  parallel := 2
+ disabledPVReprovisioningStorageClasses := "storageclass1,storageclass2"
  flags := new(pflag.FlagSet)
  o := NewCreateOptions()
  o.BindFlags(flags)
@@ -102,6 +103,7 @@ func TestCreateCommand(t *testing.T) {
  flags.Parse([]string{"--item-operation-timeout", itemOperationTimeout})
  flags.Parse([]string{"--write-sparse-files", writeSparseFiles})
  flags.Parse([]string{"--parallel-files-download", "2"})
+ flags.Parse([]string{"--disable-pv-reprovisioning-storageclasses", disabledPVReprovisioningStorageClasses})
  client := velerotest.NewFakeControllerRuntimeClient(t).(kbclient.WithWatch)
 
  f.On("Namespace").Return(mock.Anything)
@@ -139,6 +141,7 @@ func TestCreateCommand(t *testing.T) {
  require.Equal(t, itemOperationTimeout, o.ItemOperationTimeout.String())
  require.Equal(t, writeSparseFiles, o.WriteSparseFiles.String())
  require.Equal(t, parallel, o.ParallelFilesDownload)
+ require.Equal(t, disabledPVReprovisioningStorageClasses, o.DisabledPVReprovisioningStorageClasses.String())
  })
 
  t.Run("create a restore from schedule", func(t *testing.T) {

pkg/cmd/util/output/restore_describer.go

@@ -149,6 +149,13 @@ func DescribeRestore(
 
  d.Printf("\tCluster-scoped:\t%s\n", BoolPointerString(restore.Spec.IncludeClusterResources, "excluded", "included", "auto"))
 
+ d.Println()
+ s = emptyDisplay
+ if restore.Spec.DisabledPVReprovisioningStorageClasses != nil {
+ s = strings.Join(restore.Spec.IncludedNamespaces, ", ")
+ }
+ d.Printf("Disabled PV Re-provisioning StorageClasses:\t%s\n", s)
+
  d.Println()
  d.DescribeMap("Namespace mappings", restore.Spec.NamespaceMapping)
 

pkg/restore/restore.go

@@ -1231,7 +1231,19 @@ func (ctx *restoreContext) restoreItem(obj *unstructured.Unstructured, groupReso
  // When the PV data is skipped from backup, it's BackupVolumeInfo BackupMethod
  // is not set, and it will fall into the default case.
  default:
- if hasDeleteReclaimPolicy(obj.Object) {
+ hasDisabledStorageClass, err := hasDisabledPVReprovisioningStorageClass(obj, ctx)
+ if err != nil {
+ errs.Add(namespace, err)
+ return warnings, errs, itemExists
+ }
+
+ if hasDisabledStorageClass {
+ obj, err = ctx.handleSkippedPVHasDisabledReprovisioningStorageClass(obj, restoreLogger)
+ if err != nil {
+ errs.Add(namespace, err)
+ return warnings, errs, itemExists
+ }
+ } else if hasDeleteReclaimPolicy(obj.Object) {
  restoreLogger.Infof("Dynamically re-provisioning persistent volume because it doesn't have a snapshot and its reclaim policy is Delete.")
  ctx.pvsToProvision.Insert(name)
 
@@ -2523,3 +2535,36 @@ func (ctx *restoreContext) handleSkippedPVHasRetainPolicy(
  obj = resetVolumeBindingInfo(obj)
  return obj, nil
 }
+
+func hasDisabledPVReprovisioningStorageClass(unstructuredPV *unstructured.Unstructured, ctx *restoreContext) (bool, error) {
+ disabledStorageClasses := ctx.restore.Spec.DisabledPVReprovisioningStorageClasses
+
+ // Converting Unstructured to PV object.
+ pv := new(v1.PersistentVolume)
+ if err := runtime.DefaultUnstructuredConverter.FromUnstructured(unstructuredPV.Object, pv); err != nil {
+ return false, errors.Wrapf(err, "error converting persistent volume to structured")
+ }
+
+ // Checking if PV StorageClass is in the DisabledPVReprovisioningStorageClasses list.
+ for _, disabledStorageClass := range disabledStorageClasses {
+ if disabledStorageClass == pv.Spec.StorageClassName {
+ return true, nil
+ }
+ }
+ return false, nil
+}
+
+func (ctx *restoreContext) handleSkippedPVHasDisabledReprovisioningStorageClass(
+ obj *unstructured.Unstructured,
+ logger logrus.FieldLogger,
+) (*unstructured.Unstructured, error) {
+ logger.Infof("Restoring persistent volume as-is because it doesn't have a snapshot and it's storage class has re-provisionning disabled.")
+
+ // Check to see if the claimRef.namespace field needs to be remapped, and do so if necessary.
+ if _, err := remapClaimRefNS(ctx, obj); err != nil {
+ return nil, err
+ }
+
+ obj = resetVolumeBindingInfo(obj)
+ return obj, nil
+}