Skip to content

GcpNfsVolumeRestore Custom Resource ​

WARNING

This is a beta feature available only per request for SAP-internal teams.

The gcpnfsvolumerestore.cloud-resources.kyma-project.io namespaced custom resource (CR) describes the GCP Filestore instance's restore operation on the same or an existing Filestore. This operation is only supported for BASIC tiers. To learn more, read Supported tiers.

To restore a backup of a ZONAL or REGIONAL Filestore, the restore operation must be performed while a new Filestore instance is created. This is supported by the sourceBackup field in the spec of gcpnfsvolume.cloud-resources.kyma-project.io CRD. To learn more, read GcpNfsVolume Custom Resource.

While the GCP Filestore restore operation is running in the underlying cloud provider subscription, it needs its source GCP Filestore backup and its destination GCP Filestore instance to be available. Upon its completion, the GCP Filestore instance is restored to the state of the source GCP Filestore backup.

Restore on the same Filestore means that the source Filestore of the backup is the same as the destination Filestore of the restore operation. Restore on an existing Filestore means that the source Filestore of the backup is different from the destination Filestore of the restore operation and the destination Filestore of the restore operation already exists.

The capacity of the destination Filestore instance must be equal to or greater than the capacity of the source Filestore of the backup.

To learn more, read Filestore Backup/Restore limitations.

Specification ​

This table lists the parameters of the given resource together with their descriptions:

Spec:

ParameterTypeDescription
sourceobjectRequired. Specifies the source backup of the restore operation.
source.backupobjectRequired. Reference of the existing GcpNfsVolumeBackup that is restored.
source.backup.namestringRequired. Name of the source GcpNfsVolumeBackup.
source.backup.namespacestringRequired. The namespace of the source GcpNfsVolumeBackup. Defaults to the namespace of the GcpNfsVolumeBackup resource if not provided.
destinationobjectRequired. Specifies the destination of the restore operation.
destination.volumeobjectRequired. Reference of the existing GcpNfsVolume that is restored.
destination.volume.namestringRequired. Name of the destination GcpNfsVolume.
destination.volume.namespacestringOptional. The namespace of the destination GcpNfsVolume. Defaults to the namespace of the GcpNfsVolumeRestore resource if not provided.

Status:

ParameterTypeDescription
statestringSignifies the current state of CustomObject. Its value can be either Done, Processing, Error, Failed, or InProgress.
conditions[]objectRepresents the current state of the CR's conditions.
conditions.lastTransitionTimestringDefines the date of the last condition status change.
conditions.messagestringProvides more details about the condition status change.
conditions.reasonstringDefines the reason for the condition status change.
conditions.status (required)stringRepresents the status of the condition. The value is either True, False, or Unknown.
conditions.typestringProvides a short description of the condition.

Sample Custom Resource ​

See an exemplary GcpNfsVolumeRestore custom resource:

yaml
apiVersion: cloud-resources.kyma-project.io/v1beta1
kind: GcpNfsVolumeBackup
metadata:
  name: my-restore
spec:
  source:
    backup:
      name: my-backup
      namespace: my-namespace
  destination:
    volume:
      name: my-vol
      namespace: my-namespace