Planifier des sauvegardes


Ce tutoriel explique comment planifier des sauvegardes pour des instances Filestore à l'aide de Cloud Scheduler et Cloud Functions.

Objectifs

  • Créez un compte de service client pour Cloud Scheduler qui dispose des identifiants nécessaires pour appeler une fonction Cloud Functions.
  • Créez un compte de service client à utiliser par Cloud Functions avec les identifiants nécessaires pour appeler le point de terminaison Filestore.
  • Créer une fonction Cloud Functions qui crée (ou supprime) une sauvegarde d'un partage de fichiers
  • Créer une tâche Cloud Scheduler qui exécute la fonction de création de sauvegardes (ou supprimer des sauvegardes) à intervalles réguliers.

Coûts

Dans ce document, vous utilisez les composants facturables suivants de Google Cloud :

Obtenez une estimation des coûts en fonction de votre utilisation prévue à l'aide du simulateur de coût. Les nouveaux utilisateurs de Google Cloud peuvent bénéficier d'un essai gratuit.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  4. Activer les API Artifact Registry, Cloud Build, Filestore, Cloud Functions, Cloud Logging, Pub/Sub, Cloud Run, and Cloud Scheduler.

    Activer les API

  5. Installez Google Cloud CLI.
  6. Pour initialiser gcloudCLI, exécutez la commande suivante :

    gcloud init
  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  8. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  9. Activer les API Artifact Registry, Cloud Build, Filestore, Cloud Functions, Cloud Logging, Pub/Sub, Cloud Run, and Cloud Scheduler.

    Activer les API

  10. Installez Google Cloud CLI.
  11. Pour initialiser gcloudCLI, exécutez la commande suivante :

    gcloud init
  12. Si vous ne disposez d'aucune instance Filestore dans votre projet, vous devez d'abord en créer une.

Créer des comptes de service client pour Cloud Scheduler et Cloud Functions

  1. Si vous ne l'avez pas déjà fait, cliquez sur Activer Cloud Shell dans la console Google Cloud.

  2. Créer un compte de service client que Cloud Scheduler exécute pour appeler une fonction Cloud Functions Pour cet exemple, utilisez la commande iam service-accounts create pour nommer le compte schedulerunner et définir le nom à afficher sur "Compte de service pour FS Backups-Scheduler":

    gcloud iam service-accounts create schedulerunner \
        --display-name="Service Account for FS Backups-Scheduler"
    
  3. créer un compte de service client que Cloud Functions exécute pour appeler le point de terminaison Filestore ; Pour cet exemple, nous appelons le compte backupagent et f définissons le nom à afficher sur "Service Account for FS Backups-GCF":

    gcloud iam service-accounts create backupagent \
        --display-name="Service Account for FS Backups-GCF"
    

    Vous pouvez vérifier si le compte de service a été créé en exécutant la commande iam service-accounts list:

    gcloud iam service-accounts list
    

    La commande renvoie un résultat semblable à celui-ci:

    NAME                                         EMAIL                                                   DISABLED
    Service Account for FS Backups-GCF           backupagent@$PROJECT_ID.iam.gserviceaccount.com         False
    Service Account for FS Backups-Scheduler     schedulerunner@$PROJECT_ID.iam.gserviceaccount.com      False
    

Configurer des variables d'environnement

Configurez les variables d'environnement suivantes dans votre environnement local:

  • ID et projet Google Cloud:

    export PROJECT_ID=`gcloud config get-value core/project`
    export PROJECT_NUMBER=`gcloud projects describe $PROJECT_ID --format='value(projectNumber)'`
    
  • L'agent de service Cloud Scheduler et les comptes de service client pour Cloud Scheduler et Cloud Functions:

    export SCHEDULER_SA=service-$PROJECT_NUMBER@gcp-sa-cloudscheduler.iam.gserviceaccount.com
    export SCHEDULER_CLIENT_SA=schedulerunner@$PROJECT_ID.iam.gserviceaccount.com
    export GCF_CLIENT_SA=backupagent@$PROJECT_ID.iam.gserviceaccount.com
    
  • Votre instance Filestore:

    export FS_LOCATION=fs-location
    export INSTANCE_NAME=instance-id
    export SHARE_NAME=datafile-share-name
    

    Remplacez les éléments suivants :

    • fs-location par la région ou la zone où se trouve l'instance Filestore.
    • instance-id est l'ID de l'instance Filestore ;
    • file-share-name est le nom que vous spécifiez pour le partage de fichiers NFS qui est diffusé à partir de l'instance.
  • Configurez les variables d'environnement pour votre sauvegarde Filestore:

    export FS_BACKUP_LOCATION=region
    

    Remplacez region par la région dans laquelle vous souhaitez stocker la sauvegarde.

Créer une fonction permettant de créer une sauvegarde

  1. Dans la console Google Cloud, accédez à la page Cloud Functions.

    Accéder à la page Cloud Functions

  2. Cliquez sur Créer une fonction, puis configurez la fonction comme suit:

    • Principes de base :
      • Environnement: dans cet exemple, sélectionnez 2nd gen (valeur par défaut).
      • Nom de la fonction: pour cet exemple, nous appelons la fonction : fsbackup.
      • Région: pour cet exemple, sélectionnez us-central1.
    • Déclencheur :
      • Type de déclencheur: sélectionnez HTTPS dans le menu.
      • Authentification: sélectionnez Require authentication.
    • Paramètres d'exécution, de compilation, de connexion et de sécurité :
      • Environnement d'exécution > Compte de service d'exécution > Compte de service: sélectionnez Service Account for FS Backups-GCF (backupagent@$PROJECT_ID.iam.gserviceaccount.com) dans le menu.
      • Connexions > Paramètres d'entrée: sélectionnez Allow all traffic.
  3. Cliquez sur Next (Suivant), puis poursuivez la configuration comme suit:

    • Environnement d'exécution: sélectionnez Python 3.8, ou une version ultérieure, entièrement compatible avec Cloud Functions dans le menu.
    • Code source : Inline editor.
    • Point d'entrée: saisissez create_backup.
    • Ajoutez les dépendances suivantes à votre fichier requirements.txt:

      google-auth==2.29.0
      requests==2.31.0
      

      Selon votre cas d'utilisation, vous devrez peut-être spécifier d'autres dépendances ainsi que les numéros de version correspondants. Pour en savoir plus, consultez la section Packages préinstallés.

    • Copiez l'exemple de code Python suivant dans le fichier main.py à l'aide de l'éditeur intégré:

      Créer des sauvegardes

      1. Cet exemple de code crée une sauvegarde nommée mybackup- et associée à l'heure de création.
      PROJECT_ID = 'project-id'
      SOURCE_INSTANCE_ZONE = 'filestore-zone'
      SOURCE_INSTANCE_NAME = 'filestore-name'
      SOURCE_FILE_SHARE_NAME = 'file-share-name'
      BACKUP_REGION = 'backup-region'
      
      import google.auth
      import google.auth.transport.requests
      from google.auth.transport.requests import AuthorizedSession
      import time
      import requests
      import json
      
      credentials, project = google.auth.default()
      request = google.auth.transport.requests.Request()
      credentials.refresh(request)
      authed_session = AuthorizedSession(credentials)
      
      def get_backup_id():
          return "mybackup-" + time.strftime("%Y%m%d-%H%M%S")
      
      def create_backup(request):
          trigger_run_url = "https://file.googleapis.com/v1/projects/{}/locations/{}/backups?backupId={}".format(PROJECT_ID, BACKUP_REGION, get_backup_id())
          headers = {
            'Content-Type': 'application/json'
          }
          post_data = {
            "description": "my new backup",
            "source_instance": "projects/{}/locations/{}/instances/{}".format(PROJECT_ID, SOURCE_INSTANCE_ZONE, SOURCE_INSTANCE_NAME),
            "source_file_share": "{}".format(SOURCE_FILE_SHARE_NAME)
          }
          print("Making a request to " + trigger_run_url)
          r = authed_session.post(url=trigger_run_url, headers=headers, data=json.dumps(post_data))
          data = r.json()
          print(data)
          if r.status_code == requests.codes.ok:
            print(str(r.status_code) + ": The backup is uploading in the background.")
          else:
            raise RuntimeError(data['error'])
          return "Backup creation has begun!"
      

      Remplacez les éléments suivants :

      • project-id par l'ID de projet Google Cloud de l'instance Filestore source.
      • filestore-zone par la zone de l'instance Filestore source.
      • filestore-name par le nom de l'instance Filestore source.
      • file-share-name par le nom du partage de fichiers ;
      • backup-region par la région dans laquelle stocker la sauvegarde.
      1. Cliquez sur Tester la fonction.

        Une session "Nouvel onglet" s'ouvre dans Cloud Shell. Si l'opération réussit, le message suivant est renvoyé:

        Function is ready to test.
        
      2. Cliquez sur Déployer et attendez la fin du déploiement.

      3. Revenez à l'onglet Cloud Shell précédent.

      Supprimer des sauvegardes

      Cet exemple de code supprime les sauvegardes antérieures à une période prédéfinie.

      Configurez cette fonction de la même manière que la fonction "create backup", à l'exception des éléments suivants :

      • Nom de la fonction : deletefsbackups.
      • Point d'entrée : delete_backup.
      PROJECT_ID = 'project-id'
      BACKUP_REGION = 'region'
      BACKUP_RETENTION_TIME_HRS = hours
      
      import google.auth
      import google.auth.transport.requests
      from google.auth.transport.requests import AuthorizedSession
      import time
      import requests
      import json
      
      credentials, project = google.auth.default()
      request = google.auth.transport.requests.Request()
      credentials.refresh(request)
      authed_session = AuthorizedSession(credentials)
      
      retention_seconds = BACKUP_RETENTION_TIME_HRS * 60 * 60
      
      def delete_backup(request):
          now = time.time()
          list = []
          trigger_run_url = "https://file.googleapis.com/v1beta1/projects/{}/locations/{}/backups".format(PROJECT_ID, BACKUP_REGION)
          r = authed_session.get(trigger_run_url)
          data = r.json()
          if not data:
              print("No backups to delete.")
              return "No backups to delete."
          else:
              list.extend(data['backups'])
              while 'nextPageToken' in data.keys():
                  nextPageToken = data['nextPageToken']
                  trigger_run_url_next = "https://file.googleapis.com/v1beta1/projects/{}/locations/{}/backups?pageToken={}".format(PROJECT_ID, BACKUP_REGION, nextPageToken)
                  r = authed_session.get(trigger_run_url_next)
                  data = r.json()
                  list.extend(data['backups'])
          for i in list:
              backup_time = i['createTime']
              backup_time = backup_time[:-4]
              backup_time = float(time.mktime(time.strptime(backup_time, "%Y-%m-%dT%H:%M:%S.%f")))
              if now - backup_time > retention_seconds:
                  print("Deleting " + i['name'] + " in the background.")
                  r = authed_session.delete("https://file.googleapis.com/v1beta1/{}".format(i['name']))
                  data = r.json()
                  print(data)
                  if r.status_code == requests.codes.ok:
                    print(str(r.status_code) + ": Deleting " + i['name'] + " in the background.")
                  else:
                    raise RuntimeError(data['error'])
          return "Backup deletion has begun!"
      

      Remplacez les éléments suivants :

      • project-id par l'ID de projet Google Cloud de la sauvegarde.
      • region par la région dans laquelle résident les sauvegardes.
      • hours par le nombre d'heures de conservation des sauvegardes. Par exemple, si vous souhaitez conserver les sauvegardes pendant 10 jours, saisissez 240.

Attribuer des rôles IAM aux comptes de service client

  1. Ajoutez l'agent de service Cloud Scheduler à la stratégie IAM du compte de service client Cloud Scheduler avec le rôle roles/cloudscheduler.serviceAgent. Cela permet à l'agent de service d'emprunter l'identité du compte de service client afin d'appeler la fonction qui crée une sauvegarde. Exécutez la commande iam service-accounts add-iam-policy-binding:

    gcloud iam service-accounts add-iam-policy-binding $SCHEDULER_CLIENT_SA \
        --member=serviceAccount:$SCHEDULER_SA \
        --role=roles/cloudscheduler.serviceAgent
    
  2. Attribuez le rôle roles/file.editor au compte de service client de Cloud Functions afin qu'il puisse appeler le point de terminaison Filestore. Exécutez la commande projects add-iam-policy-binding:

    gcloud projects add-iam-policy-binding $PROJECT_ID \
        --member=serviceAccount:$GCF_CLIENT_SA \
        --role=roles/file.editor
    
  3. Accordez au compte de service client de Cloud Scheduler le rôle roles/cloudfunctions.invoker pour la fonction que vous souhaitez utiliser. Exécutez la commande functions add-iam-policy-binding suivante:

    Créer des sauvegardes

    gcloud functions add-iam-policy-binding fsbackup \
        --member serviceAccount:$SCHEDULER_CLIENT_SA \
        --role roles/cloudfunctions.invoker
    

    Désormais, seul le compte de service client de Cloud Scheduler peut appeler fsbackup.

    Supprimer des sauvegardes

    gcloud functions add-iam-policy-binding deletefsbackups \
        --member serviceAccount:$SCHEDULER_CLIENT_SA \
        --role roles/cloudfunctions.invoker
    

    Désormais, seul le compte de service client de Cloud Scheduler peut appeler deletefsbackups.

Créer une tâche Cloud Scheduler qui déclenche la fonction fsbackup avec une programmation spécifiée

  1. Dans l'exemple de ce tutoriel, si vous souhaitez planifier une sauvegarde tous les jours de la semaine à 22h, utilisez la commande scheduler jobs create http:

    gcloud scheduler jobs create http fsbackupschedule \
        --schedule "0 22 * * 1-5" \
        --http-method=GET \
        --uri=https://us-central1-$PROJECT_ID.cloudfunctions.net/fsbackup \
        --oidc-service-account-email=$SCHEDULER_CLIENT_SA    \
        --oidc-token-audience=https://us-central1-$PROJECT_ID.cloudfunctions.net/fsbackup
    

    L'option --schedule vous permet de spécifier la fréquence d'exécution de la tâche en utilisant le formatage unix-cron. Pour plus d'informations, consultez la section Configurer la planification de tâches Cron.

  2. Démarrez la tâche Cloud Scheduler créée à l'étape précédente. Dans notre exemple, utilisez la commande scheduler jobs runs pour l'exécuter immédiatement:

    gcloud scheduler jobs run fsbackupschedule
    

    La tâche fsbackupschedule appelle la fonction fsbackups immédiatement après avoir exécuté la commande, puis l'appelle à nouveau tous les jours de la semaine à 22h jusqu'à ce que la tâche soit mise en pause.

  3. Vérifiez les journaux de la fonction fsbackups pour voir si elle s'exécute correctement et renvoie un objet status 200.

  4. Vérifiez si la sauvegarde a été créée à l'aide de la commande backups list:

    gcloud filestore backups list
    

    La commande renvoie un résultat semblable au suivant :

    NAME                      LOCATION     SRC_INSTANCE                        SRC_FILE_SHARE  STATE
    mybackup-20201123-184500  us-central1  us-central1-c/instances/nfs-server  vol1            READY
    

Alertes de quota faibles pour les sauvegardes

Si la mise en œuvre de la programmation de sauvegardes vous présente un risque de manquer de quota de sauvegardes, nous vous recommandons de configurer des alertes de faible quota de sauvegardes. Ainsi, vous êtes averti lorsque le quota de sauvegardes est faible.

Effectuer un nettoyage

Une fois le tutoriel terminé, vous pouvez procéder au nettoyage des ressources que vous avez créées afin qu'elles ne soient plus comptabilisées dans votre quota et qu'elles ne vous soient plus facturées. Dans les sections suivantes, nous allons voir comment supprimer ou désactiver ces ressources.

Supprimer le projet

Le moyen le plus simple d'empêcher la facturation est de supprimer le projet que vous avez créé pour ce tutoriel.

Pour supprimer le projet :

  1. Dans la console Google Cloud, accédez à la page Gérer les ressources.

    Accéder à la page Gérer les ressources

  2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer.
  3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

Étapes suivantes