Skip to content

Commit 16a0469

Browse files
committed
EN proofreading
1 parent ca32815 commit 16a0469

File tree

1 file changed

+35
-30
lines changed
  • pages/storage_and_backup/block_storage/cloud_disk_array/ceph_grow_with_api

1 file changed

+35
-30
lines changed

pages/storage_and_backup/block_storage/cloud_disk_array/ceph_grow_with_api/guide.en-gb.md

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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.'
3+
excerpt: 'Learn how to increase the storage capacity of your OVHcloud Cloud Disk Array (CDA) using the OVHcloud API'
44
updated: 2025-05-09
55
---
66

@@ -18,14 +18,22 @@ details[open]>summary::before {
1818
}
1919
</style>
2020

21-
## Objectives
21+
## Objective
2222

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.
23+
This guide explains how to upgrade your OVHcloud Cloud Disk Array (CDA) cluster to increase its storage capacity. It describes the technical behaviour 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 available via the OVHcloud API.
24+
25+
> [!primary]
26+
>
27+
> At the moment, upgrading a Cloud Disk Array (CDA) cluster is only available via the OVHcloud API. It cannot be done through the OVHcloud Control Panel.
28+
>
2429
2530
## Requirements
2631

2732
- 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)
33+
- Access to the [OVHcloud API](/links/api)
34+
35+
> [!success]
36+
> If you are not familiar with the OVHcloud API, read our [First Steps with the OVHcloud API](/pages/manage_and_operate/api/first-steps) guide.
2937
3038
## Instructions
3139

@@ -45,8 +53,8 @@ The upgrade process follows these steps:
4553
- **Upgrade Order Initiation:** The customer initiates an upgrade request via the OVHcloud API and proceeds with payment.
4654
- **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.
4755
- **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 clusterincluding 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.
56+
- **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.
57+
- **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.
5058

5159
///
5260

@@ -59,37 +67,39 @@ Before initiating a CDA upgrade, you will need two key pieces of information:
5967

6068
Follow the steps below to retrieve them using the OVHcloud API.
6169

62-
/// details | **Step 1. Get you service name (Skip if you know your service name)**
70+
/// details | **Step 1. Get you service name (Skip this step if you already know your service name)**
6371

6472
Otherwise, you can retrieve it via the OVHcloud Control Panel or the following API call:
6573

6674
> [!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-
>>
7475
> Via the OVHcloud API
76+
>> Use the following API call:
77+
>>
7578
>> > [!api]
7679
>> >
7780
>> > @api {v1} /dedicated/ceph GET /dedicated/ceph
7881
>> >
7982
>>
80-
>> This will return a list of your CDA services. Each service is identified by a UUID, for example 48e5f77f-427b-4261-9799-7861033659fb
83+
>> This will return a list of your CDA services. Each service is identified by a UUID, for example 48e5f77f-427b-4261-9799-7861033659fb.
84+
>>
85+
> Via the OVHcloud Control Panel
86+
>> First, log in to your [OVHcloud Control Panel](/links/manager) and go to the `Bare Metal Cloud`{.action} section. Click the `Platforms and services`{.action} section then the `ceph-cluster`{.action} service.
87+
>>
88+
>> In the `Details`, locate the `ID` field. This value is your CDA service name.
89+
>>
90+
>> ![Ceph details](images/ceph_details.png){.thumbnail}
8191
>>
8292
8393
///
8494

85-
/// details | **Step 2. Identify Your Plan Code (Skip if you know which plan you use)**
95+
/// details | **Step 2. Identify Your Plan Code (skip this step if you know which plan you use)**
8696

8797
Your CDA plan determines the type and size of storage used. The two available plans are:
8898

8999
- storage-2tb - old setup on nvme+hdd (on 2TB HDD disks)
90100
- cda-3tb - new setup on nvme (3TB NVME disks)
91101

92-
1. Retrieve the Service ID
102+
**Retrieve the Service ID:**
93103

94104
Use the service name (UUID) from Step 1 to get the corresponding service ID:
95105

@@ -98,15 +108,15 @@ Use the service name (UUID) from Step 1 to get the corresponding service ID:
98108
> @api {v1} /services?resourceName GET /services?resourceName={serviceName}
99109
>
100110
101-
Service ID is a number - e.g. 1234567
111+
The service ID is a number, e.g. 1234567
102112

103-
2. Retrieve the Service Details
113+
**Retrieve the Service Details:**
104114

105115
Now query the service information using the service ID:
106116

107117
> [!api]
108118
>
109-
> @api {v1} /services/{serviceId} GET /services/{serviceId} // For this example, replace by 1234567
119+
> @api {v1} /services/{serviceId} GET /services/{serviceId} // For this example, replace with 1234567
110120
>
111121
112122
Look for the following field in the response:
@@ -119,17 +129,12 @@ Look for the following field in the response:
119129
}
120130
```
121131

122-
The value under billing.plan.code is your plan code, which you’ll need to perform the upgrade.
132+
The value under billing.plan.code is your plan code, which you will need to perform the upgrade.
123133

124134
///
125135

126136
### How to Perform the Upgrade
127137

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-
133138
The upgrade process is straightforward and requires just one API call.
134139

135140
**Step 1: Access the API Console**
@@ -165,7 +170,7 @@ Replace the placeholders with your service details:
165170

166171
> [!primary]
167172
>
168-
> Note: quantity refers to how many units you want in total, not how many units you want to add.
173+
> Quantity refers to how many units you want in total, not how many units you want to add.
169174
>
170175
> For example, if your cluster currently has 3 TB of storage and you want to increase it to 6 TB, you need to set quantity = 2 (not 1).
171176
>
@@ -183,7 +188,7 @@ If the API call is successful, the response will include a payment URL located i
183188
}
184189
}
185190
```
186-
191+
187192
**Step 4: Confirm the Order**
188193

189194
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.
@@ -192,6 +197,6 @@ Open the provided URL, complete the payment process, and your upgrade will begin
192197

193198
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.
194199

195-
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.
200+
If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project.
196201

197-
Join our community of users on <https://community.ovh.com/en/>.
202+
Join our [community of users](/links/community).

0 commit comments

Comments
 (0)