Skip to content

Commit 4609772

Browse files
bene2k1jcirinosclwy
bene2k1
and
jcirinosclwy
authored
docs(gen): docs content review (#4595)
* docs(gen): docs content review * Update pages/dedibox-hardware/concepts.mdx * fix(ins): fix typo * Update pages/instances/troubleshooting/fix-unreachable-ipv6-rhel-based-instance.mdx Co-authored-by: Jessica <[email protected]> * Apply suggestions from code review Co-authored-by: Jessica <[email protected]> --------- Co-authored-by: Jessica <[email protected]>
1 parent 5a44fd2 commit 4609772

20 files changed

+78
-59
lines changed

‎faq/apple-silicon.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ meta:
55
content:
66
h1: Apple silicon
77
dates:
8-
validation: 2024-09-02
8+
validation: 2025-03-11
99
category: bare-metal
1010
productIcon: AppleSiliconProductIcon
1111
---

‎pages/dedibox-account/how-to/resolve-abuse.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to resolve Abuse tickets.
88
tags: resolve abuse complaint ticket dedibox-console
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2020-03-12
1212
categories:
1313
- account

‎pages/dedibox-hardware/concepts.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains all the concepts related to your servers Hardware
88
tags: dedibox hardware cpu hdd nvme ssd raid raid 0 raid-0 raid 1 raid-1 raid-5
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
categories:
1212
- dedibox-servers
1313
---
@@ -20,7 +20,7 @@ A Central Processing Unit (CPU) is the computer's main processor. The CPU execut
2020

2121
A Hard disk drive (HDD) uses rotating magnetic disks to store data. HDDs provide larger storage capacity but slower read/write speed compared to SSDs. They are perfect for storing large volumes of data.
2222

23-
## NVMe
23+
## NVMe disk
2424

2525
NVM Express (NVMe) disks are SSDs that use the PCI Express bus for communication with the host.
2626

‎pages/dedibox-ipv6/concepts.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains all the concepts related to IPv6 on
88
tags: dedibox ipv6 duid dhcpv6 ipv4 slaac stateful stateless dhcp
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
categories:
1212
- dedibox-network
1313
---

‎pages/dedibox-kvm-over-ip/concepts.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags: kvm iso-file idrac ilo iso
99
categories:
1010
- dedibox-servers
1111
dates:
12-
validation: 2024-09-02
12+
validation: 2025-03-11
1313
---
1414

1515
## KVM Over IP

‎pages/dedibox-kvm-over-ip/quickstart.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: KVM over IP Quickstart
88
tags: dedibox kvm over-ip
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
categories:
1212
- dedibox-servers
1313
---

‎pages/dedibox/reference-content/basic-linux-commands.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn how to use some basic Linux/Unix commands
88
tags: dedibox linux unix command
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
categories:
1212
- dedibox-servers
1313
---

‎pages/generative-apis/api-cli/using-chat-api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to use the Chat API to query models
88
tags: generative-apis ai-data chat-api
99
dates:
10-
validation: 2024-09-03
10+
validation: 2025-03-11
1111
posted: 2024-09-03
1212
---
1313

‎pages/generative-apis/api-cli/using-embeddings-api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to use the Embeddings API
88
tags: generative-apis ai-data embeddings-api
99
dates:
10-
validation: 2024-09-03
10+
validation: 2025-03-11
1111
posted: 2024-09-03
1212
---
1313

‎pages/generative-apis/api-cli/using-models-api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to use the Models API
88
tags: generative-apis ai-data embeddings-api
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2024-09-02
1212
---
1313

‎pages/generative-apis/reference-content/model-lifecycle.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how each status affects model usage and updates.
88
tags: generative-apis ai-data model-lifecyle
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2024-09-02
1212
---
1313

‎pages/gpu/how-to/create-manage-gpu-instance.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to create and manage a GPU Instance
88
tags: gpu-instance gpu instance
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2022-03-25
1212
categories:
1313
- compute
@@ -34,17 +34,17 @@ When you have completed your calculations using the GPU Instance, [deletion can
3434
3. Follow these steps to configure your GPU Instance:
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](/gpu/reference-content/choosing-gpu-instance-type/) for more information.
37-
- **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.
37+
- **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 can customize your working environment using Docker with our provided Docker images or your own containers.
38+
- **Instance name and tags**: Assign a name to your Instance for easy identification. You can also add tags to organize your Instances efficiently.
3839
- **Volumes**: Optionally, add storage volumes for your Instance. You can adjust settings such as Block and Local Storage volumes according to your requirements.
3940
<Message type="note">
4041
* The recommended minimum volume size for GPU OS images is 125 GB.
4142
* If your GPU Instance supports scratch storage, the scratch volume displays but can not be edited. [Learn more about scratch storage.](/gpu/how-to/use-scratch-storage-h100-instances/)
4243
</Message>
43-
- **Network Configuration**: Choose between a routed public IP or a NAT public IP for your Instance. We recommend using a routed public IP. You can allocate IPv4 and IPv6 addresses as needed, with a maximum of 5 IPs per Instance.
44-
- **Instance Name and Tags**: Assign a name to your Instance for easy identification. You can also add tags to organize your Instances efficiently.
45-
- **Advanced Options**: Configure `cloud-init` settings if required, or leave them at default values.
46-
- **SSH Keys**: Verify the SSH keys that will grant you access to your Instance.
47-
- **Estimated Cost**: Review the estimated cost of your GPU Instance based on the selected specifications.
44+
- **Network configuration**: You can allocate routed IPv4 and IPv6 addresses as needed, with a maximum of 5 IPs per Instance.
45+
- **Cloud-init**: Configure `cloud-init` settings if required, or leave them at default values.
46+
- **SSH keys**: Verify the SSH keys that will grant you access to your Instance.
47+
- **Estimated cost**: Review the estimated cost of your GPU Instance based on the selected specifications.
4848
4. Once you have completed the configuration, click on **Create Instance** to initiate the creation process. You will receive a notification once the GPU Instance is ready for use.
4949

5050
## How to connect to a GPU Instance

‎pages/gpu/quickstart.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page shows you how to get started with Scaleway GPU Instances.
88
tags: instance gpu-instance
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2022-03-25
1212
categories:
1313
- compute
@@ -27,14 +27,14 @@ 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](/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 can customize your working environment using Docker with our provided Docker images or your own containers.
30+
- **Instance name and tags**: Assign a name to your Instance for easy identification. You can also add tags to organize your Instances efficiently.
3031
- **Volumes**: Optionally, add storage volumes for your Instance. You can adjust settings such as Block and Local Storage volumes according to your requirements.
3132
<Message type="note">
3233
* The recommended minimum volume size for GPU OS images is 125 GB.
3334
* If your GPU Instance supports scratch storage, the scratch volume displays but can not be edited. [Learn more about scratch storage.](/gpu/how-to/use-scratch-storage-h100-instances/)
3435
</Message>
35-
- **Network configuration**: Choose between a routed public IP or a NAT public IP for your Instance. We recommend using a routed public IP. You can allocate IPv4 and IPv6 addresses as needed, with a maximum of 5 IPs per Instance.
36-
- **Instance name and tags**: Assign a name to your Instance for easy identification. You can also add tags to organize your Instances efficiently.
37-
- **Advanced options**: Configure `cloud-init` settings if required, or leave them at default values.
36+
- **Network configuration**: You can allocate routed IPv4 and IPv6 addresses as needed, with a maximum of 5 IPs per Instance.
37+
- **Cloud-init**: Configure `cloud-init` settings if required, or leave them at default values.
3838
- **SSH keys**: Verify the SSH keys that will grant you access to your Instance.
3939
- **Estimated cost**: Review the estimated cost of your GPU Instance based on the selected specifications.
4040
4. Once you have completed the configuration, click on **Create Instance** to initiate the creation process. You will receive a notification once the GPU Instance is ready for use.

‎pages/instances/api-cli/increasing-volume-size.mdx

+5-1
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,17 @@ content:
77
paragraph: This page explains how to increase a Block Storage volume
88
tags: increase expand increment raise storage volume block
99
dates:
10-
validation: 2024-08-26
10+
validation: 2025-03-11
1111
posted: 2020-01-10
1212
categories:
1313
- block-storage
1414
- storage
1515
---
1616

17+
<Message type="important">
18+
Management of Block Storage volumes via the Instances API is deprecated. We recommend migrating existing volumes to the Block Storage API for continued support and improved functionality. For step-by-step instructions on migrating your volumes, refer to our [How to migrate existing volumes and snapshots to Scaleway's new Block Storage management](/instances/how-to/migrate-volumes-snapshots-to-sbs/).
19+
</Message>
20+
1721
The Instances API allows you to interact with Block Storage volumes programmatically through API calls. To increase the size of a volume using the Block Storage API, refer to the [dedicated documentation](/block-storage/api-cli/increasing-volume-size/).
1822

1923
<Macro id="requirements" />

‎pages/instances/how-to/create-a-backup.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to create an image of your Instance
88
tags: instance image backup
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2021-05-26
1212
categories:
1313
- compute

‎pages/instances/how-to/power-off-instance.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to power off a Scaleway Instance.
88
tags: power off power-off instance
99
dates:
10-
validation: 2024-08-26
10+
validation: 2025-03-11
1111
posted: 2021-05-26
1212
categories:
1313
- compute

‎pages/instances/troubleshooting/fix-unreachable-ipv6-rhel-based-instance.mdx

+40-27
Original file line numberDiff line numberDiff line change
@@ -7,78 +7,84 @@ content:
77
paragraph: This page helps recover or avoid unreachable IPv6 Instances after transitioning to routed IP
88
tags: centos-stream rockylinux almalinux network-manager ipv6 routed ip
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2023-11-16
1212
categories:
1313
- compute
1414
---
1515

16-
RHEL-based Instances created before November 15 2023 require a NetworkManager configuration that enables correct IPv6 configuration, after a transition to routed IP is performed. If your Instance is configured only with an IPv6 address, it will become unreachable after the migration. It is important to add the NetworkManager configuration so IPv6 configuration remains correct.<br />
16+
## Problem
17+
18+
RHEL-based Instances created before November 15 2023 require a NetworkManager configuration that enables correct IPv6 configuration, after a transition to routed IP is performed. If your Instance is configured only with an IPv6 address, it will become unreachable after the migration. It is important to add the NetworkManager configuration so IPv6 configuration remains correct.
1719

1820
The affected O/S distributions are:
1921

2022
- CentOS Stream versions 8 and 9
2123
- RockyLinux versions 8 and 9
2224
- AlmaLinux versions 8 and 9
23-
- Fedora versions 37 and 38
25+
- Fedora versions 37 and 38.
2426

2527
<Message type="note">
26-
CentOS 7.9 is not concerned by this issue as it does not support routed IP.
28+
CentOS 7.9 is not concerned by this issue, as it does not support routed IP.
2729
</Message>
2830

29-
<Message type="note">
30-
This guide addresses specific issues related to RHEL-based Instances after transitioning to routed IP. For general information on routed IPs and migration procedures, refer to our [main migration guide](/instances/how-to/migrate-routed-ips/) and the [related FAQ](/faq/instances/#are-there-any-limitations-on-ip-autoconfiguration-with-the-routed-ip-feature).
31-
</Message>
31+
This guide addresses specific issues related to RHEL-based Instances after transitioning to routed IP.
32+
For general information on routed IPs and migration procedures, refer to our [main migration guide](/instances/how-to/migrate-routed-ips/) and the [related FAQ](/faq/instances/#are-there-any-limitations-on-ip-autoconfiguration-with-the-routed-ip-feature).
33+
34+
## Cause
35+
36+
This issue is caused by a missing NetworkManager configuration for IPv6 address generation mode (`ipv6.addr-gen-mode=0`) on RHEL-based Instances.
37+
38+
## Possible solution
39+
40+
There are two scenarios to consider, depending on whether your Instance has been migrated to routed IP or not.
3241

33-
## Your Instance has not been migrated to routed IP yet
42+
### Your Instance has not been migrated to routed IP yet
3443

3544
Connect to your Instance and execute the following command as `root` user to add the required NetworkManager option:
36-
```
45+
```bash
3746
cat << EOF > /etc/NetworkManager/conf.d/00-scaleway.conf
3847
[connection]
3948
# The value 0 stands for eui64 -- see nm-settings-nmcli(5)
4049
ipv6.addr-gen-mode=0
4150
EOF
4251
```
52+
### Your Instance has been moved to routed IP
4353

44-
## Your Instance has been moved to routed IP
45-
46-
If your Instance has been moved to routed IP and you have IPv4 connectivity, add the NetworkManager configuration as outlined in the previous section. After the next reboot, you will recover IPv6 connectivity while IPv4 configuration will remain untouched
47-
48-
### You only have IPv6 configured so you cannot connect to the Instance anymore
54+
If your Instance has been moved to routed IP and you have IPv4 connectivity, add the NetworkManager configuration as outlined in the previous section. After the next reboot, you will recover IPv6 connectivity while IPv4 configuration will remain untouched.
4955

50-
<Message type="important">
51-
Two reboots of your Instance will be required in order to recover IPv6 connectivity.
52-
</Message>
56+
#### You only have IPv6 configured so you cannot connect to the Instance anymore
5357

54-
If you are in this situation, you need to temporarily add an IPv4 address to connect to your Instance in order to add the NetworkManager configuration.
58+
Two reboots of your Instance will be required in order to recover IPv6 connectivity. If you are in this situation, you need to temporarily add an IPv4 address to connect to your Instance in order to add the NetworkManager configuration.
5559

56-
```
60+
```bash
5761
scw instance server list
5862
ID NAME TYPE STATE ZONE PUBLIC IP PRIVATE IP TAGS IMAGE NAME ROUTED
5963
{Instance_ID} rocky8 DEV1-S running fr-par-2 2001:bc8:1210:26a:dc00:ff:fe23:ab83 - [] RockyLinux 8 true
60-
6164
scw instance ip create type=routed_ipv4 server={Instance_ID}
6265
scw instance server reboot {Instance_ID}
63-
6466
```
6567
Once the reboot is completed, list your IP addresses and identify the IPv4 address attached to your Instance:
66-
```
68+
69+
```bash
6770
$ scw instance ip list
6871
ID ADDRESS PREFIX TYPE REVERSE PROJECT SERVER ID SERVER NAME TAGS ZONE
6972
{IPv6_address_ID} - 2001:bc8:1210:26a::/64 routed_ipv6 - {project id} {project id} rocky8 [] fr-par-2
7073
{IPv4_address_ID} 51.159.143.128 - routed_ipv4 - {project id} {project id} rocky8 [] fr-par-2
7174
```
7275
You can now connect to your Instance with the IPv4 address to make the NetworkManager configuration change:
73-
```
76+
77+
```bash
7478
ssh [email protected]
7579
cat << EOF > /etc/NetworkManager/conf.d/00-scaleway.conf
7680
[connection]
7781
ipv6.addr-gen-mode=0
7882
EOF
7983
```
84+
8085
Once modified, reset your Instance to its prior configuration. It is necessary to first detach the IPv4 address before attaching the IPv6 address.
81-
```
86+
87+
```bash
8288
scw instance server standby {Instance_ID}
8389
scw instance server update {Instance_ID} ip=none
8490
scw instance server update {Instance_ID} ip={IPv6_address_ID}
@@ -87,11 +93,18 @@ scw instance ip delete {IPv4_address_ID}
8793
```
8894

8995
You can now connect using your IPv6 address:
90-
```
96+
97+
```bash
9198
ssh root@2001:bc8:1210:26a:dc00:ff:fe23:ab83
9299
Warning: Permanently added '2001:bc8:1210:26a:dc00:ff:fe23:ab83' (ED25519) to the list of known hosts.
93100
Activate the web console with: systemctl enable --now cockpit.socket
94-
95101
Last login: Wed Nov 15 16:53:09 2023 from 51.159.46.153
96102
[root@rocky8 ~]#
97-
```
103+
```
104+
105+
## Going further
106+
For general information on routed IPs and migration procedures, refer to our [main migration guide](/instances/how-to/migrate-routed-ips/) and the [related FAQ](/faq/instances/#are-there-any-limitations-on-ip-autoconfiguration-with-the-routed-ip-feature). If you still encounter issues, please provide the following information when creating a support ticket:
107+
- Instance ID
108+
- Operating System version
109+
- Current IP configuration
110+
- Steps taken to resolve the issue

‎pages/kubernetes/how-to/access-audit-logs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to access the dashboard of your Kubernetes cluster
88
tags: kubernetes kubernetes-kapsule kapsule kosmos cluster audit logs
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2024-01-24
1212
categories:
1313
- kubernetes

‎pages/kubernetes/how-to/deploy-x86-arm-images.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to deploy both x86 and ARM images in Kubernetes
88
tags: kubernetes kapsule arm x86
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2024-02-29
1212
categories:
1313
- kubernetes

‎pages/kubernetes/troubleshooting/containers-not-starting-arm-instances.mdx

+6-4
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,30 @@ content:
77
paragraph: This page helps you troubleshoot issues related to containers not starting on ARM Instances
88
tags: kapsule arm x86 crashloopbackoff
99
dates:
10-
validation: 2024-09-02
10+
validation: 2025-03-11
1111
posted: 2024-02-28
1212
categories:
1313
- kubernetes
1414
---
1515

16+
## Problem
1617
Containers failing to start on ARM nodes can often be attributed to architecture mismatches. This occurs when container images designed for x86 architecture are deployed on ARM-based nodes.
1718

19+
## Cause
1820
The binary instructions in the x86 image are incompatible with ARM processors, causing the kernel on the ARM node to encounter illegal or unknown instructions, resulting in errors.
1921

2022
The most common symptom of this issue is the occurrence of `CrashLoopBackOff` errors in Kubernetes.
2123

22-
## Inspecting container image architecture
24+
## Possible solutions
25+
26+
### Inspecting container image architecture
2327

2428
To inspect the architecture of container images, you can use the following steps:
2529

2630
1. Pull the container image from the registry using `docker pull`.
2731
2. Extract the image using `docker save` or similar tools.
2832
3. Within the extracted files, locate the image manifest file (usually named `manifest.json`). Open this file and look for the `architecture` field to determine the architecture the image is built for.
2933

30-
## Possible solutions
31-
3234
### Rebuilding ARM images
3335

3436
If you have control over the container image source, consider rebuilding the image specifically for the ARM architecture.

0 commit comments

Comments
 (0)