Skip to content

Commit d546a7b

Browse files
authored
Merge branch 'master' into funcorder
2 parents cc28fd6 + 0b5f7d0 commit d546a7b

26 files changed

+2625
-19
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,6 @@ jobs:
2929
run: |
3030
docker pull squidfunk/mkdocs-material
3131
docker run --rm -i -v ${PWD}/docs:/docs squidfunk/mkdocs-material build
32-
- name: Download and set up AWS CLI
33-
run: |
34-
sudo apt update
35-
sudo apt install curl unzip -y
36-
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64-2.22.20.zip" -o "awscliv2.zip"
37-
unzip awscliv2.zip
38-
./aws/install
3932
4033
- name: Set up AWS credentials
4134
env:
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
List all existing attachments in a specified region.
4+
By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
5+
6+
USAGE:
7+
scw file attachment list [arg=value ...]
8+
9+
ARGS:
10+
[filesystem-id] UUID of the File Storage volume
11+
[resource-id] Filter by resource ID
12+
[resource-type] Filter by resource type (unknown_resource_type | instance_server)
13+
[zone] Filter by resource zone
14+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)
15+
16+
FLAGS:
17+
-h, --help help for list
18+
19+
GLOBAL FLAGS:
20+
-c, --config string The path to the config file
21+
-D, --debug Enable debug mode
22+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
23+
-p, --profile string The config profile to use
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Attachment management.
4+
5+
USAGE:
6+
scw file attachment <command>
7+
8+
AVAILABLE COMMANDS:
9+
list List filesystems attachments
10+
11+
FLAGS:
12+
-h, --help help for attachment
13+
14+
GLOBAL FLAGS:
15+
-c, --config string The path to the config file
16+
-D, --debug Enable debug mode
17+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
18+
-p, --profile string The config profile to use
19+
20+
Use "scw file attachment [command] --help" for more information about a command.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
To create a new filesystem, you must specify a name, a size, and a project ID.
4+
5+
USAGE:
6+
scw file filesystem create [arg=value ...]
7+
8+
ARGS:
9+
name Name of the filesystem
10+
[project-id] Project ID to use. If none is passed the default project ID will be used
11+
size Filesystem size in bytes, with a granularity of 100 GB (10^11 bytes).
12+
[tags.{index}] List of tags assigned to the filesystem
13+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
14+
15+
FLAGS:
16+
-h, --help help for create
17+
18+
GLOBAL FLAGS:
19+
-c, --config string The path to the config file
20+
-D, --debug Enable debug mode
21+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
22+
-p, --profile string The config profile to use
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
You must specify the `filesystem_id` of the filesystem you want to delete.
4+
5+
USAGE:
6+
scw file filesystem delete <filesystem-id ...> [arg=value ...]
7+
8+
ARGS:
9+
filesystem-id UUID of the filesystem
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
11+
12+
FLAGS:
13+
-h, --help help for delete
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Retrieve all properties and current status of a specific filesystem identified by its ID.
4+
5+
USAGE:
6+
scw file filesystem get <filesystem-id ...> [arg=value ...]
7+
8+
ARGS:
9+
filesystem-id UUID of the filesystem
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
11+
12+
FLAGS:
13+
-h, --help help for get
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
4+
5+
USAGE:
6+
scw file filesystem list [arg=value ...]
7+
8+
ARGS:
9+
[order-by] Criteria to use when ordering the list (created_at_asc | created_at_desc | name_asc | name_desc)
10+
[project-id] Filter by project ID
11+
[name] Filter the returned filesystems by their names
12+
[tags.{index}] Filter by tags. Only filesystems with one or more matching tags will be returned
13+
[organization-id] Filter by organization ID
14+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)
15+
16+
FLAGS:
17+
-h, --help help for list
18+
19+
GLOBAL FLAGS:
20+
-c, --config string The path to the config file
21+
-D, --debug Enable debug mode
22+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
23+
-p, --profile string The config profile to use
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Update the technical details of a filesystem, such as its name, tags or its new size.
4+
5+
USAGE:
6+
scw file filesystem update [arg=value ...]
7+
8+
ARGS:
9+
filesystem-id UUID of the filesystem
10+
[name] When defined, is the new name of the filesystem
11+
[size] Optional field for increasing the size of the filesystem (must be larger than the current size)
12+
[tags.{index}] List of tags assigned to the filesystem
13+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
14+
15+
FLAGS:
16+
-h, --help help for update
17+
18+
GLOBAL FLAGS:
19+
-c, --config string The path to the config file
20+
-D, --debug Enable debug mode
21+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
22+
-p, --profile string The config profile to use
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Filesystem management.
4+
5+
USAGE:
6+
scw file filesystem <command>
7+
8+
AVAILABLE COMMANDS:
9+
create Create a new filesystem
10+
delete Delete a detached filesystem
11+
get Get filesystem details
12+
list List all filesystems
13+
update Update filesystem properties
14+
15+
FLAGS:
16+
-h, --help help for filesystem
17+
18+
GLOBAL FLAGS:
19+
-c, --config string The path to the config file
20+
-D, --debug Enable debug mode
21+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
22+
-p, --profile string The config profile to use
23+
24+
Use "scw file filesystem [command] --help" for more information about a command.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
This API allows you to manage your File Storage resources.
4+
5+
USAGE:
6+
scw file <command>
7+
8+
AVAILABLE COMMANDS:
9+
attachment Attachment management
10+
filesystem Filesystem management
11+
12+
FLAGS:
13+
-h, --help help for file
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use
20+
21+
Use "scw file [command] --help" for more information about a command.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
This command starts your default editor to edit a marshaled version of your resource
4+
Default editor will be taken from $VISUAL, then $EDITOR or an editor based on your system
5+
6+
USAGE:
7+
scw vpc-gw pat-rule edit <gateway-id ...> [arg=value ...]
8+
9+
ARGS:
10+
gateway-id ID of the PAT rules' Public Gateway
11+
[mode=yaml] marshaling used when editing data (yaml | json)
12+
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config
13+
14+
FLAGS:
15+
-h, --help help for edit
16+
17+
GLOBAL FLAGS:
18+
-c, --config string The path to the config file
19+
-D, --debug Enable debug mode
20+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
21+
-p, --profile string The config profile to use

cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-usage#01.golden

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ USAGE:
88
AVAILABLE COMMANDS:
99
create-v2 Create a PAT rule
1010
delete-v2 Delete a PAT rule
11+
edit Edit all PAT rules of a Public Gateway
1112
get-v2 Get a PAT rule
1213
list-v2 List PAT rules
1314
set-v2 Set all PAT rules

cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-usage.golden

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ USAGE:
88
AVAILABLE COMMANDS:
99
create-v2 Create a PAT rule
1010
delete-v2 Delete a PAT rule
11+
edit Edit all PAT rules of a Public Gateway
1112
get-v2 Get a PAT rule
1213
list-v2 List PAT rules
1314
set-v2 Set all PAT rules

cmd/scw/testdata/test-main-usage-usage.golden

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ SERVERLESS COMMANDS:
7171

7272
STORAGE COMMANDS:
7373
block This API allows you to manage your Block Storage volumes
74+
file This API allows you to manage your File Storage resources
7475
object Object-storage utils
7576
registry This API allows you to manage your Container Registry resources
7677

commands/commands.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ func GetCommands() *core.Commands {
9090
domain.GetCommands(),
9191
applesilicon.GetCommands(),
9292
flexibleip.GetCommands(),
93+
file.GetCommands(),
9394
container.GetCommands(),
9495
function.GetCommands(),
9596
vpcgw.GetCommands(),
@@ -116,9 +117,8 @@ func GetCommands() *core.Commands {
116117
)
117118

118119
if beta {
119-
commands.MergeAll(
120+
commands.Merge(
120121
dedibox.GetCommands(),
121-
file.GetCommands(),
122122
)
123123
}
124124

docs/commands/file.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ Attachment management.
2020
### List filesystems attachments
2121

2222
List all existing attachments in a specified region.
23-
By default, the attachments listed are ordered by creation date in ascending order.
24-
This can be modified using the `order_by` field.
23+
By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
2524

2625
**Usage:**
2726

@@ -49,7 +48,7 @@ Filesystem management.
4948

5049
### Create a new filesystem
5150

52-
To create a new filesystem, you need to provide a name, a size, and a project ID.
51+
To create a new filesystem, you must specify a name, a size, and a project ID.
5352

5453
**Usage:**
5554

@@ -112,8 +111,7 @@ scw file filesystem get <filesystem-id ...> [arg=value ...]
112111

113112
### List all filesystems
114113

115-
Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
116-
Use the order_by parameter to modify the sorting behavior.
114+
Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
117115

118116
**Usage:**
119117

@@ -128,16 +126,16 @@ scw file filesystem list [arg=value ...]
128126
|------|---|-------------|
129127
| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Criteria to use when ordering the list |
130128
| project-id | | Filter by project ID |
131-
| name | | Filter the return filesystems by their names |
129+
| name | | Filter the returned filesystems by their names |
132130
| tags.{index} | | Filter by tags. Only filesystems with one or more matching tags will be returned |
131+
| organization-id | | Filter by organization ID |
133132
| region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |
134133

135134

136135

137136
### Update filesystem properties
138137

139138
Update the technical details of a filesystem, such as its name, tags or its new size.
140-
You can only resize a filesystem to a larger size.
141139

142140
**Usage:**
143141

docs/commands/vpc-gw.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ This API allows you to manage your Public Gateways.
4141
- [PAT rules management](#pat-rules-management)
4242
- [Create a PAT rule](#create-a-pat-rule)
4343
- [Delete a PAT rule](#delete-a-pat-rule)
44+
- [Edit all PAT rules of a Public Gateway](#edit-all-pat-rules-of-a-public-gateway)
4445
- [Get a PAT rule](#get-a-pat-rule)
4546
- [List PAT rules](#list-pat-rules)
4647
- [Set all PAT rules](#set-all-pat-rules)
@@ -807,6 +808,28 @@ scw vpc-gw pat-rule delete <pat-rule-id ...> [arg=value ...]
807808

808809

809810

811+
### Edit all PAT rules of a Public Gateway
812+
813+
This command starts your default editor to edit a marshaled version of your resource
814+
Default editor will be taken from $VISUAL, then $EDITOR or an editor based on your system
815+
816+
**Usage:**
817+
818+
```
819+
scw vpc-gw pat-rule edit <gateway-id ...> [arg=value ...]
820+
```
821+
822+
823+
**Args:**
824+
825+
| Name | | Description |
826+
|------|---|-------------|
827+
| gateway-id | Required | ID of the PAT rules' Public Gateway |
828+
| mode | Default: `yaml`<br />One of: `yaml`, `json` | marshaling used when editing data |
829+
| zone | Default: `fr-par-1` | Zone to target. If none is passed will use default zone from the config |
830+
831+
832+
810833
### Get a PAT rule
811834

812835
Get a PAT rule, specified by its PAT rule ID. The response object gives full details of the PAT rule, including the Public Gateway it belongs to and the configuration settings in terms of public / private ports, private IP and protocol.

internal/namespaces/instance/v1/custom_server.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -549,6 +549,10 @@ func serverGetBuilder(c *core.Command) *core.Command {
549549
Title: "Warnings",
550550
HideIfEmpty: true,
551551
},
552+
{
553+
FieldName: "Filesystems",
554+
Title: "Server Filesystems",
555+
},
552556
},
553557
}
554558

0 commit comments

Comments
 (0)