diff --git a/menu/navigation.json b/menu/navigation.json index 88b2c1a33f..2c15a1f8e6 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -4934,6 +4934,62 @@ "label": "Block Storage", "slug": "block-storage" }, + { + "items": [ + { + "label": "Overview", + "slug": "../file-storage" + }, + { + "label": "Concepts", + "slug": "concepts" + }, + { + "label": "Quickstart", + "slug": "quickstart" + }, + { + "label": "FAQ", + "slug": "faq" + }, + { + "items": [ + { + "label": "Create a file system", + "slug": "create-file-system" + }, + { + "label": "Attach a file system", + "slug": "attach-file-system" + }, + { + "label": "Mount a file system to an Instance", + "slug": "mount-file-system" + }, + { + "label": "Manage and delete a file system", + "slug": "manage-delete-file-system" + }, + { + "label": "Resize a file system", + "slug": "resize-file-system" + }, + { + "label": "Unmount a file system from an Instance", + "slug": "unmount-file-system" + }, + { + "label": "Detach a file system", + "slug": "detach-file-system" + } + ], + "label": "How to", + "slug": "how-to" + } + ], + "label": "File Storage", + "slug": "file-storage" + }, { "items": [ { diff --git a/pages/file-storage/concepts.mdx b/pages/file-storage/concepts.mdx new file mode 100644 index 0000000000..f1b20aec40 --- /dev/null +++ b/pages/file-storage/concepts.mdx @@ -0,0 +1,52 @@ +--- +title: File Storage - Concepts +description: Explore essential concepts of File Storage. +tags: file storage file system concept glossary terms definitions +dates: + validation: 2025-07-23 + posted: 2025-07-23 +categories: + - file-storage + - storage +--- + +import AvailabilityZone from '@macros/concepts/availability-zone.mdx' +import BlockVolumes from '@macros/concepts/block-volumes.mdx' +import Region from '@macros/concepts/region.mdx' + +## Attach + +Attaching storage to your Scaleway Instance allows you to use additional or shared storage beyond its [Local Storage](/local-storage/). + +## Availability Zone + + + +## Block volumes + + + +## File Storage + +Scaleway File Storage allows you to keep data in an organized hierarchy of files and folders. This hierarchy can be shared across a network, so multiple compute instances can work on the same collection of files. + +## File system + +A file system provides a structured way to manage files and directories in the cloud, so that Instances can access, read, and write data as if it were on a local disk. File systems can be shared by several [Instances](/instances/). + +## IOPS + +IOPS or Input/Ouptut Operations Per Second, is a unit of measurement that indicates how many read/write operations a storage device is performing per second. + +Scaleway File Storage offers two IOPS limits: + +- 5 000 IOPS (5K IOPS) +- 15 000 IOPS (15K IOPS) + +## Mount + +Mounting a storage volume allows you you to assign a directory (mount point) to an [attached](#attach) storage volume. The files on that storage become available via the assigned directory. This allows you to read and write files on the storage as if they were part of your local file system. + +## Region + + diff --git a/pages/file-storage/faq.mdx b/pages/file-storage/faq.mdx new file mode 100644 index 0000000000..84417b8752 --- /dev/null +++ b/pages/file-storage/faq.mdx @@ -0,0 +1,19 @@ +--- +title: File Storage FAQ +description: Explore Scaleway File Storage with our comprehensive FAQ covering performance, persistence, and more. +dates: + created: 2025-07-23 + validation: 2025-07-23 +category: storage +productIcon: FileStorageProductIcon +--- + +## What is Scaleway File Storage? + +Scaleway File Storage allows you to keep data in an organized hierarchy of files and folders. This hierarchy can be shared across a network, so multiple compute instances can work on the same collection of files. + +Refer to the [Quickstart documentation](/file-storage/quickstart/) to get started with Scaleway File Storage. + +## How many file systems can I attach to an Instance? + +You can attach up to 16 storage resources to a Scaleway Instance, including file systems, Block Storage volumes, and Local Storage volumes. \ No newline at end of file diff --git a/pages/file-storage/how-to/attach-file-system.mdx b/pages/file-storage/how-to/attach-file-system.mdx new file mode 100644 index 0000000000..7bcff8903e --- /dev/null +++ b/pages/file-storage/how-to/attach-file-system.mdx @@ -0,0 +1,41 @@ +--- +title: How to attach a file system to a Scaleway Instance +description: This page explains how to attach a File Storage file system to Scaleway Instances +tags: attach instance server fs filesystem file storage resource +categories: + - storage + - file-storage +dates: + validation: 2025-07-23 + posted: 2025-07-23 +--- + +This page explains how to attach a file system to one or several Instances. File systems can only be attached to Instances within the same [region](/file-storage/concepts/#region). + +import Requirements from '@macros/iam/requirements.mdx' + + + +- 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 +- [Created a file system](/file-system/how-to/create-file-system/) +- [Created at least one POP2 Instance](/instances/how-to/create-an-instance/) + +## How to attach a file system to an Instance + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to attach. The **Overview** page displays. + +3. Open the **Attached Instance(s)**. A list of currently attached Instances displays. + +4. Click **Attach an Instance**. A pop-up displays. + +5. Select one Instance or more from the drop-down list, then click **Attach** to confirm. + + + File systems can only be attached to POP2 Instances within the same [region](/file-storage/concepts/#region). + + +Your file system is now attached to the selected Instance(s) and can now be [mounted](/file-storage/how-to/mount-file-system/) to a Scaleway Instance. + diff --git a/pages/file-storage/how-to/create-file-system.mdx b/pages/file-storage/how-to/create-file-system.mdx new file mode 100644 index 0000000000..3be1f803d2 --- /dev/null +++ b/pages/file-storage/how-to/create-file-system.mdx @@ -0,0 +1,38 @@ +--- +title: How to create a file system +description: This page explains how to create a File Storage file system using the Scaleway console. +tags: create add deploy fs filesystem file storage resource +categories: + - storage + - file-storage +dates: + validation: 2025-07-23 + posted: 2025-07-23 +--- +import Requirements from '@macros/iam/requirements.mdx' + + + +- 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 + +This page explains how to create a file system using the Scaleway console. + +## How to create a file system + +1. Click **File Storage** in the **Storage** section of the side menu. The [File Storage dashboard](https://console.scaleway.com/file-storage/) displays. + +2. Click **+ Create file system**. The [file system creation page](https://console.scaleway.com//file-storage/file-storage/create) displays. + +3. Complete the following steps: + - Select the region in which your file system will be created. It will be accessible by [Instances](/instances/) within the same [region](/file-storage/concepts/#region). + - Enter a name for your file system, or use the automatically generated one. The name of your file system can only contain alphanumeric characters, spaces, and dashes. + - Enter a size for your file system. Billing is based on the size provisioned here, and not actual usage. + +4. Review the estimated cost, then click **Create file system**. + +The **Overview** page of your newly created file system displays. + + +You must [attach, then mount](/file-storage/how-to/attach-mount-file-system/) your file system to an Instance before using it. + diff --git a/pages/file-storage/how-to/detach-file-system.mdx b/pages/file-storage/how-to/detach-file-system.mdx new file mode 100644 index 0000000000..ab604b9ea9 --- /dev/null +++ b/pages/file-storage/how-to/detach-file-system.mdx @@ -0,0 +1,29 @@ +--- +title: How to detach a file system from a Scaleway Instance +description: This page explains how to detach a File Storage file system from Scaleway Instances +tags: detach instance server fs filesystem file storage resource +categories: + - storage + - file-storage +dates: + validation: 2025-07-23 + posted: 2025-07-23 +--- + +## How to detach a file system from an instance + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to detach. The **Overview** page displays. + +3. Open the **Attached Instances** tab. A list of Instances attached to the selected file system displays. + +4. Click the icon next to the Instance you want to detach, then click **Detach** from the drop-down menu. A confirmation pop-up appears. + +5. Click **Detach Instance** to confirm your action. + +Your Instance is now detached, and no longer appears in the list. + + +To detach multiple Instances at once, tick the boxes next to the name of Instances you want to detach, then click at the bottom of the page, and click **Detach** from the drop-down menu. + \ No newline at end of file diff --git a/pages/file-storage/how-to/index.mdx b/pages/file-storage/how-to/index.mdx new file mode 100644 index 0000000000..5d4de053f6 --- /dev/null +++ b/pages/file-storage/how-to/index.mdx @@ -0,0 +1,4 @@ +--- +title: File Storage - How Tos +description: File Storage How Tos +--- diff --git a/pages/file-storage/how-to/manage-delete-file-system.mdx b/pages/file-storage/how-to/manage-delete-file-system.mdx new file mode 100644 index 0000000000..541b9f3b9b --- /dev/null +++ b/pages/file-storage/how-to/manage-delete-file-system.mdx @@ -0,0 +1,49 @@ +--- +title: How to manage and delete a file system +description: This page explains how to manage and delete a File Storage file system using the Scaleway console. +tags: manage settings parameters delete suppress cancel remove fs filesystem file storage resource +categories: + - storage + - file-storage +dates: + validation: 2025-07-23 + posted: 2025-07-23 +--- + +import Requirements from '@macros/iam/requirements.mdx' + +This page explains how to manage and delete a file system. + + + +- 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 +- [Created a file system](/file-system/how-to/create-file-system/) + +## How to manage a file system + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to manage. The **Overview** page displays. + +3. From this page, you can: + - Resize your file system + - Attach your file system to one or several Instance(s) + - Retrieve the command to mount your file system to your Instance(s) + - Delete your file system + +## How to delete a file system + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to delete. The **Overview** page displays. + +3. Click **Delete file system** at the bottom of the page. A confirmation pop-up displays. + +4. Type **DELETE** to confirm your action. + +5. Click **Delete file system** to confirm. + + + You can also delete a file system by clicking next to its name, then **Delete**. + diff --git a/pages/file-storage/how-to/mount-file-system.mdx b/pages/file-storage/how-to/mount-file-system.mdx new file mode 100644 index 0000000000..2650817114 --- /dev/null +++ b/pages/file-storage/how-to/mount-file-system.mdx @@ -0,0 +1,46 @@ +--- +title: How to mount a file system to a Scaleway Instance +description: This page explains how to mount a File Storage file system to one or several Scaleway Instances using the Scaleway console +categories: + - storage + - file-storage +tags: mount instance server fs filesystem file storage resource +dates: + validation: 2025-07-23 + posted: 2025-07-23 +--- + +import Requirements from '@macros/iam/requirements.mdx' + +This page explains how to mount a file system to one or several Scaleway Instances. + + + +- 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 +- [Created a file system](/file-system/how-to/create-file-system/) +- [Attached](/file-storage/how-to/attach-file-system/) a file system to one or several Instances + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to mount. The **Overview** page displays. + +3. From the **Mount** section of the **Overview** page, copy the mounting command: + + ```sh + mount -t virtiofs /mnt + ``` + +4. Open a terminal and [connect via SSH to the Instances](/instances/how-to/connect-to-instance/) you have [attached to your file system](/file-storage/how-to/attach-file-system/). + +5. Run the previously copied mount command to mount your file system at the specified mount point (`/mnt` by default): + + ```sh + mount -t virtiofs /mnt + ``` + + + You can specify a different mount point by replacing `/mnt` by the desired directory. + + +Your file system is now mounted and accessible from the specified mount point in your Instance. diff --git a/pages/file-storage/how-to/resize-file-system.mdx b/pages/file-storage/how-to/resize-file-system.mdx new file mode 100644 index 0000000000..d1efd811f8 --- /dev/null +++ b/pages/file-storage/how-to/resize-file-system.mdx @@ -0,0 +1,44 @@ +--- +title: How to resize a file system +description: This page explains how to resize a File Storage file system using the Scaleway console +tags: resize reduce increase size augment bigger smaller fs filesystem file storage disk space +categories: + - storage + - file-storage +dates: + validation: 2025-07-23 + posted: 2025-07-23 +--- + +This page explains how to resize a file system using the Scaleway console. + +import Requirements from '@macros/iam/requirements.mdx' + + + +- 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 +- [Created a file system](/file-system/how-to/create-file-system/) + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to resize. The **Overview** page displays. + +3. Click the **Resize** button. A pop-up displays. + +4. Enter a new size for your file system. + + - New file system size cannot be inferior to the currently used space. + - File system size must be at least 100 GB. + - File system size can only be resized by increments of 100 GB. + + +5. Review the updated estimated cost. File Storage billing is based on the provisioned file storage size, and not on actual usage. + +6. Click **Resize file system** to confirm. + +Your file system is resized, and its new capacity displays in the **Overview** page. + + +You can also resize a file system from the [File Storage section](https://console.scaleway.com/file-storage/) of the console, by clicking next to its name, and by selecting **Resize** from the drop-down menu. + \ No newline at end of file diff --git a/pages/file-storage/how-to/unmount-file-system.mdx b/pages/file-storage/how-to/unmount-file-system.mdx new file mode 100644 index 0000000000..df8aee23ac --- /dev/null +++ b/pages/file-storage/how-to/unmount-file-system.mdx @@ -0,0 +1,38 @@ +--- +title: How to unmount a file system from a Scaleway Instance +description: This page explains how to unmount a File Storage file system from Scaleway Instances using the Scaleway console +tags: unmount instance server fs filesystem file storage resource +categories: + - storage + - file-storage +dates: + validation: 2025-07-23 + posted: 2025-07-23 +--- + +import Requirements from '@macros/iam/requirements.mdx' + +This page explains how to unmount a file system from one or several Scaleway Instances. + + + +- 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 +- [Created a file system](/file-system/how-to/create-file-system/) +- [Attached](/file-storage/how-to/attach-file-system/) and [mounted](/file-storage/how-to/mount-file-system/) a file system to at least one Scaleway Instance + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to unmount. The **Overview** page displays. + +3. Copy the ID of your file system. + +4. Open a terminal and [connect via SSH to the Instances](/instances/how-to/connect-to-instance/) you previously [attached to your file system](/file-storage/how-to/attach-file-system/). + +5. Run the following command. Make sure to replace the placeholder and mount point with the appropriate values: + + ```sh + unmount /mnt + ``` + +Your file system is now unmounted from the specified Instance. diff --git a/pages/file-storage/index.mdx b/pages/file-storage/index.mdx new file mode 100644 index 0000000000..367174dde8 --- /dev/null +++ b/pages/file-storage/index.mdx @@ -0,0 +1,61 @@ +--- +title: File Storage Documentation +description: Explore Scaleway File Storage with quickstart guides, how-tos, and more. +--- + + + + +## Getting Started + + + + + + + + + + +## Changelog + + diff --git a/pages/file-storage/quickstart.mdx b/pages/file-storage/quickstart.mdx new file mode 100644 index 0000000000..82b039f303 --- /dev/null +++ b/pages/file-storage/quickstart.mdx @@ -0,0 +1,170 @@ +--- +title: File Storage - Quickstart +description: Get started with Scaleway File Storage. This guide covers creating, attaching, and mounting File systems to your Instances for efficient data management. +tags: file storage overview get started +dates: + validation: 2025-07-23 + posted: 2025-07-23 +categories: + - file-storage + - storage +--- +import Requirements from '@macros/iam/requirements.mdx' + +Scaleway File Storage allows you to create file systems to easily share files across multiple Instances within the same region. File systems are network-attached storage structures that can be accessed by Scaleway Instances to easily share files within your cloud infrastructure. + +Each file system can be attached to several Instances, and each Instance can have several file systems attached to it. + +This guide teaches you how to quickly create, attach, mount, unmount, detach, and delete a file system using the Scaleway console. + + + +- 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 + +## How to create a file system + +1. Click **File Storage** in the **Storage** section of the side menu. The [File Storage dashboard](https://console.scaleway.com/file-storage/) displays. + +2. Click **+ Create file system**. The [file system creation page](https://console.scaleway.com//file-storage/file-storage/create) displays. + +3. Complete the following steps: + - Select the region in which your file system will be created. It will be accessible by [Instances](/instances/) within the same [region](/file-storage/concepts/#region). + - Enter a name for your file system, or use the automatically generated one. The name of your file system can only contain alphanumeric characters, spaces, and dashes. + - Configure the provisioned size of your file system. + + File systems are billed based on the provisioned space, and not on actual usage. + + +4. Review the estimated cost. + +5. Click **Create file system**. + +A list of your file systems displays, showing your newly created resource. + +## How to manage a file system + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to manage. The **Overview** page displays. + +3. From this page, you can: + - Resize your file system + - Attach your file system to one or several Instance(s) + - Retrieve the command to mount your file system on your Instance(s) + - Delete your file system + +## How to attach a file system to one or more Instance(s) + + +To attach a file system to an Instance, you must have [created at least one POP2 Instance](/instances/how-to/create-an-instance/) beforehand. File systems can only be attached to POP2 Instances. + + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to attach. The **Overview** page displays. + +3. Open the **Attached Instance(s)** tab. A list of currently attached Instances displays. + +4. Click **Attach an Instance**. A pop-up displays. + +5. Select one Instance or more from the drop-down list, then click **Attach** to confirm. + + + File systems can only be attached to POP2 Instances within the same [region](/file-storage/concepts/#region). + + +Your file system is now attached to the selected Instance(s) and can now be [mounted](/file-storage/how-to/mount-file-system/) to a Scaleway Instance. + +## How to mount a file system to a Scaleway Instance + + +To mount a file system to an Instance, you must have [attached your file system to an Instance](#how-to-attach-a-file-system-to-one-or-more-instance-s) beforehand. File systems can only be attached to POP2 Instances. + + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to mount. The **Overview** page displays. + +3. From the **Mount** section of the **Overview** page, copy the mounting command: + + ```sh + mount -t virtiofs /mnt + ``` + +4. Open a terminal and [connect via SSH to the Instances](/instances/how-to/connect-to-instance/) you previously [attached to your file system](/file-storage/how-to/attach-file-system/). + +5. Run the previously copied mount command to mount your file system at the specified mount point (`/mnt` by default): + + ```sh + mount -t virtiofs /mnt + ``` + + + You can specify a different mount point by replacing `/mnt` by the desired directory. + + +6. Run the following command to display the file systems of your Instance: + + ```sh + df -h + ``` + + A list of your file systems displays, containing the one you just mounted: + + ```sh + Filesystem Size Used Avail Use% Mounted on + tmpfs 794M 992K 793M 1% /run + /dev/sda1 8.0G 2.1G 6.0G 26% / + /dev/sda2 881M 61M 758M 8% /boot + 2933ea63-example-file-system-c05fe2 94G 0 94G 0% /mnt + +Your file system is now mounted and accessible from the specified mount point in your Instance. + +## How to unmount a file system from a Scaleway Instance + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to unmount. The **Overview** page displays. + +3. Copy the ID of your file system. + +4. Open a terminal and [connect via SSH to the Instances](/instances/how-to/connect-to-instance/) you previously [attached to your file system](/file-storage/how-to/attach-file-system/). + +5. Run the following command. Make sure to replace the placeholder and mount point with the appropriate values: + + ```sh + unmount /mnt + ``` + +Your file system is now unmounted from the specified Instance. + +## How to detach a file system from an instance + + +You must [unmount](#how-to-unmount-a-file-system-from-a-scaleway-instance) your file system before detaching Instances from it. + + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to detach. The **Overview** page displays. + +3. Open the **Attached Instances** tab. A list of Instances attached to the selected file system displays. + +4. Click the icon next to the Instance you want to detach, then click **Detach** from the drop-down menu. A confirmation pop-up appears. + +5. Click **Detach Instance** to confirm your action. + +Your Instance is now detached, and no longer appears in the list. + +## How to delete a file system + +1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays. + +2. Click the name of the file system you want to delete. The **Overview** page displays. + +3. Click **Delete file system** at the bottom of the page. A confirmation pop-up displays. + +4. Type **DELETE** to confirm your action. + +5. Click **Delete file system** to confirm. \ No newline at end of file