-
Notifications
You must be signed in to change notification settings - Fork 366
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Encrypting backup jobs with Veeam and OKMS - Guide creation #7695
Open
Y0Coss
wants to merge
2
commits into
develop
Choose a base branch
from
YC-ds-veeam-okms
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
120 changes: 120 additions & 0 deletions
120
...ivate_cloud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/guide.en-gb.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
--- | ||
title: "Encrypting Backup Jobs with Veeam and OKMS" | ||
excerpt: "Learn how to configure encrypted backup jobs using Veeam and the OVHcloud KMS (OKMS) service to enhance data protection." | ||
updated: 2025-03-31 | ||
--- | ||
|
||
## Objective | ||
|
||
This guide explains how to configure encrypted backup jobs using the Veeam backup solution and the OVHcloud KMS (OKMS) service. | ||
|
||
## Requirements | ||
|
||
- Access to the [OVHcloud Control Panel](/links/manager). | ||
- A [Hosted Private Cloud VMware vSphere on OVHcloud](/links/hosted-private-cloud/vmware) offer. | ||
- You must have read the following guides: | ||
- [KMS integration for VMware on OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_overall_vm-encrypt). | ||
- [Getting started with OKMS](/pages/manage_and_operate/kms/quick-start). | ||
|
||
## Instructions | ||
|
||
### Step 1: Create the Certificate in OKMS Service | ||
|
||
You can create the certificate from the dedicated entry from the [OVHcloud Control Panel](/links/manager): | ||
|
||
1.\ Click `Hosted Private Cloud`{.action} then `Identity, Security & Operations`{.action} and `Key Management Service`{.action}.Select your KMS. | ||
|
||
{.thumbnail} | ||
|
||
2.\ Select your KMS. | ||
|
||
{.thumbnail} | ||
|
||
3.\ Then, click on `Generate an access certificate`{.action} button and generate the private key using the following API (without CSR): | ||
|
||
> [!api] | ||
> | ||
> @api {v1} /okms POST / /okms/resource/{okmsId}/credential | ||
|
||
{.thumbnail} | ||
|
||
4.\ Retrieve the certificate by making a GET request: | ||
|
||
> [!api] | ||
> | ||
> @api {v1} /okms GET /okms/resource/{okmsId}/credential | ||
|
||
Fill in the required fields in the Generate an access certificate window and select the option `I don’t have a private key`{.action}. | ||
|
||
{.thumbnail} | ||
|
||
5.\ Download the private key. | ||
|
||
6.\ Download the certificate. | ||
|
||
{.thumbnail} | ||
|
||
### Step 2: Convert PEM to PFX | ||
|
||
To import the certificate into Veeam, you must convert it to `.pfx` format using the following command: | ||
|
||
```bash | ||
openssl pkcs12 -export -out cert.pfx -inkey privatekey.pem -in certificate.pem | ||
``` | ||
|
||
### Step 3: Import the Certificate to Veeam Windows Certificate Store | ||
|
||
1. Open the Windows Certificate Store on your Veeam server. | ||
1. Import the `.pfx` certificate into the Veeam Windows Certificate Store. | ||
1. Mark the certificate as exportable during import. | ||
|
||
{.thumbnail} | ||
|
||
### Step 4: Register the KMS Inside Veeam | ||
|
||
1.\ Open Veeam Backup & Replication and go to `Credentials & Passwords`{.action} then click on `Key Management Servers`{.action}. | ||
|
||
{.thumbnail} | ||
|
||
2.\ Click on `Add`{.action} to a new KMS server. | ||
|
||
{.thumbnail} | ||
|
||
3.\ Enter the server address. | ||
|
||
For example, for a KMS created in the **eu-west-rbx** region: <https://eu-west-rbx.okms.ovh.net>. | ||
|
||
Then, import your certificate from the Windows Key Store (the .`.pfx` file you imported previously). | ||
|
||
{.thumbnail} | ||
|
||
### Step 5: Retrieve the Server Certificate | ||
|
||
To retrieve the certificate from the OKMS server, use this command: | ||
|
||
```bash | ||
openssl s_client -connect eu-west-rbx.okms.ovh.net:443 2>/dev/null </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' | ||
``` | ||
|
||
### Step 6: Configure Backup Job Encryption | ||
|
||
1.\ Register the KMS server in your Veeam Backup & Replication console. | ||
2.\ Select the desired backup job and configure encryption using the registered KMS. | ||
|
||
{.thumbnail} | ||
|
||
3.\ Once the backup is complete, you will see a lock icon next to the backup name indicating it is encrypted. | ||
|
||
{.thumbnail} | ||
|
||
4.\ If you encounter the error **Unsupported attribute: OPERATION_POLICY_NAME**, follow the instructions provided in the documentation to resolve the issue. | ||
|
||
{.thumbnail} | ||
|
||
## Go further | ||
|
||
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. | ||
|
||
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. | ||
|
||
Join our [community of users](/links/community). |
127 changes: 127 additions & 0 deletions
127
...ivate_cloud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/guide.fr-fr.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
--- | ||
title: "Chiffrement des tâches de sauvegarde avec Veeam et OKMS" | ||
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" | ||
updated: 2025-03-31 | ||
--- | ||
|
||
## Objectif | ||
|
||
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). | ||
|
||
## Prérequis | ||
|
||
- Être connecté à l'[espace client OVHcloud](/links/manager) et à [l'API OVHcloud](/links/api). | ||
- Disposer d'une offre [VMware on OVHcloud](/links/hosted-private-cloud/vmware). | ||
- Avoir lu les guides : | ||
- [Intégration d'un KMS pour VMware on OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_overall_vm-encrypt). | ||
- [Premiers pas avec OKMS](/pages/manage_and_operate/kms/quick-start). | ||
|
||
## En pratique | ||
|
||
### Étape 1 : Création du certificat dans le service OKMS | ||
|
||
#### 1.1 Créez une clé privée via l'API OVHcloud | ||
|
||
> [!primary] | ||
> 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) ». | ||
|
||
Générez la clé privée en utilisant l’appel API suivant (sans CSR) : | ||
|
||
> [!api] | ||
> | ||
> @api {v1} /okms POST / /okms/resource/{okmsId}/credential | ||
|
||
Récupérez ensuite la clé via l'appel GET suivant : | ||
|
||
> [!api] | ||
> | ||
> @api {v1} /okms GET /okms/resource/{okmsId}/credential | ||
|
||
#### 1.2 Créer le certificat dans l'espace client OVHcloud | ||
|
||
Connectez-vous à l'[espace client OVHcloud](/links/manager) puis cliquez sur `Hosted Private Cloud`{.action}. | ||
|
||
Cliquez ensuite sur `Identité, Securité & Opérations`{.action} et enfin sur `Key Management Service`{.action}. | ||
|
||
{.thumbnail} | ||
|
||
Sélectionnez votre KMS puis cliquez sur l'onglet `Certificats d'accès`{.action} | ||
|
||
Cliquez ensuite sur le bouton `Créer un certificat d'accès`{.action}. | ||
|
||
{.thumbnail} | ||
|
||
Remplissez les champs requis et sélectionnez l’option `Je n'ai pas de clé privée`{.action}. | ||
|
||
{.thumbnail} | ||
|
||
Téléchargez la clé privée. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Importer la clé privée ? |
||
|
||
Téléchargez le certificat. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cela doit être davantage documenté (comment le faire). |
||
|
||
{.thumbnail} | ||
|
||
### Étape 2 : Conversion du certificat PEM en format PFX | ||
|
||
Pour importer le certificat dans Veeam, vous devez le convertir au format `.pfx` en utilisant la commande suivante : | ||
|
||
```bash | ||
openssl pkcs12 -export -out cert.pfx -inkey privatekey.pem -in certificate.pem | ||
``` | ||
|
||
### Étape 3 : Importation du certificat dans le Windows Certificate Store de Veeam | ||
|
||
1. Ouvrez le Windows Certificate Store sur votre serveur Veeam. | ||
1. Importez le certificat `.pfx` dans le Windows Certificate Store de Veeam. | ||
1. Cochez l'option permettant de rendre le certificat exportable lors de l'importation. | ||
|
||
{.thumbnail} | ||
|
||
### Étape 4 : Enregistrement du KMS dans Veeam | ||
|
||
1\. Ouvrez Veeam Backup & Replication et allez dans `Credentials & Passwords`{.action} puis cliquez sur `Key Management Servers`{.action}. | ||
|
||
{.thumbnail} | ||
|
||
2\. Cliquez sur `Add`{.action} pour ajouter un nouveau serveur KMS. | ||
|
||
{.thumbnail} | ||
|
||
3\. Entrez l'adresse du serveur. | ||
|
||
Par exemple, pour un KMS créé dans la région **eu-west-rbx** : <https://eu-west-rbx.okms.ovh.net>.\ | ||
|
||
Ensuite, importez votre certificat depuis le Windows Key Store (le fichier `.pfx` que vous avez importé précédemment). | ||
|
||
{.thumbnail} | ||
|
||
### Étape 5 : Récupération du certificat serveur | ||
|
||
Pour récupérer le certificat depuis le serveur OKMS, utilisez cette commande : | ||
|
||
```bash | ||
openssl s_client -connect eu-west-rbx.okms.ovh.net:443 2>/dev/null </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' | ||
``` | ||
|
||
### Étape 6 : Configuration du chiffrement des tâches de sauvegarde | ||
|
||
1\. Enregistrez le serveur KMS dans votre console Veeam Backup & Replication. | ||
2\. Sélectionnez la tâche de sauvegarde souhaitée et configurez le chiffrement en utilisant le KMS enregistré. | ||
|
||
{.thumbnail} | ||
|
||
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. | ||
|
||
{.thumbnail} | ||
|
||
4\. Si vous rencontrez l'erreur **Unsupported attribute: OPERATION_POLICY_NAME**, suivez les instructions fournies dans la documentation pour résoudre le problème. | ||
|
||
{.thumbnail} | ||
|
||
## Aller plus loin | ||
|
||
Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. | ||
|
||
Posez vos questions, donnez votre avis et échangez directement avec l’équipe en charge des services Hosted Private Cloud sur notre canal [Discord](https://discord.gg/ovhcloud). | ||
|
||
Échangez avec notre [communauté d'utilisateurs](/links/community). |
Binary file added
BIN
+25.6 KB
...cloud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/console_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+59.7 KB
...cloud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/console_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+59.2 KB
...ud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+266 KB
...d_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+84.4 KB
...ud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+60.8 KB
...ud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+103 KB
...ud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+282 KB
...ud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+133 KB
...ud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+91 KB
...ud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+340 KB
...ud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+78.5 KB
...ud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/images/veeam_okms_9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
...cloud/hosted_private_cloud_powered_by_vmware/veeam_encrypt_backup_job_with_okms/meta.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
id: c016e630-e0e1-4909-bbb0-bd359bafc9a6 | ||
full_slug: veeam_encrypt_backup_okms | ||
reference_category: storage-backup-and-disaster-recovery-solution-veeam |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@franckcosta , j'ai replacé l'étape de génération de clé privée via API en début de guide. Ne doit-on pas ici spécifier qu'on a une clé privée et coller celle générée par API ?
Il manque aussi des étapes qu'on a dans l'espace client et qui ne sont pas indiquées ici (Ajouter des identités)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Je n'ai pas de clé privée" == (sans CSR) dans l'API
Et on peut soit le faire via l'API soit l'UI mais ça revient au même :)