Skip to content

Commit bce1268

Browse files
committed
doc: create and update documentation
1 parent 7ff2631 commit bce1268

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

docs/resources/file_filesystem.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
subcategory: "File"
3+
page_title: "Scaleway: scaleway_file_filesystem"
4+
---
5+
6+
# Resource: scaleway_file_filesystem
7+
8+
Creates and manages a Scaleway File Storage (NFS) filesystem in a specific region. A filesystem is a scalable storage resource that can be mounted on Compute instances and is typically used for shared, persistent storage.
9+
10+
This resource allows you to define and manage the size, tags, and region of a filesystem, and track its creation and update timestamps, current status, and number of active attachments.
11+
12+
## Example Usage
13+
14+
### Basic
15+
16+
```terraform
17+
resource scaleway_file_filesystem file {
18+
name = "my-nfs-filesystem"
19+
size = 100000000000 # 100 GB
20+
}
21+
```
22+
23+
## Argument Reference
24+
25+
- `name` - (Optional) The name of the filesystem. If not provided, a random name will be generated.
26+
- `size` - (Required) The size of the filesystem in bytes, with a granularity of 100 GB (10¹¹ bytes).
27+
- Minimum: 100 GB (100000000000 bytes)
28+
- Maximum: 10 TB (10000000000000 bytes)
29+
- `tags` - (Optional) A list of tags associated with the filesystem.
30+
- `region` - (Defaults to [provider](../index.md#region) `region`) The region where the filesystem will be created (e.g., fr-par, nl-ams).
31+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the server is
32+
associated with.
33+
- `organization_id` - (Defaults to [provider](../index.md#organization_id) `organization_id`) The ID of the organization the user is associated with.
34+
35+
## Attribut Reference
36+
37+
The following arguments are supported:
38+
39+
- `id` - The ID of the filesystem.
40+
- `status` - The current status of the filesystem. Possible values include creating, available, etc.
41+
- `number_of_attechments` - The number of active attachments (mounts) on the filesystem.
42+
- `created_at` - The date and time when the File Storage filesystem was created.
43+
- `updated_at` - The date and time of the last update to the File Storage filesystem.
44+
45+
## Import
46+
47+
48+
File Storage filesystems can be imported using the `{region}/{id}`, e.g.
49+
50+
```bash
51+
terraform import scaleway_file_filesystem.main fr-par/11111111-1111-1111-1111-111111111111
52+
```

0 commit comments

Comments
 (0)