From 2f71f655c3b19f046c2b8d78c15210822eea2a79 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Thu, 29 Jan 2026 17:28:24 +0100 Subject: [PATCH 1/3] docs(fls): add cli doc for crud operations MTA-6885 --- pages/file-storage/api-cli/index.mdx | 4 + .../api-cli/use-file-storage-cli.mdx | 83 +++++++++++++++++++ pages/file-storage/menu.ts | 10 +++ pages/scaleway-cli/quickstart.mdx | 4 +- 4 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 pages/file-storage/api-cli/index.mdx create mode 100644 pages/file-storage/api-cli/use-file-storage-cli.mdx diff --git a/pages/file-storage/api-cli/index.mdx b/pages/file-storage/api-cli/index.mdx new file mode 100644 index 0000000000..892eb1d997 --- /dev/null +++ b/pages/file-storage/api-cli/index.mdx @@ -0,0 +1,4 @@ +--- +title: File Storage - API/CLI documentation +description: File Storage - API/CLI documentation +--- \ No newline at end of file diff --git a/pages/file-storage/api-cli/use-file-storage-cli.mdx b/pages/file-storage/api-cli/use-file-storage-cli.mdx new file mode 100644 index 0000000000..2206c899e6 --- /dev/null +++ b/pages/file-storage/api-cli/use-file-storage-cli.mdx @@ -0,0 +1,83 @@ +--- +title: Using File Storage with the Scaleway CLI +description: This page basic commands to use File Storage with the Scaleway CLI +tags: cli command line interface terminal file storage system +dates: + validation: 2026-01-29 + posted: 2026-01-29 +--- +import Requirements from '@macros/iam/requirements.mdx' + +This page contains basic commands to manage your file systems using the Scaleway CLI. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- [Installed and configured](/scaleway-cli/quickstart/) the Scaleway CLI + +## Creating a file system + +The following command allows you to create a file system: + +```bash +scw file filesystem create name= size= +``` + +## Listing your file systems + +The following command allows you to list file systems present in your organization: + +```bash +scw file filesystem list +``` + +## Getting details on a file system + +The following command allows you to get information about a given file system: + +```bash +scw file filesystem get +``` + +## Updating a file system + +The following command allows you to modify the settings of a file system: + +```bash +scw file filesystem update +``` + +## Attaching a file system to an Instance + + +Attaching a file system to an Instance must be done using the Instances CLI. Refer to the [dedicated documentation](https://cli.scaleway.com/instance/#attach-a-filesystem-volume-to-an-instance) for more information. + + +The following command allows you to attach a file system to an Instance: + +```bash +scw instance server attach-filesystem server-id= filesystem-id= +``` + +## Detaching a file system from an Instance + + +Detaching a file system from an Instance must be done using the Instances CLI. Refer to the [dedicated documentation](https://cli.scaleway.com/instance/#detach-a-filesystem-volume-from-an-instance) for more information. + + +The following command allows you to detach a file system from an Instance: + +```bash +scw instance server attach-filesystem server-id= filesystem-id= +``` + +## Deleting a file system + +The following command allows you to delete a given file system: + +```bash +scw file filesystem delete +``` + +For comprehensive information on the different CLI commands to interact with Scaleway File Storage (including the different arguments for each command), refer to the [dedicated Scaleway CLI documentation](https://cli.scaleway.com/file/). \ No newline at end of file diff --git a/pages/file-storage/menu.ts b/pages/file-storage/menu.ts index 60670a5029..0f4ae716e6 100644 --- a/pages/file-storage/menu.ts +++ b/pages/file-storage/menu.ts @@ -50,6 +50,16 @@ export const fileStorageMenu = { label: 'How to', slug: 'how-to', }, + { + items: [ + { + label:'Using File Storage with the Scaleway CLI', + slug:'use-file-storage-cli' + }, + ], + label:'API/CLI', + slug:'api-cli' + }, { items: [ { diff --git a/pages/scaleway-cli/quickstart.mdx b/pages/scaleway-cli/quickstart.mdx index 223502b197..5c44ad9f2a 100644 --- a/pages/scaleway-cli/quickstart.mdx +++ b/pages/scaleway-cli/quickstart.mdx @@ -9,7 +9,9 @@ dates: import Requirements from '@macros/iam/requirements.mdx' -The Scaleway command line interface (CLI) is a tool that allows you to pilot your Scaleway infrastructure and resources directly from your terminal. This page explains how to install and configure the CLI on your local machine. +The Scaleway command line interface (CLI) is a tool that allows you to pilot your Scaleway infrastructure and resources directly from your terminal. It is built upon the Scaleway API, and provides a readable, and user-friendly interface to interact with Scaleway products programmatically. + +This page explains how to install and configure the CLI on your local machine. Refer to the [Scaleway CLI repository](https://github.com/scaleway/scaleway-cli?tab=readme-ov-file#reference-documentation) for more information on the different commands. From c6c5f0a5dcc2f9ea1ef868664fe1f97d990c94b8 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Thu, 5 Feb 2026 11:41:08 +0100 Subject: [PATCH 2/3] docs(fls): update --- pages/file-storage/api-cli/use-file-storage-cli.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pages/file-storage/api-cli/use-file-storage-cli.mdx b/pages/file-storage/api-cli/use-file-storage-cli.mdx index 2206c899e6..f798ed1839 100644 --- a/pages/file-storage/api-cli/use-file-storage-cli.mdx +++ b/pages/file-storage/api-cli/use-file-storage-cli.mdx @@ -1,6 +1,6 @@ --- title: Using File Storage with the Scaleway CLI -description: This page basic commands to use File Storage with the Scaleway CLI +description: This page lists basic commands to use Scaleway File Storage using the Scaleway command line interface (CLI) tags: cli command line interface terminal file storage system dates: validation: 2026-01-29 @@ -60,6 +60,8 @@ The following command allows you to attach a file system to an Instance: scw instance server attach-filesystem server-id= filesystem-id= ``` +Once your file system is attached to the desired Instance, you must mount from within the Instance to use it. Refer to the [dedicated documentation](/file-storage/how-to/mount-file-system/) for more information. + ## Detaching a file system from an Instance From 09996b41c13b96206e70f12a3d365369810f33b5 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Fri, 6 Feb 2026 11:27:57 +0100 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Rowena Jones <36301604+RoRoJ@users.noreply.github.com> --- pages/file-storage/api-cli/use-file-storage-cli.mdx | 8 ++++---- pages/scaleway-cli/quickstart.mdx | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pages/file-storage/api-cli/use-file-storage-cli.mdx b/pages/file-storage/api-cli/use-file-storage-cli.mdx index f798ed1839..e17ecf2170 100644 --- a/pages/file-storage/api-cli/use-file-storage-cli.mdx +++ b/pages/file-storage/api-cli/use-file-storage-cli.mdx @@ -1,6 +1,6 @@ --- title: Using File Storage with the Scaleway CLI -description: This page lists basic commands to use Scaleway File Storage using the Scaleway command line interface (CLI) +description: This page lists basic commands to use Scaleway File Storage using the Scaleway Command Line Interface (CLI) tags: cli command line interface terminal file storage system dates: validation: 2026-01-29 @@ -26,7 +26,7 @@ scw file filesystem create name= size= ## Listing your file systems -The following command allows you to list file systems present in your organization: +The following command allows you to list file systems present in your Organization: ```bash scw file filesystem list @@ -60,7 +60,7 @@ The following command allows you to attach a file system to an Instance: scw instance server attach-filesystem server-id= filesystem-id= ``` -Once your file system is attached to the desired Instance, you must mount from within the Instance to use it. Refer to the [dedicated documentation](/file-storage/how-to/mount-file-system/) for more information. +Once your file system is attached to the desired Instance, you must mount it from within the Instance to use it. Refer to the [dedicated documentation](/file-storage/how-to/mount-file-system/) for more information. ## Detaching a file system from an Instance @@ -71,7 +71,7 @@ Detaching a file system from an Instance must be done using the Instances CLI. R The following command allows you to detach a file system from an Instance: ```bash -scw instance server attach-filesystem server-id= filesystem-id= +scw instance server detach-filesystem server-id= filesystem-id= ``` ## Deleting a file system diff --git a/pages/scaleway-cli/quickstart.mdx b/pages/scaleway-cli/quickstart.mdx index 5c44ad9f2a..cfd23c2580 100644 --- a/pages/scaleway-cli/quickstart.mdx +++ b/pages/scaleway-cli/quickstart.mdx @@ -9,7 +9,7 @@ dates: import Requirements from '@macros/iam/requirements.mdx' -The Scaleway command line interface (CLI) is a tool that allows you to pilot your Scaleway infrastructure and resources directly from your terminal. It is built upon the Scaleway API, and provides a readable, and user-friendly interface to interact with Scaleway products programmatically. +The Scaleway Command Line Interface (CLI) is a tool that allows you to pilot your Scaleway infrastructure and resources directly from your terminal. It is built upon the Scaleway API, and provides a readable and user-friendly interface to interact with Scaleway products programmatically. This page explains how to install and configure the CLI on your local machine.