Sauvegarder l'espace de stockage Filestore à l'aide d'instantanés de volume

Autopilot Standard

Cette page vous explique comment sauvegarder et restaurer le stockage Filestore à l'aide d'instantanés de volume Kubernetes.

La création d'un instantané de volume Kubernetes équivaut à créer une sauvegarde Filestore. Pour plus d'informations, consultez la page À propos des instantanés de volume Kubernetes.

Conditions requises

Pour utiliser des instantanés de volume sur GKE, vous devez répondre aux exigences suivantes :

Vous devez déployer le pilote CSI Filestore, qui est compatible avec les niveaux de service Filestore suivants :
- HDD de base avec GKE version 1.21 ou ultérieure
- SSD de base avec GKE version 1.21 ou ultérieure
- Zonal (10 à 100 Tio) avec GKE version 1.27 ou ultérieure
- Entreprise avec GKE version 1.25 ou ultérieure
Utilisez les versions 1.17 ou ultérieures du plan de contrôle. Pour utiliser le pilote CSI Filestore dans un VolumeSnapshot, utilisez le numéro de version de GKE applicable à votre niveau de service.

Vous devez disposer d'un objet PersistentVolumeClaim pour utiliser un instantané. Le PersistentVolume que vous utilisez pour une source d'instantané doit être géré par un pilote CSI. Vous pouvez contrôler que vous utilisez un pilote CSI en vérifiant que la spécification PersistentVolume présente une section csi avec driver: pd.csi.storage.gke.io ou filestore.csi.storage.gke.io. Si le PersistentVolume est provisionné de manière dynamique par le pilote CSI, comme décrit dans les sections suivantes, il est géré par le pilote CSI.

Limites

Les volumes d'instantanés sont soumis aux mêmes restrictions de taille que les volumes standards. Par exemple, la taille des instantanés Filestore doit être supérieure ou égale à 1 Tio pour le niveau HDD de base.
Le pilote CSI Filestore n'est pas compatible avec les workflows de provisionnement ou de sauvegarde dynamiques pour les niveaux de service Filestore suivants :
- Zonal (1 Tio à 9,75 Tio)
- Régional
Vous ne pouvez sauvegarder qu'un seul partage à la fois par instance. En ce qui concerne les pools de stockage, les requêtes de sauvegarde provenant de deux partages différents de deux instances Filestore différentes s'exécutent simultanément.
Les sauvegardes à partage unique ne peuvent être restaurées que sur des volumes à partage unique. Le pilote CSI Filestore vous permet uniquement de restaurer un volume à partage unique dans une nouvelle instance Filestore.
- La nouvelle instance doit utiliser le même niveau de service que la sauvegarde.
- La nouvelle instance doit avoir la même capacité minimale que la sauvegarde.
Les opérations Filestore backup restore sur la source ou sur une instance Filestore existante ne sont pas compatibles. Pour obtenir la liste complète des limites des fonctionnalités, consultez la page Limites des fonctionnalités de sauvegarde Filestore.
Les sauvegardes avec multipartage ne sont pas compatibles.

Avant de commencer

Avant de commencer, effectuez les tâches suivantes :

Activez l'API Google Kubernetes Engine.

Activer l'API Google Kubernetes Engine

Si vous souhaitez utiliser Google Cloud CLI pour cette tâche, installez puis initialize gcloud CLI. Si vous avez déjà installé gcloud CLI, assurez-vous de disposer de la dernière version en exécutant la commande gcloud components update.
Remarque : Pour les installations de gcloud CLI existantes, veillez à définir les propriétés compute/region et compute/zone. En définissant des emplacements par défaut, vous pouvez éviter les erreurs gcloud CLI telles que celle-ci : One of [--zone, --region] must be supplied: Please specify location.

Créer et utiliser un instantané de volume

Les exemples de ce document vous montrent comment effectuer les opérations suivantes :

Créer un PersistentVolumeClaim et un Deployment
Ajouter un fichier au PersistentVolume utilisé par Deployment
Créer un objet VolumeSnapshotClass pour configurer l'instantané
Créer un instantané de volume du PersistentVolume.
Supprimer le fichier de test
Restaurer le fichier PersistentVolume dans l'instantané que vous avez créé
Vérifiez que la restauration a fonctionné

Pour utiliser un instantané de volume, procédez comme suit :

Créez un objet VolumeSnapshotClass pour spécifier le pilote CSI et la règle de suppression de votre instantané.
Créez un objet VolumeSnapshot pour demander un instantané d'un PersistentVolumeClaim existant.
Référencez le VolumeSnapshot dans un PersistentVolumeClaim pour restaurer un volume sur cet instantané, ou créez un volume à l'aide de l'instantané.

Créer un `PersistentVolumeClaim` et un `Deployment`

Pour créer l'objet PersistentVolumeClaim, enregistrez le manifeste suivant sous le nom my-pvc.yaml :
Filestore
```
 apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
   name: my-pvc
 spec:
   storageClassName: enterprise-rwx
   accessModes:
   - ReadWriteMany
   resources:
     requests:
       storage: 1Ti
```
Cet exemple crée un PVC Filestore de niveau Enterprise. Pour en savoir plus, consultez la page Accéder aux instances Filestore avec le pilote CSI Filestore.
Pour spec.storageClassName, vous pouvez spécifier n'importe quelle classe de stockage utilisant un pilote CSI compatible.
Appliquez le fichier manifeste :
```
kubectl apply -f my-pvc.yaml
```

Pour créer un Deployment, enregistrez le fichier manifeste suivant sous le nom my-deployment.yaml :

apiVersion: apps/v1
kind: Deployment
metadata:
  name: hello-app
spec:
  selector:
    matchLabels:
      app: hello-app
  template:
    metadata:
      labels:
        app: hello-app
    spec:
      containers:
      - name: hello-app
        image: google/cloud-sdk:slim
        args: [ "sleep", "3600" ]
        volumeMounts:
        - name: sdk-volume
          mountPath: /usr/share/hello/
      volumes:
      - name: sdk-volume
        persistentVolumeClaim:
          claimName: my-pvc

Appliquez le fichier manifeste :
```
kubectl apply -f my-deployment.yaml
```
Vérifiez l'état du Deployment.
```
kubectl get deployment hello-app
```
La préparation du Deployment peut prendre un certain temps. Vous pouvez exécuter la commande ci-dessus jusqu'à obtenir un résultat semblable à celui-ci :
```
NAME        READY   UP-TO-DATE   AVAILABLE   AGE
hello-app   1/1     1            1           2m55s
```

Ajouter un fichier de test au volume

Référencez les Pods dans le Deployment :

kubectl get pods -l app=hello-app

Le résultat ressemble à ce qui suit :

NAME                         READY   STATUS    RESTARTS   AGE
hello-app-6d7b457c7d-vl4jr   1/1     Running   0          2m56s

Créez un fichier de test dans un Pod :

kubectl exec POD_NAME \
    -- sh -c 'echo "Hello World!" > /usr/share/hello/hello.txt'

Remplacez POD_NAME par le nom du Pod.

Vérifiez la présence du fichier.

kubectl exec POD_NAME \
    -- sh -c 'cat /usr/share/hello/hello.txt'

Le résultat ressemble à ce qui suit :

Hello World!

Créer un objet `VolumeSnapshotClass`.

Créez un objet VolumeSnapshotClass pour spécifier le pilote CSI et deletionPolicy pour votre instantané de volume. Vous pouvez référencer des objets VolumeSnapshotClass lorsque vous créez des objets VolumeSnapshot.

Enregistrez le fichier manifeste suivant sous le nom volumesnapshotclass.yaml.
Filestore
```
apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
  name: my-snapshotclass
driver: filestore.csi.storage.gke.io
parameters:
  type: backup
deletionPolicy: Delete
```
Dans cet exemple :
- Le champ driver est utilisé par le pilote CSI pour provisionner l'instantané. Dans cet exemple, filestore.csi.storage.gke.io utilise le pilote CSI Filestore.
- Le champ deletionPolicy indique à GKE ce qu'il faut faire avec l'objet VolumeSnapshotContent et l'instantané sous-jacent lorsque l'objet VolumeSnapshot lié est supprimé. Spécifiez la valeur Delete pour supprimer l'objet VolumeSnapshotContent et l'instantané sous-jacent. Spécifiez la valeur Retain si vous souhaitez conserver l'objet VolumeSnapshotContent et l'instantané sous-jacent.

Appliquez le fichier manifeste :

kubectl apply -f volumesnapshotclass.yaml

Créer un objet `VolumeSnapshot`

Un objet VolumeSnapshot est une requête d'instantané d'un objet PersistentVolumeClaim existant. Lorsque vous créez un objet VolumeSnapshot, GKE le crée et le lie automatiquement avec un objet VolumeSnapshotContent, qui est une ressource de votre cluster comme un objet PersistentVolume.

Enregistrez le fichier manifeste suivant sous le nom volumesnapshot.yaml.

apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshot
metadata:
  name: my-snapshot
spec:
  volumeSnapshotClassName: my-snapshotclass
  source:
    persistentVolumeClaimName: my-pvc

Appliquez le fichier manifeste :
```
kubectl apply -f volumesnapshot.yaml
```
Après avoir créé un instantané Volume, GKE crée un objet VolumeSnapshotContent correspondant dans le cluster. Cet objet stocke l'instantané et les liaisons avec les objets VolumeSnapshot. Il n'est pas possible d'interagir directement avec les objets VolumeSnapshotContents.

Vérifiez que GKE a créé l'objet VolumeSnapshotContents :

kubectl get volumesnapshotcontents

Le résultat ressemble à ce qui suit :

NAME                                               AGE
snapcontent-cee5fb1f-5427-11ea-a53c-42010a1000da   55s

Une fois le contenu de l'instantané Volume créé, le pilote CSI que vous avez spécifié dans le VolumeSnapshotClass crée un instantané sur le système de stockage correspondant. Dès que GKE a créé l'instantané sur le système de stockage et l'a lié à un objet VolumeSnapshot du cluster, l'instantané devient utilisable. Vous pouvez vérifier son état à l'aide de la commande suivante :

kubectl get volumesnapshot \
  -o custom-columns='NAME:.metadata.name,READY:.status.readyToUse'

Si l'instantané est prêt à être utilisé, le résultat ressemble à ce qui suit :

NAME               READY
my-snapshot        true

Supprimer le fichier de test

Supprimez le fichier de test que vous avez créé :

kubectl exec POD_NAME \
    -- sh -c 'rm /usr/share/hello/hello.txt'

Vérifiez que le fichier n'existe plus :

kubectl exec POD_NAME \
    -- sh -c 'cat /usr/share/hello/hello.txt'

Le résultat ressemble à ce qui suit :

cat: /usr/share/hello/hello.txt: No such file or directory

Restaurer l'instantané de volume

Vous pouvez référencer un VolumeSnapshot dans un PersistentVolumeClaim pour provisionner un nouveau volume avec les données d'un volume existant.

Pour référencer un VolumeSnapshot dans une PersistentVolumeClaim, ajoutez le champ dataSource à votre PersistentVolumeClaim.

Dans cet exemple, vous référencez le VolumeSnapshot que vous avez créé dans une nouvelle PersistentVolumeClaim et vous mettez à jour le Deployment pour qu'il utilise la nouvelle revendication.

Enregistrez le manifeste suivant sous le nom pvc-restore.yaml :

Filestore

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: pvc-restore
spec:
  dataSource:
    name: my-snapshot
    kind: VolumeSnapshot
    apiGroup: snapshot.storage.k8s.io
  storageClassName: enterprise-rwx
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 1Ti

Appliquez le fichier manifeste :
```
kubectl apply -f pvc-restore.yaml
```
Mettez à jour le fichier my-deployment.yaml pour qu'il utilise le nouveau fichier PersistentVolumeClaim :
```
...
volumes:
- name: my-volume
  persistentVolumeClaim:
    claimName: pvc-restore
```
Appliquez le fichier manifeste mis à jour :
```
kubectl apply -f my-deployment.yaml
```

Vérifier que l'instantané a bien été restauré

Obtenez le nom du nouveau Pod créé par GKE pour le Deployment mis à jour :
```
 kubectl get pods -l app=hello-app
```

Vérifiez que le fichier de test existe :

   kubectl exec NEW_POD_NAME \
       -- sh -c 'cat /usr/share/hello/hello.txt'

Remplacez NEW_POD_NAME par le nom du nouveau Pod créé par GKE.

Le résultat ressemble à ce qui suit :

   Hello World!

Importer un instantané préexistant

Vous pouvez utiliser un instantané de volume existant créé en dehors du cluster actuel pour provisionner manuellement l'objet VolumeSnapshotContents. Par exemple, vous pouvez remplir un volume dans GKE avec l'instantané d'une autre ressource Google Cloud créée dans un autre cluster.

Recherchez le nom de votre instantané.

Console Google Cloud

Accédez à https://console.cloud.google.com/compute/snapshots.

Google Cloud CLI

Exécutez la commande ci-dessous.

gcloud compute snapshots list

Le résultat ressemble à ce qui suit :

NAME                                           DISK_SIZE_GB  SRC_DISK                                                     STATUS
snapshot-5e6af474-cbcc-49ed-b53f-32262959a0a0  1             us-central1-b/disks/pvc-69f80fca-bb06-4519-9e7d-b26f45c1f4aa READY

Enregistrez le manifeste VolumeSnapshot suivant sous le nom restored-snapshot.yaml.

apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshot
metadata:
  name: restored-snapshot
spec:
  volumeSnapshotClassName: my-snapshotclass
  source:
    volumeSnapshotContentName: restored-snapshot-content

Appliquez le fichier manifeste :

kubectl apply -f restored-snapshot.yaml

Enregistrez le manifeste VolumeSnapshotContent suivant sous le nom restored-snapshot-content.yaml. Remplacez le champ snapshotHandle par l'ID de votre projet et le nom de l'instantané. volumeSnapshotRef.name et volumeSnapshotRef.namespace doivent pointer vers le VolumeSnapshot créé précédemment pour que la liaison bidirectionnelle soit valide.

apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotContent
metadata:
  name: restored-snapshot-content
spec:
  deletionPolicy: Retain
  driver: filestore.csi.storage.gke.io
  source:
    snapshotHandle: projects/PROJECT_ID/global/snapshots/SNAPSHOT_NAME
  volumeSnapshotRef:
    kind: VolumeSnapshot
    name: restored-snapshot
    namespace: default

Appliquez le fichier manifeste :

kubectl apply -f restored-snapshot-content.yaml

Enregistrez le manifeste PersistentVolumeClaim suivant sous le nom restored-pvc.yaml. Le contrôleur de stockage Kubernetes recherche un VolumeSnapshot nommé restored-snapshot, puis tente de trouver ou de créer de manière dynamique un PersistentVolume comme source de données. Vous pouvez ensuite utiliser ce PVC dans un pod pour accéder aux données restaurées.
```
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: restored-pvc
spec:
  dataSource:
    name: restored-snapshot
    kind: VolumeSnapshot
    apiGroup: snapshot.storage.k8s.io
  storageClassName: enterprise-rwx
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 1Gi
```
Appliquez le fichier manifeste :
```
kubectl apply -f restored-pvc.yaml
```

Enregistrez le fichier manifeste Pod suivant en tant que restored-pod.yaml en référence à PersistentVolumeClaim Le pilote CSI provisionne un PersistentVolume et le remplit à partir de l'instantané.

apiVersion: v1
kind: Pod
metadata:
  name: restored-pod
spec:
  containers:
  - name: busybox
    image: busybox
    args:
    - sleep
    - "3600"
    volumeMounts:
    - name: source-data
      mountPath: /demo/data
  volumes:
  - name: source-data
    persistentVolumeClaim:
      claimName: restored-pvc
      readOnly: false

Appliquez le fichier manifeste :
```
kubectl apply -f restored-pod.yaml
```

Vérifiez que le fichier a été restauré :

kubectl exec restored-pod -- sh -c 'cat /demo/data/hello.txt'

Effectuer un nettoyage

Pour éviter que les ressources utilisées sur cette page soient facturées sur votre compte Google Cloud, procédez comme suit :

Supprimez le sous-réseau VolumeSnapshot :
```
kubectl delete volumesnapshot my-snapshot
```
Remarque : Si la VolumeSnapshotClass de l'instantané de volume spécifie deletionPolicy:Delete, le VolumeSnapshotContent correspondant et l'instantané physique sur le système de stockage sont également supprimés. Si deletionPolicy:Retain est spécifié, GKE conserve l'instantané sous-jacent.

Supprimez le sous-réseau VolumeSnapshotClass :

kubectl delete volumesnapshotclass my-snapshotclass

Supprimez le sous-réseau Deployment :
```
kubectl delete deployments hello-app
```
Supprimer les objets PersistentVolumeClaim :
```
kubectl delete pvc my-pvc pvc-restore
```

Étape suivante

Consultez la documentation Kubernetes sur les instantanés de volume.
Apprenez-en davantage sur l'expansion de volume.
Découvrez comment installer manuellement un pilote CSI.
Apprenez-en plus sur l'utilisation de Filestore en tant qu'option de stockage de fichiers pour GKE.

Sauvegarder l'espace de stockage Filestore à l'aide d'instantanés de volume

Conditions requises

Limites

Avant de commencer

Créer et utiliser un instantané de volume

Créer un PersistentVolumeClaim et un Deployment

Filestore

Ajouter un fichier de test au volume

Créer un objet VolumeSnapshotClass.

Filestore

Créer un objet VolumeSnapshot

Supprimer le fichier de test

Restaurer l'instantané de volume

Filestore

Vérifier que l'instantané a bien été restauré

Importer un instantané préexistant

Console Google Cloud

Google Cloud CLI

Effectuer un nettoyage

Étape suivante

Créer un `PersistentVolumeClaim` et un `Deployment`

Créer un objet `VolumeSnapshotClass`.

Créer un objet `VolumeSnapshot`