Comment programmer des sauvegardes et sauvegarder à la demande

Ce guide programme la sauvegarde récurrente d'une ressource depuis la console Hikube, lance une sauvegarde immédiate, et montre comment repérer les ressources qui ne sont pas protégées.

Prérequis

Une destination Prête dans le projet (voir Créer une destination).
Une base PostgreSQL ou MariaDB, une VM ou un disque.
Pour l'onglet API : une clé d'API du projet (admin pour créer, modifier, lancer, restaurer ou supprimer ; read pour consulter) et les variables HIKUBE_API, HIKUBE_API_KEY et PROJECT_ID (voir Préparer l'environnement) ; les exemples utilisent curl et jq.

Programmer une sauvegarde

Console
API

Ouvrez la ressource (par exemple PostgreSQL > votre base, ou Instances VM > votre VM), puis son onglet Sauvegardes.
Dans la carte Programmation, cliquez sur Programmer.
Dans la fenêtre Programmer une sauvegarde :
- Nom du plan : minuscules, chiffres et tirets, 40 caractères au plus ;
- Destination : une destination Prête ;
- l'horaire, de l'une des deux façons ci-dessous.
Cliquez sur Programmer.

Une programmation (plan) sauvegarde une ressource, désignée par son type (kind) et son nom, sur un horaire cron :

curl -sS -X POST "$HIKUBE_API/backup/v1alpha1/projects/$PROJECT_ID/plans" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "demopg-nightly",
    "application": {"kind": "postgres", "name": "demopg"},
    "destination": "backups",
    "cron": "0 1 * * *"
  }'

Champ	Règle
`name`	Mêmes règles que le Nom du plan de la console ; unique dans le projet (`180007` s'il est pris)
`application.kind`	`postgres`, `mariadb`, `instance` (VM) ou `disk`
`application.name`	Le nom de la ressource, tel que l'API le renvoie (par exemple le `name` du cluster ou de la VM)
`destination`	Une destination `ready`
`cron`	Expression à cinq champs, ou `@hourly`, `@daily`, `@weekly`, `@monthly`, `@yearly`, en UTC ; mêmes refus que dans la console (`180105`, `180106` au-delà d'une exécution par heure)

La programmation renvoyée porte status (ready ou error, avec message), nextRunAt et lastRunAt.

Horaire par préréglage

Onglet Préréglage, choisissez une Fréquence :

Fréquence	Champs
Toutes les heures	Minute
Chaque jour	Heure, Minute
Chaque semaine	Jour, Heure, Minute

L'heure est saisie en heure locale et convertie en UTC à l'enregistrement. La console affiche l'expression obtenue suivie de (UTC), et la Prochaine exécution.

Horaire en expression cron

Onglet Expression cron, saisissez une expression à cinq champs (minute, heure, jour du mois, mois, jour de la semaine), interprétée en UTC :

Expression	Signification
`0 1 * * *`	Chaque jour à 01:00 UTC
`30 2 * * 0`	Chaque dimanche à 02:30 UTC
`0 3 1 * *`	Le 1er de chaque mois à 03:00 UTC
`@daily`	Chaque jour à 00:00 UTC

Sont refusés : une expression qui se déclenche plus d'une fois par heure (par exemple */30 * * * *), les intervalles @every, et les préfixes de fuseau horaire CRON_TZ= ou TZ=.

Changement d'heure

Un horaire est fixe en UTC : il se décale d'une heure en heure locale à chaque changement d'heure. Une sauvegarde programmée à 02:00 en hiver à Zurich s'exécute à 03:00 en été.

Modifier ou supprimer une programmation

Console
API

Modifier : seul l'horaire se modifie. Le nom, la ressource et la destination sont fixés à la création ; pour changer de destination, supprimez la programmation et créez-en une autre.
Supprimer : les exécutions futures s'arrêtent et les archives déjà prises sont conservées. L'historique des exécutions de cette programmation disparaît avec elle.

Seul l'horaire se modifie :

curl -sS -X PATCH "$HIKUBE_API/backup/v1alpha1/projects/$PROJECT_ID/plans/demopg-nightly" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cron": "30 2 * * *"}'

Pour supprimer la programmation :

curl -sS -X DELETE "$HIKUBE_API/backup/v1alpha1/projects/$PROJECT_ID/plans/demopg-nightly" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY"

Les programmations d'une ressource se listent avec GET $HIKUBE_API/backup/v1alpha1/projects/$PROJECT_ID/plans?applicationName=demopg.

Une ressource peut avoir plusieurs programmations, par exemple une quotidienne et une mensuelle.

PostgreSQL : une seule destination

Toutes les programmations et sauvegardes d'une même base PostgreSQL doivent viser la même destination. Une seconde destination est refusée. Voir Concepts.

Sauvegarder maintenant

Console
API

Dans l'onglet Sauvegardes de la ressource, section Sauvegarde à la demande, choisissez la Destination si plusieurs sont prêtes.
Cliquez sur Sauvegarder maintenant.

La sauvegarde apparaît dans État des exécutions. Pour une VM ou un disque, la console affiche le pourcentage de données transférées.

Une sauvegarde à la demande est une exécution (job) sans programmation :

curl -sS -X POST "$HIKUBE_API/backup/v1alpha1/projects/$PROJECT_ID/jobs" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "application": {"kind": "postgres", "name": "demopg"},
    "destination": "backups"
  }' | jq '.job.name'

Suivez-la avec son nom :

curl -sS "$HIKUBE_API/backup/v1alpha1/projects/$PROJECT_ID/jobs/<nom-du-job>" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" | jq '.job | {status, message, backup, progress}'

status passe de pending à running, puis succeeded ou failed. Une exécution réussie nomme dans backup l'archive produite. progress (bytesDone, bytesTotal, percent) n'existe que pour une VM ou un disque.

Une sauvegarde à la demande est refusée pendant une restauration de la même ressource.

Sauvegarder les disques d'une VM

L'archive d'une VM contient tous ses disques : il suffit de programmer la VM. Dans l'onglet Sauvegardes d'un disque attaché, la console indique alors Sauvegardée avec une autre ressource. Une programmation propre au disque reste possible (Programmer une sauvegarde de cette ressource), mais une telle archive ne se restaure pas sur le disque tant qu'il existe : voir Restaurer une VM ou un disque.

Repérer les ressources non protégées

Ouvrez Sauvegardes > Protection. Chaque ressource couverte du projet y figure avec son état :

État	Signification
Programmée	Au moins une programmation valide.
Couverte	Pas de programmation propre, mais contenue dans les archives d'une autre ressource (disque d'une VM programmée).
Programmation en erreur	Toutes ses programmations sont en erreur.
Non protégée	Aucune programmation.

Le bouton Programmer de cette page ouvre directement la fenêtre de programmation. Le widget État des sauvegardes du tableau de bord résume les applications sans protection, les derniers runs en échec et les destinations indisponibles.

Vérification

Console
API

La carte Programmation affiche l'horaire, la Prochaine et la Dernière exécution.
Sauvegardes > Activité liste chaque exécution avec son statut et sa durée.

# Programmation : horaire, prochaine et dernière exécution
curl -sS "$HIKUBE_API/backup/v1alpha1/projects/$PROJECT_ID/plans/demopg-nightly" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" | jq '.plan | {status, cron, nextRunAt, lastRunAt}'

# Exécutions de la programmation
curl -sS "$HIKUBE_API/backup/v1alpha1/projects/$PROJECT_ID/jobs?plan=demopg-nightly" \
  -H "X-Hikube-Api-Key: $HIKUBE_API_KEY" | jq '.jobs[] | {name, status, startedAt, completedAt}'

Ces lectures suffisent avec une clé read.

Prérequis​

Programmer une sauvegarde​

Horaire par préréglage​

Horaire en expression cron​

Modifier ou supprimer une programmation​

Sauvegarder maintenant​

Sauvegarder les disques d'une VM​

Repérer les ressources non protégées​

Vérification​

Pour aller plus loin​