Skip to content

Commit 6b4f931

Browse files
authored
feat(em): update doc custom partitioning (#4700)
* feat(em): update doc custom partitioning * fix(em): fix typo * feat(em): update docs * Apply suggestions from code review
1 parent 575cc11 commit 6b4f931

File tree

4 files changed

+40
-23
lines changed

4 files changed

+40
-23
lines changed

pages/elastic-metal/how-to/configure-disk-partitions.mdx

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,54 @@ content:
77
paragraph: This guide explains how to configure custom disk partitions on Scaleway Elastic Metal servers.
88
tags: attach, detach, flexible-ip, elastic-metal
99
dates:
10-
validation: 2024-10-01
10+
validation: 2025-03-25
1111
posted: 2024-10-01
1212
categories:
1313
- bare-metal
1414
---
1515

16-
Scaleway Elastic Metal servers come with a default partition layout, suitable for most users and intended to speed up and simplify the installation process of the server.
17-
However, if you have specific requirements, you can define custom partitioning of your machine using a JSON configuration during server installation.
16+
Scaleway Elastic Metal servers come with a default partition layout designed for most users, optimizing installation speed and ease of use.
17+
However, if you have specific requirements, you can define a custom partition layout. Partitioning can be configured using either a simplified visual interface or an advanced JSON configuration during server installation.
1818

1919
<Message type="tip">
20-
You can change the partitioning of your server during installation or re-installation only.
21-
Be aware that all your data will be deleted if you reinstall your server.
20+
You can change the partitioning of your server only during installation or reinstallation.
21+
Be aware that all data will be deleted if you reinstall your server.
2222
</Message>
2323

24+
2425
<Macro id="requirements" />
2526
- A Scaleway account logged into the [console](https://console.scaleway.com)
2627
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2728
- An [SSH key](/organizations-and-projects/how-to/create-ssh-key/)
2829
- An [Elastic Metal server](/elastic-metal/quickstart/#how-to-create-an-elastic-metal-server)
2930

30-
## Example configuration
31+
## Simplified partitioning (visual interface)
32+
33+
During [server installation](/elastic-metal/how-to/install-server/), navigate to step 5 of the creation wizard and click **Custom Configuration** > **Simplified Partitioning**.
34+
35+
- Enable or disable partitions for SWAP and the secondary `/data` partition by selecting or deselecting checkboxes.
36+
- Define the mount point for the secondary `/data` partition as needed.
37+
38+
This method is ideal for users who prefer a simplified setup without manually specifying partition details.
3139

32-
During [server installation](/elastic-metal/) click **Advanced JSON** configuration in step 5 of the server creation wizard.
33-
You can then edit the partition configuration directly in the editor within your browser. The configuration is done via a JSON description of the partitioning.
34-
Below is an example of how to define a partitioning schema with RAID and NVMe disks.
40+
## Advanced JSON partitioning
41+
42+
For users requiring granular control, Scaleway offers an advanced partitioning method using JSON.
43+
44+
1. During [server installation](/elastic-metal/how-to/install-server/), navigate to step 5 and click **Custom Configuration** > **Advanced JSON**.
45+
2. Edit the partition schema directly in the browser-based editor.
46+
3. Use JSON to define disk partitions, RAID arrays, and file systems.
3547

3648
<Message type="important">
37-
- Disk Type Naming: Device names differ based on the disk type. For example, HDD/SSD will use `/dev/sdXXX`, while NVMe devices use `/dev/nvmeXXX`.
38-
- UEFI Partition: The EFI partition should only exist if the server uses UEFI. If UEFI is not in use, this partition should be omitted.
39-
- ZFS and LVM: ZFS is optional and can be configured if needed, while LVM should not be used for now due to functionality issues.
49+
- Disk Type Naming: HDD/SSD devices use `/dev/sdXXX`, while NVMe devices use `/dev/nvmeXXX`.
50+
- UEFI Partition: The EFI partition should only exist if the server uses UEFI. Omit this partition if UEFI is not used.
51+
- ZFS and LVM: ZFS is optional, but LVM should not be used due to functionality issues.
4052
</Message>
4153

54+
### Example JSON configuration
55+
4256
<Message type="tip">
43-
Refer to the Elastic Metal API documentation for a complete overview of the expected values for file system types, RAID configurations, and other related parameters required for partitioning. For more details, visit the [Scaleway Elastic Metal API Documentation – Default Partitioning Schema](https://www.scaleway.com/en/developers/api/elastic-metal/#path-partitioning-schemas-get-default-partitioning-schema).
57+
Refer to the [Elastic Metal API documentation](https://www.scaleway.com/en/developers/api/elastic-metal/#path-partitioning-schemas-get-default-partitioning-schema) for valid file system types, RAID configurations, and partitioning parameters.
4458
</Message>
4559

4660
```json

pages/elastic-metal/how-to/create-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Scaleway [Elastic Metal servers](https://www.scaleway.com/en/elastic-metal/) pro
3535
- Choose your preferred billing method: **hourly** or **monthly**.
3636
- Select a server configuration from the available options.
3737
- Choose an OS to run on your server or opt for no preinstalled image.
38-
- Configure server partitioning. You can either choose a default configuration or [configure your own partitioning](/elastic-metal/how-to/configure-disk-partitions/) using a JSON configuration.
38+
- Configure server partitioning. You can either choose a default configuration or [configure your own partitioning](/elastic-metal/how-to/configure-disk-partitions/).
3939
- Enter a name and, optionally, add tags to identify your server.
4040
- Add your SSH key (required if installing an image on your server). Depending on the OS image, you may also be asked to configure the panel user for your server.
4141
- Optionally, configure the available public bandwidth for your server. This option may not be available for all offers.

pages/elastic-metal/how-to/install-server.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ If you ordered your server without a preinstalled operating system, you can inst
3030

3131
1. Click **Elastic Metal** in the **Bare Metal** section of the [Scaleway console](https://console.scaleway.com) side menu. The Elastic Metal dashboard displays.
3232
2. Click **Install** next to the server you want to install. The server installation wizard displays.
33-
3. Select the operating system you want to install on the machine.
34-
<Message type="note">
35-
Elastic Metal servers are installed with a default partition layout. For custom partitioning, you can manually reinstall your server using [remote access](/elastic-metal/how-to/activate-remote-access/).
36-
</Message>
37-
4. Add your [SSH key](/organizations-and-projects/concepts/#ssh-key). If you have already [uploaded a key](/organizations-and-projects/how-to/create-ssh-key/#how-to-upload-the-public-ssh-key-to-the-scaleway-interface), it will appear in the list of keys. Select the keys to grant access to the server by checking the corresponding boxes.
38-
5. Click **Install server** to begin the installation process.
33+
3. Complete the server installation wizard:
34+
- Choose an OS to run on your server or opt for custom installation.
35+
- Configure server partitioning. You can either choose a default configuration or [configure your own partitioning](/elastic-metal/how-to/configure-disk-partitions/).
36+
- Enter a name and, optionally, add tags to identify your server.
37+
- Add your SSH key (required if installing an image on your server). Depending on the OS image, you may also be asked to configure the panel user for your server.
38+
4. Click **Install server** to begin the installation process.
3939
<Message type="note">
4040
The OS installation can take up to one hour. You will be able to access the machine once the installation is complete.
4141
</Message>

pages/elastic-metal/how-to/reinstall-server.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,11 @@ An Elastic Metal server can be reinstalled at any time from the [Scaleway consol
2929
1. Click **Elastic Metal** in the **Bare Metal** section of the [Scaleway console](https://console.scaleway.com) side menu. The Elastic Metal dashboard displays.
3030
2. Click <Icon name="more" /> next to the server you want to reinstall. A drop-down menu displays.
3131
3. Click **Reinstall** in the menu to enter the installation wizard.
32-
4. Choose the operating system that you want to install on the machine.
33-
5. Add your [SSH key](/organizations-and-projects/concepts/#ssh-key). If you have already [uploaded a key](/organizations-and-projects/how-to/create-ssh-key/#how-to-upload-the-public-ssh-key-to-the-scaleway-interface), it displays in the list of keys. Choose the keys to grant access to the server by ticking or unticking the corresponding checkbox.
34-
6. Click **Reinstall server** to launch the installation. It will take about 10 minutes to complete.
32+
4. Complete the server reinstallation wizard:
33+
- Choose an OS to run on your server or opt for custom installation.
34+
- Configure server partitioning. You can either choose a default configuration or [configure your own partitioning](/elastic-metal/how-to/configure-disk-partitions/).
35+
- Enter a name and, optionally, add tags to identify your server.
36+
- Add your SSH key (required if installing an image on your server). Depending on the OS image, you may also be asked to configure the panel user for your server.
37+
5. Click **Reinstall server** to launch the installation.
3538

3639

0 commit comments

Comments
 (0)