Skip to content

Commit d9b0ef1

Browse files
dstagnoldstagnol
authored andcommitted
reviewing guides
1 parent 25e25ad commit d9b0ef1

File tree

2 files changed

+150
-94
lines changed

2 files changed

+150
-94
lines changed
Lines changed: 82 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,120 +1,152 @@
11
---
2-
title: "Encrypting Backup Jobs with Veeam and OKMS"
3-
excerpt: "Learn how to configure encrypted backup jobs using Veeam and the OVHcloud KMS (OKMS) service to enhance data protection."
4-
updated: 2025-03-31
2+
title: "Encrypting backup jobs with Veeam and OKMS"
3+
excerpt: "Learn how to configure encrypted backup jobs using Veeam and the OVHcloud Key Management Service (OKMS) to enhance data protection."
4+
updated: 2025-04-10
55
---
66

77
## Objective
8-
9-
This guide explains how to configure encrypted backup jobs using the Veeam backup solution and the OVHcloud KMS (OKMS) service.
8+
This guide explains how to configure encrypted backup jobs using the Veeam backup solution and the OVHcloud Key Management Service (OKMS).
109

1110
## Requirements
12-
1311
- Access to the [OVHcloud Control Panel](/links/manager).
14-
- A [Hosted Private Cloud VMware vSphere on OVHcloud](/links/hosted-private-cloud/vmware) offer.
15-
- You must have read the following guides:
16-
- [KMS integration for VMware on OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_overall_vm-encrypt).
12+
- A [VMware on OVHcloud](/links/hosted-private-cloud/vmware) offer.
13+
- Review the following guides:
14+
- [Integrating a KMS with VMware on OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_overall_vm-encrypt).
1715
- [Getting started with OKMS](/pages/manage_and_operate/kms/quick-start).
1816

1917
## Instructions
2018

21-
### Step 1: Create the Certificate in OKMS Service
22-
23-
You can create the certificate from the dedicated entry from the [OVHcloud Control Panel](/links/manager):
24-
25-
1.\ Click `Hosted Private Cloud`{.action} then `Identity, Security & Operations`{.action} and `Key Management Service`{.action}.Select your KMS.
19+
### Step 1: Create the certificate using the API
2620

27-
![Console Dashboard](images/console_1.png){.thumbnail}
28-
29-
2.\ Select your KMS.
30-
31-
![KMS List](images/console_2.png){.thumbnail}
21+
You can create an access certificate directly via the OKMS API, without using the Manager interface.
3222

33-
3.\ Then, click on `Generate an access certificate`{.action} button and generate the private key using the following API (without CSR):
23+
1. Generate the private key using the API (no CSR):
3424

3525
> [!api]
3626
>
3727
> @api {v1} /okms POST / /okms/resource/{okmsId}/credential
3828
39-
![Generate an access certificate](images/veeam_okms_1.png){.thumbnail}
40-
41-
4.\ Retrieve the certificate by making a GET request:
29+
2. Retrieve the certificate using a GET request:
4230

4331
> [!api]
4432
>
4533
> @api {v1} /okms GET /okms/resource/{okmsId}/credential
4634
47-
Fill in the required fields in the Generate an access certificate window and select the option `I don’t have a private key`{.action}.
35+
> [!note]
36+
> This method is equivalent to selecting `I don't have a private key`{.action} in the Manager interface.
37+
> You may also submit a CSR if you already have your own private key.
38+
39+
3. Download the private key.
40+
41+
4. Download the certificate.
42+
43+
> [!info]
44+
> The downloaded private key is used to generate the `.pfx` file in the next step.
45+
> You don't need to import it manually into Veeam, but it is required to convert the certificate into a compatible format.
46+
> Make sure to store it securely.
47+
48+
### Step 2: Create the certificate from the Manager
49+
50+
You can also generate a certificate from the [OVHcloud Control Panel](/links/manager):
51+
52+
1. Click `Hosted Private Cloud`{.action} then `Identity, Security & Operations`{.action} and finally `Key Management Service`{.action}. Select your KMS.
53+
54+
![Console Dashboard](images/console_1.png){.thumbnail}
55+
56+
2. Select your KMS.
57+
58+
![KMS List](images/console_2.png){.thumbnail}
59+
60+
3. Click the `Access certificates` tab.
61+
62+
![Access certificates tab](images/veeam_okms_1.png){.thumbnail}
63+
64+
4. Click `Generate an access certificate`{.action}.
65+
66+
5. Fill in the required fields and select `I don’t have a private key`{.action}.
4867

4968
![Generate Access Certificate - No Private Key](images/veeam_okms_2.png){.thumbnail}
5069

51-
5.\ Download the private key.
70+
> [!note]
71+
> This option corresponds to creating a certificate without a CSR, just like with the API.
72+
> You can also choose `I already have a private key` to generate a certificate using your own CSR.
73+
74+
### Add user IDs
75+
76+
Before the certificate can be used, you must associate at least one user ID.
77+
78+
1. In the KMS management interface, click `Add user IDs`{.action}.
79+
2. Select the users allowed to access the KMS.
80+
3. Confirm to bind the certificate to these user IDs.
5281

53-
6.\ Download the certificate.
82+
> [!info]
83+
> This step is required for the certificate to be recognized and usable in Veeam.
84+
85+
6. Download the private key and the certificate.
5486

5587
![Download Certificate](images/veeam_okms_3.png){.thumbnail}
5688

57-
### Step 2: Convert PEM to PFX
89+
### Step 3: Convert the PEM certificate to PFX format
5890

59-
To import the certificate into Veeam, you must convert it to `.pfx` format using the following command:
91+
To import the certificate into Veeam, convert it to `.pfx` format using the command below:
6092

6193
```bash
6294
openssl pkcs12 -export -out cert.pfx -inkey privatekey.pem -in certificate.pem
6395
```
6496

65-
### Step 3: Import the Certificate to Veeam Windows Certificate Store
97+
### Step 4: Import the certificate into the Veeam Windows Certificate Store
6698

67-
1. Open the Windows Certificate Store on your Veeam server.
68-
1. Import the `.pfx` certificate into the Veeam Windows Certificate Store.
69-
1. Mark the certificate as exportable during import.
99+
- Open the Windows Certificate Store on your Veeam server.
100+
- Import the `.pfx` file generated in the previous step.
101+
- Check the option to make the certificate exportable.
70102

71103
![Import Certificate - Exportable](images/veeam_okms_4.png){.thumbnail}
72104

73-
### Step 4: Register the KMS Inside Veeam
105+
### Step 5: Register the KMS in Veeam
74106

75-
1.\ Open Veeam Backup & Replication and go to `Credentials & Passwords`{.action} then click on `Key Management Servers`{.action}.
107+
- Open Veeam Backup & Replication and go to `Credentials & Passwords`{.action}, then click `Key Management Servers`{.action}.
76108

77109
![Veeam Key Management Servers](images/veeam_okms_5.png){.thumbnail}
78110

79-
2.\ Click on `Add`{.action} to a new KMS server.
111+
- Click `Add`{.action} to add a new KMS server.
80112

81113
![Add KMS Server](images/veeam_okms_6.png){.thumbnail}
82114

83-
3.\ Enter the server address.
84-
85-
For example, for a KMS created in the **eu-west-rbx** region: <https://eu-west-rbx.okms.ovh.net>.
86-
87-
Then, import your certificate from the Windows Key Store (the .`.pfx` file you imported previously).
115+
- Enter the following details:
116+
- Server address: `eu-west-rbx.okms.ovh.net`
117+
- Port: `5696`
118+
- Server certificate: `*.okms.ovh.net`
119+
- Client certificate: the `.pfx` file you just imported
88120

89121
![Add KMS Server Details](images/veeam_okms_7.png){.thumbnail}
90122

91-
### Step 5: Retrieve the Server Certificate
123+
### Step 6: Retrieve the server certificate
92124

93-
To retrieve the certificate from the OKMS server, use this command:
125+
To retrieve the server certificate from OKMS, run the following command:
94126

95127
```bash
96-
openssl s_client -connect eu-west-rbx.okms.ovh.net:443 2>/dev/null </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p'
128+
openssl s_client -connect eu-west-rbx.okms.ovh.net:443 2>/dev/null </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p'
97129
```
98130

99-
### Step 6: Configure Backup Job Encryption
131+
### Step 7: Configure backup job encryption
100132

101-
1.\ Register the KMS server in your Veeam Backup & Replication console.
102-
2.\ Select the desired backup job and configure encryption using the registered KMS.
133+
- Register the KMS server in your Veeam Backup & Replication console.
134+
- Select the desired backup job and enable encryption using the registered KMS.
103135

104136
![Configure Backup Encryption](images/veeam_okms_8.png){.thumbnail}
105137

106-
3.\ Once the backup is complete, you will see a lock icon next to the backup name indicating it is encrypted.
138+
- Once the backup has run, a padlock icon appears next to its name.
107139

108140
![Encrypted Backup](images/veeam_okms_9.png){.thumbnail}
109141

110-
4.\ If you encounter the error **Unsupported attribute: OPERATION_POLICY_NAME**, follow the instructions provided in the documentation to resolve the issue.
142+
- If you encounter the error `Unsupported attribute: OPERATION_POLICY_NAME`, check the documentation or contact support.
111143

112144
![Operation Policy Name Error](images/veeam_okms_10.png){.thumbnail}
113145

114146
## Go further
115147

116-
If you need training or technical assistance to implement our solutions, please contact your Technical Account Manager or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project.
148+
If you need training or technical assistance to implement our solutions, contact your Technical Account Manager or click [this link](/links/professional-services) to request a quote and get personalized support from our Professional Services team.
117149

118-
Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel.
150+
Ask questions, share feedback, and interact directly with the Hosted Private Cloud team on our [Discord](https://discord.gg/ovhcloud) channel.
119151

120152
Join our [community of users](/links/community).

pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/guide.fr-fr.md

Lines changed: 68 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,120 +1,144 @@
11
---
22
title: "Chiffrement des tâches de sauvegarde avec Veeam et OKMS"
3-
excerpt: "Découvrez comment configurer des tâches de sauvegarde chiffrées en utilisant Veeam et le service KMS d’OVHcloud (OKMS) pour renforcer la protection des données"
4-
updated: 2025-03-31
3+
excerpt: "Découvrez comment configurer des tâches de sauvegarde chiffrées en utilisant Veeam et le service KMS d’OVHcloud (OKMS) pour renforcer la protection des données."
4+
updated: 2025-04-10
55
---
66

77
## Objectif
8-
98
Ce guide explique comment configurer des tâches de sauvegarde chiffrées en utilisant la solution de sauvegarde Veeam et le service KMS d’OVHcloud (OKMS).
109

1110
## Prérequis
12-
13-
- Être connecté à l'[espace client OVHcloud](/links/manager) et à [l'API OVHcloud](/links/api).
11+
- Être connecté à [l'espace client OVHcloud](/links/manager).
1412
- Disposer d'une offre [VMware on OVHcloud](/links/hosted-private-cloud/vmware).
15-
- Avoir lu les guides :
13+
- Avoir lu les guides :
1614
- [Intégration d'un KMS pour VMware on OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_overall_vm-encrypt).
1715
- [Premiers pas avec OKMS](/pages/manage_and_operate/kms/quick-start).
1816

1917
## En pratique
2018

21-
### Étape 1 : Création du certificat dans le service OKMS
19+
### Étape 1 : Création du certificat via l’API
2220

23-
#### 1.1 Créez une clé privée via l'API OVHcloud
21+
Vous pouvez créer un certificat d’accès directement via lAPI OKMS, sans passer par l’interface graphique.
2422

25-
> [!primary]
26-
> Si vous n'êtes pas familier avec l'utilisation de l'API OVHcloud, consultez notre guide « [Premiers pas avec les API OVHcloud](/pages/manage_and_operate/api/first-steps) ».
27-
28-
Générez la clé privée en utilisant l’appel API suivant (sans CSR) :
23+
1. Générez la clé privée via l’API (sans CSR) :
2924

3025
> [!api]
3126
>
3227
> @api {v1} /okms POST / /okms/resource/{okmsId}/credential
3328
34-
Récupérez ensuite la clé via l'appel GET suivant :
29+
2. Récupérez le certificat via une requête GET :
3530

3631
> [!api]
3732
>
3833
> @api {v1} /okms GET /okms/resource/{okmsId}/credential
3934
40-
#### 1.2 Créer le certificat dans l'espace client OVHcloud
35+
> [!note]
36+
> Cette méthode est équivalente à l’option `Je n’ai pas de clé privée`{.action} dans l’interface utilisateur du Manager.
37+
> Vous pouvez aussi passer un CSR si vous disposez déjà de votre propre clé privée.
38+
39+
3. Téléchargez la clé privée.
4140

42-
Connectez-vous à l'[espace client OVHcloud](/links/manager) puis cliquez sur `Hosted Private Cloud`{.action}.
41+
4. Téléchargez le certificat.
4342

44-
Cliquez ensuite sur `Identité, Securité & Opérations`{.action} et enfin sur `Key Management Service`{.action}.
43+
> [!info]
44+
> La clé privée téléchargée est utilisée pour générer le fichier `.pfx` à l’étape suivante.
45+
> Elle ne doit pas être importée directement dans Veeam, mais elle est indispensable pour convertir le certificat dans un format compatible.
46+
> Veillez à la conserver dans un endroit sécurisé.
47+
48+
### Étape 2 : Création du certificat via le Manager
49+
50+
Vous pouvez aussi générer un certificat depuis [l'espace client OVHcloud](/links/manager) :
51+
52+
1. Cliquez sur `Hosted Private Cloud`{.action} puis `Identity, Security & Operations`{.action} et enfin `Key Management Service`{.action}. Sélectionnez votre KMS.
4553

4654
![Console Dashboard](images/console_1.png){.thumbnail}
4755

48-
Sélectionnez votre KMS puis cliquez sur l'onglet `Certificats d'accès`{.action}
56+
2. Sélectionnez votre KMS.
57+
58+
![KMS List](images/console_2.png){.thumbnail}
4959

50-
Cliquez ensuite sur le bouton `Créer un certificat d'accès`{.action}.
60+
3. Cliquez sur l’onglet `Certificats d’accès`.
5161

52-
![Generate an access certificate](images/veeam_okms_1.png){.thumbnail}
62+
![Onglet Certificats d’accès](images/veeam_okms_1.png){.thumbnail}
5363

54-
Remplissez les champs requis et sélectionnez l’option `Je n'ai pas de clé privée`{.action}.
64+
4. Cliquez sur `Générer un certificat d’accès`{.action}.
5565

56-
![Generate Access Certificate - No Private Key](images/veeam_okms_2.png){.thumbnail}
66+
5. Remplissez les champs requis et sélectionnez l’option `Je n’ai pas de clé privée`{.action}.
5767

58-
Téléchargez la clé privée.
68+
![Génération certificat - sans clé privée](images/veeam_okms_2.png){.thumbnail}
5969

60-
Téléchargez le certificat.
70+
> [!note]
71+
> L’option `Je n’ai pas de clé privée`{.action} correspond à une génération de certificat sans CSR (comme via l’API).
72+
> Vous pouvez aussi sélectionner `J’ai déjà une clé privée` si vous souhaitez générer un certificat à partir de votre propre CSR.
73+
74+
### Ajouter des identifiants utilisateur (user IDs)
75+
76+
Avant de pouvoir utiliser le certificat, vous devez associer au moins un identifiant utilisateur.
77+
78+
1. Dans l'interface de gestion du KMS, cliquez sur `Ajouter des identifiants`{.action}.
79+
2. Sélectionnez les utilisateurs autorisés à accéder à ce KMS.
80+
3. Validez pour que le certificat soit lié à ces identifiants.
81+
82+
> [!info]
83+
> Cette étape est indispensable pour que le certificat soit reconnu et utilisable dans Veeam.
84+
85+
6. Téléchargez la clé privée et le certificat.
6186

6287
![Download Certificate](images/veeam_okms_3.png){.thumbnail}
6388

64-
### Étape 2 : Conversion du certificat PEM en format PFX
89+
### Étape 3 : Conversion du certificat PEM en format PFX
6590

6691
Pour importer le certificat dans Veeam, vous devez le convertir au format `.pfx` en utilisant la commande suivante :
6792

6893
```bash
6994
openssl pkcs12 -export -out cert.pfx -inkey privatekey.pem -in certificate.pem
7095
```
7196

72-
### Étape 3 : Importation du certificat dans le Windows Certificate Store de Veeam
97+
### Étape 4 : Importation du certificat dans le Windows Certificate Store de Veeam
7398

74-
1. Ouvrez le Windows Certificate Store sur votre serveur Veeam.
75-
1. Importez le certificat `.pfx` dans le Windows Certificate Store de Veeam.
76-
1. Cochez l'option permettant de rendre le certificat exportable lors de l'importation.
99+
- Ouvrez le Windows Certificate Store sur votre serveur Veeam.
100+
- Importez le fichier `.pfx` généré à l’étape précédente.
101+
- Cochez loption permettant de rendre le certificat exportable.
77102

78103
![Import Certificate - Exportable](images/veeam_okms_4.png){.thumbnail}
79104

80-
### Étape 4 : Enregistrement du KMS dans Veeam
105+
### Étape 5 : Enregistrement du KMS dans Veeam
81106

82-
1\. Ouvrez Veeam Backup & Replication et allez dans `Credentials & Passwords`{.action} puis cliquez sur `Key Management Servers`{.action}.
107+
- Ouvrez Veeam Backup & Replication et allez dans `Credentials & Passwords`{.action}, puis cliquez sur `Key Management Servers`{.action}.
83108

84109
![Veeam Key Management Servers](images/veeam_okms_5.png){.thumbnail}
85110

86-
2\. Cliquez sur `Add`{.action} pour ajouter un nouveau serveur KMS.
111+
- Cliquez sur `Add`{.action} pour ajouter un nouveau serveur KMS.
87112

88113
![Add KMS Server](images/veeam_okms_6.png){.thumbnail}
89114

90-
3\. Entrez l'adresse du serveur.
91-
92-
Par exemple, pour un KMS créé dans la région **eu-west-rbx** : <https://eu-west-rbx.okms.ovh.net>.\
93-
94-
Ensuite, importez votre certificat depuis le Windows Key Store (le fichier `.pfx` que vous avez importé précédemment).
115+
- Saisissez les informations suivantes :
116+
- Adresse du serveur : `eu-west-rbx.okms.ovh.net`
117+
- Port : `5696`
118+
- Certificat serveur : `*.okms.ovh.net`
119+
- Certificat client : le fichier `.pfx` que vous venez d'importer
95120

96121
![Add KMS Server Details](images/veeam_okms_7.png){.thumbnail}
97122

98-
### Étape 5 : Récupération du certificat serveur
123+
### Étape 6 : Récupération du certificat serveur
99124

100-
Pour récupérer le certificat depuis le serveur OKMS, utilisez cette commande :
125+
Pour récupérer le certificat depuis le serveur OKMS, utilisez la commande suivante :
101126

102127
```bash
103128
openssl s_client -connect eu-west-rbx.okms.ovh.net:443 2>/dev/null </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p'
104129
```
130+
### Étape 7 : Configuration du chiffrement des tâches de sauvegarde
105131

106-
### Étape 6 : Configuration du chiffrement des tâches de sauvegarde
107-
108-
1\. Enregistrez le serveur KMS dans votre console Veeam Backup & Replication.
109-
2\. Sélectionnez la tâche de sauvegarde souhaitée et configurez le chiffrement en utilisant le KMS enregistré.
132+
- Enregistrez le serveur KMS dans votre console Veeam Backup & Replication.
133+
- Sélectionnez la tâche de sauvegarde souhaitée, puis configurez le chiffrement avec le KMS enregistré.
110134

111135
![Configure Backup Encryption](images/veeam_okms_8.png){.thumbnail}
112136

113-
3\. Une fois la sauvegarde terminée, vous verrez une icône de cadenas à côté du nom de la sauvegarde indiquant qu'elle est chiffrée.
137+
- Une fois la sauvegarde exécutée, une icône de cadenas s'affiche à côté de son nom.
114138

115139
![Encrypted Backup](images/veeam_okms_9.png){.thumbnail}
116140

117-
4\. Si vous rencontrez l'erreur **Unsupported attribute: OPERATION_POLICY_NAME**, suivez les instructions fournies dans la documentation pour résoudre le problème.
141+
- En cas d’erreur `Unsupported attribute: OPERATION_POLICY_NAME`, consultez la documentation ou contactez le support.
118142

119143
![Operation Policy Name Error](images/veeam_okms_10.png){.thumbnail}
120144

0 commit comments

Comments
 (0)