Skip to content

Commit 0522f2c

Browse files
SamyOubouaziziManunerda-codesbene2k1
authored
feat(FIL): add file storage documentation MTA-6218 (#5178)
* feat(FIL): add file storage documentation MTA-6218 * feat(FIL): add concepts * feat(FIL): add faq * feat(obj): update * feat(FIL): update * feat(FIL): update * feat(FIL): update * Update concepts.mdx update new frontmatter * Update faq.mdx update new frontmatter * Update attach-mount-file-system.mdx update new frontmatter * Update create-file-system.mdx * fix(fls): update frontmatters * docs(fls): update * docs(fls): update * docs(fls): update * docs(fls): update * docs(fls): update * docs(fls): update * docs(fls): update * Apply suggestions from code review Co-authored-by: Néda <[email protected]> * Apply suggestions from code review Co-authored-by: Benedikt Rollik <[email protected]> * docs(fls): update --------- Co-authored-by: numa <[email protected]> Co-authored-by: Néda <[email protected]> Co-authored-by: Benedikt Rollik <[email protected]>
1 parent ada9c5b commit 0522f2c

13 files changed

+647
-0
lines changed

‎menu/navigation.json‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4956,6 +4956,62 @@
49564956
"label": "Block Storage",
49574957
"slug": "block-storage"
49584958
},
4959+
{
4960+
"items": [
4961+
{
4962+
"label": "Overview",
4963+
"slug": "../file-storage"
4964+
},
4965+
{
4966+
"label": "Concepts",
4967+
"slug": "concepts"
4968+
},
4969+
{
4970+
"label": "Quickstart",
4971+
"slug": "quickstart"
4972+
},
4973+
{
4974+
"label": "FAQ",
4975+
"slug": "faq"
4976+
},
4977+
{
4978+
"items": [
4979+
{
4980+
"label": "Create a file system",
4981+
"slug": "create-file-system"
4982+
},
4983+
{
4984+
"label": "Attach a file system",
4985+
"slug": "attach-file-system"
4986+
},
4987+
{
4988+
"label": "Mount a file system to an Instance",
4989+
"slug": "mount-file-system"
4990+
},
4991+
{
4992+
"label": "Manage and delete a file system",
4993+
"slug": "manage-delete-file-system"
4994+
},
4995+
{
4996+
"label": "Resize a file system",
4997+
"slug": "resize-file-system"
4998+
},
4999+
{
5000+
"label": "Unmount a file system from an Instance",
5001+
"slug": "unmount-file-system"
5002+
},
5003+
{
5004+
"label": "Detach a file system",
5005+
"slug": "detach-file-system"
5006+
}
5007+
],
5008+
"label": "How to",
5009+
"slug": "how-to"
5010+
}
5011+
],
5012+
"label": "File Storage",
5013+
"slug": "file-storage"
5014+
},
49595015
{
49605016
"items": [
49615017
{

‎pages/file-storage/concepts.mdx‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: File Storage - Concepts
3+
description: Explore essential concepts of File Storage.
4+
tags: file storage file system concept glossary terms definitions
5+
dates:
6+
validation: 2025-07-23
7+
posted: 2025-07-23
8+
categories:
9+
- file-storage
10+
- storage
11+
---
12+
13+
import AvailabilityZone from '@macros/concepts/availability-zone.mdx'
14+
import BlockVolumes from '@macros/concepts/block-volumes.mdx'
15+
import Region from '@macros/concepts/region.mdx'
16+
17+
## Attach
18+
19+
Attaching storage to your Scaleway Instance allows you to use additional or shared storage beyond its [Local Storage](/local-storage/).
20+
21+
## Availability Zone
22+
23+
<AvailabilityZone />
24+
25+
## Block volumes
26+
27+
<BlockVolumes />
28+
29+
## File Storage
30+
31+
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.
32+
33+
## File system
34+
35+
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/).
36+
37+
## IOPS
38+
39+
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.
40+
41+
Scaleway File Storage offers two IOPS limits:
42+
43+
- 5 000 IOPS (5K IOPS)
44+
- 15 000 IOPS (15K IOPS)
45+
46+
## Mount
47+
48+
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.
49+
50+
## Region
51+
52+
<Region />

‎pages/file-storage/faq.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: File Storage FAQ
3+
description: Explore Scaleway File Storage with our comprehensive FAQ covering performance, persistence, and more.
4+
dates:
5+
created: 2025-07-23
6+
validation: 2025-07-23
7+
category: storage
8+
productIcon: FileStorageProductIcon
9+
---
10+
11+
## What is Scaleway File Storage?
12+
13+
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.
14+
15+
Refer to the [Quickstart documentation](/file-storage/quickstart/) to get started with Scaleway File Storage.
16+
17+
## How many file systems can I attach to an Instance?
18+
19+
You can attach up to 16 storage resources to a Scaleway Instance, including file systems, Block Storage volumes, and Local Storage volumes.

‎pages/file-storage/how-to/attach-file-system.mdx‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: How to attach a file system to a Scaleway Instance
3+
description: This page explains how to attach a File Storage file system to Scaleway Instances
4+
tags: attach instance server fs filesystem file storage resource
5+
categories:
6+
- storage
7+
- file-storage
8+
dates:
9+
validation: 2025-07-23
10+
posted: 2025-07-23
11+
---
12+
13+
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).
14+
15+
import Requirements from '@macros/iam/requirements.mdx'
16+
17+
<Requirements />
18+
19+
- A Scaleway account logged into the [console](https://console.scaleway.com)
20+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
21+
- [Created a file system](/file-system/how-to/create-file-system/)
22+
- [Created at least one POP2 Instance](/instances/how-to/create-an-instance/)
23+
24+
## How to attach a file system to an Instance
25+
26+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
27+
28+
2. Click the name of the file system you want to attach. The **Overview** page displays.
29+
30+
3. Open the **Attached Instance(s)**. A list of currently attached Instances displays.
31+
32+
4. Click **Attach an Instance**. A pop-up displays.
33+
34+
5. Select one Instance or more from the drop-down list, then click **Attach** to confirm.
35+
36+
<Message type="important">
37+
File systems can only be attached to POP2 Instances within the same [region](/file-storage/concepts/#region).
38+
</Message>
39+
40+
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.
41+

‎pages/file-storage/how-to/create-file-system.mdx‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: How to create a file system
3+
description: This page explains how to create a File Storage file system using the Scaleway console.
4+
tags: create add deploy fs filesystem file storage resource
5+
categories:
6+
- storage
7+
- file-storage
8+
dates:
9+
validation: 2025-07-23
10+
posted: 2025-07-23
11+
---
12+
import Requirements from '@macros/iam/requirements.mdx'
13+
14+
<Requirements />
15+
16+
- A Scaleway account logged into the [console](https://console.scaleway.com)
17+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
18+
19+
This page explains how to create a file system using the Scaleway console.
20+
21+
## How to create a file system
22+
23+
1. Click **File Storage** in the **Storage** section of the side menu. The [File Storage dashboard](https://console.scaleway.com/file-storage/) displays.
24+
25+
2. Click **+ Create file system**. The [file system creation page](https://console.scaleway.com//file-storage/file-storage/create) displays.
26+
27+
3. Complete the following steps:
28+
- 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).
29+
- 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.
30+
- Enter a size for your file system. Billing is based on the size provisioned here, and not actual usage.
31+
32+
4. Review the estimated cost, then click **Create file system**.
33+
34+
The **Overview** page of your newly created file system displays.
35+
36+
<Message type="note">
37+
You must [attach, then mount](/file-storage/how-to/attach-mount-file-system/) your file system to an Instance before using it.
38+
</Message>

‎pages/file-storage/how-to/detach-file-system.mdx‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: How to detach a file system from a Scaleway Instance
3+
description: This page explains how to detach a File Storage file system from Scaleway Instances
4+
tags: detach instance server fs filesystem file storage resource
5+
categories:
6+
- storage
7+
- file-storage
8+
dates:
9+
validation: 2025-07-23
10+
posted: 2025-07-23
11+
---
12+
13+
## How to detach a file system from an instance
14+
15+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
16+
17+
2. Click the name of the file system you want to detach. The **Overview** page displays.
18+
19+
3. Open the **Attached Instances** tab. A list of Instances attached to the selected file system displays.
20+
21+
4. Click the <Icon name="more" /> icon next to the Instance you want to detach, then click **Detach** from the drop-down menu. A confirmation pop-up appears.
22+
23+
5. Click **Detach Instance** to confirm your action.
24+
25+
Your Instance is now detached, and no longer appears in the list.
26+
27+
<Message type="note">
28+
To detach multiple Instances at once, tick the boxes next to the name of Instances you want to detach, then click <Icon name="more" /> at the bottom of the page, and click **Detach** from the drop-down menu.
29+
</Message>

‎pages/file-storage/how-to/index.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: File Storage - How Tos
3+
description: File Storage How Tos
4+
---

‎pages/file-storage/how-to/manage-delete-file-system.mdx‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: How to manage and delete a file system
3+
description: This page explains how to manage and delete a File Storage file system using the Scaleway console.
4+
tags: manage settings parameters delete suppress cancel remove fs filesystem file storage resource
5+
categories:
6+
- storage
7+
- file-storage
8+
dates:
9+
validation: 2025-07-23
10+
posted: 2025-07-23
11+
---
12+
13+
import Requirements from '@macros/iam/requirements.mdx'
14+
15+
This page explains how to manage and delete a file system.
16+
17+
<Requirements />
18+
19+
- A Scaleway account logged into the [console](https://console.scaleway.com)
20+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
21+
- [Created a file system](/file-system/how-to/create-file-system/)
22+
23+
## How to manage a file system
24+
25+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
26+
27+
2. Click the name of the file system you want to manage. The **Overview** page displays.
28+
29+
3. From this page, you can:
30+
- Resize your file system
31+
- Attach your file system to one or several Instance(s)
32+
- Retrieve the command to mount your file system to your Instance(s)
33+
- Delete your file system
34+
35+
## How to delete a file system
36+
37+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
38+
39+
2. Click the name of the file system you want to delete. The **Overview** page displays.
40+
41+
3. Click **Delete file system** at the bottom of the page. A confirmation pop-up displays.
42+
43+
4. Type **DELETE** to confirm your action.
44+
45+
5. Click **Delete file system** to confirm.
46+
47+
<Message type="note">
48+
You can also delete a file system by clicking <Icon name="more" /> next to its name, then **Delete**.
49+
</Message>

‎pages/file-storage/how-to/mount-file-system.mdx‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: How to mount a file system to a Scaleway Instance
3+
description: This page explains how to mount a File Storage file system to one or several Scaleway Instances using the Scaleway console
4+
categories:
5+
- storage
6+
- file-storage
7+
tags: mount instance server fs filesystem file storage resource
8+
dates:
9+
validation: 2025-07-23
10+
posted: 2025-07-23
11+
---
12+
13+
import Requirements from '@macros/iam/requirements.mdx'
14+
15+
This page explains how to mount a file system to one or several Scaleway Instances.
16+
17+
<Requirements />
18+
19+
- A Scaleway account logged into the [console](https://console.scaleway.com)
20+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
21+
- [Created a file system](/file-system/how-to/create-file-system/)
22+
- [Attached](/file-storage/how-to/attach-file-system/) a file system to one or several Instances
23+
24+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
25+
26+
2. Click the name of the file system you want to mount. The **Overview** page displays.
27+
28+
3. From the **Mount** section of the **Overview** page, copy the mounting command:
29+
30+
```sh
31+
mount -t virtiofs <file_system_id> /mnt
32+
```
33+
34+
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/).
35+
36+
5. Run the previously copied mount command to mount your file system at the specified mount point (`/mnt` by default):
37+
38+
```sh
39+
mount -t virtiofs <file_system_id> /mnt
40+
```
41+
42+
<Message type="note">
43+
You can specify a different mount point by replacing `/mnt` by the desired directory.
44+
</Message>
45+
46+
Your file system is now mounted and accessible from the specified mount point in your Instance.

‎pages/file-storage/how-to/resize-file-system.mdx‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: How to resize a file system
3+
description: This page explains how to resize a File Storage file system using the Scaleway console
4+
tags: resize reduce increase size augment bigger smaller fs filesystem file storage disk space
5+
categories:
6+
- storage
7+
- file-storage
8+
dates:
9+
validation: 2025-07-23
10+
posted: 2025-07-23
11+
---
12+
13+
This page explains how to resize a file system using the Scaleway console.
14+
15+
import Requirements from '@macros/iam/requirements.mdx'
16+
17+
<Requirements />
18+
19+
- A Scaleway account logged into the [console](https://console.scaleway.com)
20+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
21+
- [Created a file system](/file-system/how-to/create-file-system/)
22+
23+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
24+
25+
2. Click the name of the file system you want to resize. The **Overview** page displays.
26+
27+
3. Click the **Resize** button. A pop-up displays.
28+
29+
4. Enter a new size for your file system.
30+
<Message type="important">
31+
- New file system size cannot be inferior to the currently used space.
32+
- File system size must be at least 100 GB.
33+
- File system size can only be resized by increments of 100 GB.
34+
</Message>
35+
36+
5. Review the updated estimated cost. File Storage billing is based on the provisioned file storage size, and not on actual usage.
37+
38+
6. Click **Resize file system** to confirm.
39+
40+
Your file system is resized, and its new capacity displays in the **Overview** page.
41+
42+
<Message type="note">
43+
You can also resize a file system from the [File Storage section](https://console.scaleway.com/file-storage/) of the console, by clicking <Icon name="more" /> next to its name, and by selecting **Resize** from the drop-down menu.
44+
</Message>

0 commit comments

Comments
 (0)