Planifier des sauvegardes sur un serveur distant

Vous consultez actuellement la version 1.11 de la documentation d'Apigee hybrid. Pour en savoir plus, consultez la section Versions compatibles.

Version 1.11 

   Versions compatibles :

• v1.13 (la plus récente)
• v1.12
• v1.11                         
• Liste des versions compatibles

   Versions non compatibles :

• v1.10
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

Cette page explique comment planifier des sauvegardes pour Cassandra sans Cloud Storage. Dans cette méthode, les sauvegardes sont stockées sur un serveur distant que vous avez spécifié au lieu d'un bucket Cloud Storage. Apigee utilise SSH pour communiquer avec le serveur distant.

Vous devez planifier les sauvegardes en tant que tâches cron. Une fois que la planification d'une sauvegarde a été appliquée à votre cluster hybride, une tâche de sauvegarde Kubernetes est exécutée régulièrement en fonction de la planification dans le plan d'exécution. La tâche déclenche un script de sauvegarde sur chaque nœud Cassandra de votre cluster hybride. Ce script collecte toutes les données du nœud, crée un fichier d'archive (compressé) des données et envoie l'archive au serveur spécifié dans votre fichier overrides.yaml.

Remarque :

• Vous devez vous assurer que le système de fichiers dispose de suffisamment d'espace pour les sauvegardes et ajuster la fréquence des sauvegardes pour éviter d'occuper inutilement l'espace de stockage alloué. Apigee n'impose pas de règle de conservation pour les fichiers de sauvegarde. Vous pouvez créer une règle de conservation pour les fichiers adaptés à votre installation.
• L'application de la configuration de sauvegarde sur le cluster existant entraînera le redémarrage progressif des pods Cassandra.

Les étapes suivantes incluent des exemples de tâches typiques, comme la création d'une paire de clés SSH. Utilisez les méthodes adaptées à votre installation.

La procédure comprend les éléments suivants :

• Configurer le serveur et SSH
• Planifier les sauvegardes et définir leur destination

Configurer le serveur et SSH

1. Désignez un serveur Linux ou Unix pour vos sauvegardes. Ce serveur doit être accessible à l'aide de SSH à partir de votre plan d'exécution Apigee hybrid. Il doit disposer de suffisamment d'espace de stockage pour vos sauvegardes.
2. Configurez un serveur SSH sur le serveur, ou vérifiez qu'un serveur SSH sécurisé est déjà configuré.
   Attention : Pour des raisons de sécurité, assurez-vous que votre serveur SSH est à jour.
3. Créez une paire de clés SSH et stockez le fichier de clé privée dans un emplacement accessible à partir de votre plan d'exécution hybride. Vous devez utiliser un mot de passe vide pour votre paire de clés, sinon la sauvegarde échouera. Exemple :

   ssh-keygen -t rsa -b 4096 -C [e-mail]
     Enter file in which to save the key (/Users/exampleuser/.ssh/id_rsa): $APIGEE_HOME/hybrid-files/certs/ssh_key
     Enter passphrase (empty for no passphrase):
     Enter same passphrase again:
     Your identification has been saved in ssh_key
     Your public key has been saved in ssh_key.pub
     The key fingerprint is:
     SHA256:DWKo334XMZcZYLOLrd/8HNpjTERPJJ0mc11UYmrPvSA [e-mail]
     The key's randomart image is:
     +---[RSA 4096]----+
     |          +.  ++X|
     |     .   . o.=.*+|
     |    . o . . o==o |
     |   . . . =oo+o...|
     |  .     S +E oo .|
     |   . .   .. . o .|
     |    . . .  . o.. |
     |     .  ...o ++. |
     |      .. .. +o+. |
     +----[SHA256]-----+

   Où [e-mail] est une chaîne. Toute chaîne qui suit -C dans la commande ssh-keygen devient un commentaire inclus dans la clé ssh qui vient d'être créée. La chaîne d'entrée peut être n'importe quelle chaîne. Lorsque vous utilisez un nom de compte au format [e-mail], vous pouvez rapidement identifier le compte associé à la clé.

4. Créez un compte utilisateur nommé apigee sur le serveur de sauvegarde. Assurez-vous que le nouvel utilisateur apigee possède un répertoire d'accueil sous /home.
5. Sur le serveur de sauvegarde, créez un répertoire .ssh dans le nouveau répertoire /home/apigee.
6. Copiez la clé publique (ssh_key.pub dans l'exemple précédent) dans un fichier nommé authorized_keys dans le nouveau répertoire /home/apigee/.ssh. Exemple :

   cd /home/apigee
   mkdir .ssh
   cd .ssh
   vi authorized_keys

7. Sur votre serveur de sauvegarde, créez un répertoire de sauvegarde dans le répertoire /home/apigee/. Le répertoire de sauvegarde peut être n'importe quel répertoire tant que l'utilisateur apigee y a accès. Exemple :

   cd /home/apigee
   mkdir cassandra-backup

8. Testez la connexion. Vous devez vous assurer que vos pods Cassandra peuvent se connecter à votre serveur de sauvegarde à l'aide de SSH :
   1. Connectez-vous à l'interface système de votre pod Cassandra. Exemple :

      kubectl exec -it -n apigee APIGEE_CASSANDRA_DEFAULT_0 -- /bin/bash

      Où APIGEE_CASSANDRA_DEFAULT_0 est le nom d'un pod Cassandra. Remplacez ce nom par le nom du pod à partir duquel vous souhaitez vous connecter.

   2. Connectez-vous via SSH à votre serveur de sauvegarde en utilisant la clé SSH privée installée pour le pod Cassandra et l'adresse IP du serveur :

      ssh -i /var/secrets/keys/key apigee@BACKUP_SERVER_IP

      Remarque : À ce stade, un avertissement indiquant que l'empreinte du serveur n'est pas reconnue et vous demandant si vous souhaitez continuer est susceptible de s'afficher. Lorsque cette invite s'affiche, vous pouvez continuer et vérifier la configuration SSH.

Planifier les sauvegardes et définir leur destination

Vous devez définir le calendrier et la destination des sauvegardes dans le fichier overrides.yaml.

1. Ajoutez les paramètres suivants au fichier overrides.yaml :

   Paramètres

   cassandra:
     backup:
       enabled: true
       keyFile: "PATH_TO_PRIVATE_KEY_FILE"
       server: "BACKUP_SERVER_IP"
       storageDirectory: "/home/apigee/BACKUP_DIRECTORY"
       cloudProvider: "HYBRID" # required verbatim "HYBRID" (all caps)
       schedule: "SCHEDULE"

   Exemple Helm

   cassandra:
     backup:
       enabled: true
       keyFile: "private.key"# path relative to apigee-datastore path
       server: "34.56.78.90"
       storageDirectory: "/home/apigee/cassbackup"
       cloudProvider: "HYBRID"
       schedule: "0 2 * * *"

   Exemple de fichier apigeectl

   cassandra:
     backup:
       enabled: true
       keyFile: "home/exampleuser/apigee-hybrid/hybrid-files/service-accounts/private.key"
       server: "34.56.78.90"
       storageDirectory: "/home/apigee/cassbackup"
       cloudProvider: "HYBRID"
       schedule: "0 2 * * *"

   Où :

   Propriété	Description
   backup:enabled	La sauvegarde est désactivée par défaut. Vous devez définir cette propriété sur true.
   backup:keyFile	PATH_TO_PRIVATE_KEY_FILE Chemin d'accès au fichier de clé privée SSH (nommé ssh_key à l'étape où vous avez créé la paire de clés SSH) dans votre système de fichiers local. Remarque : Pour les installations gérées par Helm, ce chemin doit être relatif au répertoire de chart apigee-datastore.
   backup:server	BACKUP_SERVER_IP Adresse IP de votre serveur de sauvegarde.
   backup:storageDirectory	BACKUP_DIRECTORY Nom du répertoire de sauvegarde sur votre serveur de sauvegarde. Il doit s'agir d'un répertoire dans home/apigee (le répertoire de sauvegarde nommé cassandra_backup à l'étape de création du répertoire de sauvegarde).
   backup:cloudProvider	GCP/HYBRID Pour effectuer une sauvegarde Cloud Storage, définissez la propriété sur GCP. Exemple : cloudProvider: "GCP". Pour effectuer une sauvegarde sur un serveur distant, définissez la propriété sur HYBRID. Exemple : cloudProvider: "HYBRID".
   backup:schedule	SCHEDULE L'heure de début de la sauvegarde, spécifiée dans la syntaxe crontab standard. Les heures sont indiquées dans le fuseau horaire local du cluster Kubernetes. Par défaut : 0 2 * * * Remarque : Évitez de programmer une sauvegarde qui démarre peu de temps après l'application de la configuration de sauvegarde à votre cluster. Lorsque vous appliquez la configuration de sauvegarde, Kubernetes recrée les nœuds Cassandra. Si la sauvegarde se lance avant le redémarrage des nœuds, la première sauvegarde échoue et les sauvegardes suivantes réussissent.

2. Appliquez la configuration de la sauvegarde au champ d'application de stockage de votre cluster :

   Helm

   helm upgrade datastore apigee-datastore/ \
     --namespace apigee \
     --atomic \
     -f OVERRIDES_FILE.yaml
   

   Remarque : Si l'erreur Error: UPGRADE FAILED: "datastore" has no deployed releases s'affiche, remplacez upgrade par install et exécutez à nouveau la commande.

   apigeectl

   $APIGEECTL_HOME/apigeectl apply -f OVERRIDES_FILE.yaml --datastore

   Où OVERRIDES_FILE est le chemin d'accès au fichier que vous venez de modifier.

3. Vérifiez la tâche de sauvegarde. Par exemple :

   kubectl get cronjob -n apigee

   NAME                      SCHEDULE     SUSPEND   ACTIVE   LAST SCHEDULE   AGE
   apigee-cassandra-backup   33 * * * *   False     0        <none>          94s