FR Snapshot rotate - titandc/titan-sc-documentation GitHub Wiki

Introduction

Cette procédure décrit comment automatiser la création des snapshots de vos serveurs hébergées sur Titan SmallCloud depuis une machine Windows ou Linux.

Pré-requis

Avant toute chose, il est nécessaire de créer une clé API sur l'interface SC de Titan Datacenter.

Linux

Installation de l'outil

Sur la page releases du projet GitHub, télécharger la dernière version de l'outil :

# Adapter le numéro de version si une mise à jour est disponible
wget https://github.com/titandc/titan-sc-cli/releases/download/v3.0.6/linux-amd64.tgz

# Décompresser l'outil
tar zxf linux-amd64.tgz
cd linux-amd64

# Copier le binaire dans /usr/local/bin/ et créer le fichier de configuration
./titan-sc setup --token "API TOKEN"

# Nettoyage
cd ..
rm -r linux-amd64

Création de la tâche planifiée

Pour créer la tâche planifiée, executer la commande suivante (pensez à adapter l'heure de déclenchement des snapshots) :

echo "30 1 * * * root /usr/local/bin/titan-sc snapshot rotate --server-uuid <server_uuid> -f" >> /etc/crontab

L'exemple précédent sera exécuté tous les jours à 1h30 du matin.

Windows

Installation de l'outil titan-sc

Dans la suite de cette documentation, l'outil sera installé dans le répertoire C:\Program Files\titan-sc\. Il est possible de l'installer ailleurs en adaptant les chemins.

Dans un premier temps, il est nécessaire de télécharger et dézipper la dernière version de l'outil titan-sc-cli pour Windows.

Créer le répertoire d'installation C:\Program Files\titan-sc\ et copier le fichier de l'archive titan-sc.exe dans le répertoire C:\Program Files\titan-sc\.

Ouvrir un Powershell puis lancer le setup de l'outil :

cd "C:\Program Files\titan-sc\"
.\titan-sc.exe setup --token "API TOKEN"

La clé API peut être trouvée/générée sur l'interface Titan SmallCloud, en cliquant sur son avatar (en haut à droite de l'interface) puis Clés API.

Un fichier de configuration a été créé dans le répertoire d'installation de l'outil C:\Program Files\titan-sc\config.

L'installation de titan-sc-cli est maintenant terminée.

Création de la tâche planifiée

Ouvrir le planificateur de tâche de Windows : taskschd.msc.

Dans le panneau de droite, cliquer sur Create task puis paramétrez la tâche :

Dans l'onglet Triggers, cliquer sur le bouton New pour ajouter un élément de déclenchement. Veuillez noter que le temps d'attente minimal entre deux snapshots est de 30 minutes. Si un snapshot est déclenché moins de 30 minutes avant le précédent, une erreur sera renvoyée.

Nous recommendons de faire des snapshots au moins tous les deux jours :

  • lundi
  • mercredi
  • vendredi

Ainsi, si un problème survient, il est possible de restaurer un snapshot datant de plusieurs jours.

Dans l'onglet Actions, cliquer sur le bouton New.

  • Program/script : En cliquant sur le bouton Browse, allez chercher l'executable titan-sc.exe. Dans l'exemple : "C:\Program Files\titan-sc\titan-sc.exe"
  • Add arguments (optional) : Arguments du binaire pour l'exécution de la commande choisie. Ici : snapshot rotate --server-uuid <server_uuid> -f. Le <server_uuid> peut être trouvé sur l'interface Titan SmallCloud, sur la page du serveur, en cliquant sur le bouton "Plus d'informations".
  • Start in (optional) : Répertoire d'exécution de la tâche. Dans notre cas, il est nécessaire de renseigner le chemin où se situe le binaire pour permettre la lecture du fichier de configuration : C:\Program Files\titan-sc\

Valider la création de la tâche.

Vous pouvez tester l'exécution de la tâche en cliquant sur le bouton Run sur le panneau de droite afin de vérifier que celle-ci fonctionne bien (attention à bien respecter un délai minimum de 30 minutes entre la prise de snapshots d'une même machine).

Le snapshot créé est consultable depuis l'interface Titan SmallCloud.