Skip to content

Commit 116990f

Browse files
OvhValentinOvhValentin
committed
feat(ceph service): new guide about how to grow service
1 parent 27865a1 commit 116990f

File tree

5 files changed

+378
-0
lines changed

5 files changed

+378
-0
lines changed

‎pages/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1791,6 +1791,7 @@
17911791
+ [Cluster status](storage_and_backup/block_storage/cloud_disk_array/ceph_check_cluster_status)
17921792
+ [Pool creation](storage_and_backup/block_storage/cloud_disk_array/ceph_create_a_pool)
17931793
+ [User creation](storage_and_backup/block_storage/cloud_disk_array/ceph_create_a_user)
1794+
+ [How to upgrade a Cloud Disk Array (CDA) using the OVHcloud API](storage_and_backup/block_storage/cloud_disk_array/ceph_grow_with_api)
17941795
+ [IP ACL creation](storage_and_backup/block_storage/cloud_disk_array/ceph_create_an_ip_acl)
17951796
+ [FAQ](storage_and_backup/block_storage/cloud_disk_array/ceph_faq)
17961797
+ [Storage Benchmarking](storage_and_backup/block_storage/cloud_disk_array/ceph_io_benchmarking)

‎pages/storage_and_backup/block_storage/cloud_disk_array/ceph_grow_with_api/guide.en-bg.md

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
---
2+
title: 'How to upgrade a Cloud Disk Array (CDA) using the OVHcloud API'
3+
excerpt: 'Learn how to increase the storage capacity of your OVHcloud Cloud Disk Array (CDA) using the OVHcloud API.'
4+
updated: 2025-05-09
5+
---
6+
7+
<style>
8+
details>summary {
9+
color:rgb(33, 153, 232) !important;
10+
cursor: pointer;
11+
}
12+
details>summary::before {
13+
content:'\25B6';
14+
padding-right:1ch;
15+
}
16+
details[open]>summary::before {
17+
content:'\25BC';
18+
}
19+
</style>
20+
21+
## Objectives
22+
23+
This guide explains how to upgrade your OVHcloud Cloud Disk Array (CDA) cluster to increase its storage capacity. It describes the technical behavior of a live upgrade, the necessary API calls, and how to retrieve required service information. This operation is performed entirely online, without interrupting read/write access to your data, and is only available via the OVHcloud API.
24+
25+
## Requirements
26+
27+
- A [Cloud Disk Array](/links/storage/cloud-disk-array) solution
28+
- Access to the [OVHcloud Control Panel](/links/manager) or to the [OVHcloud API](/links/api)
29+
30+
## Instructions
31+
32+
### How the CDA Upgrade Works
33+
34+
Upgrading a Cloud Disk Array (CDA) cluster is a fully online process that does not interrupt data availability. Throughout the operation, customers retain full read and write access to their data.
35+
36+
> [!primary]
37+
>
38+
> During the upgrade, you may observe slightly degraded performance or increased I/O latency. This is temporary and expected while data is being rebalanced across the cluster.
39+
>
40+
41+
/// details | **Upgrade Workflow**
42+
43+
The upgrade process follows these steps:
44+
45+
- **Upgrade Order Initiation:** The customer initiates an upgrade request via the OVHcloud API and proceeds with payment.
46+
- **Provisioning of New Storage Nodes:** New Ceph OSD (Object Storage Daemon) nodes are automatically provisioned and added to the cluster. These are deployed in groups of three, with each node placed in a separate rack to maintain redundancy and failure domain isolation.
47+
- **Cluster Acknowledgment:** Once the new nodes are up and running, the system marks the upgrade operation as complete from the customer’s perspective. No further action is required from the user.
48+
- **Automatic Data Rebalancing:** In the background, Ceph initiates a data rebalancing phase. Existing data is redistributed across the entire cluster—including the newly added nodes—while ensuring that the configured replication level (typically three replicas) is maintained throughout the process.
49+
- **Performance Stabilization:** The rebalancing continues until the cluster reaches an even distribution of data, as determined by Ceph’s internal placement algorithms. Once completed, the cluster returns to optimal performance.
50+
51+
///
52+
53+
### Retrieving required information
54+
55+
Before initiating a CDA upgrade, you will need two key pieces of information:
56+
57+
- The service name of your CDA cluster
58+
- The plan code corresponding to your current configuration
59+
60+
Follow the steps below to retrieve them using the OVHcloud API.
61+
62+
/// details | **Step 1. Get you service name (Skip if you know your service name)**
63+
64+
Otherwise, you can retrieve it via the OVHcloud Control Panel or the following API call:
65+
66+
> [!tabs]
67+
> Via the OVHcloud Control Panel
68+
>> First, log into your [OVHcloud Control Panel](/links/manager) and go to the `Bare Metal Cloud`{.action} section. Click the `Platforms and services`{.action} header then on the `ceph-cluster`{.action} service.
69+
>>
70+
>> In the `Details`, locate the `ID` field — this value is your CDA service name.
71+
>>
72+
>> ![Ceph details](images/ceph_details.png){.thumbnail}
73+
>>
74+
> Via the OVHcloud API
75+
>> > [!api]
76+
>> >
77+
>> > @api {v1} /dedicated/ceph GET /dedicated/ceph
78+
>> >
79+
>>
80+
>> This will return a list of your CDA services. Each service is identified by a UUID, for example 48e5f77f-427b-4261-9799-7861033659fb
81+
>>
82+
83+
///
84+
85+
/// details | **Step 2. Identify Your Plan Code (Skip if you know which plan you use)**
86+
87+
Your CDA plan determines the type and size of storage used. The two available plans are:
88+
89+
- storage-2tb - old setup on nvme+hdd (on 2TB HDD disks)
90+
- cda-3tb - new setup on nvme (3TB NVME disks)
91+
92+
1. Retrieve the Service ID
93+
94+
Use the service name (UUID) from Step 1 to get the corresponding service ID:
95+
96+
> [!api]
97+
>
98+
> @api {v1} /services?resourceName GET /services?resourceName={serviceName}
99+
>
100+
101+
Service ID is a number - e.g. 1234567
102+
103+
2. Retrieve the Service Details
104+
105+
Now query the service information using the service ID:
106+
107+
> [!api]
108+
>
109+
> @api {v1} /services/{serviceId} GET /services/{serviceId} // For this example, replace by 1234567
110+
>
111+
112+
Look for the following field in the response:
113+
114+
```json
115+
"billing": {
116+
"plan": {
117+
"code": "cda-3tb"
118+
}
119+
}
120+
```
121+
122+
The value under billing.plan.code is your plan code, which you’ll need to perform the upgrade.
123+
124+
///
125+
126+
### How to Perform the Upgrade
127+
128+
> [!primary]
129+
>
130+
> At this time, upgrading a Cloud Disk Array (CDA) cluster is only available via the OVHcloud API. It cannot be done through the OVHcloud Control Panel.
131+
>
132+
133+
The upgrade process is straightforward and requires just one API call.
134+
135+
**Step 1: Access the API Console**
136+
137+
Choose the appropriate API console for your region:
138+
139+
- [EU API console](https://eu.api.ovh.com/console-preview/)
140+
- [CA API console](https://ca.api.ovh.com/console-preview/)
141+
142+
**Step 2: Submit the Upgrade Order**
143+
144+
Use the following API endpoint:
145+
146+
> [!api]
147+
>
148+
> @api {v1} /order/upgrade/cephaas/{serviceName}/{planCode} POST /order/upgrade/cephaas/{serviceName}/{planCode}
149+
>
150+
151+
Replace the placeholders with your service details:
152+
153+
- serviceName: The UUID of your CDA cluster (e.g. 6cb82c75-29fd-4d77-9928-0de6ad9ff5fe)
154+
- planCode: Your current CDA plan code — either:
155+
- storage-2tb (legacy configuration with HDD + NVMe)
156+
- cda-3tb (new generation with full NVMe)
157+
- quantity: The number of additional units you want to provision (1–24). Each unit adds 2 TB of storage via 3 new OSDs. For example:
158+
159+
| Quantity | Total added capacity |
160+
| -------- | ---------------------- |
161+
| 1 | 2 TB (3 x 2TB disks) |
162+
| 2 | 4 TB (6 x 2TB disks) |
163+
| ... | ... |
164+
| 24 | 48 TB (72 x 2TB disks) |
165+
166+
**Step 3: Retrieve the Payment Link**
167+
168+
If the API call is successful, the response will include a payment URL located in the following field:
169+
170+
```json
171+
"order": {
172+
"details": {
173+
"url": "(https://www.ovh.com/cgi-bin/order/display-order.cgi?orderId=174448338&orderPassword=wufe4HQQQQ)",
174+
}
175+
}
176+
```
177+
178+
**Step 4: Confirm the Order**
179+
180+
Open the provided URL, complete the payment process, and your upgrade will begin automatically. The new storage nodes are typically added to your CDA cluster within a few minutes after payment is confirmed.
181+
182+
## Go further
183+
184+
Visit our dedicated Discord channel: <https://discord.gg/ovhcloud>. Ask questions, provide feedback and interact directly with the team that builds our Storage and Backup services.
185+
186+
If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](https://www.ovhcloud.com/en-gb/professional-services/) to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project.
187+
188+
Join our community of users on <https://community.ovh.com/en/>.

‎pages/storage_and_backup/block_storage/cloud_disk_array/ceph_grow_with_api/guide.fr-fr.md

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
---
2+
title: 'Comment augmenter la capacité d’un Cloud Disk Array (CDA) via l’API OVHcloud'
3+
excerpt: "Découvrez comment étendre la capacité de stockage de votre Cloud Disk Array (CDA) OVHcloud à l’aide de l'API OVHcloud."
4+
updated: 2025-05-09
5+
---
6+
7+
<style>
8+
details>summary {
9+
color:rgb(33, 153, 232) !important;
10+
cursor: pointer;
11+
}
12+
details>summary::before {
13+
content:'\25B6';
14+
padding-right:1ch;
15+
}
16+
details[open]>summary::before {
17+
content:'\25BC';
18+
}
19+
</style>
20+
21+
## Objectifs
22+
23+
Ce guide explique comment mettre à niveau votre cluster OVHcloud Cloud Disk Array (CDA) pour augmenter sa capacité de stockage. Il décrit le comportement technique d'une mise à niveau en direct, les appels d'API nécessaires et la manière de récupérer les informations de service requises. Cette opération est réalisée entièrement en ligne, sans interrompre l'accès en lecture/écriture à vos données, et n'est disponible que via l'API OVHcloud.
24+
25+
## Prérequis
26+
27+
- Une solution [Cloud Disk Array](/links/storage/cloud-disk-array)
28+
- Être connecté à l’[espace client OVHcloud](/links/manager) ou à l’[API OVHcloud](/links/api)
29+
30+
## En pratique
31+
32+
### Fonctionnement de la mise à niveau d’un Cloud Disk Array (CDA)
33+
34+
La mise à niveau d’un cluster Cloud Disk Array (CDA) s’effectue entièrement en ligne, sans interruption de service. Les clients conservent un accès complet en lecture et en écriture à leurs données pendant toute la durée de l’opération.
35+
36+
> [!primary]
37+
>
38+
> Une légère dégradation des performances ou une hausse temporaire de la latence des entrées/sorties (E/S) peut être observée durant le rééquilibrage des données au sein du cluster. Ce comportement est normal et attendu.
39+
>
40+
41+
/// details | **Déroulement de la mise à niveau**
42+
43+
Le processus de mise à niveau suit les étapes suivantes :
44+
45+
- **Lancement de la commande de mise à niveau :** Le client initie la demande de mise à niveau via l’API OVHcloud, puis procède au paiement.
46+
- **Provisionnement de nouveaux nœuds de stockage :** De nouveaux nœuds Ceph OSD (Object Storage Daemon) sont automatiquement provisionnés et ajoutés au cluster. Ces nœuds sont déployés par groupes de trois, chacun dans une baie distincte afin de garantir la redondance et l’isolation des domaines de défaillance.
47+
- **Confirmation côté client :** Une fois les nouveaux nœuds opérationnels, le système considère l’opération comme terminée du point de vue du client. Aucune action supplémentaire n’est requise de sa part.
48+
- **Rééquilibrage automatique des données :** En arrière-plan, Ceph lance une phase de rééquilibrage des données. Les données existantes sont redistribuées sur l’ensemble du cluster, y compris les nouveaux nœuds, tout en maintenant le niveau de réplication configuré (généralement trois réplicas).
49+
- **Stabilisation des performances :** Le rééquilibrage se poursuit jusqu’à ce que la distribution des données soit homogène, selon les algorithmes internes de placement de Ceph. Une fois cette étape terminée, le cluster retrouve son niveau de performance optimal.
50+
51+
///
52+
53+
### Récupération des informations nécessaires
54+
55+
Avant de lancer une mise à niveau de CDA, vous aurez besoin de deux informations essentielles :
56+
57+
- le nom de service de votre cluster CDA
58+
- Le code de plan correspondant à votre configuration actuelle
59+
60+
Suivez les étapes ci-dessous pour les récupérer à l'aide de l'API OVHcloud.
61+
62+
/// details | **Étape 1. Obtenez le nom de votre service (passez à l'étape suivante si vous connaissez le nom de votre service)**.
63+
64+
Sinon, vous pouvez le récupérer via l'espace client OVHcloud ou l'appel API suivant :
65+
66+
> [!tabs]
67+
> Via l'espace client OVHcloud
68+
>> Tout d'abord, connectez-vous à votre [espace client OVHcloud](/links/manager) et allez dans la section `Bare Metal Cloud`{.action}. Cliquez sur l'en-tête `Platformes et services`{.action} puis sur le service `ceph-cluster`{.action}.
69+
>>
70+
>> Dans les « Détails », localisez le champ « ID » - cette valeur est le nom de votre service CDA.
71+
>>
72+
>> ![Ceph details](images/ceph_details.png){.thumbnail}
73+
>>
74+
> Via l'API OVHcloud
75+
>> > [!api]
76+
>> >
77+
>> > @api {v1} /dedicated/ceph GET /dedicated/ceph
78+
>> >
79+
>>
80+
>> Cette commande renvoie une liste de vos services CDA. Chaque service est identifié par un UUID, par exemple 48e5f77f-427b-4261-9799-7861033659fb
81+
82+
///
83+
84+
/// details | **Étape 2. Identifiez le code de votre plan (passez à l'étape suivante si vous savez quel plan vous utilisez)**
85+
86+
Votre plan CDA détermine le type et la taille de l'espace de stockage utilisé. Les deux plans disponibles sont les suivants :
87+
88+
- storage-2tb - ancienne configuration sur nvme+hdd (sur disques durs de 2TB)
89+
- cda-3tb - nouvelle configuration sur nvme (disques NVME de 3 To)
90+
91+
1. Récupérer l'ID du service
92+
93+
Utilisez le nom du service (UUID) de l'étape 1 pour obtenir l'ID de service correspondant :
94+
95+
> [!api]
96+
>
97+
> @api {v1} /services?resourceName GET /services?resourceName={serviceName}
98+
>
99+
100+
L'identifiant du service est un nombre - par exemple 1234567
101+
102+
2. Récupérer les détails du service
103+
104+
Interrogez maintenant les informations sur le service à l'aide de l'identifiant du service :
105+
106+
> [!api]
107+
>
108+
> @api {v1} /services/{serviceId} GET /services/{serviceId} // Pour cet exemple, remplacer par 1234567
109+
>
110+
111+
Recherchez le champ suivant dans la réponse :
112+
113+
```json
114+
"billing": {
115+
"plan": {
116+
"code": "cda-3tb"
117+
}
118+
}
119+
```
120+
121+
La valeur sous billing.plan.code est le code de votre plan, dont vous aurez besoin pour effectuer la mise à niveau.
122+
123+
///
124+
125+
### Comment effectuer la mise à niveau
126+
127+
> [!primary]
128+
>
129+
> Pour le moment, la mise à niveau d'un cluster Cloud Disk Array (CDA) n'est disponible que via l'API OVHcloud. Elle ne peut pas être effectuée via l'espace client OVHcloud.
130+
>
131+
132+
Le processus de mise à niveau est simple et ne nécessite qu'un seul appel à l'API.
133+
134+
**Étape 1 : Accéder à la console API**
135+
136+
Choisissez la console API appropriée pour votre région :
137+
138+
- [Console de l'API EU](https://eu.api.ovh.com/console-preview/)
139+
- [Console de l'API CA](https://ca.api.ovh.com/console-preview/)
140+
141+
**Étape 2 : Envoyer l'ordre de mise à niveau**
142+
143+
Utilisez la route API suivante :
144+
145+
> [!api]
146+
>
147+
> @api {v1} /order/upgrade/cephaas/{serviceName}/{planCode} POST /order/upgrade/cephaas/{serviceName}/{planCode}
148+
>
149+
150+
Remplacez les espaces réservés par les détails de votre service :
151+
152+
- serviceName : L'UUID de votre cluster CDA (par exemple 6cb82c75-29fd-4d77-9928-0de6ad9ff5fe)
153+
- planCode : Votre code de plan CDA actuel - soit :
154+
- storage-2tb (ancienne configuration avec HDD + NVMe)
155+
- cda-3tb (nouvelle génération avec NVMe complet)
156+
- quantity : Le nombre d'unités supplémentaires que vous souhaitez provisionner (1-24). Chaque unité ajoute 2 To de stockage via 3 nouveaux OSD. Par exemple :
157+
158+
| Quantité | Capacité totale ajoutée |
159+
| -------- | ------------------------- |
160+
| 1 | 2 TB (3 x 2TB disks) |
161+
| 2 | 4 TB (6 x 2TB disks) |
162+
| ... | ... |
163+
| 24 | 48 TB (72 x 2TB disks) |
164+
165+
**Étape 3 : Récupérer le lien de paiement**
166+
167+
Si l'appel à l'API aboutit, la réponse comprendra une URL de paiement située dans le champ suivant :
168+
169+
```json
170+
"order": {
171+
"details": {
172+
"url": "(https://www.ovh.com/cgi-bin/order/display-order.cgi?orderId=174448338&orderPassword=wufe4HQQQQ)",
173+
}
174+
}
175+
```
176+
177+
**Étape 4 : Confirmer la commande**
178+
179+
Ouvrez l'URL fournie, terminez le processus de paiement et votre mise à niveau commencera automatiquement. Les nouveaux nœuds de stockage sont généralement ajoutés à votre cluster CDA quelques minutes après la confirmation du paiement.
180+
181+
## Aller plus loin
182+
183+
Rendez-vous sur notre chaîne Discord dédiée : <https://discord.gg/ovhcloud>. Posez des questions, fournissez des commentaires et interagissez directement avec l'équipe qui construit nos services de stockage et de sauvegarde.
184+
185+
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.
186+
187+
Échangez avec notre [communauté d'utilisateurs](/links/community).

‎pages/storage_and_backup/block_storage/cloud_disk_array/ceph_grow_with_api/images/ceph_details.png

121 KB
Loading

‎pages/storage_and_backup/block_storage/cloud_disk_array/ceph_grow_with_api/meta.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
id: 18eb6431-df70-405f-af40-68777e8adc7b
2+
full_slug: public-cloud-storage-ceph-grow-capacity

0 commit comments

Comments
 (0)