Gérer l'Encryption at Rest d'un serveur dédié avec l'API
Découvrez comment vérifier l'éligibilité, activer ou désactiver l'Encryption at Rest et suivre l'opération sur un serveur dédié OVHcloud avec l'API OVHcloud v2
Objectif
L'API OVHcloud v2 vous permet d'automatiser l'Encryption at Rest sur vos serveurs dédiés. Ce guide vous explique comment vérifier qu'un serveur accepte l'Encryption at Rest, l'activer ou la désactiver, et suivre l'opération avec l'API OVHcloud.
La clé de chiffrement reste à l'intérieur de chaque disque. OVHcloud gère la passphrase qui déverrouille les disques, et elle ne vous est jamais transmise. L'utilisation de vos propres clés n'est pas disponible. Pour plus d'informations, consultez le guide « Qu'est-ce que l'Encryption at Rest sur un serveur dédié ? »
L'activation et la désactivation de l'Encryption at Rest effacent l'une comme l'autre toutes les données du serveur. La désactivation efface cryptographiquement les disques : aucun déchiffrement sur place n'est possible. Dans les deux cas, le système d'exploitation doit être réinstallé ensuite. L'API ne demande aucune confirmation : la requête suffit à lancer l'opération. Sauvegardez vos données au préalable.
Prérequis
- Disposer d'un serveur dédié d'une gamme et d'une région éligibles (consultez le guide « Prérequis et limites de l'Encryption at Rest »)
- Disposer d'un accès à l'API OVHcloud v2 (consultez le guide « API v2 OVHcloud - Principes de fonctionnement »)
- Disposer d'une sauvegarde de vos données
Introduction
Sur l'API v2, un serveur dédié est une ressource qui présente deux vues de sa configuration :
targetSpeccorrespond à l'état que vous demandez ;currentStatecorrespond à l'état réellement appliqué sur le serveur.
Vous modifiez la configuration en envoyant une nouvelle targetSpec accompagnée du checksum de la ressource. OVHcloud l'applique ensuite de manière asynchrone et indique la progression dans currentTasks et resourceStatus.
L'Encryption at Rest n'est pas disponible dans le provider Terraform OVHcloud.
En pratique
Cette section couvre les trois étapes de l'opération : vérifier, demander, suivre.
Étape 1 - Vérifier que le serveur accepte l'opération
Interrogez le serveur en demandant la disponibilité de ses actions :
Sans actions=true, la réponse ne contient pas currentState.actions. Cette absence signifie que l'information n'a pas été demandée, et non que l'action est indisponible.
L'entrée ENABLE_ENCRYPTION_AT_REST de currentState.actions porte un status :
Chaque raison de blockedBy comporte un code et une nature :
Exemple d'extrait de réponse :
Notez le checksum renvoyé dans la même réponse : vous en aurez besoin à l'étape suivante.
Étape 2 - Activer ou désactiver l'Encryption at Rest
Envoyez l'état cible avec le checksum de votre dernière lecture. Deux méthodes sont disponibles :
PATCHne modifie que les fonctionnalités que vous indiquez. Utilisez-la pour modifier uniquement l'Encryption at Rest.PUTremplace toute la spécification cible : toutes les fonctionnalités doivent figurer dans le corps de la requête.
Avec PATCH, utilisez l'appel API et le corps suivants :
Avec PUT, utilisez l'appel API suivant :
Le corps a la même forme, avec toutes les fonctionnalités de targetSpec.features renseignées.
La réponse renvoie le serveur avec resourceStatus à UPDATING et l'opération listée dans currentTasks, avec le type ENCRYPTION_AT_REST_TARGET_SPEC_UPDATE.
Étape 3 - Suivre l'opération
Interrogez à nouveau le serveur avec la même requête GET, aussi souvent que nécessaire. L'opération peut prendre jusqu'à 24 heures de bout en bout, et davantage si une intervention en datacenter est nécessaire. Dans ce cas, vous recevez aussi les e-mails habituels d'ouverture et de clôture de l'intervention.
L'opération est terminée lorsque resourceStatus vaut READY et que currentState correspond à targetSpec. Lorsque l'opération réussit, le serveur redémarre en mode rescue et vous recevez l'e-mail habituel du mode rescue. Réinstallez ensuite le système d'exploitation (consultez le guide « Installer un OS via l'API OVHcloud sur un serveur dédié »).
En cas d'échec, currentState conserve sa valeur précédente, targetSpec conserve votre demande et aucune tâche ne reste en cours. Renvoyez la requête, avec le checksum de votre dernière lecture, pour réessayer.
Le lien de tâche renvoyé dans currentTasks n'ouvre pas encore de vue détaillée de la tâche. Suivez l'opération en interrogeant le serveur.
Erreurs
Le tableau ci-dessous liste les erreurs que vous pouvez recevoir lors de la demande, et la marche à suivre pour chacune.
Aller plus loin
Qu'est-ce que l'Encryption at Rest sur un serveur dédié ?
Prérequis et limites de l'Encryption at Rest
FAQ Encryption at Rest des serveurs dédiés
Échangez avec notre communauté d'utilisateurs.