Skip to content

Commit c61dc94

Browse files
authored
docs(gen): harmonization of local and block storage casings (#3991)
1 parent 5e29395 commit c61dc94

38 files changed

+98
-113
lines changed

compute/gpu/how-to/create-manage-gpu-instance.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ When you have completed your calculations using the GPU Instance, [deletion can
3535
- **Availability Zone**: Choose the geographical region, represented by the Availability Zone, where your Instance will be deployed.
3636
- **Instance Type (GPU)**: Select the desired GPU Instance type, considering factors such as processing power, memory, storage options, and bandwidth. Refer to our guide on [choosing the right GPU Instance type](/compute/gpu/reference-content/choosing-gpu-instance-type/) for more information.
3737
- **Image**: Pick an operating system image suitable for your GPU Instance. For example, select **Ubuntu Jammy GPU OS 12**, which comes with preinstalled NVIDIA drivers and an NVIDIA Docker environment. You have the flexibility to customize your working environment using Docker with our provided Docker images or your own containers.
38-
- **Volumes**: Optionally, add storage volumes for your Instance. You can adjust settings such as block and local storage volumes according to your requirements.
38+
- **Volumes**: Optionally, add storage volumes for your Instance. You can adjust settings such as Block and Local Storage volumes according to your requirements.
3939
<Message type="note">
4040
* The recommended minimum volume size for GPU OS images is 125 GB.
4141
* If your GPU Instance supports scratch storage, the scratch volume displays but can not be edited. [Learn more about scratch storage.](/compute/gpu/how-to/use-scratch-storage-h100-instances/)

compute/gpu/how-to/use-gpu-with-docker.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ We recommend that you map volumes from your GPU Instance to your Docker containe
4747

4848
### How to map local volumes
4949

50-
You can map directories from your GPU Instance's local storage to your Docker container, using the `-v <local_storage>:<container_mountpoint>` flag. See the example command below:
50+
You can map directories from your GPU Instance's Local Storage to your Docker container, using the `-v <local_storage>:<container_mountpoint>` flag. See the example command below:
5151

5252
```
5353
docker run -it --rm -v /root/mydata/:/workspace nvidia/cuda:11.2.1-runtime-ubuntu20.04
@@ -101,7 +101,7 @@ Below is a list of the most common commands you use when dealing with Docker con
101101
| **docker push** | `docker push <registry_user/docker_image>` | This command is used to push a local image to a remote repository. |
102102
| **docker images** | `docker images` | This command is used to list all available Docker images on the local system. |
103103
| **docker rm** | `docker rm <container_id>` | This command is used to remove a stopped container from the local system. |
104-
| **docker rmi** | `docker rmi <image_id>` | This command is used to delete an image from the local storage. |
104+
| **docker rmi** | `docker rmi <image_id>` | This command is used to delete an image from the Local Storage. |
105105
| docker version| `docker --version` | This command is used to display information about the currently installed version of Docker. |
106106

107107
For more information regarding the `docker run` command, refer to the [official documentation](https://docs.docker.com/engine/reference/run/).
@@ -129,7 +129,7 @@ docker run --runtime=nvidia -it --rm nvidia/cuda:11.2.1-runtime-ubuntu20.04 nvid
129129
```
130130

131131
<Message type="tip">
132-
You can omit this option if using the “Ubuntu Focal GPU OS11” Operating System image with your GPU Instance (as this option is set by default in the Docker configuration files)
132+
You can omit this option if using the “Ubuntu Focal GPU OS11” Operating System image with your GPU Instance, as this option is set by default in the Docker configuration files.
133133
</Message>
134134

135135
If your Instance has several GPUs, you can specify which GPU(s) to use with the container via the Docker CLI using either the `--gpus` option (starting with Docker 19.03) or using the environment variable `NVIDIA_VISIBLE_DEVICES`.

compute/gpu/how-to/use-scratch-storage-h100-instances.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ categories:
1313
- compute
1414
---
1515

16-
Scaleway H100 and L40S GPU Instances are equipped with additional scratch storage. This form of temporary local storage operates differently from our regular local storage.
16+
Scaleway H100 and L40S GPU Instances are equipped with additional scratch storage. This form of temporary Local Storage operates differently from our regular Local Storage.
1717

1818
Scratch storage temporarily accommodates data during computational or data processing tasks. It is commonly used for storing intermediate results, processing input data, or holding output data before that data is moved to more permanent storage.
1919

compute/gpu/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ In addition to this, GPU Instances have all the features of our regular Instance
2727
- **Availability Zone**: Choose the geographical region, represented by the Availability Zone, where your Instance will be deployed.
2828
- **Instance Type (GPU)**: Select the desired GPU Instance type, considering factors such as processing power, memory, storage options, and bandwidth. Refer to our guide on [choosing the right GPU Instance type](/compute/gpu/reference-content/choosing-gpu-instance-type/) for more information.
2929
- **Image**: Pick an operating system image suitable for your GPU Instance. For example, select **Ubuntu Jammy GPU OS 12**, which comes with preinstalled Nvidia drivers and an Nvidia Docker environment. You have the flexibility to customize your working environment using Docker with our provided Docker images or your own containers.
30-
- **Volumes**: Optionally, add storage volumes for your Instance. You can adjust settings such as block and local storage volumes according to your requirements.
30+
- **Volumes**: Optionally, add storage volumes for your Instance. You can adjust settings such as Block and Local Storage volumes according to your requirements.
3131
<Message type="note">
3232
* The recommended minimum volume size for GPU OS images is 125 GB.
3333
* If your GPU Instance supports scratch storage, the scratch volume displays but can not be edited. [Learn more about scratch storage.](/compute/gpu/how-to/use-scratch-storage-h100-instances/)

compute/instances/api-cli/migrating-instances.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ To do so, you need the Instance’s ID and a valid API key.
4343
You can retrieve a list of all available Instance types using the command `scw instance server-type list`.
4444
</Message>
4545
<Message type="important">
46-
Ensure that local storage constraints are respected. For example, downgrading from a larger Instance type to a smaller one may not be possible if the smaller Instance type cannot support the existing local storage. Check the Scaleway documentation for specific constraints.
46+
Ensure that Local Storage constraints are respected. For example, downgrading from a larger Instance type to a smaller one may not be possible if the smaller Instance type cannot support the existing Local Storage. Check the Scaleway documentation for specific constraints.
4747
</Message>
4848

4949
3. Power on the Instance.
@@ -82,7 +82,7 @@ To do so, you need the Instance’s ID and a valid API key.
8282
curl -X PATCH -H "X-Auth-Token: $SCW_SECRET_KEY" -H "Content-Type: application/json" -d '{"commercial_type" : "<NEW_INSTANCE_TYPE>"}' "https://api.scaleway.com/instance/v1/zones/{zone}/servers/{server_id}"
8383
```
8484
<Message type="important">
85-
Local storage constraints must be respected. For example, downgrading a DEV1-L Instance with 80 GB of local SSD storage to a DEV1-S Instance is not possible because the DEV1-S offer only supports a maximum of 20 GB. However, if the DEV1-L Instance is only using block storage (`b_ssd`) without relying on local SSD storage, the downgrade can be performed without any issues.
85+
Local Storage constraints must be respected. For example, downgrading a DEV1-L Instance with 80 GB of local SSD storage to a DEV1-S Instance is not possible because the DEV1-S offer only supports a maximum of 20 GB. However, if the DEV1-L Instance is only using Block Storage (`b_ssd`) without relying on local SSD storage, the downgrade can be performed without any issues.
8686
</Message>
8787

8888
Output:
@@ -135,4 +135,4 @@ To do so, you need the Instance’s ID and a valid API key.
135135

136136
For more information on using the API, refer to the complete [API documentation](https://www.scaleway.com/en/developers/api/instance/).
137137
</TabsTab>
138-
</Tabs>
138+
</Tabs>

compute/instances/concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ An image is composed of snapshots of volumes. Snapshots can only be restored to
161161

162162
## Standby mode
163163

164-
Standby mode is a way to stop an Instance temporarily. When you [put an Instance in standby mode](/compute/instances/how-to/use-standby-mode/), the server is halted, but the Instance remains allocated to your account, and all data remains on the local storage of the Instance.
164+
Standby mode is a way to stop an Instance temporarily. When you [put an Instance in standby mode](/compute/instances/how-to/use-standby-mode/), the server is halted, but the Instance remains allocated to your account, and all data remains on the Local Storage of the Instance.
165165

166166
## Stateful security groups
167167

compute/instances/how-to/create-a-snapshot.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ The snapshot feature allows you to create an image of a specific [volume](/compu
1717

1818
Several options are available to create snapshots from your Instance:
1919

20-
* **LSSD (Local storage):** This snapshot type can be created from local volumes. LSSD snapshots can be converted to local volumes only.
21-
* **BSSD (Block storage):** This snapshot type can be created from block volumes. BSSD snapshots can be converted to block volumes only.
20+
* **LSSD (Local Storage):** This snapshot type can be created from local volumes. LSSD snapshots can be converted to local volumes only.
21+
* **BSSD (Block Storage):** This snapshot type can be created from block volumes. BSSD snapshots can be converted to block volumes only.
2222

2323
<Message type="note">
2424
The snapshot feature creates backups of specific volumes only. If you wish to create a backup image that is a complete backup of your Instance including **all** of its volumes, check out our documentation on [how to create an image](/compute/instances/how-to/create-a-backup/).
@@ -66,6 +66,4 @@ Follow the instructions for [creating an Instance](/compute/instances/how-to/cre
6666

6767
<Lightbox src="scaleway-create-from-snapshot.webp" alt="" />
6868

69-
You can see the snapshotted volume in the Instance's volumes at **step 4** of the creation wizard.
70-
71-
69+
You can see the snapshotted volume in the Instance's volumes at **step 4** of the creation wizard.

compute/instances/how-to/create-an-instance.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Select a tab below for instructions on how to create an Instance via either our
153153
| commercial-type | The commercial Instance type to create (string) | Any valid ID of a Scaleway commercial Instance type, e.g. `"GP1-S"`, `"PRO2-M"`. Use the [List Instance Types](https://www.scaleway.com/en/developers/api/instance/#path-instance-types-list-instance-types) endpoint to get a list of all valid Instance types and their IDs. |
154154
| image | The image to install on the Instance, e.g. a particular OS (string) | Any valid Scaleway image ID, e.g. `"544f0add-626b-4e4f-8a96-79fa4414d99a"` which is the ID for the `Ubuntu 22.04 Jammy Jellyfish` image. Use the [Marketplace API](https://www.scaleway.com/en/developers/api/marketplace/) endpoint to find available images and their IDs. |
155155
| enable_ipv6 | Whether to enable IPv6 on the Instance (boolean) | `true` or `false` |
156-
| volumes | An object that specifies the storage volumes to attach to the Instance. Must respect the volume constraints of the `commercial_type` (i.e. for each type of Instance, a minimum amount of storage is required, and there is also a maximum that cannot be exceeded. Some Instance types support only Block Storage (`b_ssd`), others also support local storage (`l_ssd`) ). These constraints are available at the [List Instance Types](https://www.scaleway.com/en/developers/api/instance/#path-instance-types-list-instance-types) endpoint, via the `volume_constraints` parameter for each type listed in the response | A (dictionary) object with a minimum of one key (`"0"`) whose value is another object containing the parameters `"name"` (a name for the volume), `"size"` (the size for the volume, in bytes), and `"volume_type"` (`"l_ssd"` or `"b_ssd"`). Additional keys for additional volumes should increment by 1 each time (the second volume would have a key of `1`.) Further parameters are available, and it is possible to attach existing volumes rather than creating a new one, or create a volume from a snapshot. For full details see [here](https://www.scaleway.com/en/developers/api/instance/#path-volumes). |
156+
| volumes | An object that specifies the storage volumes to attach to the Instance. Must respect the volume constraints of the `commercial_type` (i.e. for each type of Instance, a minimum amount of storage is required, and there is also a maximum that cannot be exceeded. Some Instance types support only Block Storage (`b_ssd`), others also support Local Storage (`l_ssd`) ). These constraints are available at the [List Instance Types](https://www.scaleway.com/en/developers/api/instance/#path-instance-types-list-instance-types) endpoint, via the `volume_constraints` parameter for each type listed in the response | A (dictionary) object with a minimum of one key (`"0"`) whose value is another object containing the parameters `"name"` (a name for the volume), `"size"` (the size for the volume, in bytes), and `"volume_type"` (`"l_ssd"` or `"b_ssd"`). Additional keys for additional volumes should increment by 1 each time (the second volume would have a key of `1`.) Further parameters are available, and it is possible to attach existing volumes rather than creating a new one, or create a volume from a snapshot. For full details see [here](https://www.scaleway.com/en/developers/api/instance/#path-volumes). |
157157

158158
3. Use the following curl command, replacing the payload with the one you specified in step 2, to create your Instance.
159159

@@ -224,5 +224,3 @@ Select a tab below for instructions on how to create an Instance via either our
224224
</TabsTab>
225225

226226
</Tabs>
227-
228-

compute/instances/how-to/use-standby-mode.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ categories:
1313
- compute
1414
---
1515

16-
[Standby mode](/compute/instances/concepts/#stand-by-mode) temporarily stops an Instance. The Instance remains allocated to your account and all data remains on the local storage of the Instance.
16+
[Standby mode](/compute/instances/concepts/#stand-by-mode) temporarily stops an Instance. The Instance remains allocated to your account and all data remains on the Local Storage of the Instance.
1717

1818
<Macro id="requirements" />
1919

0 commit comments

Comments
 (0)