Skip to content

Commit e016901

Browse files
jcirinosclwyRoRoJ
andauthored
docs(gen): file system harmonization and general clean up (#4015)
* docs(gen): file system harmonization and general clean up * Update containers/kubernetes/api-cli/cluster-monitoring.mdx Co-authored-by: Rowena Jones <[email protected]> --------- Co-authored-by: Rowena Jones <[email protected]>
1 parent aa0619e commit e016901

File tree

56 files changed

+152
-169
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+152
-169
lines changed

ai-data/managed-inference/quickstart.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Here are some of the key features of Scaleway Managed Inference:
3838
1. Navigate to the **AI & Data** section of the [Scaleway console](https://console.scaleway.com/), and select **Managed Inference** from the side menu to access the Managed Inference dashboard.
3939
2. Click **Create deployment** to launch the deployment creation wizard.
4040
3. Provide the necessary information:
41-
- Select the desired model and the quantization to use for your deployment [from the available options](https://www.scaleway.com/en/docs/ai-data/managed-inference/reference-content/)
41+
- Select the desired model and the quantization to use for your deployment [from the available options](/ai-data/managed-inference/reference-content/)
4242
<Message type="note">
4343
Some models may require acceptance of an end-user license agreement. If prompted, review the terms and conditions and accept the license accordingly.
4444
</Message>
@@ -83,8 +83,8 @@ Managed Inference deployments have authentication enabled by default. As such, y
8383
2. Choose a deployment either by clicking its name or selecting **More info** from the drop-down menu represented by the icon <Icon name="more" /> to access the deployment dashboard.
8484
3. Click the **Settings** tab of your deployment to display additional settings.
8585
4. Click **Delete deployment**.
86-
5. Type **DELETE** to confirm and click **Delete deployment** to delete your deployment.
86+
5. Type **DELETE** to confirm and click **Delete deployment** to delete your deployment.
8787

8888
<Message type="important">
8989
Deleting a deployment is a permanent action, and will erase all its associated configuration and resources.
90-
</Message>
90+
</Message>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Below is an example of how to define a partitioning schema with RAID and NVMe di
4040
</Message>
4141

4242
<Message type="tip">
43-
Refer to the Elastic Metal API documentation for a complete overview of the expected values for filesystem 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).
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).
4444
</Message>
4545

4646
```json
@@ -170,8 +170,8 @@ Below is an example of how to define a partitioning schema with RAID and NVMe di
170170
- If RAID is required, declare the disks and the desired RAID level. In this example, we are configuring two RAID-1 arrays, one for the boot partition and one for the root partition.
171171
- Devices participating in each RAID array are specified by their partition paths (e.g., `/dev/nvme0n1p3` for partition 3 of the first NVMe disk).
172172

173-
- Filesystems:
174-
- Each partition is assigned a filesystem type and a mount point.
173+
- File systems:
174+
- Each partition is assigned a file system type and a mount point.
175175
- For example, the `/boot/efi` partition is formatted with `fat32`, while `/boot` and `/` are formatted with `ext4`.
176176

177177
- ZFS (Optional):
@@ -180,7 +180,7 @@ Below is an example of how to define a partitioning schema with RAID and NVMe di
180180

181181
### Simple configuration (No RAID or ZFS)
182182

183-
If you prefer a simpler configuration without RAID or ZFS, you can remove the `raids` and `zfs` sections. For example, if you only need a single disk setup with no RAID, declare just one disk with the partitions and filesystems as shown below:
183+
If you prefer a simpler configuration without RAID or ZFS, you can remove the `raids` and `zfs` sections. For example, if you only need a single disk setup with no RAID, declare just one disk with the partitions and file systems as shown below:
184184

185185
```json
186186
{

bare-metal/elastic-metal/how-to/kubernetes-on-riscv.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ categories:
1717

1818
- A Scaleway account logged into the [console](https://console.scaleway.com)
1919
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
20-
- [Created a Kosmos cluster](https://www.scaleway.com/en/docs/containers/kubernetes/how-to/create-kosmos-cluster/) on which you have [configured a pool of external nodes](/containers/kubernetes/how-to/edit-kosmos-cluster/#how-to-configure-external-nodes-to-join-the-cluster)
20+
- [Created a Kosmos cluster](/containers/kubernetes/how-to/create-kosmos-cluster/) on which you have [configured a pool of external nodes](/containers/kubernetes/how-to/edit-kosmos-cluster/#how-to-configure-external-nodes-to-join-the-cluster)
2121
- [Created an Elastic Metal RV1 server](/bare-metal/elastic-metal/how-to/create-server/)
2222
- [Created an API key](/identity-and-access-management/iam/how-to/create-api-keys/) with the `KubernetesExternalNodeRegister` permission set.
2323
- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/)
@@ -44,4 +44,4 @@ With Scaleway Kosmos and our Elastic Metal RV1, you can follow this guide to lau
4444
```
4545
sudo -E ./node-agent_linux_riscv64 -loglevel 0 -no-controller && sleep 10
4646
47-
7. **Restart** your server.
47+
7. **Restart** your server.

compute/instances/reference-content/identify-devices.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ categories:
1515

1616
An Instance is composed of a multitude of devices. Some of them can be configured, such as network interfaces and block devices, for example by attaching an SBS volume to the Instance or attaching the Instance to a Private Network.
1717

18-
On a Linux host, devices are named by the kernel in the order they are discovered. The order in which devices are discovered is dependent on things such as the topology of the PCI hierarchy which are *not* guaranteed to be stable across poweroff/poweron/reboot actions.
18+
On a Linux host, devices are named by the kernel in the order they are discovered. The order in which devices are discovered is dependent on things such as the topology of the PCI hierarchy which are *not* guaranteed to be stable across power off/power on/reboot actions.
1919

2020
This guide aims to provide tips to help you identify devices in a stable manner on a Linux host.
2121

2222
# Identifying Instance Block Storage volumes (b_ssd)
2323

24-
Instance Block Storage (`b_ssd`) volumes are connected to the Instance as SCSI disks. They will therefore appear as devices handled by the sd driver in the dev filesystem, i.e. as `/dev/sd{a,b,c...}` devices.
24+
Instance Block Storage (`b_ssd`) volumes are connected to the Instance as SCSI disks. They will therefore appear as devices handled by the sd driver in the dev file system, i.e. as `/dev/sd{a,b,c...}` devices.
2525

2626
SCSI disks have multiple attributes, such as vendor and product/model. They also have a serial. Instance Block Storage (`b_ssd`) volumes have the vendor name `SCW`, the model/product name `b_ssd`, and a serial set to `volume-<uuid>` where `<uuid>` is the ID of the volume.
2727

@@ -60,7 +60,7 @@ ID_SERIAL=0SCW_b_ssd_volume-f7a6f113-aaf6-4540-ac5a-9e18d7f61478
6060
ID_SERIAL_SHORT=volume-f7a6f113-aaf6-4540-ac5a-9e18d7f61478
6161
```
6262

63-
The third and fourth rules create the symlinks proper, using these attributes. This will result in the following symlinks being created:
63+
The third and fourth rules create the symlinks properly, using these attributes. This will result in the following symlinks being created:
6464

6565
```sh
6666
root@test-instance:~# ls -l /dev/disk/by-id/
@@ -102,7 +102,7 @@ Block Storage devices are similar to Instance Block Storage devices. They are al
102102

103103
The only difference is the SCSI model attribute. Instead of being fixed to the value `b_ssd`, its value depends on the class of the Block Storage volume.
104104

105-
Two Block Storage volumes classes currently exist: `bssd`, and `sbs`. Block Storage volumes migrated from Instance Block Storage (`b_ssd`) volumes have class `bssd`.
105+
Two Block Storage volume classes currently exist: `bssd`, and `sbs`. Block Storage volumes migrated from Instance Block Storage (`b_ssd`) volumes have class `bssd`.
106106

107107
Block Storage volumes with class `bssd` have a SCSI model of `b_ssd`, so migrated volumes won't change characteristics. Otherwise, Block Storage volumes have a SCSI model equal to the volume's class.
108108

compute/instances/reference-content/instances-bandwidth-overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Bandwidth impacts how your applications perform and interact with other systems.
2727
</Message>
2828

2929
<Message type="tip">
30-
To maximize compatibility with [Block Storage Low Latency 15k](https://www.scaleway.com/en/docs/storage/block/), select an Instance with **at least 3 GiB/s** of Block bandwidth.
30+
To maximize compatibility with [Block Storage Low Latency 15k](/storage/block/), select an Instance with **at least 3 GiB/s** of Block bandwidth.
3131
</Message>
3232

3333
## COPARM Range
@@ -116,4 +116,4 @@ Bandwidth impacts how your applications perform and interact with other systems.
116116
| Instance Type | Internet Bandwidth | Block Bandwidth |
117117
|-----------------------|-------------------------|---------------------|
118118
| POP2-HN-3 | 3 Gbit/s | 400 MiB/s |
119-
| POP2-HN-10 | 10 Gbit/s | 800 MiB/s |
119+
| POP2-HN-10 | 10 Gbit/s | 800 MiB/s |

compute/instances/troubleshooting/fix-unreachable-focal-with-two-public-ips.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ From this point on, your Instance may be safely rebooted and you will no longer
4343

4444
[Rescue mode](/compute/instances/concepts/#rescue-mode) allows you to boot your Instance into a temporary operating system, running from the Instance's RAM. Rescue mode is often used to diagnose and resolve issues such as faulty kernel configurations, networking issues, firewall configurations, and more.
4545

46-
1. Switch the Instance's `boot-type` to `rescue` and reboot your Instance into rescue mode using the [CLI](https://www.scaleway.com/en/docs/developer-tools/scaleway-cli/quickstart/):
46+
1. Switch the Instance's `boot-type` to `rescue` and reboot your Instance into rescue mode using the [CLI](/developer-tools/scaleway-cli/quickstart/):
4747
```
4848
scw instance server stop <Instance_ID>
4949
# Wait for the instance to be stopped.
@@ -87,16 +87,16 @@ chroot /mnt
8787
rm -f /etc/resolv.conf
8888
ln -s /run/systemd/resolve/stub-resolv.conf /etc/resolv.conf
8989
```
90-
4. Once in the `chroot` install the modified cloud-init package
90+
4. Once in the `chroot` install the modified cloud-init package:
9191
```
9292
add-apt-repository ppa:scaleway/stable
9393
apt -y install cloud-init
9494
```
95-
5. Re-initialize cloud-init to fix the netplan profile
95+
5. Re-initialize cloud-init to fix the netplan profile:
9696
```sh
9797
cloud-init clean && cloud-init init --local && cloud-init init
9898
```
99-
6. Get out of the `chroot` and remove the mounts
99+
6. Get out of the `chroot` and remove the mounts:
100100
```sh
101101
umount /mnt/sys /mnt/proc /mnt/dev /mnt/run /mnt
102102
```
@@ -110,11 +110,11 @@ scw instance server start <Instance_ID>
110110
Once rebooted, your Instance will be reachable again.
111111

112112
<Message type="important">
113-
This modification will be valid for up until Ubuntu publishes a new version, i.e. cloud-init 24.3. You can use the following commands to hold the newly installed version so it does not get updated when the new version comes in.
113+
This modification will be valid until Ubuntu publishes a new version, i.e. cloud-init 24.3. You can use the following commands to hold the newly installed version so it does not get updated when the new version comes in.
114114
</Message>
115115

116-
8. Put a hold on the newly installed cloud-init
116+
8. Put a hold on the newly installed cloud-init:
117117
```sh
118118
apt-mark hold cloud-init
119119
cloud-init set on hold.
120-
```
120+
```

compute/instances/troubleshooting/fix-unreachable-noble-after-reboot.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Instances created after June 11th 2024 will not encounter this problem.
1919

2020
## Your Instance has not been rebooted
2121

22-
You can avoid this situation by increasing the dhcpcd timeout in its configuration file
22+
You can avoid this situation by increasing the dhcpcd timeout in its configuration file:
2323
```
2424
sed -i 's/timeout 5/timeout 10/' /etc/dhcpcd.conf
2525
@@ -40,7 +40,7 @@ timeout 10
4040

4141
[Rescue mode](/compute/instances/concepts/#rescue-mode) allows you to boot your Instance into a temporary operating system, running from the Instance's RAM. Rescue mode is often used to diagnose and resolve issues such as faulty kernel configurations, networking issues, firewall configurations, and more.
4242

43-
1. Switch the Instance's `boot-type` to `rescue` and reboot your Instance into rescue mode using the [CLI](https://www.scaleway.com/en/docs/developer-tools/scaleway-cli/quickstart/):
43+
1. Switch the Instance's `boot-type` to `rescue` and reboot your Instance into rescue mode using the [CLI](/developer-tools/scaleway-cli/quickstart/):
4444
```
4545
scw instance server stop <Instance_ID>
4646
scw instance server update <Instance_ID> boot-type=rescue
@@ -63,7 +63,7 @@ timeout 10
6363
```
6464
mount /dev/sda1 /mnt
6565
```
66-
3. Once mounted, use the `chroot` command to get into your Instance's root filesystem. You can then change the timeout value for dhcpcd as shown above :
66+
3. Once mounted, use the `chroot` command to get into your Instance's root file system. You can then change the timeout value for dhcpcd as shown above:
6767
```
6868
chroot /mnt
6969
sed -i 's/timeout 5/timeout 10/' /etc/dhcpcd.conf
@@ -89,5 +89,4 @@ timeout 10
8989
scw instance server update <Instance_ID> boot-type=local
9090
scw instance server start <Instance_ID>
9191
```
92-
Once rebooted, your Instance will be reachable again.
93-
92+
Once rebooted, your Instance will be reachable again.

compute/instances/troubleshooting/reboot-from-faulty-kernel.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ categories:
2222
- Installed and configured the Scaleway [CLI](/compute/instances/api-cli/creating-managing-instances-with-cliv2) on your local computer
2323

2424

25-
1. Switch the Instance's `boot-type` to `rescue` and reboot your Instance into rescue mode using the CLI-Tools:
25+
1. Switch the Instance's `boot-type` to `rescue` and reboot your Instance into rescue mode using the CLI-Tools:
2626
```
2727
scw instance server update {Instance_ID} boot-type=rescue
2828
scw instance server reboot {Instance_ID}
@@ -48,7 +48,7 @@ categories:
4848
mount -o bind /proc /mnt/proc
4949
mount -o bind /dev /mnt/dev
5050
```
51-
3. Once mounted, use the `chroot` command to get into your Instances' root filesystem. You can then change the `GRUB_DEFAULT` value to boot using the previous kernel:
51+
3. Once mounted, use the `chroot` command to get into your Instances' root file system. You can then change the `GRUB_DEFAULT` value to boot using the previous kernel:
5252
```sh
5353
chroot /mnt
5454
nano /etc/default/grub
@@ -71,7 +71,7 @@ categories:
7171
GRUB_CMDLINE_LINUX="console=tty0 console=ttyS0,115200 earlyprintk=ttyS0,115200 consoleblank=0"
7272
```
7373
Save the file and exit the text editor.
74-
4. Update the `grub` boatloader` to apply the kernel's update
74+
4. Update the `grub` boatloader` to apply the kernel's update:
7575
```
7676
# update-grub
7777
Generating grub configuration file ...
@@ -92,7 +92,7 @@ categories:
9292

9393
### Examples of failed boots
9494

95-
* In the following example, the Instance may only boot with the root filesystem in `read-only` mode:
95+
* In the following example, the Instance may only boot with the root file system in `read-only` mode:
9696
```sh
9797
[ OK ] Finished Remove Stale Onli…ext4 Metadata Check Snapshots.
9898
[ 4.219158] cloud-init[542]: Traceback (most recent call last):
@@ -112,4 +112,4 @@ categories:
112112
[ 4.235672] cloud-init[542]: os.chmod(path, real_mode)
113113
[ 4.236227] cloud-init[542]: OSError: [Errno 30] Read-only file system: '/var/lib/cloud/data'
114114
[FAILED] Failed to start Apply the …ngs specified in cloud-config.
115-
```
115+
```

console/account/how-to/resolve-abuse.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ If you encounter any issue with the resolution of an abuse, ensure that you cont
2929
2. Click the **case ID** to view the specifics of the complaint.
3030
3. Take note of the details provided and proceed with the necessary steps to address and resolve the issue.
3131
<Message type="tip">
32-
If you need guidance on resolving outgoing DDoS attacks from your server, refer to our documentation on [how to prevent outgoing DDoS](https://www.scaleway.com/en/docs/compute/instances/reference-content/preventing-outgoing-ddos/).
32+
If you need guidance on resolving outgoing DDoS attacks from your server, refer to our documentation on [how to prevent outgoing DDoS](/compute/instances/reference-content/preventing-outgoing-ddos/).
3333
</Message>
3434
If you are the subject of an abuse report for hosting illegal content (including copyright), we urge you to delete the content from the Scaleway infrastructure promptly.
3535
* For other types of abuse, here are some suggestions to help you to correct them:
@@ -47,13 +47,13 @@ If you encounter any issue with the resolution of an abuse, ensure that you cont
4747
If you do not know how to solve the problem, you can contact our [outsourcing partners](https://www.scaleway.com/en/dedibox/outsourcing/) or reach out to Scaleway’s abuse team by opening a ticket directly from your Scaleway console account.
4848

4949
4. The case will be closed at the end of its lifetime by Scaleway’s abuse team, and so will the abuse tickets forming the case.
50-
If you receive more abuse reports on the same resource within the case lifetime, it means that you did not take the appropriate measures to prevent further abuse from happening.
51-
Therefore, we recommend you take additional actions and contact our support team if you need assistance. Failure to take appropriate measures to solve the case may result in the locking of your service as per our [Terms of Services](https://www.scaleway.com/en/contracts/) and the legal framework in force.
50+
If you receive more abuse reports on the same resource within the case lifetime, it means that you did not take the appropriate measures to prevent further abuse from happening.
51+
Therefore, we recommend you take additional actions and contact our support team if you need assistance. Failure to take appropriate measures to solve the case may result in the locking of your service as per our [Terms of Services](https://www.scaleway.com/en/contracts/) and the legal framework in force.
5252

5353
In specific instances, the case will be closed automatically:
5454
* abuse reports submitted by Scaleway’s abuse partners may be closed automatically after the automated locking of your services, if several complaints were received within the same case, or if Scaleway considers that the type of abuse reported requires immediate locking of your services.
5555
* cases regarding security holes will be closed automatically. Refer to the description of the abuse to find more details on patches and updates available.
5656

5757
<Message type="note">
5858
Refer to our [abuse notice](https://www.scaleway.com/en/abuse-notice/) for further information about Scaleway’s abuse policy.
59-
</Message>
59+
</Message>

0 commit comments

Comments
 (0)