From 966266e9f334339bd0038e856b3c742f44fbf5ff Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 16 Dec 2024 18:00:10 +0100 Subject: [PATCH 1/2] docs(bls): first batch --- .../migrate-volumes-snapshots-to-sbs.mdx | 7 +- faq/blockstorage.mdx | 16 +- .../identifying-volume-snapshot-api.mdx | 381 ++++++++++++++++++ .../how-to/identify-volume-snapshot-type.mdx | 43 ++ .../advantages-migrating-to-sbs.mdx | 65 +++ 5 files changed, 508 insertions(+), 4 deletions(-) create mode 100644 storage/block/api-cli/identifying-volume-snapshot-api.mdx create mode 100644 storage/block/how-to/identify-volume-snapshot-type.mdx create mode 100644 storage/block/reference-content/advantages-migrating-to-sbs.mdx diff --git a/compute/instances/how-to/migrate-volumes-snapshots-to-sbs.mdx b/compute/instances/how-to/migrate-volumes-snapshots-to-sbs.mdx index febc14c873..516228a992 100644 --- a/compute/instances/how-to/migrate-volumes-snapshots-to-sbs.mdx +++ b/compute/instances/how-to/migrate-volumes-snapshots-to-sbs.mdx @@ -23,8 +23,9 @@ During migration, unified snapshots will be converted into [Block Storage Low La This guide offers step-by-step instructions to migrate your volumes and snapshots using either the [Scaleway Command Line Interface (CLI)](/developer-tools/scaleway-cli/quickstart/) tool (recommended) or the [Instances API](https://www.scaleway.com/en/developers/api/instance/#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage). - - The easiest way to migrate your Block Storage volumes and snapshots is by using the [Scaleway Command Line Interface (CLI)](/developer-tools/scaleway-cli/quickstart/) tool. + + - The easiest way to migrate your Block Storage volumes and snapshots is by using the [Scaleway Command Line Interface (CLI)](/developer-tools/scaleway-cli/quickstart/) tool + - If you encounter an error about quota limitations during the migration process, [contact our support team](https://console.scaleway.com/support/tickets/create) for assistance. @@ -91,7 +92,7 @@ This guide offers step-by-step instructions to migrate your volumes and snapshot $ scw instance volume apply-migration 369feb53-165f-437d-875e-188725df462b validation-key=30d129ca895c4cd59f4c429e12dab300 zone=fr-par-1 ✅ Success ``` - The volume migration is complete. You can now manage the migrated volume from the [Block Storage Volumes section](https://console.scaleway.com/block-storage/volumes) in the Scaleway console. + The volume migration is complete. You can now manage the migrated volume from the [Block Storage volumes section](https://console.scaleway.com/block-storage/volumes) in the Scaleway console. diff --git a/faq/blockstorage.mdx b/faq/blockstorage.mdx index 565a5d2fa9..0d62fdee84 100644 --- a/faq/blockstorage.mdx +++ b/faq/blockstorage.mdx @@ -52,4 +52,18 @@ The Block Storage billing scheme is not the same as for Object Storage. You are ## What other Scaleway resources are compatible with Block Storage? -Block Storage volumes are compatible with [Scaleway Instances](/compute/instances/), [Managed Dabatase for PostgreSQL and MySQL](/managed-databases/postgresql-and-mysql/), and [Kubernetes](/containers/kubernetes/) Kapsule clusters. \ No newline at end of file +Block Storage volumes are compatible with [Scaleway Instances](/compute/instances/), [Managed Dabatase for PostgreSQL and MySQL](/managed-databases/postgresql-and-mysql/), and [Kubernetes](/containers/kubernetes/) Kapsule clusters. + +## How can I convert a Block Storage legacy volume into a Block Storage low latency volume? + +For better performance, you can convert your Block Storage legacy volumes into Block Storage Low Latency volumes. + +To convert your volume you need to: + +- Export the data: copy or back up the data from the Block storage legacy volume to an external location or intermediary storage (e.g., another temporary volume). + +- Create a Block Storage Low Latency volume + +- Import the data: restore or transfer the data from the backup or intermediary storage into the newly created volume. + +Find out [how to migrate](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) your Block Storage legacy volumes to Block Storage Low Latency volumes. \ No newline at end of file diff --git a/storage/block/api-cli/identifying-volume-snapshot-api.mdx b/storage/block/api-cli/identifying-volume-snapshot-api.mdx new file mode 100644 index 0000000000..efd8f94f53 --- /dev/null +++ b/storage/block/api-cli/identifying-volume-snapshot-api.mdx @@ -0,0 +1,381 @@ +--- +meta: + title: Identify the API managing your Block Storage volumes and snapshots + description: Learn how to determine which API (Instance or Block Storage) manages your volumes and snapshots on Scaleway using CLI and API commands. +content: + h1: Identify the API managing your Block Storage volumes and snapshots + paragraph: Determine whether your Block Storage volumes and snapshots are managed by the Instance API or Block Storage API. +dates: + validation: 2025-01-03 + posted: 2025-01-03 +categories: + - storage +--- + +This page shows you how to identify the API managing your Block Storage volumes and snapshots, using the API and CLI. + +Find out [how to migrate](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) your Block Storage legacy volumes to Block Storage Low Latency volumes. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- Created [Block Storage volumes](/storage/block/how-to/create-a-volume/) +- [Created an API key](/identity-and-access-management/iam/how-to/create-api-keys/) and set [your secret key as an environment variable](/developer-tools/scaleway-sdk/reference-content/environment-variables/#reserved-environment-variables) +- [Installed curl](https://curl.se/download.html) +- Installed the [Scaleway CLI](https://cli.scaleway.com/) + +## Listing all volumes and snapshots created in a specific Availability Zone + +The Scaleway Instance and Block Storage APIs identify their volumes differently. Volumes created with the Instance API are identified as `b_ssd` volumes, whereas volumes created with the Block Storage API are identified as `sbs_5k` or `sbs_15k` volumes. + +### Listing volumes created with the Instance API + +Open a terminal and run the following command to list your volumes managed by the Instance API. Make sure that you replace `{zone}` with the desired Availability Zone. + + ```bash + curl -X GET \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + "https://api.scaleway.com/instance/v1/zones/{zone}/volumes" + ``` +Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Instance API. Note that the `volume_type` field is set to `b_ssd`, meaning the volumes were created via the Instance API. + +``` +{ + "volumes": [ + { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "System volume", + "volume_type": "b_ssd", + "export_uri": null, + "organization": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "project": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "server": { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "scw-brave-elion" + }, + "size": 25000000000, + "state": "available", + "creation_date": "2024-01-30T13:11:15.554809+00:00", + "modification_date": "2024-01-30T13:11:17.078820+00:00", + "tags": [], + "zone": "fr-par-1" + }, + { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "Volume-data", + "volume_type": "b_ssd", + "export_uri": null, + "organization": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "project": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "server": { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "scw-brave-elion" + }, + "size": 20000000000, + "state": "available", + "creation_date": "2024-01-30T13:11:15.554809+00:00", + "modification_date": "2024-01-30T13:11:15.554809+00:00", + "tags": [], + "zone": "fr-par-1" + }, + { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "System volume", + "volume_type": "b_ssd", + "export_uri": null, + "organization": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "project": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "server": { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "scw-optimistic-wilbur" + }, + "size": 10000000000, + "state": "available", + "creation_date": "2023-11-14T12:59:42.932912+00:00", + "modification_date": "2023-11-14T12:59:42.932912+00:00", + "tags": [], + "zone": "fr-par-1" + } + ] +} +``` + +### Listing volumes created with the Block Storage API + +Open a terminal and run the following command to list your volumes managed by the Block Storage API. Make sure that you replace `{zone}` with the desired Availability Zone. + +```bash + curl -X GET \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + "https://api.scaleway.com/block/v1alpha1/zones/{zone}/volumes" +``` + +Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Block Storage API. Note that the `volume_type` field is set to either `sbs_15k` or `sbs_5k`, meaning the volumes were created via the Block Storage API. + +``` +{ + "volumes": [ + { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "volume-nifty-allen", + "type": "sbs_15k", + "size": 25000000000, + "status": "in_use", + "specs": { + "perf_iops": 15000, + "class": "sbs" + }, + "zone": "fr-par-1" + }, + { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "volume-xenodochial-mccarthy", + "type": "sbs_15k", + "size": 30000000000, + "status": "in_use", + "specs": { + "perf_iops": 15000, + "class": "sbs" + }, + "zone": "fr-par-1" + }, + { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "volume-interesting-keller", + "type": "sbs_5k", + "size": 25000000000, + "status": "available", + "specs": { + "perf_iops": 5000, + "class": "sbs" + }, + "zone": "fr-par-1" + } + ], + "total_count": 3 +} +``` + +## Identifying the API managing snapshots + +### Using the Instance API + +Open a terminal and run the following command to list all snapshots created via the Instance API. Make sure that you replace `{zone}` with the desired Availability Zone. + +```bash + curl -X GET \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + "https://api.scaleway.com/instance/v1/zones/{zone}/snapshots" +``` +An output similar to the following should display: + +``` +{ + "snapshots": [ + { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "snap-magical-driscoll", + "volume_type": "b_ssd", + "creation_date": "2024-01-29T15:19:12.357297+00:00", + "modification_date": "2024-01-29T15:22:13.885529+00:00", + "organization": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "project": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "size": 25000000000, + "state": "available", + "base_volume": null, + "tags": [], + "zone": "fr-par-1", + "error_details": null + } + ] +} +``` + +### Using the Block Storage API + +Open a terminal and run the following command to list all snapshots created via the Block Storage API. Make sure that you replace `{zone}` with the desired Availability Zone. + +```bash + curl -X GET \ + -H "X-Auth-Token: $SCW_SECRET_KEY" \ + "https://api.scaleway.com/block/v1alpha1/zones/{zone}/snapshots" +``` + +An output similar to the following should display: + +``` +{ + "snapshots": [ + { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "snap-elated-thompson", + "parent_volume": { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "volume-xenodochial-mccarthy", + "type": "sbs_15k", + "status": "in_use" + }, + "size": 30000000000, + "project_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "created_at": "2024-07-25T14:18:43.929942Z", + "updated_at": "2024-07-25T14:18:43.929942Z", + "references": [], + "status": "available", + "tags": [], + "class": "sbs", + "zone": "fr-par-1" + }, + { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "snap-busy-albattani", + "parent_volume": { + "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "name": "volume-eloquent-grothendieck", + "type": "sbs_5k", + "status": "available" + }, + "size": 25000000000, + "project_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "created_at": "2024-12-06T10:16:18.565939Z", + "updated_at": "2024-12-06T10:16:18.565939Z", + "references": [], + "status": "available", + "tags": [], + "class": "sbs", + "zone": "fr-par-1" + } + ] +} +``` + +## Identifying the API managing volumes with the CLI + +### Using the Scaleway Instance CLI + +1. Open your terminal and run the following command to list all your volumes. + + ```bash + scw instance volume list + ``` + An output similar to the following whould display: + ``` + ID STATE SERVER ID + b582c548-6dc0-4e77-bb93-9615b9baa380 available a4138186-f362-41b2-adc2-c46a2e1a46b7 + 59d48a65-3501-49eb-9a93-be9a6b262e1e available bc1b3dde-b175-42f1-b322-f6d441fc49ca + 49985053-0141-4180-acfa-7f1a51526dac available 4780cdd0-1303-4dfe-9d72-92207eb195b1 + 7e1a9b98-b7ee-4bbc-8f8f-a7abbfffc937 available 67003b8c-2fe2-4346-a381-405896aa87b4 + 86bef16c-78db-4125-aa91-1ed9de9a50eb available 67003b8c-2fe2-4346-a381-405896aa87b4 + 7c232b97-63da-46e3-a018-399e1690b14b available ea5b27d7-268f-40fe-aff7-6943fbcac379 + 1a506e55-0741-4afd-8fbc-bc086ace0265 available 8860802f-0337-4901-b58c-ba3975922349 + ``` +2. Note the ID of the volume you want to check the type of. +3. Get more information about your volume, including its type. Make sure that you replace `` with the ID of the volume. + ```bash + scw instance volume get + ``` + An output similar to the following should display: + ``` + Volume.ID 7c232b97-63da-46e3-a018-399e1690b14b + Volume.Name System volume + Volume.Size 10 GB + Volume.VolumeType b_ssd + Volume.CreationDate 1 year ago + Volume.ModificationDate 1 year ago + Volume.Organization 0c514155-9e5e-41a2-a900-9fdf0195b563 + Volume.Project 0c514155-9e5e-41a2-a900-9fdf0195b563 + Volume.Server.ID ea5b27d7-268f-40fe-aff7-6943fbcac379 + Volume.Server.Name scw-optimistic-wilbur + Volume.State available + Volume.Zone fr-par-1 + ``` +4. Check the `Volume.VolumeType` field to learn if your volume is managed by the Instance API or the Block Storage API. Note that in our example, the `Volume.VolumeType` field displays `b_ssd`, meaning our volume is managed by the Instance API. + +### Using the Scaleway Block Storage CLI + +Open your terminal and run the following command to list all your volumes. + ```bash + scw block volume list + ``` +An output similar to the following should display: + ``` + ID NAME TYPE SIZE + 7a9f3816-7bb7-44ea-a103-832b9685cdc6 volume-nifty-allen sbs_15k 25 GB + cdab395b-c1b9-4a3b-a759-2add13eb2bcb volume-xenodochial-mccarthy sbs_15k 30 GB + 6708229e-bd8c-46f6-bcec-cd3ab93198b7 volume-interesting-keller sbs_5k 25 GB + 672d6c01-465f-43bd-a315-0ac48d49fec5 volume-amazing-lamarr sbs_5k 25 GB + 965b5361-01c5-4ca5-81dd-fa0307e36d20 volume-eloquent-grothendieck sbs_5k 25 GB + 13307e4a-c075-4421-b9b5-436732a1c739 vol-admiring-noether sbs_5k 25 GB + ``` + + Note that the `TYPE` field displays `sbs-15k` or `sbs_5k`, meaning our volumes are managed by the Block Storage API. + +## Identifying the API managing snapshots with the CLI + +### Using the Scaleway Instance CLI + +1. Open a terminal and run the following command to list your snapshots: + + ```bash + scw instance snapshot list + ``` + An output similar to the following should display: + ``` + ID NAME ORGANIZATION + d4b45594-7398-481d-8299-46292e07e404 snap-magical-driscoll 0c514155-9e5e-41a2-a900-9fdf0195b563 + ``` +2. Note the ID of the snapshot you want to check the type of. +3. Get more information about your snapshot, including its type. Make sure that you replace `` with the ID of the snapshot. + ```bash + scw instance snapshot get + ``` + An output similar to the following displays: + ``` + Snapshot.ID d4b45594-7398-481d-8299-46292e07e404 + Snapshot.Name snap-magical-driscoll + Snapshot.Organization 0c514155-9e5e-41a2-a900-9fdf0195b563 + Snapshot.Project 0c514155-9e5e-41a2-a900-9fdf0195b563 + Snapshot.VolumeType b_ssd + Snapshot.Size 25 GB + Snapshot.State available + Snapshot.CreationDate 10 months ago + Snapshot.ModificationDate 10 months ago + Snapshot.Zone fr-par-1 + ``` +4. Check the `Snapshot.VolumeType` field to see the type of the snapshot. Note that in the example above, the `Snapshot.VolumeType` field displays `b_ssd`, meaning our volume is managed by the Instance API. + +### Using the Scaleway Block Storage CLI + +1. Open a terminal and run the following command to list your snapshots: + + ```bash + scw block snapshot list + ``` + An output similar to the following should display. + + ``` + ID NAME SIZE PROJECT ID + 7f6ab0bd-cd0d-466b-b1e3-bd309dddfcf8 snap-elated-thompson 30 GB 0c514155-9e5e-41a2-a900-9fdf0195b563 + 92fa0096-30cf-4e7e-a1fe-2fbe73f524b9 snap-busy-albattani 25 GB e53c4255-f982-4d9d-a003-5ea43cb33707 + ``` +2. Note the ID of the snapshot you want to check the type of. +3. Get more information about your snapshot, including its type. Make sure that you replace `` with the ID of the snapshot. + ```bash + scw block snapshot get + ``` + An output similar to the following should display: + ``` + ID 92fa0096-30cf-4e7e-a1fe-2fbe73f524b9 + Name snap-busy-albattani + ParentVolume.ID 965b5361-01c5-4ca5-81dd-fa0307e36d20 + ParentVolume.Name volume-eloquent-grothendieck + ParentVolume.Type sbs_5k + ParentVolume.Status available + Size 25 GB + ProjectID e53c4255-f982-4d9d-a003-5ea43cb33707 + CreatedAt 1 week ago + UpdatedAt 1 week ago + Status available + Zone fr-par-1 + Class sbs + ``` +4. Check the `ParentVolume.Type` field to see the type of the snapshot. Note that in the example above, the `ParentVolume.Type` field displays `sbs_5k`, meaning our volume is managed by the Block Storage API. \ No newline at end of file diff --git a/storage/block/how-to/identify-volume-snapshot-type.mdx b/storage/block/how-to/identify-volume-snapshot-type.mdx new file mode 100644 index 0000000000..de55a5ac25 --- /dev/null +++ b/storage/block/how-to/identify-volume-snapshot-type.mdx @@ -0,0 +1,43 @@ +--- +meta: + title: How to identify your volume and snapshot type + description: Learn how to identify your volume and snapshot type from the Scaleway console. +content: + h1: How to identify your volume and snapshot type + paragraph: Learn how to identify your volume and snapshot type from the Scaleway console. +tags: identify-volume-type identify-snapshot bssd sbs volume snapshot +dates: + validation: 2025-01-03 + posted: 2025-01-03 +categories: + - block-storage + - storage +--- + +This page shows you how to identify your volume and snapshot type using the Scaleway console. Find out [how to migrate](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) your Block Storage legacy volumes to Block Storage Low Latency volumes. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [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 +- Created [Block Storage volumes](/storage/block/how-to/create-a-volume/) +- Created [snapshots](/storage/block/how-to/create-a-snapshot/) + +## How to identify your volume type + +1. Click **Block Storage** in the **Storage** section of the Scaleway console side menu. Your volumes display. +2. Click the **API** drop-down and select either **Block Storage API** to filter for your volumes creates via the Block Storage API, or **Instance API** to filter for your volumes managed by the Instance API. +3. Click the **Volume type** drop-down and select **Block Storage Low Latency 5K** and/or **Block Storage Low Latency 15K** to filter for 5K IOPS and/or 15K IOPS volumes. +4. Click **Apply filters**. The volumes you have filtered for display. +5. Optionally, click a specific volume to display the information page and verify the volume type next to the **Type** field. +6. Click **Clear filters** once you are done. + +## How to identify your snapshot type + +1. Click **Block Storage** in the **Storage** section of the Scaleway console side menu. +2. Click the **Snapshots** tab. Your snapshots display. +3. Click the **API** drop-down and select either **Block Storage API** to filter for your volumes creates via the Block Storage API, or **Instance API** to filter for your volumes managed by the Instance API. +4. Click the **Snapshot type** drop-down and select **Block Storage Low Latency 5K** and/or **Block Storage Low Latency 15K** to filter for snapshots of 5K IOPS and/or 15K IOPS volumes. +5. Optionally, click the iconic next to a specific snapshot to display the information page and verify the type next to the **Type** field. +6. Click **Clear filters** once you are done. + diff --git a/storage/block/reference-content/advantages-migrating-to-sbs.mdx b/storage/block/reference-content/advantages-migrating-to-sbs.mdx new file mode 100644 index 0000000000..f387c82f67 --- /dev/null +++ b/storage/block/reference-content/advantages-migrating-to-sbs.mdx @@ -0,0 +1,65 @@ +--- +meta: + title: Advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage low latency + description: Learn the key advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage low latency. +content: + h1: Advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage low latency + paragraph: Learn the key advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage low latency. +tags: volumes block-storage 5kiops 10kiops sbs low-latency +dates: + validation: 2025-01-03 + posted: 2025-01-03 +categories: + - storage +--- + +## Transitioning from the Instances API to the Block Storage API for volume and snapshot management + +Scaleway is transitioning the management of all Block Storage legacy volumes and snapshots from the [Instances API](https://www.scaleway.com/en/developers/api/instance/) to the [Block Storage API](https://www.scaleway.com/en/developers/api/block/). This means that Block Storage volumes and snapshots will no longer be available from the [Compute section](https://console.scaleway.com/instance/) in the Scaleway console, but from the [Storage section](https://console.scaleway.com/block-storage). + +This change provides you with enhanced performance and advanced storage capabilities. If you have created volumes and snapshots via the Instances API, we strongly recommend migrating them to the Block Storage API to benefit from these improvements. + +All Block Storage volumes and snapshots created via the Scaleway console, whether from the Instances section or the Block Storage section, are now created using the Block Storage API. + +Local volumes will remain exclusively supported by the Instance API. + +## Key advantages of using the Block Storage API + +By migrating your Block Storage volumes and snapshots to the Block Storage API, you take advantage of the following benefits: + +- **Low latency**: volumes managed by the Block Storage API leverage modern hardware, ensuring faster access times and smoother performance. +- **Higher IOPS performance**: benefit from up to 5K IOPS (input/output operations per second) with Block Storage Low Latency volumes and 15K IOPS with higher-tier offerings. These performance improvements are ideal for applications requiring rapid data access and high-speed operations. + +## Differences between volumes managed by the Instances API and the Block Storage API + +Volumes created with the Instances API differ from those created with the Block Storage API in both hardware and performance characteristics: + +### Underlying hardware + +Instances API volumes are built on **older-generation SSDs**, resulting in **slower performance and have a higher latency**, which may impact the responsiveness of applications. + +Block Storage API volumes are powered by **modern NVMe (Non-Volatile Memory Express) disks**, which are optimized for **high-speed operations**. They also have **advanced hardware** which ensures faster data access and lower latency. + +### Performance + +Instances API volumes have a **limited performance** due to older SSD technology. They also have a **lower IOPS and slower data processing speed**. + +Block Storage API volumes benefit from e**nhanced performance with up to 15K IOPS**. + +### Latency + +Instances API volumes have a **higher latency**, making them less suitable for applications requiring quick data retrieval. + +Block Storage API volumes have a **reduced latency** which ensures faster application response times. They are ideal for workloads requiring rapid and reliable data access. + +## Why you should migrate your volumes and snapshot + +Currently, two APIs manage Block Storage volumes on Scaleway: the Instance API and the Scaleway Block Storage API. Maintaining both APIs for the same product is not sustainable. + +Migrating your volumes to the Block Storage API ensures you benefit from: + +- The latest in storage technology with NVMe-powered performance +- Improved reliability and scalability for your applications +- Ongoing support and updates tailored for volumes and snapshots managed with the Block Storage API + +Find out [how to migrate](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) your Block Storage legacy volumes to Block Storage Low Latency volumes. \ No newline at end of file From 44c430d96b24cd8e0fdcc8f9329c88b9ea69fc30 Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Thu, 19 Dec 2024 15:44:28 +0100 Subject: [PATCH 2/2] docs(bls): second batch --- faq/blockstorage.mdx | 6 +++-- macros/storage/block-storage-migration.mdx | 9 +++++++ menu/navigation.json | 12 +++++++++ .../identifying-volume-snapshot-api.mdx | 6 ++--- .../how-to/identify-volume-snapshot-type.mdx | 22 +++++++++------- storage/block/index.mdx | 5 ++++ .../advantages-migrating-to-sbs.mdx | 26 +++++++++---------- 7 files changed, 57 insertions(+), 29 deletions(-) create mode 100644 macros/storage/block-storage-migration.mdx diff --git a/faq/blockstorage.mdx b/faq/blockstorage.mdx index 0d62fdee84..a9bee863cd 100644 --- a/faq/blockstorage.mdx +++ b/faq/blockstorage.mdx @@ -54,7 +54,7 @@ The Block Storage billing scheme is not the same as for Object Storage. You are Block Storage volumes are compatible with [Scaleway Instances](/compute/instances/), [Managed Dabatase for PostgreSQL and MySQL](/managed-databases/postgresql-and-mysql/), and [Kubernetes](/containers/kubernetes/) Kapsule clusters. -## How can I convert a Block Storage legacy volume into a Block Storage low latency volume? +## How can I convert a Block Storage legacy volume into a Block Storage Low Latency volume? For better performance, you can convert your Block Storage legacy volumes into Block Storage Low Latency volumes. @@ -66,4 +66,6 @@ To convert your volume you need to: - Import the data: restore or transfer the data from the backup or intermediary storage into the newly created volume. -Find out [how to migrate](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) your Block Storage legacy volumes to Block Storage Low Latency volumes. \ No newline at end of file +Find out how to [migrate your Block Storage legacy volumes and snapshots](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) from the Instance API to the Block Storage API. + +Find out about the [advantages of migrating the management of your volumes and snapshots](advantages-migrating-to-sbs) from the Instance API to the Block Storage API. diff --git a/macros/storage/block-storage-migration.mdx b/macros/storage/block-storage-migration.mdx new file mode 100644 index 0000000000..9d4458a9d3 --- /dev/null +++ b/macros/storage/block-storage-migration.mdx @@ -0,0 +1,9 @@ +--- +macro: block-storage-migration +--- + + + - Scaleway is transitioning the management of all Block Storage legacy volumes and snapshots from the [Instance API](https://www.scaleway.com/en/developers/api/instance/) to the [Block Storage API](https://www.scaleway.com/en/developers/api/block/). + - Find out about the [advantages of migrating the management of your volumes and snapshots](advantages-migrating-to-sbs) from the Instance API to the Block Storage API. + - Find out how to [migrate your Block Storage legacy volumes and snapshots](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) from the Instance API to the Block Storage API. + diff --git a/menu/navigation.json b/menu/navigation.json index 747ef44dd3..5e4f21eb22 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -4559,6 +4559,10 @@ "label": "Create a Block Storage volume from a snapshot", "slug": "create-volume-from-snapshot" }, + { + "label": "Identify a volume and snapshot type", + "slug": "identify-volume-snapshot-type" + }, { "label": "Detach a volume", "slug": "detach-a-volume" @@ -4585,6 +4589,10 @@ "label": "Managing a volume", "slug": "managing-a-volume" }, + { + "label": "Identifying the API managing Block Storage volumes and snapshots", + "slug": "identifying-volume-snapshot-api" + }, { "label": "Unmounting a volume", "slug": "unmounting-a-volume" @@ -4598,6 +4606,10 @@ { "label": "Differences between Block Storage volumes and Block Storage Low Latency volumes", "slug": "differences-between-5kiops-volumes" + }, + { + "label": "Advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage Low Latency", + "slug": "advantages-migrating-to-sbs" } ], "label": "Additional Content", diff --git a/storage/block/api-cli/identifying-volume-snapshot-api.mdx b/storage/block/api-cli/identifying-volume-snapshot-api.mdx index efd8f94f53..f6edaa68ec 100644 --- a/storage/block/api-cli/identifying-volume-snapshot-api.mdx +++ b/storage/block/api-cli/identifying-volume-snapshot-api.mdx @@ -1,9 +1,9 @@ --- meta: - title: Identify the API managing your Block Storage volumes and snapshots + title: Identifying the API managing Block Storage volumes and snapshots description: Learn how to determine which API (Instance or Block Storage) manages your volumes and snapshots on Scaleway using CLI and API commands. content: - h1: Identify the API managing your Block Storage volumes and snapshots + h1: Identifying the API managing Block Storage volumes and snapshots paragraph: Determine whether your Block Storage volumes and snapshots are managed by the Instance API or Block Storage API. dates: validation: 2025-01-03 @@ -14,7 +14,7 @@ categories: This page shows you how to identify the API managing your Block Storage volumes and snapshots, using the API and CLI. -Find out [how to migrate](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) your Block Storage legacy volumes to Block Storage Low Latency volumes. + diff --git a/storage/block/how-to/identify-volume-snapshot-type.mdx b/storage/block/how-to/identify-volume-snapshot-type.mdx index de55a5ac25..31130426df 100644 --- a/storage/block/how-to/identify-volume-snapshot-type.mdx +++ b/storage/block/how-to/identify-volume-snapshot-type.mdx @@ -1,11 +1,11 @@ --- meta: title: How to identify your volume and snapshot type - description: Learn how to identify your volume and snapshot type from the Scaleway console. + description: Learn how to identify the API managing your volumes and snapshots using the Scaleway console. content: h1: How to identify your volume and snapshot type - paragraph: Learn how to identify your volume and snapshot type from the Scaleway console. -tags: identify-volume-type identify-snapshot bssd sbs volume snapshot + paragraph: Learn how to identify the API managing your volumes and snapshots using the Scaleway console. +tags: identify-volume-type identify-snapshot bssd sbs volume snapshot api dates: validation: 2025-01-03 posted: 2025-01-03 @@ -14,7 +14,7 @@ categories: - storage --- -This page shows you how to identify your volume and snapshot type using the Scaleway console. Find out [how to migrate](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) your Block Storage legacy volumes to Block Storage Low Latency volumes. +This page shows you how to identify the API that manages your volumes and snapshots using the Scaleway console. Refer to our [dedicated documentation](/storage/api-cli/identifying-volume-snapshot-api/) to learn how to identify the API managing your volumes and snapshots using the API and CLI. @@ -23,21 +23,23 @@ This page shows you how to identify your volume and snapshot type using the Scal - Created [Block Storage volumes](/storage/block/how-to/create-a-volume/) - Created [snapshots](/storage/block/how-to/create-a-snapshot/) + + ## How to identify your volume type 1. Click **Block Storage** in the **Storage** section of the Scaleway console side menu. Your volumes display. -2. Click the **API** drop-down and select either **Block Storage API** to filter for your volumes creates via the Block Storage API, or **Instance API** to filter for your volumes managed by the Instance API. -3. Click the **Volume type** drop-down and select **Block Storage Low Latency 5K** and/or **Block Storage Low Latency 15K** to filter for 5K IOPS and/or 15K IOPS volumes. +2. Leave the **Block Storage API** filter in the drop-down or select **Instance API** to display either your volumes managed by the Block Storage API, or the Instance API. +3. Click the **Volume type** drop-down and select the volume type(s) to filter for. 4. Click **Apply filters**. The volumes you have filtered for display. -5. Optionally, click a specific volume to display the information page and verify the volume type next to the **Type** field. +5. Optionally, click a specific volume to display its information page, and verify the volume type next to the **Type** field. 6. Click **Clear filters** once you are done. ## How to identify your snapshot type 1. Click **Block Storage** in the **Storage** section of the Scaleway console side menu. 2. Click the **Snapshots** tab. Your snapshots display. -3. Click the **API** drop-down and select either **Block Storage API** to filter for your volumes creates via the Block Storage API, or **Instance API** to filter for your volumes managed by the Instance API. -4. Click the **Snapshot type** drop-down and select **Block Storage Low Latency 5K** and/or **Block Storage Low Latency 15K** to filter for snapshots of 5K IOPS and/or 15K IOPS volumes. -5. Optionally, click the iconic next to a specific snapshot to display the information page and verify the type next to the **Type** field. +3. Leave the **Block Storage API** filter in the drop-down or select **Instance API** to display either your snapshots managed by the Block Storage API, or the Instance API. +4. Click the **Snapshot type** drop-down and select the snapshot type(s) to filter for. +5. Optionally, click the icon next to a specific snapshot to display its information page, and verify the type next to the **Type** field. 6. Click **Clear filters** once you are done. diff --git a/storage/block/index.mdx b/storage/block/index.mdx index acff850daa..bd806c371f 100644 --- a/storage/block/index.mdx +++ b/storage/block/index.mdx @@ -60,6 +60,11 @@ meta: url="/storage/block/api-cli/unmounting-a-volume/" label="Read more" /> + diff --git a/storage/block/reference-content/advantages-migrating-to-sbs.mdx b/storage/block/reference-content/advantages-migrating-to-sbs.mdx index f387c82f67..b91bacc2fb 100644 --- a/storage/block/reference-content/advantages-migrating-to-sbs.mdx +++ b/storage/block/reference-content/advantages-migrating-to-sbs.mdx @@ -1,10 +1,10 @@ --- meta: - title: Advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage low latency - description: Learn the key advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage low latency. + title: Advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage Low Latency + description: Learn the key advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage Low Latency. content: - h1: Advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage low latency - paragraph: Learn the key advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage low latency. + h1: Advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage Low Latency + paragraph: Learn the key advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage Low Latency. tags: volumes block-storage 5kiops 10kiops sbs low-latency dates: validation: 2025-01-03 @@ -13,13 +13,11 @@ categories: - storage --- -## Transitioning from the Instances API to the Block Storage API for volume and snapshot management +## Transitioning from the Instance API to the Block Storage API for volume and snapshot management -Scaleway is transitioning the management of all Block Storage legacy volumes and snapshots from the [Instances API](https://www.scaleway.com/en/developers/api/instance/) to the [Block Storage API](https://www.scaleway.com/en/developers/api/block/). This means that Block Storage volumes and snapshots will no longer be available from the [Compute section](https://console.scaleway.com/instance/) in the Scaleway console, but from the [Storage section](https://console.scaleway.com/block-storage). +Scaleway is transitioning the management of all Block Storage legacy volumes and snapshots from the [Instance API](https://www.scaleway.com/en/developers/api/instance/) to the [Block Storage API](https://www.scaleway.com/en/developers/api/block/). All Block Storage volumes and snapshots created via the [Scaleway console](https://console.scaleway.com) will no longer be available from the [Compute section](https://console.scaleway.com/instance/), but from the [Storage section](https://console.scaleway.com/block-storage). -This change provides you with enhanced performance and advanced storage capabilities. If you have created volumes and snapshots via the Instances API, we strongly recommend migrating them to the Block Storage API to benefit from these improvements. - -All Block Storage volumes and snapshots created via the Scaleway console, whether from the Instances section or the Block Storage section, are now created using the Block Storage API. +This change provides you with enhanced performance and advanced storage capabilities. If you have created volumes and snapshots via the Instance API, we **strongly recommend migrating them to the Block Storage API** to benefit from these improvements. Local volumes will remain exclusively supported by the Instance API. @@ -30,25 +28,25 @@ By migrating your Block Storage volumes and snapshots to the Block Storage API, - **Low latency**: volumes managed by the Block Storage API leverage modern hardware, ensuring faster access times and smoother performance. - **Higher IOPS performance**: benefit from up to 5K IOPS (input/output operations per second) with Block Storage Low Latency volumes and 15K IOPS with higher-tier offerings. These performance improvements are ideal for applications requiring rapid data access and high-speed operations. -## Differences between volumes managed by the Instances API and the Block Storage API +## Differences between volumes managed by the Instance API and the Block Storage API -Volumes created with the Instances API differ from those created with the Block Storage API in both hardware and performance characteristics: +Volumes created with the Instance API differ from those created with the Block Storage API in both hardware and performance characteristics: ### Underlying hardware -Instances API volumes are built on **older-generation SSDs**, resulting in **slower performance and have a higher latency**, which may impact the responsiveness of applications. +Instance API volumes are built on **older-generation SSDs**, resulting in **slower performance and have a higher latency**, which may impact the responsiveness of applications. Block Storage API volumes are powered by **modern NVMe (Non-Volatile Memory Express) disks**, which are optimized for **high-speed operations**. They also have **advanced hardware** which ensures faster data access and lower latency. ### Performance -Instances API volumes have a **limited performance** due to older SSD technology. They also have a **lower IOPS and slower data processing speed**. +Instance API volumes have a **limited performance** due to older SSD technology. They also have a **lower IOPS and slower data processing speed**. Block Storage API volumes benefit from e**nhanced performance with up to 15K IOPS**. ### Latency -Instances API volumes have a **higher latency**, making them less suitable for applications requiring quick data retrieval. +Instance API volumes have a **higher latency**, making them less suitable for applications requiring quick data retrieval. Block Storage API volumes have a **reduced latency** which ensures faster application response times. They are ideal for workloads requiring rapid and reliable data access.