Skip to content

chore(gen): doc review MTA-6082 #5026

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

Merged
merged 9 commits into from
Jun 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions pages/block-storage/api-cli/managing-a-volume.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Master Block Storage with our comprehensive guide. Learn to format, mount, transfer data, and expand partitions efficiently. Perfect for all skill levels.
tags: volume block-storage block mount format use
dates:
validation: 2024-12-06
validation: 2025-06-09
posted: 2019-11-29
categories:
- block-storage
Expand All @@ -20,7 +20,6 @@ This documentation only explains how to mount **additional block volumes to your

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- An [SSH key](/organizations-and-projects/how-to/create-ssh-key/)
- An [Instance](/instances/concepts/#instance)
- [Attached](/block-storage/how-to/attach-a-volume/) an additional Block Storage volume to your Instance

Expand All @@ -29,7 +28,6 @@ This documentation only explains how to mount **additional block volumes to your
In order to mount and use your Block Storage volume, you need to connect to the Instance it is attached to, via SSH.
Then, check that the volume is available, format it, and mount it following the instructions below.


### Verifying device availability

1. Connect to your Instance with `ssh`.
Expand All @@ -41,8 +39,7 @@ Then, check that the volume is available, format it, and mount it following the
lsblk
```


You should see an output similar to the following. The root Block volume `sda`, runs your OS. The Block volume named `sdb` is the one we will be mounting to the Instance.
You should see an output similar to the following. The root Block volume `sda`, contains your OS. The Block volume named `sdb` is the one we will be mounting to the Instance.

```sh no-copy
root@scw-festive-agnesi:~# lsblk
Expand All @@ -58,8 +55,6 @@ Then, check that the volume is available, format it, and mount it following the
The Scaleway ecosystem uses [GB](https://en.wikipedia.org/wiki/Gigabyte) to define storage sizes and not [GiB](https://en.wikipedia.org/wiki/Gibibyte) as the default on linux.
</Message>

---

### Formatting the Block volume

Formatting your volume prepares it for storing files.
Expand Down Expand Up @@ -100,19 +95,19 @@ Formatting your volume prepares it for storing files.

Once you have created your file system, you need to define where you want to mount your volume, and create a mount point (directory) for it.

1. Create the mount point. Feel free to replace `block-volume` with another name for your mount point.
1. Create the mount point. You can replace `block-volume` with another name for your mount point.
```
mkdir /mnt/block-volume
```
2. Mount the volume. We recommend that you use the `defaults` option, as in the command below.
```
# Make sure that you replace sdX with the name of your volume
# Replace sdX with the name of your volume
mount -o defaults /dev/sdX /mnt/block-volume
```

If you want to see all available options, you can run `man mount` on your Instance.

3. Run the following command to check if your file system was properly mounted:
3. Run the following command to check if your volume was properly mounted:
```
lsblk
```
Expand Down Expand Up @@ -147,14 +142,14 @@ echo "UUID=$(blkid --output value /dev/sdX | head -n1) /mnt/block-volume ext4 de

### Transferring data from your local machine to the remote Block volume

You may wish to transfer files from your local machine to your Instance's remote Block volume. This can be achieved with [rsync](https://en.wikipedia.org/wiki/Rsync), a tool for efficiently transferring and copying files. The rsync utility is pre-installed on most Linux distributions and macOS.
You can transfer files from your local machine to your Instance's remote Block volume with [rsync](https://en.wikipedia.org/wiki/Rsync), a tool for efficiently transferring and copying files. The rsync utility is pre-installed on most Linux distributions and macOS.

1. Check that rsync is installed on your local machine with the following command:
```
rsync --version
```

You should see an output similar to the following:
An output similar to the following displays:

```sh no-copy
rsync version 3.1.3 protocol version 31
Expand All @@ -176,14 +171,18 @@ You may wish to transfer files from your local machine to your Instance's remote
- For Linux CentOS/ Fedora, you can use the YUM package manager: `sudo yum install rsync`.
- On Mac OSX with the Homebrew package manager, you can use `brew install rsync`.
</Message>

2. On your local machine, open a new terminal and use the following command to create a file called `hello-world.txt`:
```
nano hello-world.txt
```

3. Enter the text `Hello World!`.
4. Press `Ctrl O`, `Enter`, and `Ctrl X` to save and exit the file.

4. Press `Ctrl+O`, then `Enter`, then `Ctrl+X` to save and exit the file.

5. Enter the following command to transfer the file to your Instance's mounted block volume. Ensure that you use your own Instance's IP address:

```
rsync -a hello-world.txt root@<your_instance_ip>:/mnt/block-volume
```
Expand All @@ -194,16 +193,18 @@ The file is now transferred. You can connect to your Instance again, and use the

## Increasing the partition size of the volume with growpart

`growpart` allows you to resize partitions. If you have increased the size of the partition's underlying volume, for example, you can increase the size of the partition to make use of the additional space.

<Message type="important">
- We recommend that you make a backup of your data using the [snapshot](/block-storage/how-to/create-a-snapshot/) feature, before increasing the partition size of your volume. This helps you avoid any potential data loss.
- You need to have partitioned your volume to follow the procedure below
- If the partition you want to resize is mounted, you need to [unmount it](/block-storage/api-cli/unmounting-a-volume/) beforehand
- Make sure to make a backup of your data using the [snapshot](/block-storage/how-to/create-a-snapshot/) feature beforehand to avoid any potential data loss
- You must have partitioned your volume to follow the procedure below
- If the partition you want to resize is mounted, you must [unmount it](/block-storage/api-cli/unmounting-a-volume/) beforehand
</Message>

`growpart` allows you to resize partitions. If you have increased the size of the partition's underlying volume, for example, you might want to increase the size of the partition to make use of the additional space.

1. Connect to your Instance using [SSH](/instances/how-to/connect-to-instance/).

2. Use the `lsblk` command to identify your volume partition. Ensure that the partition is **not mounted before you resize it**. In the following example, we are resizing `sdb1`:

```
root@scw-festive-agnesi:~# lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS
Expand All @@ -216,20 +217,19 @@ The file is now transferred. You can connect to your Instance again, and use the
```

3. Use `growpart` to increase the partition size of your Block Storage volume (here `sdb1`):

```
# Replace /dev/sdX 1 with the name of your partition
growpart /dev/sdX 1
```

<Message type="tip">
Make sure that you add a space between the device identifier (`/dev/sdX`) and the partition number (`1`).
</Message>
An output similar to the following displays:

You should see an output similar to the following:
```
CHANGED: partition=1 start=0 old: size=39061504 end=39061504 new: size=58490880 end=58490880
```
4. Use `lsblk` to check that the partition was correctly resized. In the following output, you can see in the `SIZE` field that our partition `sbd1` went from `18.6G` (step 2) to `27.9G`.

4. Use `lsblk` to check that the partition was correctly resized. In the following output, you can see that our partition `sbd1` went from `18.6G` (step 2) to `27.9G`.
```
root@scw-festive-agnesi:~# lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS
Expand Down
19 changes: 8 additions & 11 deletions pages/block-storage/api-cli/unmounting-a-volume.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,37 @@ content:
paragraph: Learn how to safely unmount a Block Storage volume from your Instance, and ensure data integrity.
tags: volume block-storage block unmount
dates:
validation: 2024-12-06
validation: 2025-06-09
posted: 2023-11-23
categories:
- block-storage
- storage
---


## Unmounting a Block Storage volume


Unmounting a volume means detaching it from the operating system so it is no longer accessible. You can do this if you want to stop using it, prevent data corruption, or plan to [detach it](/block-storage/how-to/detach-a-volume/) from your Instance and attach it to another. This page shows you how to unmount a volume from the operating system using the `umount` command.

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- Created an [SSH key](/organizations-and-projects/how-to/create-ssh-key/)
- Created an [Instance](/instances/how-to/create-an-instance/) with an additional Block Storage volume

1. Open a terminal and use the following command to [connect to your Instance](/instances/how-to/connect-to-instance/). Make sure that you replace `<your_instance_ip>` with your Instance's IP. You can also find the SSH command in your Instance's **Overview** tab in the Scaleway console.

1. Open a terminal and use the following command to connect to your Instance. Make sure that you replace `<your_instance_ip>` with your Instance's IP. You can also find the SSH command in your Instance's **Overview** tab in the Scaleway console.
```
ssh root@<your_instance_ip>
```
2. Use `lsblk` to check where your volume is mounted. You should see an output similar to the following:

2. Run the `lsblk` command to check where your volume is mounted. You should see an output similar to the following:

```
root@scw-heuristic-shtern:~# lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS
sdb 8:0 0 18.6G 0 disk /mnt/block-volume
```
3. Unmount the volume to remove it from your current setup. Replace `/mnt/block-volume` with your mount point.
3. Run the command below to unmount the volume to remove it from your current setup. Replace `/mnt/block-volume` with your mount point.
```
umount /mnt/block-volume
```
Expand All @@ -48,9 +47,7 @@ Unmounting a volume means detaching it from the operating system so it is no lon
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
sdb 8:0 0 18.6G 0 disk
```
<Message type="important">
Remember to edit the `/etc/fstab` file and delete the line corresponding to your block volume if you have used [Persistent Mounting](/block-storage/api-cli/managing-a-volume/#using-fstab-for-persistent-mounting).
</Message>

Refer to the [dedicated documentation](/block-storage/api-cli/managing-a-volume/) for more information about managing your Block Storage volumes.
5. If you have used [Persistent Mounting](/block-storage/api-cli/managing-a-volume/#using-fstab-for-persistent-mounting), edit the `/etc/fstab` file and delete the line corresponding to your block volume.

Your Block Storage volume is now unmounted from your Instance. Refer to the [dedicated documentation](/block-storage/api-cli/managing-a-volume/) for more information about managing your Block Storage volumes.
5 changes: 3 additions & 2 deletions pages/block-storage/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ content:
paragraph: Explore essential concepts of Block Storage, including block devices, IOPS, SANs, local volumes, and their roles in enhancing storage performance and reliability.
tags: block storage volumes concept
dates:
validation: 2024-11-13
validation: 2025-06-09
posted: 2023-11-23
categories:
- block-storage
- storage
Expand All @@ -19,7 +20,7 @@ A block device is a storage volume on a network-connected storage system that is

## IOPS

IOPS or Input/Ouptut Operations Per Second, is a unit of measurement that indicates how many input or output operations a storage device is performing per second.
IOPS or Input/Ouptut Operations Per Second, is a unit of measurement that indicates how many read/write operations a storage device is performing per second.

Scaleway Block Storage Low Latency offers two IOPS limits:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Integrate IAM with Scaleway Object Storage for enhanced access control.
tags: object storage command bucket amazon-s3 iam permissions acl policy
dates:
validation: 2024-11-27
validation: 2025-06-12
posted: 2023-01-17
categories:
- storage
Expand Down
2 changes: 1 addition & 1 deletion pages/object-storage/api-cli/enable-sse-c.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Enable server-side encryption with customer-provided keys (SSE-C) in Scaleway.
tags: object storage server side encryption sse sse-c cli s3
dates:
validation: 2024-11-12
validation: 2025-06-12
posted: 2024-05-30
categories:
- storage
Expand Down
7 changes: 4 additions & 3 deletions pages/object-storage/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ content:
paragraph: Understand key concepts and features of Scaleway Object Storage.
tags: retention endpoint object-storage storage bucket acl multipart object amazon-s3 retention signature versioning archived
dates:
validation: 2024-11-27
validation: 2025-06-09
posted: 2021-05-26
categories:
- storage
- object-storage
Expand Down Expand Up @@ -90,7 +91,7 @@ A multipart upload consists of three steps:

- The client initiates the upload to a specific bucket
- The different parts are uploaded
- Object Storage constructs the object from the uploaded parts
- Object Storage builds the object from the uploaded parts

## Object

Expand All @@ -116,7 +117,7 @@ Parts are the chunks of data that compose multipart objects.

## Prefix

A prefix is a string of characters at the beginning of the [object key name](#object). They are often used to organize your data similarly to directories and to manage object [lifecycle](#lifecycle-configuration). However, prefixes are not directories.
A prefix is a string of characters at the beginning of the [object key name](#object). They are often used to organize your data similarly to directories, and to manage object [lifecycle](#lifecycle-configuration). However, prefixes are not directories.

In the context of Scaleway Object Storage, prefixes are used to display folders in the Scaleway console for practical reasons. The `/` character in a prefix is used as a delimiter to allow you to organize your objects hierarchically.

Expand Down
2 changes: 1 addition & 1 deletion pages/object-storage/how-to/create-bucket-policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Create and apply bucket policies for Object Storage.
tags: bucket policy bucket console object storage aws-s3 access
dates:
validation: 2024-11-05
validation: 2025-06-09
posted: 2024-05-30
categories:
- storage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Discover the checksums supported by Scaleway Object Storage.
tags: object storage checksum supported aws object integrity
dates:
validation: 2024-11-14
validation: 2025-06-09
posted: 2024-11-14
categories:
- network
Expand Down
2 changes: 1 addition & 1 deletion pages/scaleway-sdk/go-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: This page explains how to install and use the Scaleway Go software development kit (SDK)
tags: devtools sdk go-sdk go golang
dates:
validation: 2024-11-27
validation: 2025-06-09s
posted: 2023-11-14
categories:
- devtools
Expand Down
2 changes: 1 addition & 1 deletion pages/scaleway-sdk/js-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: This page explains how to install and use the Scaleway JS software development kit (SDK)
tags: devtools sdk go-sdk scaleway-sdk go golang
dates:
validation: 2024-11-27
validation: 2025-06-09
posted: 2023-11-14
categories:
- devtools
Expand Down
2 changes: 1 addition & 1 deletion pages/scaleway-sdk/python-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: This page explains how to install and use the Scaleway Python software development kit (SDK)
tags: devtools sdk python-sdkscaleway-sdk
dates:
validation: 2024-11-27
validation: 2025-06-09
posted: 2023-11-14
categories:
- devtools
Expand Down
17 changes: 8 additions & 9 deletions pages/serverless-containers/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Key concepts of Scaleway Serverless Containers.
tags: containers cold-start concurrency container-registry environment-variables jwt vcpu serverless scale autoscaling
dates:
validation: 2024-11-14
validation: 2025-05-26
categories:
- serverless
---
Expand Down Expand Up @@ -138,15 +138,15 @@ The Serverless infrastructure manages incoming request traffic. In scenarios lik

## Logging

Serverless Containers offers a built-in logging system based on Cockpit to track the activity of your resources: see [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/).
Serverless Containers offers a built-in logging system based on Cockpit to track the activity of your resources. Refer to [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/) for more information.

## Max scale

This parameter sets the maximum number of container instances. You should adjust it based on your container's traffic spikes, keeping in mind that you may wish to limit the max scale to manage costs effectively.
This parameter sets the maximum number of container instances. You should adjust it based on your container's traffic spikes, keeping in mind that you may wish to limit the maximum scale to manage costs effectively.

## Metrics

Performance metrics for your Serverless resources are natively available: see [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/).
Performance metrics for your Serverless resources are natively available. Refer to [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/) for more information.

## Min scale

Expand Down Expand Up @@ -188,7 +188,7 @@ Refer to the [dedicated FAQ](/serverless-containers/faq/#how-can-i-configure-acc
A queue trigger is a mechanism that connects a container to a queue created with [Scaleway Queues](/queues/concepts/#scaleway-queues), and invokes the container automatically whenever a message is added to the queue.

For each message that is sent to a queue, the trigger reads the message and invokes the associated container with the message as the input parameter.
The container can then process the message and perform any required actions, such as updating a database or sending a notification.
The container can then process the message, and perform any required actions, such as updating a database or sending a notification.

## Registry endpoint

Expand All @@ -204,11 +204,10 @@ Use cases:

## Rolling update

When deploying a new version of a Serverless Container, a rolling update is applied by default. This means that the new version of the service is gradually rolled out to your users without downtime.
Here is how it works:
When deploying a new version of a Serverless Container, a rolling update is applied by default. The new version of the service is gradually rolled out to your users without downtime, as follows:

* When a new version of your container is deployed, the platform automatically starts routing traffic to it incrementally, while still serving requests from the old version until the new one is fully deployed.
* Once the new version is successfully running, we gradually shift all traffic to it, ensuring zero downtime.
* Once the new version is successfully running, the platform gradually shifts all traffic to it, ensuring zero downtime.
* The old version is decommissioned once the new version is fully serving traffic.

This process ensures a seamless update experience, minimizing user disruption during deployments. If needed, you can also manage traffic splitting between versions during the update process, allowing you to test new versions with a subset of traffic before fully migrating to it.
Expand All @@ -223,7 +222,7 @@ Refer to the [dedicated documentation](/serverless-containers/reference-content/

## Scale to zero

One of the advantages of Serverless Containers is that when your container is not triggered, it does not consume any resources, which enables great savings.
When provisioned with a [minimum scale](#min-scale) of `0`, Serverless Containers scale down to zero active instances as long as they are not triggered. While idling, they do not consume any resources, which allows to reduce the cost of your infrastructure.

## Secrets

Expand Down
Loading