Skip to content

Commit e27bf28

Browse files
bene2k1SamyOubouaziznerda-codes
authored
docs(em): add cloud-init (#5749)
* docs(em): add cloud-init * Update pages/elastic-metal/concepts.mdx Co-authored-by: SamyOubouaziz <[email protected]> * Update pages/elastic-metal/concepts.mdx Co-authored-by: Néda <[email protected]> --------- Co-authored-by: SamyOubouaziz <[email protected]> Co-authored-by: Néda <[email protected]>
1 parent 236e2b0 commit e27bf28

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

pages/elastic-metal/concepts.mdx

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,37 @@ title: Elastic Metal - Concepts
33
description: This page explains all the concepts related to Scaleway Elastic Metal servers
44
tags: elastic-metal rescue-mode private-networks remote-access az
55
dates:
6-
validation: 2025-08-27
6+
validation: 2025-11-03
77
---
88
import RegionAndAz from '@macros/console/region-and-az.mdx'
99

1010

11+
## Cloud-init
12+
13+
**Cloud-init** is a widely used tool that automates the initial configuration of Elastic Metal servers at boot time. It allows users to define and execute custom setup instructions, transforming a generic operating system image into a fully configured dedicated machine within seconds.
14+
15+
When an Elastic Metal server is launched, `cloud-init` reads user-provided configuration data (also known as *user-data*) and applies it during the boot process. This enables tasks such as installing packages, creating users, configuring SSH keys, or running shell scripts automatically, without manual intervention.
16+
17+
### Cloud-init user-data
18+
19+
User-data is the mechanism through which configuration instructions are passed to an Instance. When cloud-init detects user-data during boot, it interprets and executes it based on the data format provided.
20+
The following formats are supported:
21+
22+
| Format | Starts with | Description |
23+
| --------------------------- | ----------------- | ---------------------------------------------------------------- |
24+
| **Cloud config file** | `#cloud-config` | YAML file containing cloud-init configuration directives. |
25+
| **Shell script** | `#!` | Shell script executed during the first boot of the Instance. |
26+
| **Include file** | `#include` | File listing URLs whose contents will be fetched and executed. |
27+
| **Gzip compressed content** | N/A | Gzip-compressed user-data that is decompressed and executed. |
28+
| **MIME multipart archive** | N/A | File combining multiple data types (e.g. cloud-config + script). |
29+
| **Upstart job** | `#upstart-job` | Upstart job to be executed during boot. |
30+
| **Cloud boothook** | `#cloud-boothook` | Script executed very early in the boot process. |
31+
| **Part handler** | `#part-handler` | Custom handler for processing specific data parts. |
32+
33+
<Message type="note">
34+
Only user-data with content type `text/plain` is currently supported on Scaleway.
35+
</Message>
36+
1137
## Elastic Metal server
1238

1339
Scaleway Elastic Metal are dedicated physical servers you can order on-demand, like Instances. These servers can be used for large workloads, big data and applications that require increased security and dedicated resources.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Scaleway [Elastic Metal servers](https://www.scaleway.com/en/elastic-metal/) pro
3535
- Select a server configuration from the available options.
3636
- Choose an OS to run on your server or opt for no preinstalled image.
3737
- Configure server partitioning. You can either choose a default configuration or [configure your own partitioning](/elastic-metal/how-to/configure-disk-partitions/).
38+
- Optionally, enable and configure cloud-init. Cloud-init is a widely adopted standard for customizing dedicated servers. [Learn more](/elastic-metal/concepts/#cloud-init).
3839
- Enter a name and, optionally, add tags to identify your server.
3940
- 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.
4041
- Optionally, configure the available public bandwidth for your server. This option may not be available for all offers.

0 commit comments

Comments
 (0)