From aca973ab58f6bffbd9a9634b3f9bf90edd89da4a Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 16 Dec 2024 18:00:10 +0100 Subject: [PATCH 1/7] 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 e326b448b7..c408375a60 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 f74aa09a5e019474a5edfd617330d4443a6d5aca Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Thu, 19 Dec 2024 15:44:28 +0100 Subject: [PATCH 2/7] 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 c408375a60..f61c39cb82 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 c9e5ec6b9d..9054343807 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -4586,6 +4586,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" @@ -4612,6 +4616,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" @@ -4625,6 +4633,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. From 3f85956fad0f8a579e758853811f1775e68e1651 Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Tue, 31 Dec 2024 15:19:34 +0100 Subject: [PATCH 3/7] docs(bls): feedback --- faq/blockstorage.mdx | 16 +++--- .../identifying-volume-snapshot-api.mdx | 2 +- .../how-to/identify-volume-snapshot-type.mdx | 3 +- .../advantages-migrating-to-sbs.mdx | 56 +++++++++++-------- 4 files changed, 44 insertions(+), 33 deletions(-) diff --git a/faq/blockstorage.mdx b/faq/blockstorage.mdx index f61c39cb82..843c588ab0 100644 --- a/faq/blockstorage.mdx +++ b/faq/blockstorage.mdx @@ -56,16 +56,18 @@ Block Storage volumes are compatible with [Scaleway Instances](/compute/instance ## 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. +Currently, there is no direct way to change the storage class of a volume while preserving its ID. -To convert your volume you need to: +However, you can use the snapshot export/import feature as a temporary solution to transition a Block Storage legacy volume into a Block Storage Low Latency volume. -- 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). + + The process below requires manual intervention and **does not preserve the original volume's ID**. + While this approach allows you to transition to a Block Storage Low Latency volume, it is only a workaround. + -- 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. +1. [Export a snapshot of your Block Storage legacy volume](/compute/instances/api-cli/snapshot-import-export-feature/#exporting-snapshots). +2. [Import the snapshot into a new Low Latency volume](/compute/instances/api-cli/snapshot-import-export-feature/#importing-snapshots). 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. +Find out about the [advantages of migrating the management of your volumes and snapshots](/storage/block/reference-content/advantages-migrating-to-sbs) from the Instance API to the Block Storage API. diff --git a/storage/block/api-cli/identifying-volume-snapshot-api.mdx b/storage/block/api-cli/identifying-volume-snapshot-api.mdx index f6edaa68ec..ebde302720 100644 --- a/storage/block/api-cli/identifying-volume-snapshot-api.mdx +++ b/storage/block/api-cli/identifying-volume-snapshot-api.mdx @@ -257,7 +257,7 @@ An output similar to the following should display: ```bash scw instance volume list ``` - An output similar to the following whould display: + An output similar to the following should display: ``` ID STATE SERVER ID b582c548-6dc0-4e77-bb93-9615b9baa380 available a4138186-f362-41b2-adc2-c46a2e1a46b7 diff --git a/storage/block/how-to/identify-volume-snapshot-type.mdx b/storage/block/how-to/identify-volume-snapshot-type.mdx index 31130426df..ad70a940e0 100644 --- a/storage/block/how-to/identify-volume-snapshot-type.mdx +++ b/storage/block/how-to/identify-volume-snapshot-type.mdx @@ -41,5 +41,4 @@ This page shows you how to identify the API that manages your volumes and snapsh 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. - +6. Click **Clear filters** once you are done. \ No newline at end of file diff --git a/storage/block/reference-content/advantages-migrating-to-sbs.mdx b/storage/block/reference-content/advantages-migrating-to-sbs.mdx index b91bacc2fb..0592eb4a78 100644 --- a/storage/block/reference-content/advantages-migrating-to-sbs.mdx +++ b/storage/block/reference-content/advantages-migrating-to-sbs.mdx @@ -15,49 +15,59 @@ categories: ## 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 [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). +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 Instance API, we **strongly recommend migrating them to the Block Storage API** to benefit from these improvements. +This change streamlines how storage resources are managed by consolidating them under the Block Storage API, providing enhanced management features and clearer storage class distinctions. If you have created volumes and snapshots via the Instance API, we **strongly recommend transitioning to the Block Storage API** to align with the latest management practices. Local volumes will remain exclusively supported by the Instance API. -## Key advantages of using the Block Storage API +## Differences between the Instance API and the Block Storage API -By migrating your Block Storage volumes and snapshots to the Block Storage API, you take advantage of the following benefits: +The key differences between the Instance API and the Block Storage API lie in the storage classes they manage, rather than just the APIs themselves. This distinction influences the underlying hardware and performance characteristics of the volumes. -- **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. +### Storage classes -## Differences between volumes managed by the Instance API and the Block Storage API +The Instance API handles only **BSSD (Basic SSD)** volumes. +The Block Storage API supports a broader range of storage classes, including: -Volumes created with the Instance API differ from those created with the Block Storage API in both hardware and performance characteristics: + - **BSSD volumes** + - **Scaleway Block Storage (SBS) 5K IOPS volumes** + - **Scaleway Block Storage (SBS) 15K IOPS volumes** ### Underlying hardware -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. +**BSSD volumes** (managed by both APIs) are built on **older-generation SSDs**, offering reliable performance but with limitations in speed and latency. -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. +**Scaleway Block Storage 5K and 15K volumes** (managed only by the Block Storage API) are powered by **modern NVMe (Non-Volatile Memory Express) disks**. They are optimized for **low-latency and high-speed operations**. -### Performance +### Performance and latency -Instance API volumes have a **limited performance** due to older SSD technology. They also have a **lower IOPS and slower data processing speed**. +**BSSD volumes**: -Block Storage API volumes benefit from e**nhanced performance with up to 15K IOPS**. + - **Performance**: Limited IOPS and slower data processing speed due to older SSD technology. + - **Latency**: Higher latency, less suitable for applications requiring rapid data retrieval. -### Latency +**Scaleway Block Storage 5K and 15K volumes**: -Instance API volumes have a **higher latency**, making them less suitable for applications requiring quick data retrieval. + - **Performance**: Enhanced performance with up to 5K IOPS (SBS 5K) and 15K IOPS (SBS 15K). + - **Latency**: Lower latency, ideal for workloads demanding rapid and reliable data access. -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 transition to the Block Storage API? -## Why you should migrate your volumes and snapshot +By transitioning to the Block Storage API, you align with Scaleway's consolidated storage management approach and gain access to advanced storage features and flexibility. While migrating to the Block Storage API does not inherently change the performance of BSSD volumes, you benefit from: -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. +- **Unified management**: Simplified volume and snapshot management through a dedicated API. +- **Access to advanced storage classes**: You can create new Scaleway Block Storage 5K or 15K volumes for workloads needing higher performance and lower latency. +- **Ongoing support**: Enhanced support and updates tailored for Block Storage API-managed resources. -Migrating your volumes to the Block Storage API ensures you benefit from: +## Impact on volume names in virtual machines -- 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 +When transitioning to the Block Storage API, you may notice changes in how volumes are identified in your virtual machines (VMs). For more details on how devices are named and identified, please refer to [this documentation](/compute/instances/reference-content/identify-devices/). -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 +## How to transition + +For a step-by-step guide to transitioning your Block Storage legacy volumes to the Block Storage API, refer to [our migration documentation](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/). + +--- + +This transition ensures Scaleway can continue to provide robust, scalable, and high-performance storage solutions tailored to your needs. If you have questions or need assistance, [contact our support team](https://console.scaleway.com/support/tickets/create). \ No newline at end of file From 967005247cf37a7a8e5b569309dbb7a5c953dbe4 Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 6 Jan 2025 14:43:06 +0100 Subject: [PATCH 4/7] docs(block-storage): feedback --- macros/storage/block-storage-migration.mdx | 4 +- menu/navigation.json | 6 +-- .../identifying-volume-snapshot-api.mdx | 6 +-- .../how-to/identify-volume-snapshot-type.mdx | 44 ---------------- .../advantages-migrating-to-sbs.mdx | 52 ++++++++++++++----- 5 files changed, 45 insertions(+), 67 deletions(-) delete mode 100644 storage/block/how-to/identify-volume-snapshot-type.mdx diff --git a/macros/storage/block-storage-migration.mdx b/macros/storage/block-storage-migration.mdx index 9d4458a9d3..9a00696a62 100644 --- a/macros/storage/block-storage-migration.mdx +++ b/macros/storage/block-storage-migration.mdx @@ -3,7 +3,7 @@ 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. + - Scaleway is transitioning the management of all block 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](/storage/block/reference-content/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 9054343807..dced8bbe4c 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -4586,10 +4586,6 @@ "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" @@ -4635,7 +4631,7 @@ "slug": "differences-between-5kiops-volumes" }, { - "label": "Advantages of migrating your Block Storage legacy volumes and snapshots to Block Storage Low Latency", + "label": "Advantages of migrating from the Instance API to the Block Storage API for managing block volumes and snapshots", "slug": "advantages-migrating-to-sbs" } ], diff --git a/storage/block/api-cli/identifying-volume-snapshot-api.mdx b/storage/block/api-cli/identifying-volume-snapshot-api.mdx index ebde302720..c383564ff3 100644 --- a/storage/block/api-cli/identifying-volume-snapshot-api.mdx +++ b/storage/block/api-cli/identifying-volume-snapshot-api.mdx @@ -6,13 +6,13 @@ content: 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 - posted: 2025-01-03 + validation: 2025-01-07 + posted: 2025-01-07 categories: - storage --- -This page shows you how to identify the API managing your Block Storage volumes and snapshots, using the API and CLI. +This page shows you how to identify the API managing your Block Storage volumes and snapshots, using the Scaleway API and CLI. diff --git a/storage/block/how-to/identify-volume-snapshot-type.mdx b/storage/block/how-to/identify-volume-snapshot-type.mdx deleted file mode 100644 index ad70a940e0..0000000000 --- a/storage/block/how-to/identify-volume-snapshot-type.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -meta: - title: How to identify your volume and snapshot type - 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 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 -categories: - - block-storage - - storage ---- - -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. - - - -- 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. 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 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. 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. \ No newline at end of file diff --git a/storage/block/reference-content/advantages-migrating-to-sbs.mdx b/storage/block/reference-content/advantages-migrating-to-sbs.mdx index 0592eb4a78..a7c73f70eb 100644 --- a/storage/block/reference-content/advantages-migrating-to-sbs.mdx +++ b/storage/block/reference-content/advantages-migrating-to-sbs.mdx @@ -1,29 +1,55 @@ --- 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 from the Instance API to the Block Storage API for managing block volumes and snapshots + description: Learn the key advantages of migrating to the Block Storage API for managing your Block Storage volumes and snapshots. 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 + h1: Advantages of migrating from the Instance API to the Block Storage API for managing block volumes and snapshots + paragraph: Learn the key advantages of migrating to the Block Storage API for managing your Block Storage volumes and snapshots. +tags: volumes block-storage 5kiops 10kiops sbs low-latency migration dates: - validation: 2025-01-03 - posted: 2025-01-03 + validation: 2025-01-07 + posted: 2025-01-07 categories: - storage --- +This page explains why you should migrate from the Instance API to the Block Storage API to create and manage block volumes and snapshots. + + + The information displayed on this page **only applies to Instance users with block volumes**. It **does not apply to Kapsule users with block persistent volumes**. + + ## 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 [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). +Scaleway is transitioning the management of all Block Storage 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 streamlines how storage resources are managed by consolidating them under the Block Storage API, providing enhanced management features and clearer storage class distinctions. If you have created volumes and snapshots via the Instance API, we **strongly recommend transitioning to the Block Storage API** to align with the latest management practices. +This change streamlines how storage resources are managed by consolidating them under the Block Storage API, providing enhanced management features and clearer storage class distinctions. Local volumes will remain exclusively supported by the Instance API. +## What is required from you in the context of the migration? + +If you have created volumes and snapshots via the Instance API, you **must transition to the Block Storage API** to align with the latest management practices. + +This entails [migrating your existing volumes and snapshots to the Block Storage API](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/), and **switching to using only the Block Storage API for Block Storage volumes and snapshots creation and management**. + + + Unified volume creation and management will no longer be available via the Block Storage API and will no longer be supported by the Instance API at the end of the migration. For this reason, it is also necessary to convert your existing unified volumes and snapshots to either local or block volumes. + + +## What will happen at the end of the migration? + +From **April 30th 2025, block volumes and snapshots will no longer be available for creation/management through the Instance API**. + +From **June 2nd, 2025, all block volumes and snapshots that you have not migrated manually will be automatically switched behind the Block Storage API**. + +What's more, creating and managing block volumes and snapshots through the Instance API will no longer be possible. The Instance API will only allow you to create and manage local volumes and snapshots. + +Creating and managing block volumes and snapshots will **only be available via the Block Storage API**. + ## Differences between the Instance API and the Block Storage API -The key differences between the Instance API and the Block Storage API lie in the storage classes they manage, rather than just the APIs themselves. This distinction influences the underlying hardware and performance characteristics of the volumes. +The key differences between the Instance API and the Block Storage API lie in the storage classes they manage, rather than just the APIs themselves. The [Block Storage API](https://www.scaleway.com/en/developers/api/block/) is the only API to use to create and manage all types of volumes, including high performance ones. ### Storage classes @@ -62,11 +88,11 @@ By transitioning to the Block Storage API, you align with Scaleway's consolidate ## Impact on volume names in virtual machines -When transitioning to the Block Storage API, you may notice changes in how volumes are identified in your virtual machines (VMs). For more details on how devices are named and identified, please refer to [this documentation](/compute/instances/reference-content/identify-devices/). +When transitioning to the Block Storage API, you may notice changes in how volumes are identified in your virtual machines (VMs). For more details on how devices are named and identified, refer to [this documentation](/compute/instances/reference-content/identify-devices/). -## How to transition +## How to transition? -For a step-by-step guide to transitioning your Block Storage legacy volumes to the Block Storage API, refer to [our migration documentation](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/). +For a step-by-step guide to transitioning your block volumes and snapshots from the Instance API to the Block Storage API, refer to [our migration documentation](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/). --- From f4df2279e643e83190f3262b8a850e3ab5709390 Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 6 Jan 2025 15:20:40 +0100 Subject: [PATCH 5/7] docs(bls): fix --- faq/blockstorage.mdx | 6 +++--- macros/storage/block-storage-migration.mdx | 2 +- storage/block/api-cli/identifying-volume-snapshot-api.mdx | 2 +- .../block/reference-content/advantages-migrating-to-sbs.mdx | 6 +++--- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/faq/blockstorage.mdx b/faq/blockstorage.mdx index 843c588ab0..2e68b7bc00 100644 --- a/faq/blockstorage.mdx +++ b/faq/blockstorage.mdx @@ -5,7 +5,7 @@ meta: content: h1: Block Storage dates: - validation: 2024-12-19 + validation: 2025-01-07 category: storage productIcon: BlockStorageProductIcon --- @@ -65,9 +65,9 @@ However, you can use the snapshot export/import feature as a temporary solution While this approach allows you to transition to a Block Storage Low Latency volume, it is only a workaround. -1. [Export a snapshot of your Block Storage legacy volume](/compute/instances/api-cli/snapshot-import-export-feature/#exporting-snapshots). +1. [Export a snapshot of your Block Storage volume](/compute/instances/api-cli/snapshot-import-export-feature/#exporting-snapshots). 2. [Import the snapshot into a new Low Latency volume](/compute/instances/api-cli/snapshot-import-export-feature/#importing-snapshots). -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 how to [migrate your Block Storage 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](/storage/block/reference-content/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 index 9a00696a62..e04c220f6b 100644 --- a/macros/storage/block-storage-migration.mdx +++ b/macros/storage/block-storage-migration.mdx @@ -5,5 +5,5 @@ macro: block-storage-migration - Scaleway is transitioning the management of all block 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](/storage/block/reference-content/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. + - Find out how to [migrate your Block Storage volumes and snapshots](/compute/instances/how-to/migrate-volumes-snapshots-to-sbs/) from the Instance API to the Block Storage API. diff --git a/storage/block/api-cli/identifying-volume-snapshot-api.mdx b/storage/block/api-cli/identifying-volume-snapshot-api.mdx index c383564ff3..dfe716889f 100644 --- a/storage/block/api-cli/identifying-volume-snapshot-api.mdx +++ b/storage/block/api-cli/identifying-volume-snapshot-api.mdx @@ -307,7 +307,7 @@ An output similar to the following should display: 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. + 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 diff --git a/storage/block/reference-content/advantages-migrating-to-sbs.mdx b/storage/block/reference-content/advantages-migrating-to-sbs.mdx index a7c73f70eb..e5c7935f6d 100644 --- a/storage/block/reference-content/advantages-migrating-to-sbs.mdx +++ b/storage/block/reference-content/advantages-migrating-to-sbs.mdx @@ -13,10 +13,10 @@ categories: - storage --- -This page explains why you should migrate from the Instance API to the Block Storage API to create and manage block volumes and snapshots. +This page explains why **Instance users** should migrate from the Instance API to the Block Storage API to create and manage block volumes and snapshots. - The information displayed on this page **only applies to Instance users with block volumes**. It **does not apply to Kapsule users with block persistent volumes**. + The information displayed on this page **does not apply to Kapsule users with block persistent volumes**. ## Transitioning from the Instance API to the Block Storage API for volume and snapshot management @@ -88,7 +88,7 @@ By transitioning to the Block Storage API, you align with Scaleway's consolidate ## Impact on volume names in virtual machines -When transitioning to the Block Storage API, you may notice changes in how volumes are identified in your virtual machines (VMs). For more details on how devices are named and identified, refer to [this documentation](/compute/instances/reference-content/identify-devices/). +When transitioning to the Block Storage API, you may notice changes in how volumes are identified in your virtual machines (VMs). For more details on how devices are named and identified, refer to [our documentation on identifying devices on a Scaleway Instance](/compute/instances/reference-content/identify-devices/). ## How to transition? From caebbd1f33a59763e060b39b14d6bb8cc20a7cab Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 6 Jan 2025 15:41:27 +0100 Subject: [PATCH 6/7] docs(bls): last update --- storage/block/index.mdx | 4 ++-- storage/block/quickstart.mdx | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/storage/block/index.mdx b/storage/block/index.mdx index bd806c371f..100567a678 100644 --- a/storage/block/index.mdx +++ b/storage/block/index.mdx @@ -56,8 +56,8 @@ meta: label="Read more" /> + - A Scaleway account logged into the [console](https://console.scaleway.com) From 1e26c6bf2f0bc67a073e7e4a980696fda693afe0 Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 6 Jan 2025 17:13:31 +0100 Subject: [PATCH 7/7] docs(bls): feedback --- .../block/reference-content/advantages-migrating-to-sbs.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/storage/block/reference-content/advantages-migrating-to-sbs.mdx b/storage/block/reference-content/advantages-migrating-to-sbs.mdx index e5c7935f6d..7e3a6724ab 100644 --- a/storage/block/reference-content/advantages-migrating-to-sbs.mdx +++ b/storage/block/reference-content/advantages-migrating-to-sbs.mdx @@ -21,7 +21,7 @@ This page explains why **Instance users** should migrate from the Instance API t ## Transitioning from the Instance API to the Block Storage API for volume and snapshot management -Scaleway is transitioning the management of all Block Storage 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). +Scaleway is transitioning the management of all Block Storage 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/). This change streamlines how storage resources are managed by consolidating them under the Block Storage API, providing enhanced management features and clearer storage class distinctions. @@ -39,7 +39,7 @@ This entails [migrating your existing volumes and snapshots to the Block Storage ## What will happen at the end of the migration? -From **April 30th 2025, block volumes and snapshots will no longer be available for creation/management through the Instance API**. +From **April 30th 2025, it will no longer be possible to create Block volumes through the Instance API**. From **June 2nd, 2025, all block volumes and snapshots that you have not migrated manually will be automatically switched behind the Block Storage API**.