Programmer des instantanés Filestore Enterprise

Modèle de déploiement

Le diagramme suivant présente le modèle de déploiement compatible avec les fonctions Cloud Run des instantanés Filestore.

La tâche Cloud Scheduler se coordonne avec les fonctions Cloud Run pour planifier et générer des instantanés et des fichiers journaux Filestore. Les instantanés sont disponibles dans le partage Filestore.

Limitations connues

Lorsque vous vous préparez à configurer un planificateur d'instantanés pour les instances Filestore, tenez compte des limites suivantes:

• La fonction ne supprime qu'un seul instantané si nécessaire, même s'il y a plus d'instantanés de planificateur que définis dans le fichier de configuration de la règle de conservation ou si le fichier de configuration de la règle de conservation est mis à jour pour conserver moins d'instantanés qu'auparavant.
• Si vous diminuez la valeur numérique de snapshots dans le fichier de configuration JSON, les instantanés redondants de l'instance ne sont pas automatiquement supprimés. Si vous modifiez ce paramètre, vous devez supprimer manuellement les instantanés redondants.
• Comme la limite de l'ID d'instantané est de 75 caractères, le nom de la stratégie de conservation est limité à 50 caractères.

Préparer votre environnement

Dans cette section, vous allez configurer vos variables d'environnement, cloner le dépôt et créer les applications et les fichiers dont vous avez besoin pour ce tutoriel.

Définir des variables d'environnement

• Dans Cloud Shell, saisissez la commande suivante :

gcloud components update

• Dans Cloud Shell, créez les variables suivantes:

  export PROJECT_ID=PROJECT_ID
  export GCP_REGION=GCP_REGION
  export APP_ENGINE_REGION=APP_ENGINE_REGION
  export FUNCTION_NAME=FUNCTION_NAME
  export SCHEDULER_NAME=SCHEDULER_NAME
  export SCHEDULER_EXPRESSION="SCHEDULER_EXPRESSION"
  export SCHEDULER_TZ=SCHEDULER_TZ
  export SERVICE_ACCOUNT_NAME=SERVICE_ACCOUNT_NAME
  

  Remplacez les éléments suivants :

  • PROJECT_ID: ID du projet Google Cloud dans lequel vous souhaitez installer l'instance Filestore Enterprise, la fonction Cloud Run et le planificateur Cloud.
  • GCP_REGION: région Google Cloud dans laquelle vous souhaitez installer l'instance Filestore Enterprise, la fonction Cloud Run et Cloud Scheduler.
  • APP_ENGINE_REGION: région de la liste des emplacements App Engine dans laquelle vous souhaitez installer App Engine. Tenez compte des exigences suivantes :
    • Un projet Google Cloud ne peut comporter qu'une seule instance App Engine, et la région App Engine ne peut plus être modifiée ultérieurement.
    • La tâche Cloud Scheduler et l'instance App Engine doivent se trouver dans la même région.
      • Par exemple, si les ressources Cloud Scheduler utilisent us-central1, utilisez l'équivalent App Engine us-central.
      • App Engine applique une convention d'attribution de nom unique pour certaines régions. Pour en savoir plus, consultez la liste des emplacements App Engine.
  • FUNCTION_NAME: nom que vous souhaitez donner à la fonction Cloud Run.
  • SCHEDULER_NAME: nom que vous souhaitez attribuer à Cloud Scheduler.
  • SCHEDULER_EXPRESSION: expression cron Cloud Scheduler (par exemple, 10 0 * * *) Pour en savoir plus, consultez la section Configurer des job Cron Cron.
  • SCHEDULER_TZ: votre fuseau horaire pour Cloud Scheduler, au format de nom de la liste des fuseaux horaires de la base de données tz (par exemple, America/Los_Angeles).
  • SERVICE_ACCOUNT_NAME: nom du compte de service nouvellement créé (par exemple, scheduler-sa).

Créer un compte de service

Dans cette section, vous allez créer un compte de service dédié, qui vous permettra de créer et de gérer la fonction Cloud Run et la tâche Cloud Scheduler.

Lorsque vous effectuez cette procédure, le compte de service nécessite les autorisations suivantes:

• file.instances.get
• file.snapshots.list
• file.snapshots.create
• file.operations.get
• file.snapshots.delete
• cloudfunctions.functions.invoke

Pour en savoir plus, consultez les pages Autorisations IAM Filestore ou Autorisations IAM des fonctions Cloud Run.

Pour créer le compte de service, procédez comme suit :

1. Dans Cloud Shell, créez un rôle dédié au planificateur d'instantanés avec les autorisations requises:

   gcloud iam roles create snapshot_scheduler --project $PROJECT_ID --permissions file.instances.get,file.snapshots.list,file.snapshots.create,file.operations.get,file.snapshots.delete,logging.logEntries.create,cloudfunctions.functions.invoke --stage GA
   

2. Créez le compte de service :

   gcloud iam service-accounts create $SERVICE_ACCOUNT_NAME --project $PROJECT_ID
   

3. Associez le rôle au compte de service:

   gcloud projects add-iam-policy-binding $PROJECT_ID --member serviceAccount:$SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com --role projects/$PROJECT_ID/roles/snapshot_scheduler
   

Créer une instance Filestore Enterprise

1. Si vous n'avez pas encore créé de variables d'environnement pour une instance Filestore Enterprise que vous souhaitez utiliser, créez les variables suivantes dans Cloud Shell:

   export FILESTORE_INSTANCE_ID=FILESTORE_INSTANCE_ID
   export FILESTORE_SHARE_NAME=SHARE_NAME
   export FILESTORE_SHARE_SIZE=NUMERIC_IN_GB
   export NETWORK_NAME=VPC_NAME
   

   Remplacez les éléments suivants :

   • FILESTORE_INSTANCE_ID: nom de l'instance Filestore Enterprise
   • SHARE_NAME: nom du partage de l'instance Filestore Enterprise
   • NUMERIC_IN_GB: taille du partage de l'instance Filestore Enterprise, un nombre compris entre 1 024 et 10 240, par incréments de 256
   • VPC_NAME: nom du réseau VPC où vous souhaitez installer l'instance Filestore Enterprise

2. Si vous n'en avez pas encore, créez une instance Filestore:

   gcloud filestore instances create $FILESTORE_INSTANCE_ID --network name=$NETWORK_NAME --file-share=capacity=$FILESTORE_SHARE_SIZE,name=$FILESTORE_SHARE_NAME --tier ENTERPRISE --project=$PROJECT_ID --location=$GCP_REGION
   

Pour en savoir plus, consultez la page Créer des instances.

Créer un App Engine

Dans cette section, vous allez créer un App Engine pour votre projet Google Cloud. Vous pourrez ainsi créer une tâche Cloud Scheduler plus tard dans ce tutoriel.

Un projet Google Cloud ne peut comporter qu'un seul App Engine, et la région ne peut plus être modifiée ultérieurement.

• Si vous n'en avez pas encore, créez un App Engine dans Cloud Shell:

  gcloud app create --region=$APP_ENGINE_REGION --project=$PROJECT_ID
  

Créer le fichier de configuration JSON

Le fichier de configuration JSON peut contenir jusqu'à huit instances Filestore, en raison d'une limite des fonctions Cloud Run. Si vous avez plus de huit instances Filestore pour lesquelles planifier des instantanés, utilisez des tâches Cloud Scheduler supplémentaires.

• Dans Cloud Shell, créez un fichier nommé request.json et modifiez son contenu en fonction de votre environnement:

  {
              "retention_policy": "RETENTION_NAME",
              "instances": [
                  {"instance_path": "projects/PROJECT_ID/locations/GCP_REGION/instances/FILESTORE_INSTANCE_ID/",
                      "snapshots": NUMBER_OF_SNAPSHOTS
                  }
              ]
  }
  

  Remplacez les éléments suivants :

  • RETENTION_NAME: nom du type de conservation de l'instantané, qui fait partie du nom de l'instantané (par exemple, daily).
  • NUMBER_OF_SNAPSHOTS: nombre d'instantanés.

Cloner le dépôt

Clonez le dépôt de l'atelier, puis accédez au répertoire:

1. Dans Cloud Shell, clonez le dépôt de l'atelier:

   git clone https://github.com/GoogleCloudPlatform/Filestore-Snapshot-Scheduler
   

   Le résultat ressemble à ce qui suit :

   Cloning into Filestore-Snapshot-Scheduler
   

2. Accédez au répertoire:

   cd Filestore-Snapshot-Scheduler
   

Créer la fonction Cloud Run

Dans Cloud Shell, créez la solution de fonction Cloud Run:

gcloud functions deploy $FUNCTION_NAME --region $GCP_REGION --runtime=python39 --trigger-http --source scheduler/ --timeout 540 --service-account $SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com --entry-point main --project $PROJECT_ID

Exemple :

gcloud functions deploy scheduler_func --region us-central1 --runtime=python39 --trigger-http --source scheduler/ --timeout 540 --service-account scheduler-sa@project1.iam.gserviceaccount.com --entry-point main --project project1

Créer une tâche Cloud Scheduler

La tâche Cloud Scheduler doit se trouver dans une région équivalente à celle d'App Engine.

Dans Cloud Shell, créez une tâche Cloud Scheduler avec un ou plusieurs planificateurs sur la même instance Filestore:

gcloud scheduler jobs create http $SCHEDULER_NAME --schedule "$SCHEDULER_EXPRESSION" --uri "https://$GCP_REGION-$PROJECT_ID.cloudfunctions.net/$FUNCTION_NAME"  --http-method POST --message-body-from-file ../request.json --oidc-service-account-email $SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com --time-zone $SCHEDULER_TZ --project $PROJECT_ID

Dans l'exemple suivant, le planificateur quotidien s'exécute à 20h :

gcloud scheduler jobs create http daily_scheduler --schedule "0 20 * * *" --uri "https://us-central1-project1.cloudfunctions.net/scheduler_func"  --http-method POST --message-body-from-file ../request.json --oidc-service-account-email scheduler-sa@project1.iam.gserviceaccount.com --time-zone America/Los_angeles --project project1

Valider les instantanés Filestore programmés

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

   Accéder à Cloud Scheduler

2. Sur la ligne de la tâche que vous avez créée, cliquez sur more_vert Actions > Forcer l'exécution d'une tâche.

3. Cliquez sur Actualiser.

   • Si la tâche s'exécute correctement, la colonne Résultat de la dernière exécution affiche un code temporel de la dernière tâche réussie.

   • Si la tâche échoue, procédez comme suit:

     1. Accédez à la page Cloud Functions.

        Accéder à Cloud Functions

     2. Sur la ligne de la fonction que vous avez créée, cliquez sur more_vert Actions > Afficher les journaux.

     3. Recherchez un message d'erreur et procédez au dépannage en conséquence.

4. Dans la console Google Cloud, accédez à la page Instances Filestore.

5. Dans la liste Instances, sélectionnez votre instance et vérifiez qu'elle dispose d'un instantané au format de nom suivant:

   sched-RETENTION_NAME-DATE-TIME
   

   Par exemple, sched-daily-20220315-120640.