Skip to content

feat(FIL): add file storage documentation MTA-6218 #5178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from
48 changes: 48 additions & 0 deletions pages/file-storage/concepts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: File Storage - Concepts
description: Explore essential concepts of File Storage.
tags: file storage file system concept glossary terms definitions
dates:
validation: 2025-06-25
posted: 2025-06-25
categories:
- file-storage
- storage
---

## Attach

Attaching storage to your Scaleway Instance enables you to use additional or shared storage beyond its [Local Storage](/local-storage/).

## Availability Zone

<Macro id="availability-zone" />

## Block volumes

<Macro id="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

<Macro id="region" />
15 changes: 15 additions & 0 deletions pages/file-storage/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: File Storage
description: Explore Scaleway File Storage with our comprehensive FAQ covering performance, persistence, and more.
dates:
created: 2025-06-25
validation: 2025-06-25
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.
40 changes: 40 additions & 0 deletions pages/file-storage/how-to/attach-file-system.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
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-06-24
posted: 2025-06-24
---

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'

<Requirements />

- 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 Instance

## How to attach a file system to one or more Instance(s)

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.

<Message type="note">a
File systems can only be attached to Instances within the same [region](/file-storage/concepts/#region).
</Message>

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.
36 changes: 36 additions & 0 deletions pages/file-storage/how-to/create-file-system.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
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-06-24
posted: 2025-06-24
---
import Requirements from '@macros/iam/requirements.mdx'

<Requirements />

- 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.

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.

<Message type="note">
You must [attach, then mount](/file-storage/how-to/attach-mount-file-system/) your file system to an Instance before using it.
</Message>
17 changes: 17 additions & 0 deletions pages/file-storage/how-to/detach-file-system.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
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-06-24
posted: 2025-06-24
---

## 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.
8 changes: 8 additions & 0 deletions pages/file-storage/how-to/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
meta:
title: File Storage - How Tos
description: File Storage How Tos
content:
h1: File Storage - How Tos
paragraph: File Storage How Tos
---
49 changes: 49 additions & 0 deletions pages/file-storage/how-to/manage-delete-file-system.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: How to manage and delete a file system
description: This page explains how to manage 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-06-24
posted: 2025-06-24
---

import Requirements from '@macros/iam/requirements.mdx'

This page explains how to manage and delete a file system.

<Requirements />

- 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 on 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.

<Message type="note">
You can also delete a file system by clicking <Icon name="more" /> next to its name, then **Delete**.
</Message>
23 changes: 23 additions & 0 deletions pages/file-storage/how-to/unmount-file-system.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
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-06-24
posted: 2025-06-24
---

import Requirements from '@macros/iam/requirements.mdx'

This page explains how to unmount a file system from one or several Scaleway Instances.

<Requirements />

- 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

62 changes: 62 additions & 0 deletions pages/file-storage/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
meta:
title: File Storage Documentation
description: Explore Scaleway File Storage with quickstart guides, how-tos, and more.
---


<ProductHeader
productName="File Storage"
productLogo="fileStorage"
description="File Storage offers fast, reliable, and shareable file systems for Scaleway Instances."
url="/file-storage/quickstart/"
label="File Storage Quickstart"
/>

## Getting Started

<Grid>
<SummaryCard
title="Quickstart"
icon="rocket"
description="Learn to create File Storage volumes, attach, and mount them to a Scaleway Instance in a few easy steps."
label="View Quickstart"
url="/file-storage/quickstart/"
/>
<SummaryCard
title="Concepts"
icon="info"
description="Master core concepts for a deeper understanding of File Storage."
label="View Concepts"
url="/file-storage/concepts/"
/>
<SummaryCard
title="How-Tos"
icon="help-circle-outline"
description="Learn to use File Storage through the Scaleway console."
label="View How-Tos"
url="/file-storage/how-to/"
/>
<SummaryCard
title="Additional Content"
icon="book-open-outline"
description="Go further with detailed, in-depth information on File Storage."
label="View Additional Content"
url="/file-storage/reference-content/"
/>
</Grid>

<ClickableBanner
productLogo="cli"
title="File Storage API"
description="Manage File Storage using the Scaleway API."
url="https://www.scaleway.com/en/developers/api/file/"
label="Go to File Storage API"
/>

## Changelog

<ChangelogList
productName="file-storage"
numberOfChanges={3}
/>
32 changes: 32 additions & 0 deletions pages/file-storage/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
meta:
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.
content:
h1: File Storage - Quickstart
paragraph: Get started with Scaleway File Storage. This guide covers creating, attaching, and mounting File Storagefile systems to your Instances for efficient data management.
tags: file storage overview get started
dates:
validation: 2025-06-24
posted: 2025-06-24
categories:
- file-storage
- storage
---
import Requirements from '@macros/iam/requirements.mdx'

<Requirements />

- 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.
Loading