Skip to content

Commit 63b020d

Browse files
committed
docs(fls): update
1 parent 801b945 commit 63b020d

File tree

3 files changed

+139
-5
lines changed

3 files changed

+139
-5
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import Requirements from '@macros/iam/requirements.mdx'
1919
- A Scaleway account logged into the [console](https://console.scaleway.com)
2020
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2121
- [Created a file system](/file-system/how-to/create-file-system/)
22-
- Created at least one Instance
22+
- [Created at least one POP2 Instance](/instances/how-to/create-an-instance/)
2323

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

@@ -33,8 +33,9 @@ import Requirements from '@macros/iam/requirements.mdx'
3333

3434
5. Select one Instance or more from the drop-down list, then click **Attach** to confirm.
3535

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

4040
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/detach-file-system.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,16 @@ dates:
1414

1515
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
1616

17-
2. Click the name of the file system you want to detach. The **Overview** page displays.
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/quickstart.mdx

Lines changed: 122 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,125 @@ import Requirements from '@macros/iam/requirements.mdx'
2929
3. Complete the following steps:
3030
- 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).
3131
- 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.
32-
- Configure the provisioned size of your file system.
32+
- Configure the provisioned size of your file system.
33+
<Message type="note">
34+
File systems are billed based on the provisioned space, and not on actual usage.
35+
</Message>
36+
37+
4. Review the estimated cost.
38+
39+
5. Click **Create file system**.
40+
41+
A list of your file systems displays, showing your newly created resource.
42+
43+
## How to manage a file system
44+
45+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
46+
47+
2. Click the name of the file system you want to manage. The **Overview** page displays.
48+
49+
3. From this page, you can:
50+
- Resize your file system
51+
- Attach your file system to one or several Instance(s)
52+
- Retrieve the command to mount your file system on your Instance(s)
53+
- Delete your file system
54+
55+
## How to attach a file system to one or more Instance(s)
56+
57+
<Message type="note">
58+
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.
59+
</Message>
60+
61+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
62+
63+
2. Click the name of the file system you want to attach. The **Overview** page displays.
64+
65+
3. Open the **Attached Instance(s)**. A list of currently attached Instances displays.
66+
67+
4. Click **Attach an Instance**. A pop-up displays.
68+
69+
5. Select one Instance or more from the drop-down list, then click **Attach** to confirm.
70+
71+
<Message type="important">
72+
File systems can only be attached to POP2 Instances within the same [region](/file-storage/concepts/#region).
73+
</Message>
74+
75+
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.``
76+
77+
## How to mount a file system to a Scaleway Instance
78+
79+
<Message type="note">
80+
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.
81+
</Message>
82+
83+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
84+
85+
2. Click the name of the file system you want to mount. The **Overview** page displays.
86+
87+
3. From the **Mount** section of the **Overview** page, copy the mounting command:
88+
89+
```sh
90+
mount -t virtiofs <file_system_id> /mnt
91+
```
92+
93+
4. [Connect to the Instances](/instances/how-to/connect-to-instance/) you previously [attached to your file system](/file-storage/how-to/attach-file-system/).
94+
95+
5. From the terminal logged in to your Instance via SSH, run the previously copied mount command to mount your file system at the specified mount point (`/mnt` by default):
96+
97+
```sh
98+
mount -t virtiofs <file_system_id> /mnt
99+
```
100+
101+
<Message type="note">
102+
You can specify a different mount point by replacing `/mnt` by the desired directory.
103+
</Message>
104+
105+
Your file system is now mounted and accessible from the specified mount point in your Instance.
106+
107+
## How to unmount a file system from a Scaleway Instance
108+
109+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
110+
111+
2. Click the name of the file system you want to unmount. The **Overview** page displays.
112+
113+
3. Copy the ID of your file system.
114+
115+
4. [Connect to the Instances](/instances/how-to/connect-to-instance/) you previously [attached to your file system](/file-storage/how-to/attach-file-system/).
116+
117+
5. From the terminal logged in to your Instance via SSH, run the following command. Make sure to replace the placeholder and mount point with the appropriate values:
118+
119+
```sh
120+
unmount <file_system_id> /mnt
121+
```
122+
123+
Your file system is now unmounted from the specified Instance.
124+
125+
## How to detach a file system from an instance
126+
127+
<Message type="note">
128+
You must [unmount](#how-to-unmount-a-file-system-from-a-scaleway-instance) your file system before detaching Instances from it.
129+
</Message>
130+
131+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
132+
133+
2. Click the name of the file system you want to detach. The **Overview** page displays.
134+
135+
3. Open the **Attached Instances** tab. A list of Instances attached to the selected file system displays.
136+
137+
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.
138+
139+
5. Click **Detach Instance** to confirm your action.
140+
141+
Your Instance is now detached, and no longer appears in the list.
142+
143+
## How to delete a file system
144+
145+
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
146+
147+
2. Click the name of the file system you want to delete. The **Overview** page displays.
148+
149+
3. Click **Delete file system** at the bottom of the page. A confirmation pop-up displays.
150+
151+
4. Type **DELETE** to confirm your action.
152+
153+
5. Click **Delete file system** to confirm.

0 commit comments

Comments
 (0)