From 30955b64373f2346d6b0461722cdc3b955e9df43 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Tue, 14 Mar 2023 16:55:38 +0000 Subject: [PATCH] feat: update generated APIs --- ...-usage-account-project-create-usage.golden | 6 +- ...-usage-account-project-delete-usage.golden | 2 +- ...all-usage-account-project-get-usage.golden | 2 +- ...ll-usage-account-project-list-usage.golden | 8 +- ...-usage-account-project-update-usage.golden | 6 +- ...est-all-usage-account-project-usage.golden | 10 +- ...ll-usage-apple-silicon-os-get-usage.golden | 2 +- ...l-usage-apple-silicon-os-list-usage.golden | 6 +- ...e-apple-silicon-server-create-usage.golden | 2 +- ...e-apple-silicon-server-delete-usage.golden | 2 +- ...sage-apple-silicon-server-get-usage.golden | 2 +- ...age-apple-silicon-server-list-usage.golden | 8 +- ...e-apple-silicon-server-reboot-usage.golden | 2 +- ...pple-silicon-server-reinstall-usage.golden | 2 +- ...pple-silicon-server-type-list-usage.golden | 2 +- ...e-apple-silicon-server-update-usage.golden | 2 +- .../test-all-usage-apple-silicon-usage.golden | 2 +- ...t-all-usage-baremetal-bmc-get-usage.golden | 2 +- ...all-usage-baremetal-bmc-start-usage.golden | 8 +- ...-all-usage-baremetal-bmc-stop-usage.golden | 2 +- .../test-all-usage-baremetal-bmc-usage.golden | 10 +- ...all-usage-baremetal-offer-get-usage.golden | 4 +- ...ll-usage-baremetal-offer-list-usage.golden | 4 +- ...est-all-usage-baremetal-offer-usage.golden | 4 +- ...l-usage-baremetal-options-add-usage.golden | 4 +- ...sage-baremetal-options-delete-usage.golden | 2 +- ...l-usage-baremetal-options-get-usage.golden | 4 +- ...-usage-baremetal-options-list-usage.golden | 4 +- ...st-all-usage-baremetal-os-get-usage.golden | 2 +- ...t-all-usage-baremetal-os-list-usage.golden | 4 +- .../test-all-usage-baremetal-os-usage.golden | 4 +- ...baremetal-private-network-add-usage.golden | 4 +- ...emetal-private-network-delete-usage.golden | 4 +- ...aremetal-private-network-list-usage.golden | 12 +- ...baremetal-private-network-set-usage.golden | 4 +- ...age-baremetal-private-network-usage.golden | 14 +- ...usage-baremetal-server-create-usage.golden | 12 +- ...usage-baremetal-server-delete-usage.golden | 4 +- ...ll-usage-baremetal-server-get-usage.golden | 4 +- ...sage-baremetal-server-install-usage.golden | 8 +- ...l-usage-baremetal-server-list-usage.golden | 16 +- ...usage-baremetal-server-reboot-usage.golden | 2 +- ...-usage-baremetal-server-start-usage.golden | 4 +- ...l-usage-baremetal-server-stop-usage.golden | 4 +- ...usage-baremetal-server-update-usage.golden | 6 +- ...st-all-usage-baremetal-server-usage.golden | 18 +- ...usage-baremetal-settings-list-usage.golden | 2 +- ...age-baremetal-settings-update-usage.golden | 2 +- ...-all-usage-baremetal-settings-usage.golden | 2 +- .../test-all-usage-baremetal-usage.golden | 4 +- ...-all-usage-iam-api-key-create-usage.golden | 10 +- ...-all-usage-iam-api-key-delete-usage.golden | 2 +- ...est-all-usage-iam-api-key-get-usage.golden | 2 +- ...st-all-usage-iam-api-key-list-usage.golden | 20 +- ...-all-usage-iam-api-key-update-usage.golden | 4 +- ...-usage-iam-application-create-usage.golden | 6 +- ...-usage-iam-application-delete-usage.golden | 4 +- ...all-usage-iam-application-get-usage.golden | 4 +- ...ll-usage-iam-application-list-usage.golden | 10 +- ...-usage-iam-application-update-usage.golden | 8 +- ...est-all-usage-iam-application-usage.golden | 6 +- ...ll-usage-iam-group-add-member-usage.golden | 4 +- ...st-all-usage-iam-group-create-usage.golden | 4 +- ...st-all-usage-iam-group-delete-usage.golden | 4 +- .../test-all-usage-iam-group-get-usage.golden | 4 +- ...test-all-usage-iam-group-list-usage.golden | 10 +- ...usage-iam-group-remove-member-usage.golden | 4 +- ...st-all-usage-iam-group-update-usage.golden | 6 +- .../test-all-usage-iam-group-usage.golden | 4 +- ...usage-iam-permission-set-list-usage.golden | 2 +- ...t-all-usage-iam-policy-create-usage.golden | 18 +- ...t-all-usage-iam-policy-delete-usage.golden | 2 +- ...test-all-usage-iam-policy-get-usage.golden | 2 +- ...est-all-usage-iam-policy-list-usage.golden | 16 +- ...t-all-usage-iam-policy-update-usage.golden | 14 +- .../test-all-usage-iam-policy-usage.golden | 2 +- .../test-all-usage-iam-rule-list-usage.golden | 2 +- ...est-all-usage-iam-rule-update-usage.golden | 6 +- .../test-all-usage-iam-rule-usage.golden | 4 +- ...-all-usage-iam-ssh-key-create-usage.golden | 4 +- ...-all-usage-iam-ssh-key-delete-usage.golden | 2 +- ...est-all-usage-iam-ssh-key-get-usage.golden | 2 +- ...st-all-usage-iam-ssh-key-list-usage.golden | 10 +- ...-all-usage-iam-ssh-key-update-usage.golden | 2 +- ...est-all-usage-iam-user-delete-usage.golden | 4 +- .../test-all-usage-iam-user-get-usage.golden | 4 +- .../test-all-usage-iam-user-list-usage.golden | 6 +- .../test-all-usage-iam-user-usage.golden | 6 +- ...t-all-usage-tem-domain-create-usage.golden | 3 +- ...test-all-usage-tem-email-list-usage.golden | 1 + .../test-all-usage-vpc-gw-dh-cpusage.golden | 2 +- ...-all-usage-vpc-gw-dhcp-create-usage.golden | 20 +- ...-all-usage-vpc-gw-dhcp-delete-usage.golden | 4 +- ...sage-vpc-gw-dhcp-entry-create-usage.golden | 4 +- ...sage-vpc-gw-dhcp-entry-delete-usage.golden | 4 +- ...l-usage-vpc-gw-dhcp-entry-get-usage.golden | 2 +- ...-usage-vpc-gw-dhcp-entry-list-usage.golden | 12 +- ...l-usage-vpc-gw-dhcp-entry-set-usage.golden | 6 +- ...sage-vpc-gw-dhcp-entry-update-usage.golden | 6 +- ...t-all-usage-vpc-gw-dhcp-entry-usage.golden | 8 +- ...est-all-usage-vpc-gw-dhcp-get-usage.golden | 4 +- ...st-all-usage-vpc-gw-dhcp-list-usage.golden | 10 +- ...-all-usage-vpc-gw-dhcp-update-usage.golden | 22 +- ...l-usage-vpc-gw-gateway-create-usage.golden | 14 +- ...l-usage-vpc-gw-gateway-delete-usage.golden | 4 +- ...-all-usage-vpc-gw-gateway-get-usage.golden | 2 +- ...all-usage-vpc-gw-gateway-list-usage.golden | 16 +- ...vpc-gw-gateway-network-create-usage.golden | 10 +- ...vpc-gw-gateway-network-delete-usage.golden | 6 +- ...ge-vpc-gw-gateway-network-get-usage.golden | 2 +- ...e-vpc-gw-gateway-network-list-usage.golden | 12 +- ...vpc-gw-gateway-network-update-usage.golden | 8 +- ...-usage-vpc-gw-gateway-network-usage.golden | 12 +- ...c-gw-gateway-refresh-ssh-keys-usage.golden | 4 +- ...sage-vpc-gw-gateway-type-list-usage.golden | 2 +- ...all-usage-vpc-gw-gateway-type-usage.golden | 4 +- ...l-usage-vpc-gw-gateway-update-usage.golden | 10 +- ...-usage-vpc-gw-gateway-upgrade-usage.golden | 2 +- ...test-all-usage-vpc-gw-gateway-usage.golden | 16 +- ...st-all-usage-vpc-gw-ip-create-usage.golden | 4 +- ...st-all-usage-vpc-gw-ip-delete-usage.golden | 4 +- .../test-all-usage-vpc-gw-ip-get-usage.golden | 4 +- ...test-all-usage-vpc-gw-ip-list-usage.golden | 12 +- ...st-all-usage-vpc-gw-ip-update-usage.golden | 10 +- .../test-all-usage-vpc-gw-ip-usage.golden | 2 +- ...-usage-vpc-gw-pat-rule-create-usage.golden | 4 +- ...-usage-vpc-gw-pat-rule-delete-usage.golden | 4 +- ...all-usage-vpc-gw-pat-rule-get-usage.golden | 4 +- ...ll-usage-vpc-gw-pat-rule-list-usage.golden | 8 +- ...all-usage-vpc-gw-pat-rule-set-usage.golden | 4 +- ...-usage-vpc-gw-pat-rule-update-usage.golden | 4 +- ...est-all-usage-vpc-gw-pat-rule-usage.golden | 4 +- .../test-all-usage-vpc-gw-usage.golden | 4 +- cmd/scw/testdata/test-main-usage-usage.golden | 4 +- docs/commands/account.md | 44 +-- docs/commands/apple-silicon.md | 32 +- docs/commands/baremetal.md | 220 ++++++------ docs/commands/iam.md | 246 ++++++------- docs/commands/tem.md | 4 +- docs/commands/vpc-gw.md | 336 +++++++++--------- go.mod | 2 +- go.sum | 4 +- internal/namespaces/vpcgw/v1/vpcgw_cli.go | 302 ++++++++-------- 143 files changed, 988 insertions(+), 984 deletions(-) diff --git a/cmd/scw/testdata/test-all-usage-account-project-create-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-create-usage.golden index d000ed69d2..33ca4fd3c9 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-create-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create project. +Generate a new Project for an Organization, specifying its configuration including name and description. USAGE: scw account project create [arg=value ...] ARGS: - [name] The name of the project - [description] The description of the project + [name] Name of the Project + [description] Description of the Project [organization-id] Organization ID to use. If none is passed the default organization ID will be used FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-account-project-delete-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-delete-usage.golden index 13bffbff9e..60ba230c6d 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete project. +Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone. USAGE: scw account project delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-account-project-get-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-get-usage.golden index c63e207218..e32a50be2a 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get project. +Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object. USAGE: scw account project get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-account-project-list-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-list-usage.golden index 0dd6617b70..caeb4ed68d 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-list-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List projects. +List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project. USAGE: scw account project list [arg=value ...] ARGS: - [name] The name of the project - [order-by] The sort order of the returned projects (created_at_asc | created_at_desc | name_asc | name_desc) - [project-ids.{index}] Filter out by a list of project ID + [name] Name of the Project + [order-by] Sort order of the returned Projects (created_at_asc | created_at_desc | name_asc | name_desc) + [project-ids.{index}] Project IDs to filter for. The results will be limited to any Projects with an ID in this array [organization-id] Organization ID to use. If none is passed the default organization ID will be used FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-account-project-update-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-update-usage.golden index 1c279bac6e..c3a6acdd0a 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-update-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update project. +Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description. USAGE: scw account project update [arg=value ...] ARGS: [project-id] Project ID to use. If none is passed the default project ID will be used - [name] The name of the project - [description] The description of the project + [name] Name of the Project + [description] Description of the Project FLAGS: -h, --help help for update diff --git a/cmd/scw/testdata/test-all-usage-account-project-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-usage.golden index 2f0d6a2a41..fb5cde849a 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-usage.golden @@ -6,11 +6,11 @@ USAGE: scw account project AVAILABLE COMMANDS: - create Create project - delete Delete project - get Get project - list List projects - update Update project + create Create a new Project for an Organization + delete Delete an existing Project + get Get an existing Project + list List all Projects of an Organization + update Update Project FLAGS: -h, --help help for project diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-os-get-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-os-get-usage.golden index cbddc61009..070b906ef3 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-os-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-os-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get an Operating System (OS). +Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label. USAGE: scw apple-silicon os get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-os-list-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-os-list-usage.golden index 20e2805df8..782891f300 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-os-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-os-list-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all Operating System (OS). +List all Operating System (OS). The response will include the total number of OS as well as their associated IDs, names and labels. USAGE: scw apple-silicon os list [arg=value ...] ARGS: - [server-type] List of compatible server type - [name] Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12") + [server-type] List of compatible server types + [name] Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")) [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-create-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-create-usage.golden index f22d5bbcea..87750a3378 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a server. +Create a new server in the targeted zone, specifying its configuration including name and type. USAGE: scw apple-silicon server create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-delete-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-delete-usage.golden index 4f4fef3ac8..3fc28af370 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a server. +Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that. USAGE: scw apple-silicon server delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-get-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-get-usage.golden index 31f2f5b0d6..bc8866dfa5 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a server. +Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object. USAGE: scw apple-silicon server get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-list-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-list-usage.golden index 39d3fed8b1..fcbf0fccd7 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-list-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all servers. +List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. USAGE: scw apple-silicon server list [arg=value ...] ARGS: - [order-by] The sort order of the returned servers (created_at_asc | created_at_desc) - [project-id] List only servers of this project ID - [organization-id] List only servers of this organization ID + [order-by] Sort order of the returned servers (created_at_asc | created_at_desc) + [project-id] Only list servers of this project ID + [organization-id] Only list servers of this Organization ID [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-reboot-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-reboot-usage.golden index 89077f2231..eb2a99bec0 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-reboot-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-reboot-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Reboot a server. +Reboot an existing Apple silicon server, specified by its server ID. USAGE: scw apple-silicon server reboot [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-reinstall-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-reinstall-usage.golden index 7ada701b1f..d10b268554 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-reinstall-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-reinstall-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Reinstall a server. +Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS). USAGE: scw apple-silicon server reinstall [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-type-list-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-type-list-usage.golden index 8e52343351..37fbe942a2 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-type-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-type-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all server types technical details. +List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`. USAGE: scw apple-silicon server-type list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-update-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-update-usage.golden index d56f83bcde..752bcc9873 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a server. +Update the parameters of an existing Apple silicon server, specified by its server ID. USAGE: scw apple-silicon server update [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-usage.golden index 7a2fc8ac4e..827c4d0661 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Scaleway Apple silicon M1 as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). +Scaleway Apple silicon as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). These dedicated Mac mini M1s are designed for developing, building, testing, and signing applications for Apple devices, including iPhones, iPads, Mac computers and much more. diff --git a/cmd/scw/testdata/test-all-usage-baremetal-bmc-get-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-bmc-get-usage.golden index 5de14e8cc1..488632dc95 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-bmc-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-bmc-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get the BMC (Baseboard Management Controller) access associated with the given ID. +Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect. USAGE: scw baremetal bmc get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-baremetal-bmc-start-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-bmc-start-usage.golden index 8d8e2fb0e5..5f72b5319f 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-bmc-start-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-bmc-start-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Start BMC (Baseboard Management Controller) access associated with the given ID. +Start BMC (Baseboard Management Controller) access associated with the ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. -You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. - After start BMC, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. +You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. +After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use. USAGE: scw baremetal bmc start [arg=value ...] ARGS: server-id ID of the server - ip The IP authorized to connect to the given server + ip The IP authorized to connect to the server [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-bmc-stop-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-bmc-stop-usage.golden index 5b80504107..657b5713b1 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-bmc-stop-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-bmc-stop-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Stop BMC (Baseboard Management Controller) access associated with the given ID. +Stop BMC (Baseboard Management Controller) access associated with the ID. USAGE: scw baremetal bmc stop [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-baremetal-bmc-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-bmc-usage.golden index 3b614fbe49..0cfd22824d 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-bmc-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-bmc-usage.golden @@ -1,8 +1,8 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. +A Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. For instance, your KVM-IP management console could be accessed with it. -You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. +You need first to create an Remote Access option. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. Then you need to create Remote Access https://developers.scaleway.com/en/products/baremetal/api/#post-1af723. And finally Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. @@ -10,9 +10,9 @@ USAGE: scw baremetal bmc AVAILABLE COMMANDS: - get Get BMC (Baseboard Management Controller) access for a given elastic metal server - start Start BMC (Baseboard Management Controller) access for a given elastic metal server - stop Stop BMC (Baseboard Management Controller) access for a given elastic metal server + get Get BMC access + start Start BMC access + stop Stop BMC access FLAGS: -h, --help help for bmc diff --git a/cmd/scw/testdata/test-all-usage-baremetal-offer-get-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-offer-get-usage.golden index b50bdd686f..138ed2b327 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-offer-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-offer-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Return specific offer for the given ID. +Get details of an offer identified by its offer ID. USAGE: scw baremetal offer get [arg=value ...] EXAMPLES: - Get a server offer with the given ID + Get a server offer with the ID scw baremetal offer get zone=fr-par-1 offer-id=11111111-1111-1111-1111-111111111111 ARGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-offer-list-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-offer-list-usage.golden index 1b006bea7f..d2d5b79d91 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-offer-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-offer-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all available server offers. +List all available Elastic Metal server configurations. USAGE: scw baremetal offer list [arg=value ...] @@ -13,7 +13,7 @@ EXAMPLES: scw baremetal offer list zone=fr-par-1 ARGS: - [subscription-period] Period of subscription to filter offers (unknown_subscription_period | hourly | monthly) + [subscription-period] Subscription period type to filter offers by (unknown_subscription_period | hourly | monthly) [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-offer-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-offer-usage.golden index eebfb497ad..91cda9b120 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-offer-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-offer-usage.golden @@ -1,7 +1,7 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Server offers will answer with all different elastic metal server ranges available in a given zone. -Each of them will contain all the features of the server (cpus, memories, disks) with their associated pricing. +Server offers will answer with all different Elastic Metal server ranges available in a zone. +Each of them will contain all the features of the server (CPUs, memory, disks) with their associated pricing. USAGE: scw baremetal offer diff --git a/cmd/scw/testdata/test-all-usage-baremetal-options-add-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-options-add-usage.golden index 9dcbcdeef9..d9d23da3d8 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-options-add-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-options-add-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Add an option to a specific server. +Add an option, such as Private Networks, to a specific server. USAGE: scw baremetal options add [arg=value ...] EXAMPLES: - Add a given option to a server + Add an option, such as Private Networks, to a server scw baremetal options add server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111 ARGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-options-delete-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-options-delete-usage.golden index 08ac84e850..011caccdb4 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-options-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-options-delete-usage.golden @@ -6,7 +6,7 @@ USAGE: scw baremetal options delete [arg=value ...] EXAMPLES: - Delete a given option from a server + Delete an option from a server scw baremetal options delete server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111 ARGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-options-get-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-options-get-usage.golden index c15a463a18..cadabeda2c 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-options-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-options-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Return specific option for the given ID. +Return specific option for the ID. USAGE: scw baremetal options get [arg=value ...] EXAMPLES: - Get a server option with the given ID + Get a server option with the ID scw baremetal options get zone=fr-par-1 option-id=11111111-1111-1111-1111-111111111111 ARGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-options-list-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-options-list-usage.golden index fe2a2490d2..73ddd5783b 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-options-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-options-list-usage.golden @@ -13,8 +13,8 @@ EXAMPLES: scw baremetal options list zone=fr-par-1 ARGS: - [offer-id] Filter options by offer_id - [name] Filter options by name + [offer-id] Offer ID to filter options for + [name] Name to filter options for [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden index 18e165d64d..819418d6f3 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-os-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Return specific OS for the given ID. +Return specific OS for the ID. USAGE: scw baremetal os get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-baremetal-os-list-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-os-list-usage.golden index 893e8ca90d..28475daab4 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-os-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-os-list-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all available OS that can be install on an elastic metal server. +List all OSes that are available for installation on Elastic Metal servers. USAGE: scw baremetal os list [arg=value ...] ARGS: - [offer-id] Filter OS by offer ID + [offer-id] Offer IDs to filter OSes for [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden index 2aa107b545..0ddace3b44 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-os-usage.golden @@ -6,8 +6,8 @@ USAGE: scw baremetal os AVAILABLE COMMANDS: - get Get an OS with a given ID - list List all available OS that can be install on an elastic metal server + get Get an OS with an ID + list List available OSes FLAGS: -h, --help help for os diff --git a/cmd/scw/testdata/test-all-usage-baremetal-private-network-add-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-private-network-add-usage.golden index ab5aff89b1..53843dc7d4 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-private-network-add-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-private-network-add-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Add a server to a private network. +Add a server to a Private Network. USAGE: scw baremetal private-network add [arg=value ...] ARGS: server-id The ID of the server - private-network-id The ID of the private network + private-network-id The ID of the Private Network [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-private-network-delete-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-private-network-delete-usage.golden index dff147520d..5e22593518 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-private-network-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-private-network-delete-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a private network. +Delete a Private Network. USAGE: scw baremetal private-network delete [arg=value ...] ARGS: server-id The ID of the server - private-network-id The ID of the private network + private-network-id The ID of the Private Network [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-private-network-list-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-private-network-list-usage.golden index fa4c1eb32a..86244d0be9 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-private-network-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-private-network-list-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List the private networks of a server. +List the Private Networks of a server. USAGE: scw baremetal private-network list [arg=value ...] ARGS: - [order-by] The sort order for the returned private networks (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc) - [server-id] Filter private networks by server ID - [private-network-id] Filter private networks by private network ID - [project-id] Filter private networks by project ID - [organization-id] Filter private networks by organization ID + [order-by] The sort order for the returned Private Networks (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc) + [server-id] Filter Private Networks by server ID + [private-network-id] Filter Private Networks by Private Network ID + [project-id] Filter Private Networks by Project ID + [organization-id] Filter Private Networks by Organization ID [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-private-network-set-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-private-network-set-usage.golden index 3eed231053..798f2943c6 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-private-network-set-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-private-network-set-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Set multiple private networks on a server. +Set multiple Private Networks on a server. USAGE: scw baremetal private-network set [arg=value ...] ARGS: server-id The ID of the server - private-network-ids.{index} The IDs of the private networks + private-network-ids.{index} The IDs of the Private Networks [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-private-network-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-private-network-usage.golden index f6b5935b72..bc00da6321 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-private-network-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-private-network-usage.golden @@ -1,22 +1,22 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -A private network allows interconnecting your resources +A Private Network allows you to interconnect your resources (servers, instances, ...) in an isolated and private network. The network reachability is limited to the -resources that are on the same private network. A VLAN +resources that are on the same Private Network . A VLAN interface is available on the server and can be freely managed (adding IP addresses, shutdown interface...). -Note that a resource can be a part of multiple private networks. +Note that a resource can be a part of multiple Private Networks. USAGE: scw baremetal private-network AVAILABLE COMMANDS: - add Add a server to a private network - delete Delete a private network - list List the private networks of a server - set Set multiple private networks on a server + add Add a server to a Private Network + delete Delete a Private Network + list List the Private Networks of a server + set Set multiple Private Networks on a server FLAGS: -h, --help help for private-network diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden index 0a4fb87b78..48d9024663 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a new elastic metal server. Once the server is created, you probably want to install an OS. +Create a new Elastic Metal server. Once the server is created, proceed with the [installation of an OS](#post-3e949e). USAGE: scw baremetal server create [arg=value ...] @@ -12,15 +12,15 @@ EXAMPLES: ARGS: [project-id] Project ID to use. If none is passed the default project ID will be used name= Name of the server (β‰ hostname) - [description] Description associated to the server, max 255 characters + [description] Description associated with the server, max 255 characters [type] Server commercial type [tags.{index}] Tags to associate to the server - [install.os-id] ID of the OS to install on the server + [install.os-id] ID of the OS to installation on the server [install.hostname] Hostname of the server [install.ssh-key-ids.{index}] SSH key IDs authorized on the server - [install.user] User used for the installation - [install.password] Password used for the installation - [install.service-user] User used for the service to install + [install.user] User for the installation + [install.password] Password for the installation + [install.service-user] Regular user that runs the service to be installed on the server [install.service-password] Password used for the service to install [option-ids.{index}] IDs of options to enable on server [organization-id] Organization ID to use. If none is passed the default organization ID will be used diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-delete-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-delete-usage.golden index b362e3572b..67d7edbdb8 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete the server associated with the given ID. +Delete the server associated with the ID. USAGE: scw baremetal server delete [arg=value ...] EXAMPLES: - Delete an elastic metal server + Delete an Elastic Metal server scw baremetal server delete 11111111-1111-1111-1111-111111111111 ARGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-get-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-get-usage.golden index e13f2e8b57..172eefff98 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get the server associated with the given ID. +Get full details of an existing Elastic Metal server associated with the ID. USAGE: scw baremetal server get [arg=value ...] EXAMPLES: - Get a given server + Get a specific server scw baremetal server get 11111111-1111-1111-1111-111111111111 ARGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-install-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-install-usage.golden index 47e60ab285..2696472720 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-install-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-install-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Install an OS on the server associated with the given ID. +Install an Operating System (OS) on the Elastic Metal server with a specific ID. USAGE: scw baremetal server install [arg=value ...] EXAMPLES: - Install an OS on a given server with a particular SSH key ID + Install an OS on a server with a particular SSH key ID scw baremetal server install 11111111-1111-1111-1111-111111111111 os-id=11111111-1111-1111-1111-111111111111 ssh-key-ids.0=11111111-1111-1111-1111-111111111111 ARGS: server-id Server ID to install - os-id ID of the OS to install on the server + os-id ID of the OS to installation on the server hostname Hostname of the server [all-ssh-keys] Add all SSH keys on your baremetal instance (cannot be used with ssh-key-ids) ssh-key-ids.{index} SSH key IDs authorized on the server (cannot be used with all-ssh-keys) @@ -38,5 +38,5 @@ SEE ALSO: # List OS (useful to get all OS IDs) scw baremetal os list - # Create an elastic metal server + # Create an Elastic Metal server scw baremetal server create diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden index 01b8fb856a..5830929aed 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-list-usage.golden @@ -1,22 +1,22 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List elastic metal servers for organization. +List Elastic Metal servers for a specific organization. USAGE: scw baremetal server list [arg=value ...] EXAMPLES: - List all servers on your default zone + List all servers in your default zone scw baremetal server list ARGS: [order-by] Order of the servers (created_at_asc | created_at_desc) - [tags.{index}] Filter by tags - [status.{index}] Filter by status - [name] Filter by name - [project-id] Filter by project ID - [option-id] Filter by option ID - [organization-id] Filter by organization ID + [tags.{index}] Tags to filter for + [status.{index}] Status to filter for + [name] Names to filter for + [project-id] Project ID to filter for + [option-id] Option ID to filter for + [organization-id] Organization ID to filter for [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-reboot-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-reboot-usage.golden index b1db450bf9..35f7fb2738 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-reboot-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-reboot-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Reboot the server associated with the given ID, use boot param to reboot in rescue. +Reboot the Elastic Metal server associated with the ID, use the `boot_type` `rescue` to reboot the server in rescue mode. USAGE: scw baremetal server reboot [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-start-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-start-usage.golden index 7c8c156c49..3792c4bc4e 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-start-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-start-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Start the server associated with the given ID. +Start the server associated with the ID. USAGE: scw baremetal server start [arg=value ...] EXAMPLES: - Start an elastic metal server + Start an Elastic Metalx server scw baremetal server start 11111111-1111-1111-1111-111111111111 Start a server in rescue mode diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-stop-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-stop-usage.golden index 3b56d5121b..bebab979b1 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-stop-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-stop-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Stop the server associated with the given ID. +Stop the server associated with the ID. The server remains allocated to your account and all data remains on the local storage of the server. USAGE: scw baremetal server stop [arg=value ...] EXAMPLES: - Stop an elastic metal server + Stop an Elastic Metal server scw baremetal server stop 11111111-1111-1111-1111-111111111111 ARGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-update-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-update-usage.golden index 67575dd5ff..219cbfa544 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update the server associated with the given ID. +Update the server associated with the ID. You can update parameters such as the server's name, tags and description. Any parameters left null in the request body are not updated. USAGE: scw baremetal server update [arg=value ...] @@ -8,8 +8,8 @@ USAGE: ARGS: server-id ID of the server to update [name] Name of the server (β‰ hostname), not updated if null - [description] Description associated to the server, max 255 characters, not updated if null - [tags.{index}] Tags associated to the server, not updated if null + [description] Description associated with the server, max 255 characters, not updated if null + [tags.{index}] Tags associated with the server, not updated if null [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden index fb85035899..0283e2af72 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-usage.golden @@ -6,15 +6,15 @@ USAGE: scw baremetal server AVAILABLE COMMANDS: - create Create an elastic metal server - delete Delete an elastic metal server - get Get a specific elastic metal server - install Install an elastic metal server - list List elastic metal servers for organization - reboot Reboot an elastic metal server - start Start an elastic metal server - stop Stop an elastic metal server - update Update an elastic metal server + create Create an Elastic Metal server + delete Delete an Elastic Metal server + get Get a specific Elastic Metal server + install Install an Elastic Metal server + list List Elastic Metal servers for an organization + reboot Reboot an Elastic Metal server + start Start an Elastic Metal server + stop Stop an Elastic Metal server + update Update an Elastic Metal server WORKFLOW COMMANDS: wait Wait for a server to reach a stable state (delivery and installation) diff --git a/cmd/scw/testdata/test-all-usage-baremetal-settings-list-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-settings-list-usage.golden index ab21d0a4ed..446f6fe1ff 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-settings-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-settings-list-usage.golden @@ -6,7 +6,7 @@ USAGE: scw baremetal settings list [arg=value ...] ARGS: - [order-by] Order the response (created_at_asc | created_at_desc) + [order-by] Sort order for items in the response (created_at_asc | created_at_desc) project-id ID of the project [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all) diff --git a/cmd/scw/testdata/test-all-usage-baremetal-settings-update-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-settings-update-usage.golden index eef90512c8..ddc0b888a9 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-settings-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-settings-update-usage.golden @@ -7,7 +7,7 @@ USAGE: ARGS: setting-id ID of the setting - [enabled] Enable/Disable the setting + [enabled] Defines whether the setting is enabled [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-baremetal-settings-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-settings-usage.golden index 9c615d666e..dd50124c81 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-settings-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-settings-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Allows to configure the general settings for your elastic metal server. +Allows to configure the general settings for your Elastic Metal server. USAGE: scw baremetal settings diff --git a/cmd/scw/testdata/test-all-usage-baremetal-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-usage.golden index d052421709..5dc1b1e6b8 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -This API allows to manage your Bare metal server. +This API allows to manage your Elastic Metal server. USAGE: scw baremetal @@ -10,7 +10,7 @@ AVAILABLE COMMANDS: offer Server offer management commands options Server options management commands os Operating System (OS) management commands - private-network Private network management command + private-network Private Network management command server Server management commands settings Settings management commands diff --git a/cmd/scw/testdata/test-all-usage-iam-api-key-create-usage.golden b/cmd/scw/testdata/test-all-usage-iam-api-key-create-usage.golden index 2f8b1d87fe..f9ca79e01a 100644 --- a/cmd/scw/testdata/test-all-usage-iam-api-key-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-api-key-create-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create an API key. +Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id` which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that he secret key is only showed once. Make sure that you copy and store both keys somewhere safe. USAGE: scw iam api-key create [arg=value ...] ARGS: - [application-id] ID of application principal - [user-id] ID of user principal + [application-id] ID of the application + [user-id] ID of the user [expires-at] Expiration date of the API key - [default-project-id] The default project ID to use with object storage - [description] The description of the API key (max length is 200 chars) + [default-project-id] The default Project ID to use with Object Storage + [description] The description of the API key (max length is 200 characters) FLAGS: -h, --help help for create diff --git a/cmd/scw/testdata/test-all-usage-iam-api-key-delete-usage.golden b/cmd/scw/testdata/test-all-usage-iam-api-key-delete-usage.golden index 80bc936b66..a4b84d1dac 100644 --- a/cmd/scw/testdata/test-all-usage-iam-api-key-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-api-key-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete an API key. +Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete. USAGE: scw iam api-key delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iam-api-key-get-usage.golden b/cmd/scw/testdata/test-all-usage-iam-api-key-get-usage.golden index e4e199542f..94eb577609 100644 --- a/cmd/scw/testdata/test-all-usage-iam-api-key-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-api-key-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get an API key. +Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation. USAGE: scw iam api-key get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iam-api-key-list-usage.golden b/cmd/scw/testdata/test-all-usage-iam-api-key-list-usage.golden index d36d04675a..da76760858 100644 --- a/cmd/scw/testdata/test-all-usage-iam-api-key-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-api-key-list-usage.golden @@ -1,23 +1,23 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List API keys. +List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`. USAGE: scw iam api-key list [arg=value ...] ARGS: [order-by=created_at_asc] Criteria for sorting results (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | expires_at_asc | expires_at_desc | access_key_asc | access_key_desc) - [editable] Filter out editable API keys or not - [expired] Filter out expired API keys or not - [access-key] Filter out by access key - [description] Filter out by description - [bearer-id] Filter out by bearer ID - [bearer-type] Filter out by type of bearer (unknown_bearer_type | user | application) - organization-id= ID of organization + [editable] Whether to filter out editable API keys or not + [expired] Whether to filter out expired API keys or not + [access-key] Filter by access key + [description] Filter by description + [bearer-id] Filter by bearer ID + [bearer-type] Filter by type of bearer (unknown_bearer_type | user | application) + organization-id= ID of Organization DEPRECATED ARGS: - [application-id] ID of an application bearer - [user-id] ID of a user bearer + [application-id] ID of application that bears the API key + [user-id] ID of user that bears the API key FLAGS: -h, --help help for list diff --git a/cmd/scw/testdata/test-all-usage-iam-api-key-update-usage.golden b/cmd/scw/testdata/test-all-usage-iam-api-key-update-usage.golden index b4a1a9a6a1..96ad5e7d0c 100644 --- a/cmd/scw/testdata/test-all-usage-iam-api-key-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-api-key-update-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update an API key. +Update the parameters of an API key, including `default_project_id` and `description`. USAGE: scw iam api-key update [arg=value ...] ARGS: access-key Access key to update - [default-project-id] The new default project ID to set + [default-project-id] The new default Project ID to set [description] The new description to update FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iam-application-create-usage.golden b/cmd/scw/testdata/test-all-usage-iam-application-create-usage.golden index ac80669596..5c179c758c 100644 --- a/cmd/scw/testdata/test-all-usage-iam-application-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-application-create-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a new application. +Create a new application. You must define the `name` parameter in the request. USAGE: scw iam application create [arg=value ...] ARGS: - name= Name of application to create (max length is 64 chars) - [description] Description of application (max length is 200 chars) + name= Name of the application to create (max length is 64 characters) + [description] Description of the application (max length is 200 characters) [organization-id] Organization ID to use. If none is passed the default organization ID will be used FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iam-application-delete-usage.golden b/cmd/scw/testdata/test-all-usage-iam-application-delete-usage.golden index 6200aecf94..9990c0248d 100644 --- a/cmd/scw/testdata/test-all-usage-iam-application-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-application-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete an application. +Delete an application. Note that this action is irreversible and will automatically delete the application's API keys. Policies attached to users and applications via this group will no longer apply. USAGE: scw iam application delete [arg=value ...] ARGS: - application-id ID of application to delete + application-id ID of the application to delete FLAGS: -h, --help help for delete diff --git a/cmd/scw/testdata/test-all-usage-iam-application-get-usage.golden b/cmd/scw/testdata/test-all-usage-iam-application-get-usage.golden index d37c2a9fdb..8d23933f3e 100644 --- a/cmd/scw/testdata/test-all-usage-iam-application-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-application-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get an existing application. +Retrieve information about an application, specified by the `application_id` parameter. The application's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response. USAGE: scw iam application get [arg=value ...] ARGS: - application-id ID of application to find + application-id ID of the application to find FLAGS: -h, --help help for get diff --git a/cmd/scw/testdata/test-all-usage-iam-application-list-usage.golden b/cmd/scw/testdata/test-all-usage-iam-application-list-usage.golden index 2d49c02457..c1dc73f72d 100644 --- a/cmd/scw/testdata/test-all-usage-iam-application-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-application-list-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List applications of an organization. +List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`. USAGE: scw iam application list [arg=value ...] ARGS: [order-by=created_at_asc] Criteria for sorting results (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc) - [name] Name of application to filter - [editable] Filter out editable applications or not - [application-ids.{index}] Filter out by a list of ID - organization-id= ID of organization to filter + [name] Name of the application to filter + [editable] Whether to filter out editable applications or not + [application-ids.{index}] Filter by list of IDs + organization-id= ID of the Organization to filter FLAGS: -h, --help help for list diff --git a/cmd/scw/testdata/test-all-usage-iam-application-update-usage.golden b/cmd/scw/testdata/test-all-usage-iam-application-update-usage.golden index 75557e4ec7..56a129cc95 100644 --- a/cmd/scw/testdata/test-all-usage-iam-application-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-application-update-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update an existing application. +Update the parameters of an application, including `name` and `description`. USAGE: scw iam application update [arg=value ...] ARGS: - application-id ID of application to update - [name] New name of application (max length is 64 chars) - [description] New description of application (max length is 200 chars) + application-id ID of the application to update + [name] New name for the application (max length is 64 chars) + [description] New description for the application (max length is 200 chars) FLAGS: -h, --help help for update diff --git a/cmd/scw/testdata/test-all-usage-iam-application-usage.golden b/cmd/scw/testdata/test-all-usage-iam-application-usage.golden index cfdf6cf489..ad25a55e3e 100644 --- a/cmd/scw/testdata/test-all-usage-iam-application-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-application-usage.golden @@ -8,9 +8,9 @@ USAGE: AVAILABLE COMMANDS: create Create a new application delete Delete an application - get Get an existing application - list List applications of an organization - update Update an existing application + get Get a given application + list List applications of an Organization + update Update an application FLAGS: -h, --help help for application diff --git a/cmd/scw/testdata/test-all-usage-iam-group-add-member-usage.golden b/cmd/scw/testdata/test-all-usage-iam-group-add-member-usage.golden index 3fd069bb52..4371d1dc8d 100644 --- a/cmd/scw/testdata/test-all-usage-iam-group-add-member-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-group-add-member-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Add a user of an application to a group. +Add a user or an application to a group. You can specify a `user_id` and and `application_id` in the body of your request. Note that you can only add one of each per request. USAGE: scw iam group add-member [arg=value ...] ARGS: - group-id ID of group + group-id ID of the group [user-id] ID of the user to add [application-id] ID of the application to add diff --git a/cmd/scw/testdata/test-all-usage-iam-group-create-usage.golden b/cmd/scw/testdata/test-all-usage-iam-group-create-usage.golden index ebb41d8d55..64c9e993c3 100644 --- a/cmd/scw/testdata/test-all-usage-iam-group-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-group-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a new group. +Create a new group. You must define the `name` and `organization_id` parameters in the request. USAGE: scw iam group create [arg=value ...] @@ -10,7 +10,7 @@ EXAMPLES: scw iam group create name=foobar ARGS: - name= Name of the group to create (max length is 64 chars). MUST be unique inside an organization + name= Name of the group to create (max length is 64 chars). MUST be unique inside an Organization [description] Description of the group to create (max length is 200 chars) [organization-id] Organization ID to use. If none is passed the default organization ID will be used diff --git a/cmd/scw/testdata/test-all-usage-iam-group-delete-usage.golden b/cmd/scw/testdata/test-all-usage-iam-group-delete-usage.golden index fe2f32c785..0ba7042221 100644 --- a/cmd/scw/testdata/test-all-usage-iam-group-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-group-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a group. +Delete a group. Note that this action is irreversible and could delete permissions for group members. Policies attached to users and applications via this group will no longer apply. USAGE: scw iam group delete [arg=value ...] @@ -10,7 +10,7 @@ EXAMPLES: scw iam group delete 11111111-1111-1111-1111-111111111111 ARGS: - group-id ID of group to delete + group-id ID of the group to delete FLAGS: -h, --help help for delete diff --git a/cmd/scw/testdata/test-all-usage-iam-group-get-usage.golden b/cmd/scw/testdata/test-all-usage-iam-group-get-usage.golden index dd9964eb40..626a3455b4 100644 --- a/cmd/scw/testdata/test-all-usage-iam-group-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-group-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a group. +Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response. USAGE: scw iam group get [arg=value ...] ARGS: - group-id ID of group + group-id ID of the group FLAGS: -h, --help help for get diff --git a/cmd/scw/testdata/test-all-usage-iam-group-list-usage.golden b/cmd/scw/testdata/test-all-usage-iam-group-list-usage.golden index 448cc44b55..9acd546555 100644 --- a/cmd/scw/testdata/test-all-usage-iam-group-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-group-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List groups. +List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters to filter your query. Use `user_ids` or `application_ids` to list all groups certain users or applications belong to. USAGE: scw iam group list [arg=value ...] @@ -8,10 +8,10 @@ USAGE: ARGS: [order-by=created_at_asc] Sort order of groups (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc) [name] Name of group to find - [application-ids.{index}] Filter out by a list of application ID - [user-ids.{index}] Filter out by a list of user ID - [group-ids.{index}] Filter out by a list of group ID - [organization-id=] Filter by organization ID + [application-ids.{index}] Filter by a list of application IDs + [user-ids.{index}] Filter by a list of user IDs + [group-ids.{index}] Filter by a list of group IDs + [organization-id=] Filter by Organization ID FLAGS: -h, --help help for list diff --git a/cmd/scw/testdata/test-all-usage-iam-group-remove-member-usage.golden b/cmd/scw/testdata/test-all-usage-iam-group-remove-member-usage.golden index 3c6e4b4306..151c05c46a 100644 --- a/cmd/scw/testdata/test-all-usage-iam-group-remove-member-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-group-remove-member-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Remove a user or an application from a group. +Remove a user or an application from a group. You can specify a `user_id` and and `application_id` in the body of your request. Note that you can only remove one of each per request. Removing a user from a group means that any permissions given to them via the group (i.e. from an attached policy) will no longer apply. Be sure you want to remove these permissions from the user before proceeding. USAGE: scw iam group remove-member [arg=value ...] ARGS: - group-id ID of group + group-id ID of the group [user-id] ID of the user to remove [application-id] ID of the application to remove diff --git a/cmd/scw/testdata/test-all-usage-iam-group-update-usage.golden b/cmd/scw/testdata/test-all-usage-iam-group-update-usage.golden index d5f910787a..e198f86c11 100644 --- a/cmd/scw/testdata/test-all-usage-iam-group-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-group-update-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a group. +Update the parameters of group, including `name` and `description`. USAGE: scw iam group update [arg=value ...] ARGS: - group-id ID of group to update - [name] New name for the group (max length is 64 chars). MUST be unique inside an organization + group-id ID of the group to update + [name] New name for the group (max length is 64 chars). MUST be unique inside an Organization [description] New description for the group (max length is 200 chars) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iam-group-usage.golden b/cmd/scw/testdata/test-all-usage-iam-group-usage.golden index e694ef5c71..76279215b1 100644 --- a/cmd/scw/testdata/test-all-usage-iam-group-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-group-usage.golden @@ -6,8 +6,8 @@ USAGE: scw iam group AVAILABLE COMMANDS: - add-member Add a user of an application to a group - create Create a new group + add-member Add a user or an application to a group + create Create a group delete Delete a group get Get a group list List groups diff --git a/cmd/scw/testdata/test-all-usage-iam-permission-set-list-usage.golden b/cmd/scw/testdata/test-all-usage-iam-permission-set-list-usage.golden index a433300654..61966e7efb 100644 --- a/cmd/scw/testdata/test-all-usage-iam-permission-set-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-permission-set-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List permission sets. +List permission sets available for given Organization. You must define the `organization_id` in the query path of your request. USAGE: scw iam permission-set list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iam-policy-create-usage.golden b/cmd/scw/testdata/test-all-usage-iam-policy-create-usage.golden index 3bdd14acc9..6e4068af22 100644 --- a/cmd/scw/testdata/test-all-usage-iam-policy-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-policy-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a new policy. +Create a new application. You must define the `name` parameter in the request. You can specify parameters such as `user_id`, `groups_id`, `application_id`, `no_principal`, `rules` and its child attributes. USAGE: scw iam policy create [arg=value ...] @@ -10,15 +10,15 @@ EXAMPLES: scw iam policy create group-id=11111111-1111-1111-1111-111111111111 rules.0.organization-id=11111111-1111-1111-1111-111111111111 rules.0.permission-set-names.0=InstanceFullAccess ARGS: - name= Name of policy to create (max length is 64 chars) - [description] Description of policy to create (max length is 200 chars) + name= Name of the policy to create (max length is 64 characters) + [description] Description of the policy to create (max length is 200 characters) [rules.{index}.permission-set-names.{index}] Names of permission sets bound to the rule - [rules.{index}.project-ids.{index}] List of project IDs scoped to the rule - [rules.{index}.organization-id] ID of organization scoped to the rule - [user-id] ID of user, owner of the policy - [group-id] ID of group, owner of the policy - [application-id] ID of application, owner of the policy - [no-principal] True when the policy do not belong to any principal + [rules.{index}.project-ids.{index}] List of Project IDs the rule is scoped to + [rules.{index}.organization-id] ID of Organization the rule is scoped to + [user-id] ID of user attributed to the policy + [group-id] ID of group attributed to the policy + [application-id] ID of application attributed to the policy + [no-principal] Whether or not a policy is attributed to a principal [organization-id] Organization ID to use. If none is passed the default organization ID will be used FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iam-policy-delete-usage.golden b/cmd/scw/testdata/test-all-usage-iam-policy-delete-usage.golden index 5cbea3a638..c24ab57904 100644 --- a/cmd/scw/testdata/test-all-usage-iam-policy-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-policy-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a policy. +Delete a policy. You must define specify the `policy_id` parameter in your request. Note that when deleting a policy, all permissions it gives to its principal (user, group or application) will be revoked. USAGE: scw iam policy delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iam-policy-get-usage.golden b/cmd/scw/testdata/test-all-usage-iam-policy-get-usage.golden index a7e44927ed..2a929574fb 100644 --- a/cmd/scw/testdata/test-all-usage-iam-policy-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-policy-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get an existing policy. +Retrieve information about a policy, speficified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response. USAGE: scw iam policy get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iam-policy-list-usage.golden b/cmd/scw/testdata/test-all-usage-iam-policy-list-usage.golden index 2ca71ee787..51ce1b1138 100644 --- a/cmd/scw/testdata/test-all-usage-iam-policy-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-policy-list-usage.golden @@ -1,19 +1,19 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List policies of an organization. +List the policies of an Organization. By default, the policies listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters to filter your query, such as `user_ids`, `groups_ids`, `application_ids`, and `policy_name`. USAGE: scw iam policy list [arg=value ...] ARGS: [order-by=created_at_asc] Criteria for sorting results (policy_name_asc | policy_name_desc | created_at_asc | created_at_desc) - [editable] Filter out editable policies or not - [user-ids.{index}] Filter out by a list of user ID - [group-ids.{index}] Filter out by a list of group ID - [application-ids.{index}] Filter out by a list of application ID - [no-principal] True when the policy do not belong to any principal - [policy-name] Name of policy to fetch - organization-id= ID of organization to filter + [editable] Whether or not filter out editable policies + [user-ids.{index}] Whether or not to filter by list of user IDs + [group-ids.{index}] Whether or not to filter by list of group IDs + [application-ids.{index}] Filter by a list of application IDs + [no-principal] Whether or not the policy is attributed to a principal + [policy-name] Name of the policy to fetch + organization-id= ID of the Organization to filter FLAGS: -h, --help help for list diff --git a/cmd/scw/testdata/test-all-usage-iam-policy-update-usage.golden b/cmd/scw/testdata/test-all-usage-iam-policy-update-usage.golden index 0fc1704a8e..01981cac02 100644 --- a/cmd/scw/testdata/test-all-usage-iam-policy-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-policy-update-usage.golden @@ -1,18 +1,18 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update an existing policy. +Update the parameters of a policy, including `name`, `description`, `user_id`, `group_id`, `application_id` and `no_principal`. USAGE: scw iam policy update [arg=value ...] ARGS: policy-id Id of policy to update - [name] New name of policy (max length is 64 chars) - [description] New description of policy (max length is 200 chars) - [user-id] New ID of user, owner of the policy - [group-id] New ID of group, owner of the policy - [application-id] New ID of application, owner of the policy - [no-principal] True when the policy do not belong to any principal + [name] New name for the policy (max length is 64 characters) + [description] New description of policy (max length is 200 characters) + [user-id] New ID of user attributed to the policy + [group-id] New ID of group attributed to the policy + [application-id] New ID of application attributed to the policy + [no-principal] Whether or not the policy is attributed to a principal FLAGS: -h, --help help for update diff --git a/cmd/scw/testdata/test-all-usage-iam-policy-usage.golden b/cmd/scw/testdata/test-all-usage-iam-policy-usage.golden index 8f2ab22203..fd96596526 100644 --- a/cmd/scw/testdata/test-all-usage-iam-policy-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-policy-usage.golden @@ -9,7 +9,7 @@ AVAILABLE COMMANDS: create Create a new policy delete Delete a policy get Get an existing policy - list List policies of an organization + list List policies of an Organization update Update an existing policy FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iam-rule-list-usage.golden b/cmd/scw/testdata/test-all-usage-iam-rule-list-usage.golden index cfbbfd9705..ec8ea1f1fe 100644 --- a/cmd/scw/testdata/test-all-usage-iam-rule-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-rule-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List rules of an existing policy. +List the rules of a given policy. By default, the rules listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `policy_id` in the query path of your request. USAGE: scw iam rule list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iam-rule-update-usage.golden b/cmd/scw/testdata/test-all-usage-iam-rule-update-usage.golden index 471498fac9..01e1d55399 100644 --- a/cmd/scw/testdata/test-all-usage-iam-rule-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-rule-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Set rules of an existing policy. +Overwrite the rules of a given policy. Any information that you add using this command will overwrite the previous configuration. If you include some of the rules you already had in your previous configuration in your new one, but you change their order, the new order of display will apply. While policy rules are ordered, they have no impact on the access logic of IAM because rules are allow-only. USAGE: scw iam rule update [arg=value ...] @@ -8,8 +8,8 @@ USAGE: ARGS: policy-id Id of policy to update [rules.{index}.permission-set-names.{index}] Names of permission sets bound to the rule - [rules.{index}.project-ids.{index}] List of project IDs scoped to the rule - [rules.{index}.organization-id] ID of organization scoped to the rule + [rules.{index}.project-ids.{index}] List of Project IDs the rule is scoped to + [rules.{index}.organization-id] ID of Organization the rule is scoped to FLAGS: -h, --help help for update diff --git a/cmd/scw/testdata/test-all-usage-iam-rule-usage.golden b/cmd/scw/testdata/test-all-usage-iam-rule-usage.golden index 19e7e20b40..b44ead2da5 100644 --- a/cmd/scw/testdata/test-all-usage-iam-rule-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-rule-usage.golden @@ -6,8 +6,8 @@ USAGE: scw iam rule AVAILABLE COMMANDS: - list List rules of an existing policy - update Set rules of an existing policy + list List rules of a given policy + update Set rules of a given policy FLAGS: -h, --help help for rule diff --git a/cmd/scw/testdata/test-all-usage-iam-ssh-key-create-usage.golden b/cmd/scw/testdata/test-all-usage-iam-ssh-key-create-usage.golden index 036bddbbab..62b51cfd56 100644 --- a/cmd/scw/testdata/test-all-usage-iam-ssh-key-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-ssh-key-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create an SSH key. +Add a new SSH key to a Scaleway Project. You must specify the `name`, `public_key` and `project_id`. USAGE: scw iam ssh-key create [arg=value ...] @@ -11,7 +11,7 @@ EXAMPLES: ARGS: name= The name of the SSH key. Max length is 1000 - public-key SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000 + public-key SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000 [project-id] Project ID to use. If none is passed the default project ID will be used FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-iam-ssh-key-delete-usage.golden b/cmd/scw/testdata/test-all-usage-iam-ssh-key-delete-usage.golden index 106519a235..4c2d553cef 100644 --- a/cmd/scw/testdata/test-all-usage-iam-ssh-key-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-ssh-key-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete an SSH key. +Delete a given SSH key, specified by the `ssh_key_id`. Deleting an SSH is permanent, and cannot be undone. Note that you might need to update any configurations that used the SSH key. USAGE: scw iam ssh-key delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iam-ssh-key-get-usage.golden b/cmd/scw/testdata/test-all-usage-iam-ssh-key-get-usage.golden index d590f8e110..31012af018 100644 --- a/cmd/scw/testdata/test-all-usage-iam-ssh-key-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-ssh-key-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get an SSH key. +Retrieve information about a given SSH key, specified by the `ssh_key_id` parameter. The SSH key's full details, including `id`, `name`, `public_key`, and `project_id` are returned in the response. USAGE: scw iam ssh-key get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iam-ssh-key-list-usage.golden b/cmd/scw/testdata/test-all-usage-iam-ssh-key-list-usage.golden index 8ebf6ec623..1fd3f42390 100644 --- a/cmd/scw/testdata/test-all-usage-iam-ssh-key-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-ssh-key-list-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List SSH keys. +List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`. USAGE: scw iam ssh-key list [arg=value ...] ARGS: - [order-by=created_at_asc] Sort order of SSH keys (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc) + [order-by=created_at_asc] Sort order of the SSH keys (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc) [name] Name of group to find - [project-id] Filter by project ID - [disabled] Filter out disabled SSH keys or not - [organization-id=] Filter by organization ID + [project-id] Filter by Project ID + [disabled] Whether to include disabled SSH keys or not + [organization-id=] Filter by Organization ID FLAGS: -h, --help help for list diff --git a/cmd/scw/testdata/test-all-usage-iam-ssh-key-update-usage.golden b/cmd/scw/testdata/test-all-usage-iam-ssh-key-update-usage.golden index 9e5e41f9d4..de9658fe5e 100644 --- a/cmd/scw/testdata/test-all-usage-iam-ssh-key-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-ssh-key-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update an SSH key. +Update the parameters of an SSH key, including `name` and `disable`. USAGE: scw iam ssh-key update [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-iam-user-delete-usage.golden b/cmd/scw/testdata/test-all-usage-iam-user-delete-usage.golden index 40a53617a6..72068dc454 100644 --- a/cmd/scw/testdata/test-all-usage-iam-user-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-user-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a guest user from an organization. +Remove a user from an Organization in which they are a guest. You must define the `user_id` in your request. Note that removing a user from an Organization automatically deletes their API keys, and any policies directly attached to them become orphaned. USAGE: scw iam user delete [arg=value ...] ARGS: - user-id ID of user to delete + user-id ID of the user to delete FLAGS: -h, --help help for delete diff --git a/cmd/scw/testdata/test-all-usage-iam-user-get-usage.golden b/cmd/scw/testdata/test-all-usage-iam-user-get-usage.golden index 61505fa634..1a8e39681f 100644 --- a/cmd/scw/testdata/test-all-usage-iam-user-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-user-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Retrieve a user from its ID. +Retrieve information about a user, specified by the `user_id` parameter. The user's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response. USAGE: scw iam user get [arg=value ...] ARGS: - user-id ID of user to find + user-id ID of the user to find FLAGS: -h, --help help for get diff --git a/cmd/scw/testdata/test-all-usage-iam-user-list-usage.golden b/cmd/scw/testdata/test-all-usage-iam-user-list-usage.golden index e8df8d223c..142ba09203 100644 --- a/cmd/scw/testdata/test-all-usage-iam-user-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-user-list-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List users of an organization. +List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`. USAGE: scw iam user list [arg=value ...] ARGS: [order-by=created_at_asc] Criteria for sorting results (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | email_asc | email_desc | last_login_asc | last_login_desc) - [user-ids.{index}] Filter out by a list of ID - organization-id= ID of organization to filter + [user-ids.{index}] Filter by list of IDs + organization-id= ID of the Organization to filter FLAGS: -h, --help help for list diff --git a/cmd/scw/testdata/test-all-usage-iam-user-usage.golden b/cmd/scw/testdata/test-all-usage-iam-user-usage.golden index 3d6bcca258..0e2eccec68 100644 --- a/cmd/scw/testdata/test-all-usage-iam-user-usage.golden +++ b/cmd/scw/testdata/test-all-usage-iam-user-usage.golden @@ -6,9 +6,9 @@ USAGE: scw iam user AVAILABLE COMMANDS: - delete Delete a guest user from an organization - get Retrieve a user from its ID - list List users of an organization + delete Delete a guest user from an Organization + get Get a given user + list List users of an Organization FLAGS: -h, --help help for user diff --git a/cmd/scw/testdata/test-all-usage-tem-domain-create-usage.golden b/cmd/scw/testdata/test-all-usage-tem-domain-create-usage.golden index 2d7751a1b7..0e70ba7d6b 100644 --- a/cmd/scw/testdata/test-all-usage-tem-domain-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-tem-domain-create-usage.golden @@ -7,7 +7,8 @@ USAGE: ARGS: [project-id] Project ID to use. If none is passed the default project ID will be used - [domain-name] + [domain-name] Fully qualified domain dame + [accept-tos] Accept the Scaleway Terms of Service [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-tem-email-list-usage.golden b/cmd/scw/testdata/test-all-usage-tem-email-list-usage.golden index 340ba696ba..16218ff987 100644 --- a/cmd/scw/testdata/test-all-usage-tem-email-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-tem-email-list-usage.golden @@ -14,6 +14,7 @@ ARGS: [mail-from] Optional, list emails sent with this `mail_from` sender's address [mail-to] Optional, list emails sent with this `mail_to` recipient's address [statuses.{index}] Optional, list emails having any of this status (unknown | new | sending | sent | failed | canceled) + [subject] Optional, list emails having this subject [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dh-cpusage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dh-cpusage.golden index e6247b0a73..f71742a48d 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dh-cpusage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dh-cpusage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -DHCP configuration allows you to set parameters for assignment of IP addresses to devices on a Private Network attached to a VPC Public Gateway (subnet, lease time etc). +These objects define a DHCP configuration, i.e. how IP addresses should be assigned to devices on a Private Network attached to a Public Gateway. Definable parameters include the subnet for the DHCP server, the validity period for DHCP entries, whether to use dynamic pooling, and more. A DHCP configuration object has a DHCP ID, which can then be used as part of a call to create or update a Gateway Network. This lets you attach an existing DHCP configuration to a Public Gateway attached to a Private Network. Similarly, you can use a DHCP ID as a query parameter to list Gateway Networks which use this DHCP configuration object. USAGE: scw vpc-gw dhcp diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-create-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-create-usage.golden index d7f8f4402b..a4a1442059 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a DHCP configuration. +Create a new DHCP configuration object, containing settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. The response object includes the ID of the DHCP configuration object. You can use this ID as part of a call to `Create a Public Gateway connection to a Private Network` or `Update a Public Gateway connection to a Private Network` to directly apply this DHCP configuration. USAGE: scw vpc-gw dhcp create [arg=value ...] @@ -8,21 +8,21 @@ USAGE: ARGS: [project-id] Project ID to use. If none is passed the default project ID will be used subnet Subnet for the DHCP server - [address] Address of the DHCP server. This will be the gateway's address in the private network. Defaults to the first address of the subnet - [pool-low] Low IP (included) of the dynamic address pool - [pool-high] High IP (included) of the dynamic address pool - [enable-dynamic] Whether to enable dynamic pooling of IPs + [address] IP address of the DHCP server. This will be the gateway's address in the Private Network. Defaults to the first address of the subnet + [pool-low] Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet. Defaults to the second address of the subnet + [pool-high] High IP (inclusive) of the dynamic address pool. Must be in the config's subnet. Defaults to the last address of the subnet + [enable-dynamic] Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out. Defaults to true [valid-lifetime.seconds] [valid-lifetime.nanos] [renew-timer.seconds] [renew-timer.nanos] [rebind-timer.seconds] [rebind-timer.nanos] - [push-default-route] Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true - [push-dns-server] Whether the gateway should push custom DNS servers to clients - [dns-servers-override.{index}] Override the DNS server list pushed to DHCP clients, instead of the gateway itself - [dns-search.{index}] Additional DNS search paths - [dns-local-name] TLD given to hosts in the Private Network + [push-default-route] Defines whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true + [push-dns-server] Defines whether the gateway should push custom DNS servers to clients. This allows for Instance hostname -> IP resolution. Defaults to true + [dns-servers-override.{index}] Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself + [dns-search.{index}] Array of search paths in addition to the pushed DNS configuration + [dns-local-name] TLD given to hostnames in the Private Network. Allowed characters are `a-z0-9-.`. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to `priv` [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-delete-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-delete-usage.golden index 57938f640c..9d55115655 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a DHCP configuration. +Delete a DHCP configuration object, identified by its DHCP ID. Note that you cannot delete a DHCP configuration object that is currently being used by a Gateway Network. USAGE: scw vpc-gw dhcp delete [arg=value ...] ARGS: - dhcp-id DHCP config id to delete + dhcp-id DHCP configuration ID to delete [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-create-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-create-usage.golden index 71717c03a5..80ddc8d1ab 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a static DHCP reservation. +Create a static DHCP reservation, specifying the Gateway Network for the reservation, the MAC address of the target device and the IP address to assign this device. The response is a DHCP entry object, confirming the ID and configuration details of the static DHCP reservation. USAGE: scw vpc-gw dhcp-entry create [arg=value ...] @@ -8,7 +8,7 @@ USAGE: ARGS: [gateway-network-id] GatewayNetwork on which to create a DHCP reservation [mac-address] MAC address to give a static entry to - [ip-address] IP address to give to the machine + [ip-address] IP address to give to the device [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-delete-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-delete-usage.golden index 5b9f2c3712..447c94af98 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a DHCP reservation. +Delete a static DHCP reservation, identified by its DHCP entry ID. Note that you cannot delete DHCP entries of type `lease`, these are deleted automatically when their time-to-live expires. USAGE: scw vpc-gw dhcp-entry delete [arg=value ...] ARGS: - dhcp-entry-id DHCP entry ID to delete + dhcp-entry-id ID of the DHCP entry to delete [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-get-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-get-usage.golden index 9eb0df1080..c1df7d613a 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get DHCP entries. +Get a DHCP entry, specified by its DHCP entry ID. USAGE: scw vpc-gw dhcp-entry get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-list-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-list-usage.golden index c280eb730d..708e84fd1b 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-list-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List DHCP entries. +List DHCP entries, whether dynamically assigned and/or statically reserved. DHCP entries can be filtered by the Gateway Network they are on, their MAC address, IP address, type or hostname. USAGE: scw vpc-gw dhcp-entry list [arg=value ...] ARGS: [order-by] Order in which to return results (created_at_asc | created_at_desc | ip_address_asc | ip_address_desc | hostname_asc | hostname_desc) - [gateway-network-id] Filter entries based on the gateway network they are on - [mac-address] Filter entries on their MAC address - [ip-address] Filter entries on their IP address - [hostname] Filter entries on their hostname substring - [type] Filter entries on their type (unknown | reservation | lease) + [gateway-network-id] Filter for entries on this GatewayNetwork + [mac-address] Filter for entries with this MAC address + [ip-address] Filter for entries with this IP address + [hostname] Filter for entries with this hostname substring + [type] Filter for entries of this type (unknown | reservation | lease) [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-set-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-set-usage.golden index d0a7e3f29f..f1bc2fd69b 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-set-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-set-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries. +Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries accordingly. USAGE: scw vpc-gw dhcp-entry set [arg=value ...] ARGS: - [gateway-network-id] Gateway Network on which to set DHCP reservation list + [gateway-network-id] ID of the Gateway Network on which to set DHCP reservation list [dhcp-entries.{index}.mac-address] MAC address to give a static entry to - [dhcp-entries.{index}.ip-address] IP address to give to the machine + [dhcp-entries.{index}.ip-address] IP address to give to the device [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-update-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-update-usage.golden index 66cd95ff98..eda3506b45 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-update-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a DHCP entry. +Update the IP address for a DHCP entry, specified by its DHCP entry ID. You can update an existing DHCP entry of any type (`reservation` (static), `lease` (dynamic) or `unknown`), but in manually updating the IP address the entry will necessarily be of type `reservation` after the update. USAGE: scw vpc-gw dhcp-entry update [arg=value ...] ARGS: - dhcp-entry-id DHCP entry ID to update - [ip-address] New IP address to give to the machine + dhcp-entry-id ID of the DHCP entry to update + [ip-address] New IP address to give to the device [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-usage.golden index 95345ab443..5ab4526ac6 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-entry-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -DHCP entries hold both dynamic DHCP leases (IP addresses dynamically assigned by the gateway to instances) and static user-created DHCP reservations. +DHCP entries belong to a specified Gateway Network (Public Gateway / Private Network connection). A DHCP entry can hold either a dynamic DHCP lease (an IP address dynamically assigned by the Public Gateway to a device) or a static, user-created DHCP reservation. USAGE: scw vpc-gw dhcp-entry AVAILABLE COMMANDS: - create Create a static DHCP reservation - delete Delete a DHCP reservation - get Get DHCP entries + create Create a DHCP entry + delete Delete a DHCP entry + get Get a DHCP entry list List DHCP entries set Set all DHCP reservations on a Gateway Network update Update a DHCP entry diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-get-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-get-usage.golden index e8a6b0b090..f940d4a121 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a DHCP configuration. +Get a DHCP configuration object, identified by its DHCP ID. The response object contains configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID. USAGE: scw vpc-gw dhcp get [arg=value ...] ARGS: - dhcp-id ID of the DHCP config to fetch + dhcp-id ID of the DHCP configuration to fetch [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-list-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-list-usage.golden index 413c583ef8..ee4cbe6d5a 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-list-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List DHCP configurations. +List DHCP configurations, optionally filtering by Organization, Project, Public Gateway IP address or more. The response is an array of DHCP configuration objects, each identified by a DHCP ID and containing configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID. USAGE: scw vpc-gw dhcp list [arg=value ...] ARGS: [order-by] Order in which to return results (created_at_asc | created_at_desc | subnet_asc | subnet_desc) - [project-id] Include only DHCPs in this project - [address] Filter on gateway address - [has-address] Filter on subnets containing address - [organization-id] Include only DHCPs in this organization + [project-id] Include only DHCP configuration objects in this Project + [address] Filter for DHCP configuration objects with this DHCP server IP address (the gateway's address in the Private Network) + [has-address] Filter for DHCP configuration objects with subnets containing this IP address + [organization-id] Include only DHCP configuration objects in this Organization [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-update-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-update-usage.golden index 5c78df5d16..2e0c607774 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-dhcp-update-usage.golden @@ -1,28 +1,28 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a DHCP configuration. +Update a DHCP configuration object, identified by its DHCP ID. USAGE: scw vpc-gw dhcp update [arg=value ...] ARGS: - dhcp-id DHCP config to update + dhcp-id DHCP configuration to update [subnet] Subnet for the DHCP server - [address] Address of the DHCP server. This will be the gateway's address in the private network - [pool-low] Low IP (included) of the dynamic address pool - [pool-high] High IP (included) of the dynamic address pool - [enable-dynamic] Whether to enable dynamic pooling of IPs + [address] IP address of the DHCP server. This will be the Public Gateway's address in the Private Network. It must be part of config's subnet + [pool-low] Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet + [pool-high] High IP (inclusive) of the dynamic address pool. Must be in the config's subnet + [enable-dynamic] Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out. Defaults to true [valid-lifetime.seconds] [valid-lifetime.nanos] [renew-timer.seconds] [renew-timer.nanos] [rebind-timer.seconds] [rebind-timer.nanos] - [push-default-route] Whether the gateway should push a default route to DHCP clients or only hand out IPs - [push-dns-server] Whether the gateway should push custom DNS servers to clients - [dns-servers-override.{index}] Override the DNS server list pushed to DHCP clients, instead of the gateway itself - [dns-search.{index}] Additional DNS search paths - [dns-local-name] TLD given to hosts in the Private Network + [push-default-route] Defines whether the gateway should push a default route to DHCP clients, or only hand out IPs + [push-dns-server] Defines whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution + [dns-servers-override.{index}] Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself + [dns-search.{index}] Array of search paths in addition to the pushed DNS configuration + [dns-local-name] TLD given to hostnames in the Private Networks. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. Allowed characters are `a-z0-9-.` [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-create-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-create-usage.golden index 17e0dae00a..0d22e668e3 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-create-usage.golden @@ -1,19 +1,19 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a VPC Public Gateway. +Create a new Public Gateway in the specified Scaleway Project, defining its **name**, **type** and other configuration details such as whether to enable SSH bastion. USAGE: scw vpc-gw gateway create [arg=value ...] ARGS: [project-id] Project ID to use. If none is passed the default project ID will be used - [name=] Name of the gateway + [name=] Name for the gateway [tags.{index}] Tags for the gateway - [type=VPC-GW-S] Gateway type - [upstream-dns-servers.{index}] Override the gateway's default recursive DNS servers, if DNS features are enabled - [ip-id] Attach an existing IP to the gateway - [enable-smtp] Allow SMTP traffic to pass through the gateway - [enable-bastion] Enable SSH bastion on the gateway + [type=VPC-GW-S] Gateway type (commercial offer type) + [upstream-dns-servers.{index}] Array of DNS server IP addresses to override the gateway's default recursive DNS servers + [ip-id] Existing IP address to attach to the gateway + [enable-smtp] Defines whether SMTP traffic should be allowed pass through the gateway + [enable-bastion] Defines whether SSH bastion should be enabled the gateway [bastion-port] Port of the SSH bastion [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-delete-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-delete-usage.golden index af4033ee83..2bc87ae91a 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-delete-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a VPC Public Gateway. +Delete an existing Public Gateway, specified by its gateway ID. This action is irreversible. USAGE: scw vpc-gw gateway delete [arg=value ...] ARGS: gateway-id ID of the gateway to delete - [cleanup-dhcp] Whether to cleanup attached DHCP configurations + [cleanup-dhcp] Defines whether to clean up attached DHCP configurations (if any, and if not attached to another Gateway Network) [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-get-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-get-usage.golden index 03cb68f0b4..d9df7f008f 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a VPC Public Gateway. +Get details of a Public Gateway, specified by its gateway ID. The response object contains full details of the gateway, including its **name**, **type**, **status** and more. USAGE: scw vpc-gw gateway get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-list-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-list-usage.golden index 63033f150f..a93398b790 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-list-usage.golden @@ -1,19 +1,19 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List VPC Public Gateways. +List Public Gateways in a given Scaleway Organization or Project. By default, results are displayed in ascending order of creation date. USAGE: scw vpc-gw gateway list [arg=value ...] ARGS: [order-by] Order in which to return results (created_at_asc | created_at_desc | name_asc | name_desc | type_asc | type_desc | status_asc | status_desc) - [project-id] Include only gateways in this project - [name] Filter gateways including this name - [tags.{index}] Filter gateways with these tags - [type] Filter gateways of this type - [status] Filter gateways in this status (unknown for any) (unknown | stopped | allocating | configuring | running | stopping | failed | deleting | deleted | locked) - [private-network-id] Filter gateways attached to this private network - [organization-id] Include only gateways in this organization + [project-id] Include only gateways in this Project + [name] Filter for gateways which have this search term in their name + [tags.{index}] Filter for gateways with these tags + [type] Filter for gateways of this type + [status] Filter for gateways with this current status. Use `unknown` to include all statuses (unknown | stopped | allocating | configuring | running | stopping | failed | deleting | deleted | locked) + [private-network-id] Filter for gateways attached to this Private nNetwork + [organization-id] Include only gateways in this Organization [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-create-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-create-usage.golden index 093c7ec1cf..e283016a68 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-create-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Attach a gateway to a Private Network. +Attach a specific Public Gateway to a specific Private Network (create a GatewayNetwork). You can configure parameters for the connection including DHCP settings, whether to enable masquerade (dynamic NAT), and more. USAGE: scw vpc-gw gateway-network create [arg=value ...] ARGS: - [gateway-id] Gateway to connect + [gateway-id] Public Gateway to connect [private-network-id] Private Network to connect - [enable-masquerade] Whether to enable masquerade on this network - [dhcp-id] Existing configuration + [enable-masquerade] Defines whether to enable masquerade (dynamic NAT) on this network + [dhcp-id] ID of an existing DHCP configuration object to use for this GatewayNetwork [address] Static IP address in CIDR format to to use without DHCP - [enable-dhcp] Whether to enable DHCP on this Private Network + [enable-dhcp] Defines whether to enable DHCP on this Private Network. Defaults to `true` if either `dhcp_id` or `dhcp` are present. If set to `true`, either `dhcp_id` or `dhcp` must be present [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-delete-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-delete-usage.golden index 5fb5648b5b..ee4cd33679 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-delete-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Detach a gateway from a Private Network. +Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id. USAGE: scw vpc-gw gateway-network delete [arg=value ...] ARGS: - gateway-network-id GatewayNetwork to delete - [cleanup-dhcp] Whether to cleanup the attached DHCP configuration + gateway-network-id ID of the GatewayNetwork to delete + [cleanup-dhcp] Defines whether to clean up attached DHCP configurations (if any, and if not attached to another Gateway Network) [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-get-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-get-usage.golden index 5fcd320575..d7a654ed39 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a gateway connection to a Private Network. +Get details of a given connection between a Public Gateway and a Private Network (this connection = a GatewayNetwork), specified by its `gateway_network_id`. The response object contains details of the connection including the IDs of the Public Gateway and Private Network, the dates the connection was created/updated and its configuration settings. USAGE: scw vpc-gw gateway-network get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-list-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-list-usage.golden index bedcccb2a3..8d47cab0cd 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-list-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List gateway connections to Private Networks. +List the connections between Public Gateways and Private Networks (a connection = a GatewayNetwork). You can choose to filter by `gateway-id` to list all Private Networks attached to the specified Public Gateway, or by `private_network_id` to list all Public Gateways attached to the specified Private Network. Other query parameters are also available. The result is an array of GatewayNetwork objects, each giving details of the connection between a given Public Gateway and a given Private Network. USAGE: scw vpc-gw gateway-network list [arg=value ...] ARGS: [order-by] Order in which to return results (created_at_asc | created_at_desc | status_asc | status_desc) - [gateway-id] Filter by gateway - [private-network-id] Filter by private network - [enable-masquerade] Filter by masquerade enablement - [dhcp-id] Filter by DHCP configuration - [status] Filter GatewayNetworks by this status (unknown for any) (unknown | created | attaching | configuring | ready | detaching | deleted) + [gateway-id] Filter for GatewayNetworks connected to this gateway + [private-network-id] Filter for GatewayNetworks connected to this Private Network + [enable-masquerade] Filter for GatewayNetworks with this `enable_masquerade` setting + [dhcp-id] Filter for GatewayNetworks using this DHCP configuration + [status] Filter for GatewayNetworks with this current status this status. Use `unknown` to include all statuses (unknown | created | attaching | configuring | ready | detaching | deleted) [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-update-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-update-usage.golden index 93c901a773..46e0d9a70a 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-update-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a gateway connection to a Private Network. +Update the configuration parameters of a connection between a given Public Gateway and Private Network (the connection = a GatewayNetwork). Updatable parameters include DHCP settings and whether to enable traffic masquerade (dynamic NAT). USAGE: scw vpc-gw gateway-network update [arg=value ...] ARGS: gateway-network-id ID of the GatewayNetwork to update - [enable-masquerade] New masquerade enablement - [dhcp-id] New DHCP configuration - [enable-dhcp] Whether to enable DHCP on the connected Private Network + [enable-masquerade] Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork + [dhcp-id] ID of the new DHCP configuration object to use with this GatewayNetwork + [enable-dhcp] Defines whether to enable DHCP on the connected Private Network [address] New static IP address [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-usage.golden index 310ede6ae6..992d88bd96 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-network-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -A Gateway Network represents the connection of a Private Network to a VPC Public Gateway. It holds configuration options relative to this specific connection, such as the DHCP configuration. +A Gateway Network represents the connection of a Private Network to a Public Gateway. It holds configuration options relative to this specific connection, such as the DHCP configuration. USAGE: scw vpc-gw gateway-network AVAILABLE COMMANDS: - create Attach a gateway to a Private Network - delete Detach a gateway from a Private Network - get Get a gateway connection to a Private Network - list List gateway connections to Private Networks - update Update a gateway connection to a Private Network + create Attach a Public Gateway to a Private Network + delete Detach a Public Gateway from a Private Network + get Get a Public Gateway connection to a Private Network + list List Public Gateway connections to Private Networks + update Update a Public Gateway's connection to a Private Network FLAGS: -h, --help help for gateway-network diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-refresh-ssh-keys-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-refresh-ssh-keys-usage.golden index 75985416c5..4441107bb7 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-refresh-ssh-keys-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-refresh-ssh-keys-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Refresh SSH keys of a VPC Public Gateway. +Refresh the SSH keys of a given Public Gateway, specified by its gateway ID. This adds any new SSH keys in the gateway's Scaleway Project to the gateway itself. USAGE: scw vpc-gw gateway refresh-ssh-keys [arg=value ...] ARGS: - gateway-id ID of the gateway that needs fresh ssh keys + gateway-id ID of the gateway to refresh SSH keys on [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-type-list-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-type-list-usage.golden index 1941d32e6d..77584a718f 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-type-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-type-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List VPC Public Gateway types. +List the different Public Gateway commercial offer types available at Scaleway. The response is an array of objects describing the name and technical details of each available gateway type. USAGE: scw vpc-gw gateway-type list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-type-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-type-usage.golden index 393b71088f..2fccb628db 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-type-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-type-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Gateways come in multiple shapes and size, which are described by the various gateway types. +Public Gateways come in various shapes, sizes and prices, which are described by gateway types. They represent the different commercial offer types for Public Gateways available at Scaleway. USAGE: scw vpc-gw gateway-type AVAILABLE COMMANDS: - list List VPC Public Gateway types + list List Public Gateway types FLAGS: -h, --help help for gateway-type diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-update-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-update-usage.golden index eb37361482..a924c2ab3c 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-update-usage.golden @@ -1,18 +1,18 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a VPC Public Gateway. +Update the parameters of an existing Public Gateway, for example, its **name**, **tags**, **SSH bastion configuration**, and **DNS servers**. USAGE: scw vpc-gw gateway update [arg=value ...] ARGS: gateway-id ID of the gateway to update - [name] Name fo the gateway + [name] Name for the gateway [tags.{index}] Tags for the gateway - [upstream-dns-servers.{index}] Override the gateway's default recursive DNS servers, if DNS features are enabled - [enable-bastion] Enable SSH bastion on the gateway + [upstream-dns-servers.{index}] Array of DNS server IP addresses to override the gateway's default recursive DNS servers + [enable-bastion] Defines whether SSH bastion should be enabled the gateway [bastion-port] Port of the SSH bastion - [enable-smtp] Allow SMTP traffic to pass through the gateway + [enable-smtp] Defines whether SMTP traffic should be allowed to pass through the gateway [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-upgrade-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-upgrade-usage.golden index 32127d257e..b7e49cb71e 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-upgrade-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-upgrade-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Upgrade a VPC Public Gateway to the latest version. +Upgrade a given Public Gateway to the newest software version. This applies the latest bugfixes and features to your Public Gateway, but its service will be interrupted during the update. USAGE: scw vpc-gw gateway upgrade [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-usage.golden index 974423b9d9..fecac90296 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-gateway-usage.golden @@ -1,18 +1,18 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -The VPC Public Gateway is a building block for your infrastructure on Scaleway's shared public cloud. It provides a set of managed network services and features for Scaleway's Private Networks such as DHCP, NAT and routing. +Public Gateways are building blocks for your infrastructure on Scaleway's shared public cloud. They provide a set of managed network services and features for Scaleway's Private Networks such as DHCP, NAT and routing. USAGE: scw vpc-gw gateway AVAILABLE COMMANDS: - create Create a VPC Public Gateway - delete Delete a VPC Public Gateway - get Get a VPC Public Gateway - list List VPC Public Gateways - refresh-ssh-keys Refresh SSH keys of a VPC Public Gateway - update Update a VPC Public Gateway - upgrade Upgrade a VPC Public Gateway to the latest version + create Create a Public Gateway + delete Delete a Public Gateway + get Get a Public Gateway + list List Public Gateways + refresh-ssh-keys Refresh a Public Gateway's SSH keys + update Update a Public Gateway + upgrade Upgrade a Public Gateway to the latest version FLAGS: -h, --help help for gateway diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-create-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-create-usage.golden index 8b98158b59..a1d78b179c 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-create-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Reserve an IP. +Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project. USAGE: scw vpc-gw ip create [arg=value ...] ARGS: [project-id] Project ID to use. If none is passed the default project ID will be used - [tags.{index}] Tags to give to the IP + [tags.{index}] Tags to give to the IP address [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-delete-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-delete-usage.golden index cd338fa22d..3491926756 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete an IP. +Delete a flexible IP address from your account. This action is irreversible. USAGE: scw vpc-gw ip delete [arg=value ...] ARGS: - ip-id ID of the IP to delete + ip-id ID of the IP address to delete [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-get-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-get-usage.golden index 5ec2e7e91b..342fd84dc2 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get an IP. +Get details of a Public Gateway flexible IP address, identified by its IP ID. The response object contains information including which (if any) Public Gateway using this IP address, the reverse and various other metadata. USAGE: scw vpc-gw ip get [arg=value ...] ARGS: - ip-id ID of the IP to get + ip-id ID of the IP address to get [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-list-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-list-usage.golden index b4fe1a6d37..18cca56855 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-list-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List IPs. +List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response. USAGE: scw vpc-gw ip list [arg=value ...] ARGS: [order-by] Order in which to return results (created_at_asc | created_at_desc | ip_asc | ip_desc | reverse_asc | reverse_desc) - [project-id] Include only IPs in this project - [tags.{index}] Filter IPs with these tags - [reverse] Filter by reverse containing this string - [is-free] Filter whether the IP is attached to a gateway or not - [organization-id] Include only IPs in this organization + [project-id] Filter for IP addresses in this Project + [tags.{index}] Filter for IP addresses with these tags + [reverse] Filter for IP addresses that have a reverse containing this string + [is-free] Filter based on whether the IP is attached to a gateway or not + [organization-id] Filter for IP addresses in this Organization [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-update-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-update-usage.golden index 0dfe2694a2..49fd3492bc 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-update-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update an IP. +Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to. USAGE: scw vpc-gw ip update [arg=value ...] ARGS: - ip-id ID of the IP to update - [tags.{index}] Tags to give to the IP - [reverse] Reverse to set on the IP. Empty string to unset - [gateway-id] Gateway to attach the IP to. Empty string to detach + ip-id ID of the IP address to update + [tags.{index}] Tags to give to the IP address + [reverse] Reverse to set on the address. Empty string to unset + [gateway-id] Gateway to attach the IP address to. Empty string to detach [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-usage.golden index 97e2d81ab8..e59c5c4268 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-ip-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-ip-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -A VPC Public Gateway has a public IP address, allowing it to reach the public internet, as well as forward (masquerade) traffic from member instances of attached Private Networks. +Public, flexible IP addresses for Public Gateways, allowing the gateway to reach the public internet, as well as forward (masquerade) traffic from member devices of attached Private Networks. USAGE: scw vpc-gw ip diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-create-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-create-usage.golden index f0b6f60960..168fcc7a16 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-create-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a PAT rule. +Create a new PAT rule on a specified Public Gateway, defining the protocol to use, public port to listen on, and private port / IP address to map to. USAGE: scw vpc-gw pat-rule create [arg=value ...] ARGS: - [gateway-id] Gateway on which to attach the rule to + [gateway-id] ID of the Gateway on which to create the rule [public-port] Public port to listen on [private-ip] Private IP to forward data to [private-port] Private port to translate to diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-delete-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-delete-usage.golden index 6ff36a3647..c4f3a3e35f 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a PAT rule. +Delete a PAT rule, identified by its PAT rule ID. This action is irreversible. USAGE: scw vpc-gw pat-rule delete [arg=value ...] ARGS: - pat-rule-id PAT rule to delete + pat-rule-id ID of the PAT rule to delete [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-get-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-get-usage.golden index 134b659c01..3e461dec15 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a PAT rule. +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. USAGE: scw vpc-gw pat-rule get [arg=value ...] ARGS: - pat-rule-id PAT rule to get + pat-rule-id ID of the PAT rule to get [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-list-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-list-usage.golden index a825fe3047..d0544d6cbf 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-list-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List PAT rules. +List PAT rules. You can filter by gateway ID to list all PAT rules for a particular gateway, or filter for PAT rules targeting a specific IP address or using a specific protocol. USAGE: scw vpc-gw pat-rule list [arg=value ...] ARGS: [order-by] Order in which to return results (created_at_asc | created_at_desc | public_port_asc | public_port_desc) - [gateway-id] Fetch rules for this gateway - [private-ip] Fetch rules targeting this private ip - [protocol] Fetch rules for this protocol (unknown | both | tcp | udp) + [gateway-id] Filter for PAT rules on this Gateway + [private-ip] Filter for PAT rules targeting this private ip + [protocol] Filter for PAT rules with this protocol (unknown | both | tcp | udp) [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-set-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-set-usage.golden index e21d945861..0b2349d6c0 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-set-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-set-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Set the list of PAT rules attached to a Gateway. Rules are identified by their public port and protocol. This will sync the current PAT rule list with the givent list, creating, updating or deleting PAT rules. +Set a definitive list of PAT rules attached to a Public Gateway. Each rule is identified by its public port and protocol. This will sync the current PAT rule list on the gateway with the new list, creating, updating or deleting PAT rules accordingly. USAGE: scw vpc-gw pat-rule set [arg=value ...] ARGS: - [gateway-id] Gateway on which to set the PAT rules + [gateway-id] ID of the gateway on which to set the PAT rules [pat-rules.{index}.public-port] Public port to listen on [pat-rules.{index}.private-ip] Private IP to forward data to [pat-rules.{index}.private-port] Private port to translate to diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-update-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-update-usage.golden index feac085ac2..2b43fcf154 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-update-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a PAT rule. +Update a PAT rule, specified by its PAT rule ID. Configuration settings including private/public port, private IP address and protocol can all be updated. USAGE: scw vpc-gw pat-rule update [arg=value ...] ARGS: - pat-rule-id PAT rule to update + pat-rule-id ID of the PAT rule to update [public-port] Public port to listen on [private-ip] Private IP to forward data to [private-port] Private port to translate to diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-usage.golden index 5a482d645f..240ae10fe9 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-pat-rule-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -PAT (Port Address Translation) rules are global to a gateway. They define the forwarding of a public port to a specific instance on a Private Network. +PAT (Port Address Translation) rules, aka static NAT rules, belong to a specified Public Gateway. They define the forwarding of a public port to a specific device on a Private Network, enabling enables ingress traffic from the public Internet to reach the correct device in the Private Network. USAGE: scw vpc-gw pat-rule @@ -10,7 +10,7 @@ AVAILABLE COMMANDS: delete Delete a PAT rule get Get a PAT rule list List PAT rules - set Set all PAT rules on a Gateway + set Set all PAT rules update Update a PAT rule FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-vpc-gw-usage.golden b/cmd/scw/testdata/test-all-usage-vpc-gw-usage.golden index fba6e1ae30..fcda32c741 100644 --- a/cmd/scw/testdata/test-all-usage-vpc-gw-usage.golden +++ b/cmd/scw/testdata/test-all-usage-vpc-gw-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -VPC Public Gateway API. +Public Gateways API. USAGE: scw vpc-gw @@ -8,7 +8,7 @@ USAGE: AVAILABLE COMMANDS: dhcp DHCP configuration management dhcp-entry DHCP entries management - gateway VPC Public Gateway management + gateway Public Gateway management gateway-network Gateway Networks management gateway-type Gateway types information ip IP address management diff --git a/cmd/scw/testdata/test-main-usage-usage.golden b/cmd/scw/testdata/test-main-usage-usage.golden index 26b7faed33..b2609e679d 100644 --- a/cmd/scw/testdata/test-main-usage-usage.golden +++ b/cmd/scw/testdata/test-main-usage-usage.golden @@ -7,7 +7,7 @@ AVAILABLE COMMANDS: account User related data apple-silicon Apple silicon API autocomplete Autocomplete related commands - baremetal Elastic metal API + baremetal Elastic Metal API cockpit Cockpit API container Container as a Service API dns DNS API @@ -28,7 +28,7 @@ AVAILABLE COMMANDS: secret This API allows you to conveniently store, access and share sensitive data tem Tem vpc VPC API - vpc-gw VPC Public Gateway API + vpc-gw Public Gateways API webhosting Webhosting API CONFIGURATION COMMANDS: diff --git a/docs/commands/account.md b/docs/commands/account.md index 1ceae6b494..df0095feab 100644 --- a/docs/commands/account.md +++ b/docs/commands/account.md @@ -3,11 +3,11 @@ This API allows you to manage projects. - [Project management commands](#project-management-commands) - - [Create project](#create-project) - - [Delete project](#delete-project) - - [Get project](#get-project) - - [List projects](#list-projects) - - [Update project](#update-project) + - [Create a new Project for an Organization](#create-a-new-project-for-an-organization) + - [Delete an existing Project](#delete-an-existing-project) + - [Get an existing Project](#get-an-existing-project) + - [List all Projects of an Organization](#list-all-projects-of-an-organization) + - [Update Project](#update-project) ## Project management commands @@ -15,9 +15,9 @@ This API allows you to manage projects. Project management commands. -### Create project +### Create a new Project for an Organization -Create project. +Generate a new Project for an Organization, specifying its configuration including name and description. **Usage:** @@ -30,15 +30,15 @@ scw account project create [arg=value ...] | Name | | Description | |------|---|-------------| -| name | | The name of the project | -| description | | The description of the project | +| name | | Name of the Project | +| description | | Description of the Project | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | -### Delete project +### Delete an existing Project -Delete project. +Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone. **Usage:** @@ -55,9 +55,9 @@ scw account project delete [arg=value ...] -### Get project +### Get an existing Project -Get project. +Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object. **Usage:** @@ -74,9 +74,9 @@ scw account project get [arg=value ...] -### List projects +### List all Projects of an Organization -List projects. +List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project. **Usage:** @@ -89,16 +89,16 @@ scw account project list [arg=value ...] | Name | | Description | |------|---|-------------| -| name | | The name of the project | -| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | The sort order of the returned projects | -| project-ids.{index} | | Filter out by a list of project ID | +| name | | Name of the Project | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Sort order of the returned Projects | +| project-ids.{index} | | Project IDs to filter for. The results will be limited to any Projects with an ID in this array | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | -### Update project +### Update Project -Update project. +Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description. **Usage:** @@ -112,8 +112,8 @@ scw account project update [arg=value ...] | Name | | Description | |------|---|-------------| | project-id | | Project ID to use. If none is passed the default project ID will be used | -| name | | The name of the project | -| description | | The description of the project | +| name | | Name of the Project | +| description | | Description of the Project | diff --git a/docs/commands/apple-silicon.md b/docs/commands/apple-silicon.md index 43e2d60a1d..5e238ee173 100644 --- a/docs/commands/apple-silicon.md +++ b/docs/commands/apple-silicon.md @@ -1,6 +1,6 @@ # Documentation for `scw apple-silicon` -Scaleway Apple silicon M1 as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). +Scaleway Apple silicon as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). These dedicated Mac mini M1s are designed for developing, building, testing, and signing applications for Apple devices, including iPhones, iPads, Mac computers and much more. @@ -37,7 +37,7 @@ OS management commands ### Get an Operating System (OS) -Get an Operating System (OS). +Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label. **Usage:** @@ -57,7 +57,7 @@ scw apple-silicon os get [arg=value ...] ### List all Operating System (OS) -List all Operating System (OS). +List all Operating System (OS). The response will include the total number of OS as well as their associated IDs, names and labels. **Usage:** @@ -70,8 +70,8 @@ scw apple-silicon os list [arg=value ...] | Name | | Description | |------|---|-------------| -| server-type | | List of compatible server type | -| name | | Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12") | +| server-type | | List of compatible server types | +| name | | Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")) | | zone | Default: `fr-par-1`
One of: `fr-par-3`, `all` | Zone to target. If none is passed will use default zone from the config | @@ -83,7 +83,7 @@ Apple silicon management commands ### Create a server -Create a server. +Create a new server in the targeted zone, specifying its configuration including name and type. **Usage:** @@ -105,7 +105,7 @@ scw apple-silicon server create [arg=value ...] ### Delete a server -Delete a server. +Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that. **Usage:** @@ -125,7 +125,7 @@ scw apple-silicon server delete [arg=value ...] ### Get a server -Get a server. +Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object. **Usage:** @@ -145,7 +145,7 @@ scw apple-silicon server get [arg=value ...] ### List all servers -List all servers. +List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. **Usage:** @@ -158,16 +158,16 @@ scw apple-silicon server list [arg=value ...] | Name | | Description | |------|---|-------------| -| order-by | One of: `created_at_asc`, `created_at_desc` | The sort order of the returned servers | -| project-id | | List only servers of this project ID | -| organization-id | | List only servers of this organization ID | +| order-by | One of: `created_at_asc`, `created_at_desc` | Sort order of the returned servers | +| project-id | | Only list servers of this project ID | +| organization-id | | Only list servers of this Organization ID | | zone | Default: `fr-par-1`
One of: `fr-par-3`, `all` | Zone to target. If none is passed will use default zone from the config | ### Reboot a server -Reboot a server. +Reboot an existing Apple silicon server, specified by its server ID. **Usage:** @@ -187,7 +187,7 @@ scw apple-silicon server reboot [arg=value ...] ### Reinstall a server -Reinstall a server. +Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS). **Usage:** @@ -230,7 +230,7 @@ scw apple-silicon server ssh [arg=value ...] ### Update a server -Update a server. +Update the parameters of an existing Apple silicon server, specified by its server ID. **Usage:** @@ -306,7 +306,7 @@ scw apple-silicon server-type get [arg=value ...] ### List server types -List all server types technical details. +List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`. **Usage:** diff --git a/docs/commands/baremetal.md b/docs/commands/baremetal.md index 9f8542128b..a0188bdc62 100644 --- a/docs/commands/baremetal.md +++ b/docs/commands/baremetal.md @@ -1,11 +1,11 @@ # Documentation for `scw baremetal` -This API allows to manage your Bare metal server. +This API allows to manage your Elastic Metal server. - [Baseboard Management Controller (BMC) management commands](#baseboard-management-controller-(bmc)-management-commands) - - [Get BMC (Baseboard Management Controller) access for a given elastic metal server](#get-bmc-(baseboard-management-controller)-access-for-a-given-elastic-metal-server) - - [Start BMC (Baseboard Management Controller) access for a given elastic metal server](#start-bmc-(baseboard-management-controller)-access-for-a-given-elastic-metal-server) - - [Stop BMC (Baseboard Management Controller) access for a given elastic metal server](#stop-bmc-(baseboard-management-controller)-access-for-a-given-elastic-metal-server) + - [Get BMC access](#get-bmc-access) + - [Start BMC access](#start-bmc-access) + - [Stop BMC access](#stop-bmc-access) - [Server offer management commands](#server-offer-management-commands) - [Get offer](#get-offer) - [List offers](#list-offers) @@ -15,23 +15,23 @@ This API allows to manage your Bare metal server. - [Get option](#get-option) - [List options](#list-options) - [Operating System (OS) management commands](#operating-system-(os)-management-commands) - - [Get an OS with a given ID](#get-an-os-with-a-given-id) - - [List all available OS that can be install on an elastic metal server](#list-all-available-os-that-can-be-install-on-an-elastic-metal-server) -- [Private network management command](#private-network-management-command) - - [Add a server to a private network](#add-a-server-to-a-private-network) - - [Delete a private network](#delete-a-private-network) - - [List the private networks of a server](#list-the-private-networks-of-a-server) - - [Set multiple private networks on a server](#set-multiple-private-networks-on-a-server) + - [Get an OS with an ID](#get-an-os-with-an-id) + - [List available OSes](#list-available-oses) +- [Private Network management command](#private-network-management-command) + - [Add a server to a Private Network](#add-a-server-to-a-private-network) + - [Delete a Private Network](#delete-a-private-network) + - [List the Private Networks of a server](#list-the-private-networks-of-a-server) + - [Set multiple Private Networks on a server](#set-multiple-private-networks-on-a-server) - [Server management commands](#server-management-commands) - - [Create an elastic metal server](#create-an-elastic-metal-server) - - [Delete an elastic metal server](#delete-an-elastic-metal-server) - - [Get a specific elastic metal server](#get-a-specific-elastic-metal-server) - - [Install an elastic metal server](#install-an-elastic-metal-server) - - [List elastic metal servers for organization](#list-elastic-metal-servers-for-organization) - - [Reboot an elastic metal server](#reboot-an-elastic-metal-server) - - [Start an elastic metal server](#start-an-elastic-metal-server) - - [Stop an elastic metal server](#stop-an-elastic-metal-server) - - [Update an elastic metal server](#update-an-elastic-metal-server) + - [Create an Elastic Metal server](#create-an-elastic-metal-server) + - [Delete an Elastic Metal server](#delete-an-elastic-metal-server) + - [Get a specific Elastic Metal server](#get-a-specific-elastic-metal-server) + - [Install an Elastic Metal server](#install-an-elastic-metal-server) + - [List Elastic Metal servers for an organization](#list-elastic-metal-servers-for-an-organization) + - [Reboot an Elastic Metal server](#reboot-an-elastic-metal-server) + - [Start an Elastic Metal server](#start-an-elastic-metal-server) + - [Stop an Elastic Metal server](#stop-an-elastic-metal-server) + - [Update an Elastic Metal server](#update-an-elastic-metal-server) - [Wait for a server to reach a stable state (delivery and installation)](#wait-for-a-server-to-reach-a-stable-state-(delivery-and-installation)) - [Settings management commands](#settings-management-commands) - [List all settings](#list-all-settings) @@ -40,17 +40,17 @@ This API allows to manage your Bare metal server. ## Baseboard Management Controller (BMC) management commands -Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. +A Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. For instance, your KVM-IP management console could be accessed with it. -You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. +You need first to create an Remote Access option. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. Then you need to create Remote Access https://developers.scaleway.com/en/products/baremetal/api/#post-1af723. And finally Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. -### Get BMC (Baseboard Management Controller) access for a given elastic metal server +### Get BMC access -Get the BMC (Baseboard Management Controller) access associated with the given ID. +Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect. **Usage:** @@ -68,12 +68,12 @@ scw baremetal bmc get [arg=value ...] -### Start BMC (Baseboard Management Controller) access for a given elastic metal server +### Start BMC access -Start BMC (Baseboard Management Controller) access associated with the given ID. +Start BMC (Baseboard Management Controller) access associated with the ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. -You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. - After start BMC, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. +You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. +After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use. **Usage:** @@ -87,14 +87,14 @@ scw baremetal bmc start [arg=value ...] | Name | | Description | |------|---|-------------| | server-id | Required | ID of the server | -| ip | Required | The IP authorized to connect to the given server | +| ip | Required | The IP authorized to connect to the server | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | -### Stop BMC (Baseboard Management Controller) access for a given elastic metal server +### Stop BMC access -Stop BMC (Baseboard Management Controller) access associated with the given ID. +Stop BMC (Baseboard Management Controller) access associated with the ID. **Usage:** @@ -114,14 +114,14 @@ scw baremetal bmc stop [arg=value ...] ## Server offer management commands -Server offers will answer with all different elastic metal server ranges available in a given zone. -Each of them will contain all the features of the server (cpus, memories, disks) with their associated pricing. +Server offers will answer with all different Elastic Metal server ranges available in a zone. +Each of them will contain all the features of the server (CPUs, memory, disks) with their associated pricing. ### Get offer -Return specific offer for the given ID. +Get details of an offer identified by its offer ID. **Usage:** @@ -141,7 +141,7 @@ scw baremetal offer get [arg=value ...] **Examples:** -Get a server offer with the given ID +Get a server offer with the ID ``` scw baremetal offer get zone=fr-par-1 offer-id=11111111-1111-1111-1111-111111111111 ``` @@ -151,7 +151,7 @@ scw baremetal offer get zone=fr-par-1 offer-id=11111111-1111-1111-1111-111111111 ### List offers -List all available server offers. +List all available Elastic Metal server configurations. **Usage:** @@ -164,7 +164,7 @@ scw baremetal offer list [arg=value ...] | Name | | Description | |------|---|-------------| -| subscription-period | One of: `unknown_subscription_period`, `hourly`, `monthly` | Period of subscription to filter offers | +| subscription-period | One of: `unknown_subscription_period`, `hourly`, `monthly` | Subscription period type to filter offers by | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `all` | Zone to target. If none is passed will use default zone from the config | @@ -192,7 +192,7 @@ A Server has additional options that let you personalize it to better fit your n ### Add server option -Add an option to a specific server. +Add an option, such as Private Networks, to a specific server. **Usage:** @@ -214,7 +214,7 @@ scw baremetal options add [arg=value ...] **Examples:** -Add a given option to a server +Add an option, such as Private Networks, to a server ``` scw baremetal options add server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111 ``` @@ -245,7 +245,7 @@ scw baremetal options delete [arg=value ...] **Examples:** -Delete a given option from a server +Delete an option from a server ``` scw baremetal options delete server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111 ``` @@ -255,7 +255,7 @@ scw baremetal options delete server-id=11111111-1111-1111-1111-111111111111 opti ### Get option -Return specific option for the given ID. +Return specific option for the ID. **Usage:** @@ -275,7 +275,7 @@ scw baremetal options get [arg=value ...] **Examples:** -Get a server option with the given ID +Get a server option with the ID ``` scw baremetal options get zone=fr-par-1 option-id=11111111-1111-1111-1111-111111111111 ``` @@ -298,8 +298,8 @@ scw baremetal options list [arg=value ...] | Name | | Description | |------|---|-------------| -| offer-id | | Filter options by offer_id | -| name | | Filter options by name | +| offer-id | | Offer ID to filter options for | +| name | | Name to filter options for | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `all` | Zone to target. If none is passed will use default zone from the config | @@ -324,9 +324,9 @@ scw baremetal options list zone=fr-par-1 An Operating System (OS) is the underlying software installed on your server -### Get an OS with a given ID +### Get an OS with an ID -Return specific OS for the given ID. +Return specific OS for the ID. **Usage:** @@ -354,9 +354,9 @@ scw baremetal os get -### List all available OS that can be install on an elastic metal server +### List available OSes -List all available OS that can be install on an elastic metal server. +List all OSes that are available for installation on Elastic Metal servers. **Usage:** @@ -369,27 +369,27 @@ scw baremetal os list [arg=value ...] | Name | | Description | |------|---|-------------| -| offer-id | | Filter OS by offer ID | +| offer-id | | Offer IDs to filter OSes for | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `all` | Zone to target. If none is passed will use default zone from the config | -## Private network management command +## Private Network management command -A private network allows interconnecting your resources +A Private Network allows you to interconnect your resources (servers, instances, ...) in an isolated and private network. The network reachability is limited to the -resources that are on the same private network. A VLAN +resources that are on the same Private Network . A VLAN interface is available on the server and can be freely managed (adding IP addresses, shutdown interface...). -Note that a resource can be a part of multiple private networks. +Note that a resource can be a part of multiple Private Networks. -### Add a server to a private network +### Add a server to a Private Network -Add a server to a private network. +Add a server to a Private Network. **Usage:** @@ -403,14 +403,14 @@ scw baremetal private-network add [arg=value ...] | Name | | Description | |------|---|-------------| | server-id | Required | The ID of the server | -| private-network-id | Required | The ID of the private network | +| private-network-id | Required | The ID of the Private Network | | zone | Default: `fr-par-1`
One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config | -### Delete a private network +### Delete a Private Network -Delete a private network. +Delete a Private Network. **Usage:** @@ -424,14 +424,14 @@ scw baremetal private-network delete [arg=value ...] | Name | | Description | |------|---|-------------| | server-id | Required | The ID of the server | -| private-network-id | Required | The ID of the private network | +| private-network-id | Required | The ID of the Private Network | | zone | Default: `fr-par-1`
One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config | -### List the private networks of a server +### List the Private Networks of a server -List the private networks of a server. +List the Private Networks of a server. **Usage:** @@ -444,18 +444,18 @@ scw baremetal private-network list [arg=value ...] | Name | | Description | |------|---|-------------| -| order-by | One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc` | The sort order for the returned private networks | -| server-id | | Filter private networks by server ID | -| private-network-id | | Filter private networks by private network ID | -| project-id | | Filter private networks by project ID | -| organization-id | | Filter private networks by organization ID | +| order-by | One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc` | The sort order for the returned Private Networks | +| server-id | | Filter Private Networks by server ID | +| private-network-id | | Filter Private Networks by Private Network ID | +| project-id | | Filter Private Networks by Project ID | +| organization-id | | Filter Private Networks by Organization ID | | zone | Default: `fr-par-1`
One of: `fr-par-2`, `all` | Zone to target. If none is passed will use default zone from the config | -### Set multiple private networks on a server +### Set multiple Private Networks on a server -Set multiple private networks on a server. +Set multiple Private Networks on a server. **Usage:** @@ -469,7 +469,7 @@ scw baremetal private-network set [arg=value ...] | Name | | Description | |------|---|-------------| | server-id | Required | The ID of the server | -| private-network-ids.{index} | Required | The IDs of the private networks | +| private-network-ids.{index} | Required | The IDs of the Private Networks | | zone | Default: `fr-par-1`
One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config | @@ -479,9 +479,9 @@ scw baremetal private-network set [arg=value ...] A server is a denomination of a type of instances provided by Scaleway -### Create an elastic metal server +### Create an Elastic Metal server -Create a new elastic metal server. Once the server is created, you probably want to install an OS. +Create a new Elastic Metal server. Once the server is created, proceed with the [installation of an OS](#post-3e949e). **Usage:** @@ -496,15 +496,15 @@ scw baremetal server create [arg=value ...] |------|---|-------------| | project-id | | Project ID to use. If none is passed the default project ID will be used | | name | Required
Default: `` | Name of the server (β‰ hostname) | -| description | | Description associated to the server, max 255 characters | +| description | | Description associated with the server, max 255 characters | | type | | Server commercial type | | tags.{index} | | Tags to associate to the server | -| install.os-id | | ID of the OS to install on the server | +| install.os-id | | ID of the OS to installation on the server | | install.hostname | | Hostname of the server | | install.ssh-key-ids.{index} | | SSH key IDs authorized on the server | -| install.user | | User used for the installation | -| install.password | | Password used for the installation | -| install.service-user | | User used for the service to install | +| install.user | | User for the installation | +| install.password | | Password for the installation | +| install.service-user | | Regular user that runs the service to be installed on the server | | install.service-password | | Password used for the service to install | | option-ids.{index} | | IDs of options to enable on server | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | @@ -522,9 +522,9 @@ scw baremetal server create -### Delete an elastic metal server +### Delete an Elastic Metal server -Delete the server associated with the given ID. +Delete the server associated with the ID. **Usage:** @@ -544,7 +544,7 @@ scw baremetal server delete [arg=value ...] **Examples:** -Delete an elastic metal server +Delete an Elastic Metal server ``` scw baremetal server delete 11111111-1111-1111-1111-111111111111 ``` @@ -552,9 +552,9 @@ scw baremetal server delete 11111111-1111-1111-1111-111111111111 -### Get a specific elastic metal server +### Get a specific Elastic Metal server -Get the server associated with the given ID. +Get full details of an existing Elastic Metal server associated with the ID. **Usage:** @@ -574,7 +574,7 @@ scw baremetal server get [arg=value ...] **Examples:** -Get a given server +Get a specific server ``` scw baremetal server get 11111111-1111-1111-1111-111111111111 ``` @@ -582,9 +582,9 @@ scw baremetal server get 11111111-1111-1111-1111-111111111111 -### Install an elastic metal server +### Install an Elastic Metal server -Install an OS on the server associated with the given ID. +Install an Operating System (OS) on the Elastic Metal server with a specific ID. **Usage:** @@ -598,7 +598,7 @@ scw baremetal server install [arg=value ...] | Name | | Description | |------|---|-------------| | server-id | Required | Server ID to install | -| os-id | Required | ID of the OS to install on the server | +| os-id | Required | ID of the OS to installation on the server | | hostname | Required | Hostname of the server | | all-ssh-keys | | Add all SSH keys on your baremetal instance (cannot be used with ssh-key-ids) | | ssh-key-ids.{index} | Required | SSH key IDs authorized on the server (cannot be used with all-ssh-keys) | @@ -612,7 +612,7 @@ scw baremetal server install [arg=value ...] **Examples:** -Install an OS on a given server with a particular SSH key ID +Install an OS on a server with a particular SSH key ID ``` scw baremetal server install 11111111-1111-1111-1111-111111111111 os-id=11111111-1111-1111-1111-111111111111 ssh-key-ids.0=11111111-1111-1111-1111-111111111111 ``` @@ -620,9 +620,9 @@ scw baremetal server install 11111111-1111-1111-1111-111111111111 os-id=11111111 -### List elastic metal servers for organization +### List Elastic Metal servers for an organization -List elastic metal servers for organization. +List Elastic Metal servers for a specific organization. **Usage:** @@ -636,19 +636,19 @@ scw baremetal server list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `created_at_asc`, `created_at_desc` | Order of the servers | -| tags.{index} | | Filter by tags | -| status.{index} | | Filter by status | -| name | | Filter by name | -| project-id | | Filter by project ID | -| option-id | | Filter by option ID | -| organization-id | | Filter by organization ID | +| tags.{index} | | Tags to filter for | +| status.{index} | | Status to filter for | +| name | | Names to filter for | +| project-id | | Project ID to filter for | +| option-id | | Option ID to filter for | +| organization-id | | Organization ID to filter for | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `all` | Zone to target. If none is passed will use default zone from the config | **Examples:** -List all servers on your default zone +List all servers in your default zone ``` scw baremetal server list ``` @@ -656,9 +656,9 @@ scw baremetal server list -### Reboot an elastic metal server +### Reboot an Elastic Metal server -Reboot the server associated with the given ID, use boot param to reboot in rescue. +Reboot the Elastic Metal server associated with the ID, use the `boot_type` `rescue` to reboot the server in rescue mode. **Usage:** @@ -692,9 +692,9 @@ scw baremetal server reboot 11111111-1111-1111-1111-111111111111 boot-type=rescu -### Start an elastic metal server +### Start an Elastic Metal server -Start the server associated with the given ID. +Start the server associated with the ID. **Usage:** @@ -715,7 +715,7 @@ scw baremetal server start [arg=value ...] **Examples:** -Start an elastic metal server +Start an Elastic Metalx server ``` scw baremetal server start 11111111-1111-1111-1111-111111111111 ``` @@ -728,9 +728,9 @@ scw baremetal server start 11111111-1111-1111-1111-111111111111 boot-type=rescue -### Stop an elastic metal server +### Stop an Elastic Metal server -Stop the server associated with the given ID. +Stop the server associated with the ID. The server remains allocated to your account and all data remains on the local storage of the server. **Usage:** @@ -750,7 +750,7 @@ scw baremetal server stop [arg=value ...] **Examples:** -Stop an elastic metal server +Stop an Elastic Metal server ``` scw baremetal server stop 11111111-1111-1111-1111-111111111111 ``` @@ -758,9 +758,9 @@ scw baremetal server stop 11111111-1111-1111-1111-111111111111 -### Update an elastic metal server +### Update an Elastic Metal server -Update the server associated with the given ID. +Update the server associated with the ID. You can update parameters such as the server's name, tags and description. Any parameters left null in the request body are not updated. **Usage:** @@ -775,8 +775,8 @@ scw baremetal server update [arg=value ...] |------|---|-------------| | server-id | Required | ID of the server to update | | name | | Name of the server (β‰ hostname), not updated if null | -| description | | Description associated to the server, max 255 characters, not updated if null | -| tags.{index} | | Tags associated to the server, not updated if null | +| description | | Description associated with the server, max 255 characters, not updated if null | +| tags.{index} | | Tags associated with the server, not updated if null | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | @@ -813,7 +813,7 @@ scw baremetal server wait 11111111-1111-1111-1111-111111111111 ## Settings management commands -Allows to configure the general settings for your elastic metal server. +Allows to configure the general settings for your Elastic Metal server. @@ -832,7 +832,7 @@ scw baremetal settings list [arg=value ...] | Name | | Description | |------|---|-------------| -| order-by | One of: `created_at_asc`, `created_at_desc` | Order the response | +| order-by | One of: `created_at_asc`, `created_at_desc` | Sort order for items in the response | | project-id | Required | ID of the project | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `all` | Zone to target. If none is passed will use default zone from the config | @@ -854,7 +854,7 @@ scw baremetal settings update [arg=value ...] | Name | | Description | |------|---|-------------| | setting-id | Required | ID of the setting | -| enabled | | Enable/Disable the setting | +| enabled | | Defines whether the setting is enabled | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | diff --git a/docs/commands/iam.md b/docs/commands/iam.md index 04359ee43e..8a2c3eb7e3 100644 --- a/docs/commands/iam.md +++ b/docs/commands/iam.md @@ -11,12 +11,12 @@ IAM API. - [Applications management commands](#applications-management-commands) - [Create a new application](#create-a-new-application) - [Delete an application](#delete-an-application) - - [Get an existing application](#get-an-existing-application) - - [List applications of an organization](#list-applications-of-an-organization) - - [Update an existing application](#update-an-existing-application) + - [Get a given application](#get-a-given-application) + - [List applications of an Organization](#list-applications-of-an-organization) + - [Update an application](#update-an-application) - [Groups management commands](#groups-management-commands) - - [Add a user of an application to a group](#add-a-user-of-an-application-to-a-group) - - [Create a new group](#create-a-new-group) + - [Add a user or an application to a group](#add-a-user-or-an-application-to-a-group) + - [Create a group](#create-a-group) - [Delete a group](#delete-a-group) - [Get a group](#get-a-group) - [List groups](#list-groups) @@ -32,11 +32,11 @@ IAM API. - [Create a new policy](#create-a-new-policy) - [Delete a policy](#delete-a-policy) - [Get an existing policy](#get-an-existing-policy) - - [List policies of an organization](#list-policies-of-an-organization) + - [List policies of an Organization](#list-policies-of-an-organization) - [Update an existing policy](#update-an-existing-policy) - [Rules management commands](#rules-management-commands) - - [List rules of an existing policy](#list-rules-of-an-existing-policy) - - [Set rules of an existing policy](#set-rules-of-an-existing-policy) + - [List rules of a given policy](#list-rules-of-a-given-policy) + - [Set rules of a given policy](#set-rules-of-a-given-policy) - [SSH keys management commands](#ssh-keys-management-commands) - [Create an SSH key](#create-an-ssh-key) - [Delete an SSH key](#delete-an-ssh-key) @@ -45,9 +45,9 @@ IAM API. - [List SSH keys](#list-ssh-keys) - [Update an SSH key](#update-an-ssh-key) - [Users management commands](#users-management-commands) - - [Delete a guest user from an organization](#delete-a-guest-user-from-an-organization) - - [Retrieve a user from its ID](#retrieve-a-user-from-its-id) - - [List users of an organization](#list-users-of-an-organization) + - [Delete a guest user from an Organization](#delete-a-guest-user-from-an-organization) + - [Get a given user](#get-a-given-user) + - [List users of an Organization](#list-users-of-an-organization) ## API keys management commands @@ -57,7 +57,7 @@ API keys management commands. ### Create an API key -Create an API key. +Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id` which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that he secret key is only showed once. Make sure that you copy and store both keys somewhere safe. **Usage:** @@ -70,17 +70,17 @@ scw iam api-key create [arg=value ...] | Name | | Description | |------|---|-------------| -| application-id | | ID of application principal | -| user-id | | ID of user principal | +| application-id | | ID of the application | +| user-id | | ID of the user | | expires-at | | Expiration date of the API key | -| default-project-id | | The default project ID to use with object storage | -| description | | The description of the API key (max length is 200 chars) | +| default-project-id | | The default Project ID to use with Object Storage | +| description | | The description of the API key (max length is 200 characters) | ### Delete an API key -Delete an API key. +Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete. **Usage:** @@ -109,7 +109,7 @@ scw iam api-key delete SCW00000000000 ### Get an API key -Get an API key. +Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation. **Usage:** @@ -128,7 +128,7 @@ scw iam api-key get [arg=value ...] ### List API keys -List API keys. +List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`. **Usage:** @@ -142,21 +142,21 @@ scw iam api-key list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | Default: `created_at_asc`
One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `expires_at_asc`, `expires_at_desc`, `access_key_asc`, `access_key_desc` | Criteria for sorting results | -| ~~application-id~~ | Deprecated | ID of an application bearer | -| ~~user-id~~ | Deprecated | ID of a user bearer | -| editable | | Filter out editable API keys or not | -| expired | | Filter out expired API keys or not | -| access-key | | Filter out by access key | -| description | | Filter out by description | -| bearer-id | | Filter out by bearer ID | -| bearer-type | One of: `unknown_bearer_type`, `user`, `application` | Filter out by type of bearer | -| organization-id | Required
Default: `` | ID of organization | +| ~~application-id~~ | Deprecated | ID of application that bears the API key | +| ~~user-id~~ | Deprecated | ID of user that bears the API key | +| editable | | Whether to filter out editable API keys or not | +| expired | | Whether to filter out expired API keys or not | +| access-key | | Filter by access key | +| description | | Filter by description | +| bearer-id | | Filter by bearer ID | +| bearer-type | One of: `unknown_bearer_type`, `user`, `application` | Filter by type of bearer | +| organization-id | Required
Default: `` | ID of Organization | ### Update an API key -Update an API key. +Update the parameters of an API key, including `default_project_id` and `description`. **Usage:** @@ -170,7 +170,7 @@ scw iam api-key update [arg=value ...] | Name | | Description | |------|---|-------------| | access-key | Required | Access key to update | -| default-project-id | | The new default project ID to set | +| default-project-id | | The new default Project ID to set | | description | | The new description to update | @@ -182,7 +182,7 @@ Applications management commands. ### Create a new application -Create a new application. +Create a new application. You must define the `name` parameter in the request. **Usage:** @@ -195,15 +195,15 @@ scw iam application create [arg=value ...] | Name | | Description | |------|---|-------------| -| name | Required
Default: `` | Name of application to create (max length is 64 chars) | -| description | | Description of application (max length is 200 chars) | +| name | Required
Default: `` | Name of the application to create (max length is 64 characters) | +| description | | Description of the application (max length is 200 characters) | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | ### Delete an application -Delete an application. +Delete an application. Note that this action is irreversible and will automatically delete the application's API keys. Policies attached to users and applications via this group will no longer apply. **Usage:** @@ -216,13 +216,13 @@ scw iam application delete [arg=value ...] | Name | | Description | |------|---|-------------| -| application-id | Required | ID of application to delete | +| application-id | Required | ID of the application to delete | -### Get an existing application +### Get a given application -Get an existing application. +Retrieve information about an application, specified by the `application_id` parameter. The application's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response. **Usage:** @@ -235,13 +235,13 @@ scw iam application get [arg=value ...] | Name | | Description | |------|---|-------------| -| application-id | Required | ID of application to find | +| application-id | Required | ID of the application to find | -### List applications of an organization +### List applications of an Organization -List applications of an organization. +List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`. **Usage:** @@ -255,16 +255,16 @@ scw iam application list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | Default: `created_at_asc`
One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `name_asc`, `name_desc` | Criteria for sorting results | -| name | | Name of application to filter | -| editable | | Filter out editable applications or not | -| application-ids.{index} | | Filter out by a list of ID | -| organization-id | Required
Default: `` | ID of organization to filter | +| name | | Name of the application to filter | +| editable | | Whether to filter out editable applications or not | +| application-ids.{index} | | Filter by list of IDs | +| organization-id | Required
Default: `` | ID of the Organization to filter | -### Update an existing application +### Update an application -Update an existing application. +Update the parameters of an application, including `name` and `description`. **Usage:** @@ -277,9 +277,9 @@ scw iam application update [arg=value ...] | Name | | Description | |------|---|-------------| -| application-id | Required | ID of application to update | -| name | | New name of application (max length is 64 chars) | -| description | | New description of application (max length is 200 chars) | +| application-id | Required | ID of the application to update | +| name | | New name for the application (max length is 64 chars) | +| description | | New description for the application (max length is 200 chars) | @@ -288,9 +288,9 @@ scw iam application update [arg=value ...] Groups management commands. -### Add a user of an application to a group +### Add a user or an application to a group -Add a user of an application to a group. +Add a user or an application to a group. You can specify a `user_id` and and `application_id` in the body of your request. Note that you can only add one of each per request. **Usage:** @@ -303,15 +303,15 @@ scw iam group add-member [arg=value ...] | Name | | Description | |------|---|-------------| -| group-id | Required | ID of group | +| group-id | Required | ID of the group | | user-id | | ID of the user to add | | application-id | | ID of the application to add | -### Create a new group +### Create a group -Create a new group. +Create a new group. You must define the `name` and `organization_id` parameters in the request. **Usage:** @@ -324,7 +324,7 @@ scw iam group create [arg=value ...] | Name | | Description | |------|---|-------------| -| name | Required
Default: `` | Name of the group to create (max length is 64 chars). MUST be unique inside an organization | +| name | Required
Default: `` | Name of the group to create (max length is 64 chars). MUST be unique inside an Organization | | description | | Description of the group to create (max length is 200 chars) | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | @@ -342,7 +342,7 @@ scw iam group create name=foobar ### Delete a group -Delete a group. +Delete a group. Note that this action is irreversible and could delete permissions for group members. Policies attached to users and applications via this group will no longer apply. **Usage:** @@ -355,7 +355,7 @@ scw iam group delete [arg=value ...] | Name | | Description | |------|---|-------------| -| group-id | Required | ID of group to delete | +| group-id | Required | ID of the group to delete | **Examples:** @@ -371,7 +371,7 @@ scw iam group delete 11111111-1111-1111-1111-111111111111 ### Get a group -Get a group. +Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response. **Usage:** @@ -384,13 +384,13 @@ scw iam group get [arg=value ...] | Name | | Description | |------|---|-------------| -| group-id | Required | ID of group | +| group-id | Required | ID of the group | ### List groups -List groups. +List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters to filter your query. Use `user_ids` or `application_ids` to list all groups certain users or applications belong to. **Usage:** @@ -405,16 +405,16 @@ scw iam group list [arg=value ...] |------|---|-------------| | order-by | Default: `created_at_asc`
One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `name_asc`, `name_desc` | Sort order of groups | | name | | Name of group to find | -| application-ids.{index} | | Filter out by a list of application ID | -| user-ids.{index} | | Filter out by a list of user ID | -| group-ids.{index} | | Filter out by a list of group ID | -| organization-id | Default: `` | Filter by organization ID | +| application-ids.{index} | | Filter by a list of application IDs | +| user-ids.{index} | | Filter by a list of user IDs | +| group-ids.{index} | | Filter by a list of group IDs | +| organization-id | Default: `` | Filter by Organization ID | ### Remove a user or an application from a group -Remove a user or an application from a group. +Remove a user or an application from a group. You can specify a `user_id` and and `application_id` in the body of your request. Note that you can only remove one of each per request. Removing a user from a group means that any permissions given to them via the group (i.e. from an attached policy) will no longer apply. Be sure you want to remove these permissions from the user before proceeding. **Usage:** @@ -427,7 +427,7 @@ scw iam group remove-member [arg=value ...] | Name | | Description | |------|---|-------------| -| group-id | Required | ID of group | +| group-id | Required | ID of the group | | user-id | | ID of the user to remove | | application-id | | ID of the application to remove | @@ -435,7 +435,7 @@ scw iam group remove-member [arg=value ...] ### Update a group -Update a group. +Update the parameters of group, including `name` and `description`. **Usage:** @@ -448,8 +448,8 @@ scw iam group update [arg=value ...] | Name | | Description | |------|---|-------------| -| group-id | Required | ID of group to update | -| name | | New name for the group (max length is 64 chars). MUST be unique inside an organization | +| group-id | Required | ID of the group to update | +| name | | New name for the group (max length is 64 chars). MUST be unique inside an Organization | | description | | New description for the group (max length is 200 chars) | @@ -525,7 +525,7 @@ Permission sets management commands. ### List permission sets -List permission sets. +List permission sets available for given Organization. You must define the `organization_id` in the query path of your request. **Usage:** @@ -550,7 +550,7 @@ Policies management commands. ### Create a new policy -Create a new policy. +Create a new application. You must define the `name` parameter in the request. You can specify parameters such as `user_id`, `groups_id`, `application_id`, `no_principal`, `rules` and its child attributes. **Usage:** @@ -563,15 +563,15 @@ scw iam policy create [arg=value ...] | Name | | Description | |------|---|-------------| -| name | Required
Default: `` | Name of policy to create (max length is 64 chars) | -| description | | Description of policy to create (max length is 200 chars) | +| name | Required
Default: `` | Name of the policy to create (max length is 64 characters) | +| description | | Description of the policy to create (max length is 200 characters) | | rules.{index}.permission-set-names.{index} | | Names of permission sets bound to the rule | -| rules.{index}.project-ids.{index} | | List of project IDs scoped to the rule | -| rules.{index}.organization-id | | ID of organization scoped to the rule | -| user-id | | ID of user, owner of the policy | -| group-id | | ID of group, owner of the policy | -| application-id | | ID of application, owner of the policy | -| no-principal | | True when the policy do not belong to any principal | +| rules.{index}.project-ids.{index} | | List of Project IDs the rule is scoped to | +| rules.{index}.organization-id | | ID of Organization the rule is scoped to | +| user-id | | ID of user attributed to the policy | +| group-id | | ID of group attributed to the policy | +| application-id | | ID of application attributed to the policy | +| no-principal | | Whether or not a policy is attributed to a principal | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | @@ -588,7 +588,7 @@ scw iam policy create group-id=11111111-1111-1111-1111-111111111111 rules.0.orga ### Delete a policy -Delete a policy. +Delete a policy. You must define specify the `policy_id` parameter in your request. Note that when deleting a policy, all permissions it gives to its principal (user, group or application) will be revoked. **Usage:** @@ -607,7 +607,7 @@ scw iam policy delete [arg=value ...] ### Get an existing policy -Get an existing policy. +Retrieve information about a policy, speficified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response. **Usage:** @@ -624,9 +624,9 @@ scw iam policy get [arg=value ...] -### List policies of an organization +### List policies of an Organization -List policies of an organization. +List the policies of an Organization. By default, the policies listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters to filter your query, such as `user_ids`, `groups_ids`, `application_ids`, and `policy_name`. **Usage:** @@ -640,19 +640,19 @@ scw iam policy list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | Default: `created_at_asc`
One of: `policy_name_asc`, `policy_name_desc`, `created_at_asc`, `created_at_desc` | Criteria for sorting results | -| editable | | Filter out editable policies or not | -| user-ids.{index} | | Filter out by a list of user ID | -| group-ids.{index} | | Filter out by a list of group ID | -| application-ids.{index} | | Filter out by a list of application ID | -| no-principal | | True when the policy do not belong to any principal | -| policy-name | | Name of policy to fetch | -| organization-id | Required
Default: `` | ID of organization to filter | +| editable | | Whether or not filter out editable policies | +| user-ids.{index} | | Whether or not to filter by list of user IDs | +| group-ids.{index} | | Whether or not to filter by list of group IDs | +| application-ids.{index} | | Filter by a list of application IDs | +| no-principal | | Whether or not the policy is attributed to a principal | +| policy-name | | Name of the policy to fetch | +| organization-id | Required
Default: `` | ID of the Organization to filter | ### Update an existing policy -Update an existing policy. +Update the parameters of a policy, including `name`, `description`, `user_id`, `group_id`, `application_id` and `no_principal`. **Usage:** @@ -666,12 +666,12 @@ scw iam policy update [arg=value ...] | Name | | Description | |------|---|-------------| | policy-id | Required | Id of policy to update | -| name | | New name of policy (max length is 64 chars) | -| description | | New description of policy (max length is 200 chars) | -| user-id | | New ID of user, owner of the policy | -| group-id | | New ID of group, owner of the policy | -| application-id | | New ID of application, owner of the policy | -| no-principal | | True when the policy do not belong to any principal | +| name | | New name for the policy (max length is 64 characters) | +| description | | New description of policy (max length is 200 characters) | +| user-id | | New ID of user attributed to the policy | +| group-id | | New ID of group attributed to the policy | +| application-id | | New ID of application attributed to the policy | +| no-principal | | Whether or not the policy is attributed to a principal | @@ -680,9 +680,9 @@ scw iam policy update [arg=value ...] Rules management commands. -### List rules of an existing policy +### List rules of a given policy -List rules of an existing policy. +List the rules of a given policy. By default, the rules listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `policy_id` in the query path of your request. **Usage:** @@ -699,9 +699,9 @@ scw iam rule list [arg=value ...] -### Set rules of an existing policy +### Set rules of a given policy -Set rules of an existing policy. +Overwrite the rules of a given policy. Any information that you add using this command will overwrite the previous configuration. If you include some of the rules you already had in your previous configuration in your new one, but you change their order, the new order of display will apply. While policy rules are ordered, they have no impact on the access logic of IAM because rules are allow-only. **Usage:** @@ -716,8 +716,8 @@ scw iam rule update [arg=value ...] |------|---|-------------| | policy-id | Required | Id of policy to update | | rules.{index}.permission-set-names.{index} | | Names of permission sets bound to the rule | -| rules.{index}.project-ids.{index} | | List of project IDs scoped to the rule | -| rules.{index}.organization-id | | ID of organization scoped to the rule | +| rules.{index}.project-ids.{index} | | List of Project IDs the rule is scoped to | +| rules.{index}.organization-id | | ID of Organization the rule is scoped to | @@ -728,7 +728,7 @@ SSH keys management commands. ### Create an SSH key -Create an SSH key. +Add a new SSH key to a Scaleway Project. You must specify the `name`, `public_key` and `project_id`. **Usage:** @@ -742,7 +742,7 @@ scw iam ssh-key create [arg=value ...] | Name | | Description | |------|---|-------------| | name | Required
Default: `` | The name of the SSH key. Max length is 1000 | -| public-key | Required | SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000 | +| public-key | Required | SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000 | | project-id | | Project ID to use. If none is passed the default project ID will be used | @@ -759,7 +759,7 @@ scw iam ssh-key create name=foobar public-key="$(cat )" ### Delete an SSH key -Delete an SSH key. +Delete a given SSH key, specified by the `ssh_key_id`. Deleting an SSH is permanent, and cannot be undone. Note that you might need to update any configurations that used the SSH key. **Usage:** @@ -788,7 +788,7 @@ scw iam ssh-key delete 11111111-1111-1111-1111-111111111111 ### Get an SSH key -Get an SSH key. +Retrieve information about a given SSH key, specified by the `ssh_key_id` parameter. The SSH key's full details, including `id`, `name`, `public_key`, and `project_id` are returned in the response. **Usage:** @@ -819,7 +819,7 @@ scw iam ssh-key init ### List SSH keys -List SSH keys. +List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`. **Usage:** @@ -832,17 +832,17 @@ scw iam ssh-key list [arg=value ...] | Name | | Description | |------|---|-------------| -| order-by | Default: `created_at_asc`
One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `name_asc`, `name_desc` | Sort order of SSH keys | +| order-by | Default: `created_at_asc`
One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `name_asc`, `name_desc` | Sort order of the SSH keys | | name | | Name of group to find | -| project-id | | Filter by project ID | -| disabled | | Filter out disabled SSH keys or not | -| organization-id | Default: `` | Filter by organization ID | +| project-id | | Filter by Project ID | +| disabled | | Whether to include disabled SSH keys or not | +| organization-id | Default: `` | Filter by Organization ID | ### Update an SSH key -Update an SSH key. +Update the parameters of an SSH key, including `name` and `disable`. **Usage:** @@ -866,9 +866,9 @@ scw iam ssh-key update [arg=value ...] Users management commands. -### Delete a guest user from an organization +### Delete a guest user from an Organization -Delete a guest user from an organization. +Remove a user from an Organization in which they are a guest. You must define the `user_id` in your request. Note that removing a user from an Organization automatically deletes their API keys, and any policies directly attached to them become orphaned. **Usage:** @@ -881,13 +881,13 @@ scw iam user delete [arg=value ...] | Name | | Description | |------|---|-------------| -| user-id | Required | ID of user to delete | +| user-id | Required | ID of the user to delete | -### Retrieve a user from its ID +### Get a given user -Retrieve a user from its ID. +Retrieve information about a user, specified by the `user_id` parameter. The user's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response. **Usage:** @@ -900,13 +900,13 @@ scw iam user get [arg=value ...] | Name | | Description | |------|---|-------------| -| user-id | Required | ID of user to find | +| user-id | Required | ID of the user to find | -### List users of an organization +### List users of an Organization -List users of an organization. +List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`. **Usage:** @@ -920,8 +920,8 @@ scw iam user list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | Default: `created_at_asc`
One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `email_asc`, `email_desc`, `last_login_asc`, `last_login_desc` | Criteria for sorting results | -| user-ids.{index} | | Filter out by a list of ID | -| organization-id | Required
Default: `` | ID of organization to filter | +| user-ids.{index} | | Filter by list of IDs | +| organization-id | Required
Default: `` | ID of the Organization to filter | diff --git a/docs/commands/tem.md b/docs/commands/tem.md index 47e26fc990..215f05c9ca 100644 --- a/docs/commands/tem.md +++ b/docs/commands/tem.md @@ -57,7 +57,8 @@ scw tem domain create [arg=value ...] | Name | | Description | |------|---|-------------| | project-id | | Project ID to use. If none is passed the default project ID will be used | -| domain-name | | | +| domain-name | | Fully qualified domain dame | +| accept-tos | | Accept the Scaleway Terms of Service | | region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | @@ -252,6 +253,7 @@ scw tem email list [arg=value ...] | mail-from | | Optional, list emails sent with this `mail_from` sender's address | | mail-to | | Optional, list emails sent with this `mail_to` recipient's address | | statuses.{index} | One of: `unknown`, `new`, `sending`, `sent`, `failed`, `canceled` | Optional, list emails having any of this status | +| subject | | Optional, list emails having this subject | | region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | diff --git a/docs/commands/vpc-gw.md b/docs/commands/vpc-gw.md index 529d062d96..30de109968 100644 --- a/docs/commands/vpc-gw.md +++ b/docs/commands/vpc-gw.md @@ -1,6 +1,6 @@ # Documentation for `scw vpc-gw` -VPC Public Gateway API. +Public Gateways API. - [DHCP configuration management](#dhcp-configuration-management) - [Create a DHCP configuration](#create-a-dhcp-configuration) @@ -9,28 +9,28 @@ VPC Public Gateway API. - [List DHCP configurations](#list-dhcp-configurations) - [Update a DHCP configuration](#update-a-dhcp-configuration) - [DHCP entries management](#dhcp-entries-management) - - [Create a static DHCP reservation](#create-a-static-dhcp-reservation) - - [Delete a DHCP reservation](#delete-a-dhcp-reservation) - - [Get DHCP entries](#get-dhcp-entries) + - [Create a DHCP entry](#create-a-dhcp-entry) + - [Delete a DHCP entry](#delete-a-dhcp-entry) + - [Get a DHCP entry](#get-a-dhcp-entry) - [List DHCP entries](#list-dhcp-entries) - [Set all DHCP reservations on a Gateway Network](#set-all-dhcp-reservations-on-a-gateway-network) - [Update a DHCP entry](#update-a-dhcp-entry) -- [VPC Public Gateway management](#vpc-public-gateway-management) - - [Create a VPC Public Gateway](#create-a-vpc-public-gateway) - - [Delete a VPC Public Gateway](#delete-a-vpc-public-gateway) - - [Get a VPC Public Gateway](#get-a-vpc-public-gateway) - - [List VPC Public Gateways](#list-vpc-public-gateways) - - [Refresh SSH keys of a VPC Public Gateway](#refresh-ssh-keys-of-a-vpc-public-gateway) - - [Update a VPC Public Gateway](#update-a-vpc-public-gateway) - - [Upgrade a VPC Public Gateway to the latest version](#upgrade-a-vpc-public-gateway-to-the-latest-version) +- [Public Gateway management](#public-gateway-management) + - [Create a Public Gateway](#create-a-public-gateway) + - [Delete a Public Gateway](#delete-a-public-gateway) + - [Get a Public Gateway](#get-a-public-gateway) + - [List Public Gateways](#list-public-gateways) + - [Refresh a Public Gateway's SSH keys](#refresh-a-public-gateway's-ssh-keys) + - [Update a Public Gateway](#update-a-public-gateway) + - [Upgrade a Public Gateway to the latest version](#upgrade-a-public-gateway-to-the-latest-version) - [Gateway Networks management](#gateway-networks-management) - - [Attach a gateway to a Private Network](#attach-a-gateway-to-a-private-network) - - [Detach a gateway from a Private Network](#detach-a-gateway-from-a-private-network) - - [Get a gateway connection to a Private Network](#get-a-gateway-connection-to-a-private-network) - - [List gateway connections to Private Networks](#list-gateway-connections-to-private-networks) - - [Update a gateway connection to a Private Network](#update-a-gateway-connection-to-a-private-network) + - [Attach a Public Gateway to a Private Network](#attach-a-public-gateway-to-a-private-network) + - [Detach a Public Gateway from a Private Network](#detach-a-public-gateway-from-a-private-network) + - [Get a Public Gateway connection to a Private Network](#get-a-public-gateway-connection-to-a-private-network) + - [List Public Gateway connections to Private Networks](#list-public-gateway-connections-to-private-networks) + - [Update a Public Gateway's connection to a Private Network](#update-a-public-gateway's-connection-to-a-private-network) - [Gateway types information](#gateway-types-information) - - [List VPC Public Gateway types](#list-vpc-public-gateway-types) + - [List Public Gateway types](#list-public-gateway-types) - [IP address management](#ip-address-management) - [Reserve an IP](#reserve-an-ip) - [Delete an IP](#delete-an-ip) @@ -42,19 +42,19 @@ VPC Public Gateway API. - [Delete a PAT rule](#delete-a-pat-rule) - [Get a PAT rule](#get-a-pat-rule) - [List PAT rules](#list-pat-rules) - - [Set all PAT rules on a Gateway](#set-all-pat-rules-on-a-gateway) + - [Set all PAT rules](#set-all-pat-rules) - [Update a PAT rule](#update-a-pat-rule) ## DHCP configuration management -DHCP configuration allows you to set parameters for assignment of IP addresses to devices on a Private Network attached to a VPC Public Gateway (subnet, lease time etc). +These objects define a DHCP configuration, i.e. how IP addresses should be assigned to devices on a Private Network attached to a Public Gateway. Definable parameters include the subnet for the DHCP server, the validity period for DHCP entries, whether to use dynamic pooling, and more. A DHCP configuration object has a DHCP ID, which can then be used as part of a call to create or update a Gateway Network. This lets you attach an existing DHCP configuration to a Public Gateway attached to a Private Network. Similarly, you can use a DHCP ID as a query parameter to list Gateway Networks which use this DHCP configuration object. ### Create a DHCP configuration -Create a DHCP configuration. +Create a new DHCP configuration object, containing settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. The response object includes the ID of the DHCP configuration object. You can use this ID as part of a call to `Create a Public Gateway connection to a Private Network` or `Update a Public Gateway connection to a Private Network` to directly apply this DHCP configuration. **Usage:** @@ -69,28 +69,28 @@ scw vpc-gw dhcp create [arg=value ...] |------|---|-------------| | project-id | | Project ID to use. If none is passed the default project ID will be used | | subnet | Required | Subnet for the DHCP server | -| address | | Address of the DHCP server. This will be the gateway's address in the private network. Defaults to the first address of the subnet | -| pool-low | | Low IP (included) of the dynamic address pool | -| pool-high | | High IP (included) of the dynamic address pool | -| enable-dynamic | | Whether to enable dynamic pooling of IPs | +| address | | IP address of the DHCP server. This will be the gateway's address in the Private Network. Defaults to the first address of the subnet | +| pool-low | | Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet. Defaults to the second address of the subnet | +| pool-high | | High IP (inclusive) of the dynamic address pool. Must be in the config's subnet. Defaults to the last address of the subnet | +| enable-dynamic | | Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out. Defaults to true | | valid-lifetime.seconds | | | | valid-lifetime.nanos | | | | renew-timer.seconds | | | | renew-timer.nanos | | | | rebind-timer.seconds | | | | rebind-timer.nanos | | | -| push-default-route | | Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true | -| push-dns-server | | Whether the gateway should push custom DNS servers to clients | -| dns-servers-override.{index} | | Override the DNS server list pushed to DHCP clients, instead of the gateway itself | -| dns-search.{index} | | Additional DNS search paths | -| dns-local-name | | TLD given to hosts in the Private Network | +| push-default-route | | Defines whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true | +| push-dns-server | | Defines whether the gateway should push custom DNS servers to clients. This allows for Instance hostname -> IP resolution. Defaults to true | +| dns-servers-override.{index} | | Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself | +| dns-search.{index} | | Array of search paths in addition to the pushed DNS configuration | +| dns-local-name | | TLD given to hostnames in the Private Network. Allowed characters are `a-z0-9-.`. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to `priv` | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ### Delete a DHCP configuration -Delete a DHCP configuration. +Delete a DHCP configuration object, identified by its DHCP ID. Note that you cannot delete a DHCP configuration object that is currently being used by a Gateway Network. **Usage:** @@ -103,14 +103,14 @@ scw vpc-gw dhcp delete [arg=value ...] | Name | | Description | |------|---|-------------| -| dhcp-id | Required | DHCP config id to delete | +| dhcp-id | Required | DHCP configuration ID to delete | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ### Get a DHCP configuration -Get a DHCP configuration. +Get a DHCP configuration object, identified by its DHCP ID. The response object contains configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID. **Usage:** @@ -123,14 +123,14 @@ scw vpc-gw dhcp get [arg=value ...] | Name | | Description | |------|---|-------------| -| dhcp-id | Required | ID of the DHCP config to fetch | +| dhcp-id | Required | ID of the DHCP configuration to fetch | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ### List DHCP configurations -List DHCP configurations. +List DHCP configurations, optionally filtering by Organization, Project, Public Gateway IP address or more. The response is an array of DHCP configuration objects, each identified by a DHCP ID and containing configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID. **Usage:** @@ -144,17 +144,17 @@ scw vpc-gw dhcp list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `created_at_asc`, `created_at_desc`, `subnet_asc`, `subnet_desc` | Order in which to return results | -| project-id | | Include only DHCPs in this project | -| address | | Filter on gateway address | -| has-address | | Filter on subnets containing address | -| organization-id | | Include only DHCPs in this organization | +| project-id | | Include only DHCP configuration objects in this Project | +| address | | Filter for DHCP configuration objects with this DHCP server IP address (the gateway's address in the Private Network) | +| has-address | | Filter for DHCP configuration objects with subnets containing this IP address | +| organization-id | | Include only DHCP configuration objects in this Organization | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config | ### Update a DHCP configuration -Update a DHCP configuration. +Update a DHCP configuration object, identified by its DHCP ID. **Usage:** @@ -167,36 +167,36 @@ scw vpc-gw dhcp update [arg=value ...] | Name | | Description | |------|---|-------------| -| dhcp-id | Required | DHCP config to update | +| dhcp-id | Required | DHCP configuration to update | | subnet | | Subnet for the DHCP server | -| address | | Address of the DHCP server. This will be the gateway's address in the private network | -| pool-low | | Low IP (included) of the dynamic address pool | -| pool-high | | High IP (included) of the dynamic address pool | -| enable-dynamic | | Whether to enable dynamic pooling of IPs | +| address | | IP address of the DHCP server. This will be the Public Gateway's address in the Private Network. It must be part of config's subnet | +| pool-low | | Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet | +| pool-high | | High IP (inclusive) of the dynamic address pool. Must be in the config's subnet | +| enable-dynamic | | Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out. Defaults to true | | valid-lifetime.seconds | | | | valid-lifetime.nanos | | | | renew-timer.seconds | | | | renew-timer.nanos | | | | rebind-timer.seconds | | | | rebind-timer.nanos | | | -| push-default-route | | Whether the gateway should push a default route to DHCP clients or only hand out IPs | -| push-dns-server | | Whether the gateway should push custom DNS servers to clients | -| dns-servers-override.{index} | | Override the DNS server list pushed to DHCP clients, instead of the gateway itself | -| dns-search.{index} | | Additional DNS search paths | -| dns-local-name | | TLD given to hosts in the Private Network | +| push-default-route | | Defines whether the gateway should push a default route to DHCP clients, or only hand out IPs | +| push-dns-server | | Defines whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution | +| dns-servers-override.{index} | | Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself | +| dns-search.{index} | | Array of search paths in addition to the pushed DNS configuration | +| dns-local-name | | TLD given to hostnames in the Private Networks. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. Allowed characters are `a-z0-9-.` | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ## DHCP entries management -DHCP entries hold both dynamic DHCP leases (IP addresses dynamically assigned by the gateway to instances) and static user-created DHCP reservations. +DHCP entries belong to a specified Gateway Network (Public Gateway / Private Network connection). A DHCP entry can hold either a dynamic DHCP lease (an IP address dynamically assigned by the Public Gateway to a device) or a static, user-created DHCP reservation. -### Create a static DHCP reservation +### Create a DHCP entry -Create a static DHCP reservation. +Create a static DHCP reservation, specifying the Gateway Network for the reservation, the MAC address of the target device and the IP address to assign this device. The response is a DHCP entry object, confirming the ID and configuration details of the static DHCP reservation. **Usage:** @@ -211,14 +211,14 @@ scw vpc-gw dhcp-entry create [arg=value ...] |------|---|-------------| | gateway-network-id | | GatewayNetwork on which to create a DHCP reservation | | mac-address | | MAC address to give a static entry to | -| ip-address | | IP address to give to the machine | +| ip-address | | IP address to give to the device | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | -### Delete a DHCP reservation +### Delete a DHCP entry -Delete a DHCP reservation. +Delete a static DHCP reservation, identified by its DHCP entry ID. Note that you cannot delete DHCP entries of type `lease`, these are deleted automatically when their time-to-live expires. **Usage:** @@ -231,14 +231,14 @@ scw vpc-gw dhcp-entry delete [arg=value ...] | Name | | Description | |------|---|-------------| -| dhcp-entry-id | Required | DHCP entry ID to delete | +| dhcp-entry-id | Required | ID of the DHCP entry to delete | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | -### Get DHCP entries +### Get a DHCP entry -Get DHCP entries. +Get a DHCP entry, specified by its DHCP entry ID. **Usage:** @@ -258,7 +258,7 @@ scw vpc-gw dhcp-entry get [arg=value ...] ### List DHCP entries -List DHCP entries. +List DHCP entries, whether dynamically assigned and/or statically reserved. DHCP entries can be filtered by the Gateway Network they are on, their MAC address, IP address, type or hostname. **Usage:** @@ -272,18 +272,18 @@ scw vpc-gw dhcp-entry list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `created_at_asc`, `created_at_desc`, `ip_address_asc`, `ip_address_desc`, `hostname_asc`, `hostname_desc` | Order in which to return results | -| gateway-network-id | | Filter entries based on the gateway network they are on | -| mac-address | | Filter entries on their MAC address | -| ip-address | | Filter entries on their IP address | -| hostname | | Filter entries on their hostname substring | -| type | One of: `unknown`, `reservation`, `lease` | Filter entries on their type | +| gateway-network-id | | Filter for entries on this GatewayNetwork | +| mac-address | | Filter for entries with this MAC address | +| ip-address | | Filter for entries with this IP address | +| hostname | | Filter for entries with this hostname substring | +| type | One of: `unknown`, `reservation`, `lease` | Filter for entries of this type | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config | ### Set all DHCP reservations on a Gateway Network -Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries. +Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries accordingly. **Usage:** @@ -296,16 +296,16 @@ scw vpc-gw dhcp-entry set [arg=value ...] | Name | | Description | |------|---|-------------| -| gateway-network-id | | Gateway Network on which to set DHCP reservation list | +| gateway-network-id | | ID of the Gateway Network on which to set DHCP reservation list | | dhcp-entries.{index}.mac-address | | MAC address to give a static entry to | -| dhcp-entries.{index}.ip-address | | IP address to give to the machine | +| dhcp-entries.{index}.ip-address | | IP address to give to the device | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ### Update a DHCP entry -Update a DHCP entry. +Update the IP address for a DHCP entry, specified by its DHCP entry ID. You can update an existing DHCP entry of any type (`reservation` (static), `lease` (dynamic) or `unknown`), but in manually updating the IP address the entry will necessarily be of type `reservation` after the update. **Usage:** @@ -318,21 +318,21 @@ scw vpc-gw dhcp-entry update [arg=value ...] | Name | | Description | |------|---|-------------| -| dhcp-entry-id | Required | DHCP entry ID to update | -| ip-address | | New IP address to give to the machine | +| dhcp-entry-id | Required | ID of the DHCP entry to update | +| ip-address | | New IP address to give to the device | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | -## VPC Public Gateway management +## Public Gateway management -The VPC Public Gateway is a building block for your infrastructure on Scaleway's shared public cloud. It provides a set of managed network services and features for Scaleway's Private Networks such as DHCP, NAT and routing. +Public Gateways are building blocks for your infrastructure on Scaleway's shared public cloud. They provide a set of managed network services and features for Scaleway's Private Networks such as DHCP, NAT and routing. -### Create a VPC Public Gateway +### Create a Public Gateway -Create a VPC Public Gateway. +Create a new Public Gateway in the specified Scaleway Project, defining its **name**, **type** and other configuration details such as whether to enable SSH bastion. **Usage:** @@ -346,21 +346,21 @@ scw vpc-gw gateway create [arg=value ...] | Name | | Description | |------|---|-------------| | project-id | | Project ID to use. If none is passed the default project ID will be used | -| name | Default: `` | Name of the gateway | +| name | Default: `` | Name for the gateway | | tags.{index} | | Tags for the gateway | -| type | Default: `VPC-GW-S` | Gateway type | -| upstream-dns-servers.{index} | | Override the gateway's default recursive DNS servers, if DNS features are enabled | -| ip-id | | Attach an existing IP to the gateway | -| enable-smtp | | Allow SMTP traffic to pass through the gateway | -| enable-bastion | | Enable SSH bastion on the gateway | +| type | Default: `VPC-GW-S` | Gateway type (commercial offer type) | +| upstream-dns-servers.{index} | | Array of DNS server IP addresses to override the gateway's default recursive DNS servers | +| ip-id | | Existing IP address to attach to the gateway | +| enable-smtp | | Defines whether SMTP traffic should be allowed pass through the gateway | +| enable-bastion | | Defines whether SSH bastion should be enabled the gateway | | bastion-port | | Port of the SSH bastion | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | -### Delete a VPC Public Gateway +### Delete a Public Gateway -Delete a VPC Public Gateway. +Delete an existing Public Gateway, specified by its gateway ID. This action is irreversible. **Usage:** @@ -374,14 +374,14 @@ scw vpc-gw gateway delete [arg=value ...] | Name | | Description | |------|---|-------------| | gateway-id | Required | ID of the gateway to delete | -| cleanup-dhcp | | Whether to cleanup attached DHCP configurations | +| cleanup-dhcp | | Defines whether to clean up attached DHCP configurations (if any, and if not attached to another Gateway Network) | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | -### Get a VPC Public Gateway +### Get a Public Gateway -Get a VPC Public Gateway. +Get details of a Public Gateway, specified by its gateway ID. The response object contains full details of the gateway, including its **name**, **type**, **status** and more. **Usage:** @@ -399,9 +399,9 @@ scw vpc-gw gateway get [arg=value ...] -### List VPC Public Gateways +### List Public Gateways -List VPC Public Gateways. +List Public Gateways in a given Scaleway Organization or Project. By default, results are displayed in ascending order of creation date. **Usage:** @@ -415,20 +415,20 @@ scw vpc-gw gateway list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `type_asc`, `type_desc`, `status_asc`, `status_desc` | Order in which to return results | -| project-id | | Include only gateways in this project | -| name | | Filter gateways including this name | -| tags.{index} | | Filter gateways with these tags | -| type | | Filter gateways of this type | -| status | One of: `unknown`, `stopped`, `allocating`, `configuring`, `running`, `stopping`, `failed`, `deleting`, `deleted`, `locked` | Filter gateways in this status (unknown for any) | -| private-network-id | | Filter gateways attached to this private network | -| organization-id | | Include only gateways in this organization | +| project-id | | Include only gateways in this Project | +| name | | Filter for gateways which have this search term in their name | +| tags.{index} | | Filter for gateways with these tags | +| type | | Filter for gateways of this type | +| status | One of: `unknown`, `stopped`, `allocating`, `configuring`, `running`, `stopping`, `failed`, `deleting`, `deleted`, `locked` | Filter for gateways with this current status. Use `unknown` to include all statuses | +| private-network-id | | Filter for gateways attached to this Private nNetwork | +| organization-id | | Include only gateways in this Organization | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config | -### Refresh SSH keys of a VPC Public Gateway +### Refresh a Public Gateway's SSH keys -Refresh SSH keys of a VPC Public Gateway. +Refresh the SSH keys of a given Public Gateway, specified by its gateway ID. This adds any new SSH keys in the gateway's Scaleway Project to the gateway itself. **Usage:** @@ -441,14 +441,14 @@ scw vpc-gw gateway refresh-ssh-keys [arg=value ...] | Name | | Description | |------|---|-------------| -| gateway-id | Required | ID of the gateway that needs fresh ssh keys | +| gateway-id | Required | ID of the gateway to refresh SSH keys on | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | -### Update a VPC Public Gateway +### Update a Public Gateway -Update a VPC Public Gateway. +Update the parameters of an existing Public Gateway, for example, its **name**, **tags**, **SSH bastion configuration**, and **DNS servers**. **Usage:** @@ -462,19 +462,19 @@ scw vpc-gw gateway update [arg=value ...] | Name | | Description | |------|---|-------------| | gateway-id | Required | ID of the gateway to update | -| name | | Name fo the gateway | +| name | | Name for the gateway | | tags.{index} | | Tags for the gateway | -| upstream-dns-servers.{index} | | Override the gateway's default recursive DNS servers, if DNS features are enabled | -| enable-bastion | | Enable SSH bastion on the gateway | +| upstream-dns-servers.{index} | | Array of DNS server IP addresses to override the gateway's default recursive DNS servers | +| enable-bastion | | Defines whether SSH bastion should be enabled the gateway | | bastion-port | | Port of the SSH bastion | -| enable-smtp | | Allow SMTP traffic to pass through the gateway | +| enable-smtp | | Defines whether SMTP traffic should be allowed to pass through the gateway | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | -### Upgrade a VPC Public Gateway to the latest version +### Upgrade a Public Gateway to the latest version -Upgrade a VPC Public Gateway to the latest version. +Upgrade a given Public Gateway to the newest software version. This applies the latest bugfixes and features to your Public Gateway, but its service will be interrupted during the update. **Usage:** @@ -494,13 +494,13 @@ scw vpc-gw gateway upgrade [arg=value ...] ## Gateway Networks management -A Gateway Network represents the connection of a Private Network to a VPC Public Gateway. It holds configuration options relative to this specific connection, such as the DHCP configuration. +A Gateway Network represents the connection of a Private Network to a Public Gateway. It holds configuration options relative to this specific connection, such as the DHCP configuration. -### Attach a gateway to a Private Network +### Attach a Public Gateway to a Private Network -Attach a gateway to a Private Network. +Attach a specific Public Gateway to a specific Private Network (create a GatewayNetwork). You can configure parameters for the connection including DHCP settings, whether to enable masquerade (dynamic NAT), and more. **Usage:** @@ -513,19 +513,19 @@ scw vpc-gw gateway-network create [arg=value ...] | Name | | Description | |------|---|-------------| -| gateway-id | | Gateway to connect | +| gateway-id | | Public Gateway to connect | | private-network-id | | Private Network to connect | -| enable-masquerade | | Whether to enable masquerade on this network | -| dhcp-id | | Existing configuration | +| enable-masquerade | | Defines whether to enable masquerade (dynamic NAT) on this network | +| dhcp-id | | ID of an existing DHCP configuration object to use for this GatewayNetwork | | address | | Static IP address in CIDR format to to use without DHCP | -| enable-dhcp | | Whether to enable DHCP on this Private Network | +| enable-dhcp | | Defines whether to enable DHCP on this Private Network. Defaults to `true` if either `dhcp_id` or `dhcp` are present. If set to `true`, either `dhcp_id` or `dhcp` must be present | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | -### Detach a gateway from a Private Network +### Detach a Public Gateway from a Private Network -Detach a gateway from a Private Network. +Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id. **Usage:** @@ -538,15 +538,15 @@ scw vpc-gw gateway-network delete [arg=value ...] | Name | | Description | |------|---|-------------| -| gateway-network-id | Required | GatewayNetwork to delete | -| cleanup-dhcp | | Whether to cleanup the attached DHCP configuration | +| gateway-network-id | Required | ID of the GatewayNetwork to delete | +| cleanup-dhcp | | Defines whether to clean up attached DHCP configurations (if any, and if not attached to another Gateway Network) | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | -### Get a gateway connection to a Private Network +### Get a Public Gateway connection to a Private Network -Get a gateway connection to a Private Network. +Get details of a given connection between a Public Gateway and a Private Network (this connection = a GatewayNetwork), specified by its `gateway_network_id`. The response object contains details of the connection including the IDs of the Public Gateway and Private Network, the dates the connection was created/updated and its configuration settings. **Usage:** @@ -564,9 +564,9 @@ scw vpc-gw gateway-network get [arg=value ...] -### List gateway connections to Private Networks +### List Public Gateway connections to Private Networks -List gateway connections to Private Networks. +List the connections between Public Gateways and Private Networks (a connection = a GatewayNetwork). You can choose to filter by `gateway-id` to list all Private Networks attached to the specified Public Gateway, or by `private_network_id` to list all Public Gateways attached to the specified Private Network. Other query parameters are also available. The result is an array of GatewayNetwork objects, each giving details of the connection between a given Public Gateway and a given Private Network. **Usage:** @@ -580,18 +580,18 @@ scw vpc-gw gateway-network list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `created_at_asc`, `created_at_desc`, `status_asc`, `status_desc` | Order in which to return results | -| gateway-id | | Filter by gateway | -| private-network-id | | Filter by private network | -| enable-masquerade | | Filter by masquerade enablement | -| dhcp-id | | Filter by DHCP configuration | -| status | One of: `unknown`, `created`, `attaching`, `configuring`, `ready`, `detaching`, `deleted` | Filter GatewayNetworks by this status (unknown for any) | +| gateway-id | | Filter for GatewayNetworks connected to this gateway | +| private-network-id | | Filter for GatewayNetworks connected to this Private Network | +| enable-masquerade | | Filter for GatewayNetworks with this `enable_masquerade` setting | +| dhcp-id | | Filter for GatewayNetworks using this DHCP configuration | +| status | One of: `unknown`, `created`, `attaching`, `configuring`, `ready`, `detaching`, `deleted` | Filter for GatewayNetworks with this current status this status. Use `unknown` to include all statuses | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config | -### Update a gateway connection to a Private Network +### Update a Public Gateway's connection to a Private Network -Update a gateway connection to a Private Network. +Update the configuration parameters of a connection between a given Public Gateway and Private Network (the connection = a GatewayNetwork). Updatable parameters include DHCP settings and whether to enable traffic masquerade (dynamic NAT). **Usage:** @@ -605,9 +605,9 @@ scw vpc-gw gateway-network update [arg=value ...] | Name | | Description | |------|---|-------------| | gateway-network-id | Required | ID of the GatewayNetwork to update | -| enable-masquerade | | New masquerade enablement | -| dhcp-id | | New DHCP configuration | -| enable-dhcp | | Whether to enable DHCP on the connected Private Network | +| enable-masquerade | | Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork | +| dhcp-id | | ID of the new DHCP configuration object to use with this GatewayNetwork | +| enable-dhcp | | Defines whether to enable DHCP on the connected Private Network | | address | | New static IP address | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | @@ -615,13 +615,13 @@ scw vpc-gw gateway-network update [arg=value ...] ## Gateway types information -Gateways come in multiple shapes and size, which are described by the various gateway types. +Public Gateways come in various shapes, sizes and prices, which are described by gateway types. They represent the different commercial offer types for Public Gateways available at Scaleway. -### List VPC Public Gateway types +### List Public Gateway types -List VPC Public Gateway types. +List the different Public Gateway commercial offer types available at Scaleway. The response is an array of objects describing the name and technical details of each available gateway type. **Usage:** @@ -640,13 +640,13 @@ scw vpc-gw gateway-type list [arg=value ...] ## IP address management -A VPC Public Gateway has a public IP address, allowing it to reach the public internet, as well as forward (masquerade) traffic from member instances of attached Private Networks. +Public, flexible IP addresses for Public Gateways, allowing the gateway to reach the public internet, as well as forward (masquerade) traffic from member devices of attached Private Networks. ### Reserve an IP -Reserve an IP. +Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project. **Usage:** @@ -660,14 +660,14 @@ scw vpc-gw ip create [arg=value ...] | Name | | Description | |------|---|-------------| | project-id | | Project ID to use. If none is passed the default project ID will be used | -| tags.{index} | | Tags to give to the IP | +| tags.{index} | | Tags to give to the IP address | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ### Delete an IP -Delete an IP. +Delete a flexible IP address from your account. This action is irreversible. **Usage:** @@ -680,14 +680,14 @@ scw vpc-gw ip delete [arg=value ...] | Name | | Description | |------|---|-------------| -| ip-id | Required | ID of the IP to delete | +| ip-id | Required | ID of the IP address to delete | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ### Get an IP -Get an IP. +Get details of a Public Gateway flexible IP address, identified by its IP ID. The response object contains information including which (if any) Public Gateway using this IP address, the reverse and various other metadata. **Usage:** @@ -700,14 +700,14 @@ scw vpc-gw ip get [arg=value ...] | Name | | Description | |------|---|-------------| -| ip-id | Required | ID of the IP to get | +| ip-id | Required | ID of the IP address to get | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ### List IPs -List IPs. +List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response. **Usage:** @@ -721,18 +721,18 @@ scw vpc-gw ip list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `created_at_asc`, `created_at_desc`, `ip_asc`, `ip_desc`, `reverse_asc`, `reverse_desc` | Order in which to return results | -| project-id | | Include only IPs in this project | -| tags.{index} | | Filter IPs with these tags | -| reverse | | Filter by reverse containing this string | -| is-free | | Filter whether the IP is attached to a gateway or not | -| organization-id | | Include only IPs in this organization | +| project-id | | Filter for IP addresses in this Project | +| tags.{index} | | Filter for IP addresses with these tags | +| reverse | | Filter for IP addresses that have a reverse containing this string | +| is-free | | Filter based on whether the IP is attached to a gateway or not | +| organization-id | | Filter for IP addresses in this Organization | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config | ### Update an IP -Update an IP. +Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to. **Usage:** @@ -745,23 +745,23 @@ scw vpc-gw ip update [arg=value ...] | Name | | Description | |------|---|-------------| -| ip-id | Required | ID of the IP to update | -| tags.{index} | | Tags to give to the IP | -| reverse | | Reverse to set on the IP. Empty string to unset | -| gateway-id | | Gateway to attach the IP to. Empty string to detach | +| ip-id | Required | ID of the IP address to update | +| tags.{index} | | Tags to give to the IP address | +| reverse | | Reverse to set on the address. Empty string to unset | +| gateway-id | | Gateway to attach the IP address to. Empty string to detach | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ## PAT rules management -PAT (Port Address Translation) rules are global to a gateway. They define the forwarding of a public port to a specific instance on a Private Network. +PAT (Port Address Translation) rules, aka static NAT rules, belong to a specified Public Gateway. They define the forwarding of a public port to a specific device on a Private Network, enabling enables ingress traffic from the public Internet to reach the correct device in the Private Network. ### Create a PAT rule -Create a PAT rule. +Create a new PAT rule on a specified Public Gateway, defining the protocol to use, public port to listen on, and private port / IP address to map to. **Usage:** @@ -774,7 +774,7 @@ scw vpc-gw pat-rule create [arg=value ...] | Name | | Description | |------|---|-------------| -| gateway-id | | Gateway on which to attach the rule to | +| gateway-id | | ID of the Gateway on which to create the rule | | public-port | | Public port to listen on | | private-ip | | Private IP to forward data to | | private-port | | Private port to translate to | @@ -785,7 +785,7 @@ scw vpc-gw pat-rule create [arg=value ...] ### Delete a PAT rule -Delete a PAT rule. +Delete a PAT rule, identified by its PAT rule ID. This action is irreversible. **Usage:** @@ -798,14 +798,14 @@ scw vpc-gw pat-rule delete [arg=value ...] | Name | | Description | |------|---|-------------| -| pat-rule-id | Required | PAT rule to delete | +| pat-rule-id | Required | ID of the PAT rule to delete | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ### Get a PAT rule -Get a PAT rule. +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. **Usage:** @@ -818,14 +818,14 @@ scw vpc-gw pat-rule get [arg=value ...] | Name | | Description | |------|---|-------------| -| pat-rule-id | Required | PAT rule to get | +| pat-rule-id | Required | ID of the PAT rule to get | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config | ### List PAT rules -List PAT rules. +List PAT rules. You can filter by gateway ID to list all PAT rules for a particular gateway, or filter for PAT rules targeting a specific IP address or using a specific protocol. **Usage:** @@ -839,16 +839,16 @@ scw vpc-gw pat-rule list [arg=value ...] | Name | | Description | |------|---|-------------| | order-by | One of: `created_at_asc`, `created_at_desc`, `public_port_asc`, `public_port_desc` | Order in which to return results | -| gateway-id | | Fetch rules for this gateway | -| private-ip | | Fetch rules targeting this private ip | -| protocol | One of: `unknown`, `both`, `tcp`, `udp` | Fetch rules for this protocol | +| gateway-id | | Filter for PAT rules on this Gateway | +| private-ip | | Filter for PAT rules targeting this private ip | +| protocol | One of: `unknown`, `both`, `tcp`, `udp` | Filter for PAT rules with this protocol | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config | -### Set all PAT rules on a Gateway +### Set all PAT rules -Set the list of PAT rules attached to a Gateway. Rules are identified by their public port and protocol. This will sync the current PAT rule list with the givent list, creating, updating or deleting PAT rules. +Set a definitive list of PAT rules attached to a Public Gateway. Each rule is identified by its public port and protocol. This will sync the current PAT rule list on the gateway with the new list, creating, updating or deleting PAT rules accordingly. **Usage:** @@ -861,7 +861,7 @@ scw vpc-gw pat-rule set [arg=value ...] | Name | | Description | |------|---|-------------| -| gateway-id | | Gateway on which to set the PAT rules | +| gateway-id | | ID of the gateway on which to set the PAT rules | | pat-rules.{index}.public-port | | Public port to listen on | | pat-rules.{index}.private-ip | | Private IP to forward data to | | pat-rules.{index}.private-port | | Private port to translate to | @@ -872,7 +872,7 @@ scw vpc-gw pat-rule set [arg=value ...] ### Update a PAT rule -Update a PAT rule. +Update a PAT rule, specified by its PAT rule ID. Configuration settings including private/public port, private IP address and protocol can all be updated. **Usage:** @@ -885,7 +885,7 @@ scw vpc-gw pat-rule update [arg=value ...] | Name | | Description | |------|---|-------------| -| pat-rule-id | Required | PAT rule to update | +| pat-rule-id | Required | ID of the PAT rule to update | | public-port | | Public port to listen on | | private-ip | | Private IP to forward data to | | private-port | | Private port to translate to | diff --git a/go.mod b/go.mod index 464996fe37..2d77f4760a 100644 --- a/go.mod +++ b/go.mod @@ -19,7 +19,7 @@ require ( github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98 github.com/mattn/go-colorable v0.1.13 github.com/mattn/go-isatty v0.0.17 - github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230310155856-7a2786489bc6 + github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314101523-398c37802c41 github.com/spf13/cobra v1.6.1 github.com/spf13/pflag v1.0.5 github.com/stretchr/testify v1.8.2 diff --git a/go.sum b/go.sum index 76be72212c..d6cfc3cd51 100644 --- a/go.sum +++ b/go.sum @@ -72,8 +72,8 @@ github.com/pkg/term v1.1.0/go.mod h1:E25nymQcrSllhX42Ok8MRm1+hyBdHY0dCeiKZ9jpNGw github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230310155856-7a2786489bc6 h1:bAqxZt/1FAD/M4XLqWYHySz5kNcoQ7Mrdo7imgWAyaQ= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230310155856-7a2786489bc6/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314101523-398c37802c41 h1:D9rWQCzAaXoBOEQTnw+x5YI1JLZRj/ccKtT4u5DCC1E= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314101523-398c37802c41/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ= github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA= diff --git a/internal/namespaces/vpcgw/v1/vpcgw_cli.go b/internal/namespaces/vpcgw/v1/vpcgw_cli.go index cabe96b8c3..942b9daad7 100644 --- a/internal/namespaces/vpcgw/v1/vpcgw_cli.go +++ b/internal/namespaces/vpcgw/v1/vpcgw_cli.go @@ -66,16 +66,16 @@ func GetGeneratedCommands() *core.Commands { } func vpcGwRoot() *core.Command { return &core.Command{ - Short: `VPC Public Gateway API`, - Long: `VPC Public Gateway API.`, + Short: `Public Gateways API`, + Long: `Public Gateways API.`, Namespace: "vpc-gw", } } func vpcGwGateway() *core.Command { return &core.Command{ - Short: `VPC Public Gateway management`, - Long: `The VPC Public Gateway is a building block for your infrastructure on Scaleway's shared public cloud. It provides a set of managed network services and features for Scaleway's Private Networks such as DHCP, NAT and routing. + Short: `Public Gateway management`, + Long: `Public Gateways are building blocks for your infrastructure on Scaleway's shared public cloud. They provide a set of managed network services and features for Scaleway's Private Networks such as DHCP, NAT and routing. `, Namespace: "vpc-gw", Resource: "gateway", @@ -85,7 +85,7 @@ func vpcGwGateway() *core.Command { func vpcGwGatewayNetwork() *core.Command { return &core.Command{ Short: `Gateway Networks management`, - Long: `A Gateway Network represents the connection of a Private Network to a VPC Public Gateway. It holds configuration options relative to this specific connection, such as the DHCP configuration. + Long: `A Gateway Network represents the connection of a Private Network to a Public Gateway. It holds configuration options relative to this specific connection, such as the DHCP configuration. `, Namespace: "vpc-gw", Resource: "gateway-network", @@ -95,7 +95,7 @@ func vpcGwGatewayNetwork() *core.Command { func vpcGwDHCP() *core.Command { return &core.Command{ Short: `DHCP configuration management`, - Long: `DHCP configuration allows you to set parameters for assignment of IP addresses to devices on a Private Network attached to a VPC Public Gateway (subnet, lease time etc). + Long: `These objects define a DHCP configuration, i.e. how IP addresses should be assigned to devices on a Private Network attached to a Public Gateway. Definable parameters include the subnet for the DHCP server, the validity period for DHCP entries, whether to use dynamic pooling, and more. A DHCP configuration object has a DHCP ID, which can then be used as part of a call to create or update a Gateway Network. This lets you attach an existing DHCP configuration to a Public Gateway attached to a Private Network. Similarly, you can use a DHCP ID as a query parameter to list Gateway Networks which use this DHCP configuration object. `, Namespace: "vpc-gw", Resource: "dhcp", @@ -105,7 +105,7 @@ func vpcGwDHCP() *core.Command { func vpcGwDHCPEntry() *core.Command { return &core.Command{ Short: `DHCP entries management`, - Long: `DHCP entries hold both dynamic DHCP leases (IP addresses dynamically assigned by the gateway to instances) and static user-created DHCP reservations. + Long: `DHCP entries belong to a specified Gateway Network (Public Gateway / Private Network connection). A DHCP entry can hold either a dynamic DHCP lease (an IP address dynamically assigned by the Public Gateway to a device) or a static, user-created DHCP reservation. `, Namespace: "vpc-gw", Resource: "dhcp-entry", @@ -115,7 +115,7 @@ func vpcGwDHCPEntry() *core.Command { func vpcGwPatRule() *core.Command { return &core.Command{ Short: `PAT rules management`, - Long: `PAT (Port Address Translation) rules are global to a gateway. They define the forwarding of a public port to a specific instance on a Private Network. + Long: `PAT (Port Address Translation) rules, aka static NAT rules, belong to a specified Public Gateway. They define the forwarding of a public port to a specific device on a Private Network, enabling enables ingress traffic from the public Internet to reach the correct device in the Private Network. `, Namespace: "vpc-gw", Resource: "pat-rule", @@ -125,7 +125,7 @@ func vpcGwPatRule() *core.Command { func vpcGwIP() *core.Command { return &core.Command{ Short: `IP address management`, - Long: `A VPC Public Gateway has a public IP address, allowing it to reach the public internet, as well as forward (masquerade) traffic from member instances of attached Private Networks. + Long: `Public, flexible IP addresses for Public Gateways, allowing the gateway to reach the public internet, as well as forward (masquerade) traffic from member devices of attached Private Networks. `, Namespace: "vpc-gw", Resource: "ip", @@ -135,7 +135,7 @@ func vpcGwIP() *core.Command { func vpcGwGatewayType() *core.Command { return &core.Command{ Short: `Gateway types information`, - Long: `Gateways come in multiple shapes and size, which are described by the various gateway types. + Long: `Public Gateways come in various shapes, sizes and prices, which are described by gateway types. They represent the different commercial offer types for Public Gateways available at Scaleway. `, Namespace: "vpc-gw", Resource: "gateway-type", @@ -144,8 +144,8 @@ func vpcGwGatewayType() *core.Command { func vpcGwGatewayList() *core.Command { return &core.Command{ - Short: `List VPC Public Gateways`, - Long: `List VPC Public Gateways.`, + Short: `List Public Gateways`, + Long: `List Public Gateways in a given Scaleway Organization or Project. By default, results are displayed in ascending order of creation date.`, Namespace: "vpc-gw", Resource: "gateway", Verb: "list", @@ -162,35 +162,35 @@ func vpcGwGatewayList() *core.Command { }, { Name: "project-id", - Short: `Include only gateways in this project`, + Short: `Include only gateways in this Project`, Required: false, Deprecated: false, Positional: false, }, { Name: "name", - Short: `Filter gateways including this name`, + Short: `Filter for gateways which have this search term in their name`, Required: false, Deprecated: false, Positional: false, }, { Name: "tags.{index}", - Short: `Filter gateways with these tags`, + Short: `Filter for gateways with these tags`, Required: false, Deprecated: false, Positional: false, }, { Name: "type", - Short: `Filter gateways of this type`, + Short: `Filter for gateways of this type`, Required: false, Deprecated: false, Positional: false, }, { Name: "status", - Short: `Filter gateways in this status (unknown for any)`, + Short: `Filter for gateways with this current status. Use ` + "`" + `unknown` + "`" + ` to include all statuses`, Required: false, Deprecated: false, Positional: false, @@ -198,14 +198,14 @@ func vpcGwGatewayList() *core.Command { }, { Name: "private-network-id", - Short: `Filter gateways attached to this private network`, + Short: `Filter for gateways attached to this Private nNetwork`, Required: false, Deprecated: false, Positional: false, }, { Name: "organization-id", - Short: `Include only gateways in this organization`, + Short: `Include only gateways in this Organization`, Required: false, Deprecated: false, Positional: false, @@ -269,8 +269,8 @@ func vpcGwGatewayList() *core.Command { func vpcGwGatewayGet() *core.Command { return &core.Command{ - Short: `Get a VPC Public Gateway`, - Long: `Get a VPC Public Gateway.`, + Short: `Get a Public Gateway`, + Long: `Get details of a Public Gateway, specified by its gateway ID. The response object contains full details of the gateway, including its **name**, **type**, **status** and more.`, Namespace: "vpc-gw", Resource: "gateway", Verb: "get", @@ -299,8 +299,8 @@ func vpcGwGatewayGet() *core.Command { func vpcGwGatewayCreate() *core.Command { return &core.Command{ - Short: `Create a VPC Public Gateway`, - Long: `Create a VPC Public Gateway.`, + Short: `Create a Public Gateway`, + Long: `Create a new Public Gateway in the specified Scaleway Project, defining its **name**, **type** and other configuration details such as whether to enable SSH bastion.`, Namespace: "vpc-gw", Resource: "gateway", Verb: "create", @@ -310,7 +310,7 @@ func vpcGwGatewayCreate() *core.Command { core.ProjectIDArgSpec(), { Name: "name", - Short: `Name of the gateway`, + Short: `Name for the gateway`, Required: false, Deprecated: false, Positional: false, @@ -325,7 +325,7 @@ func vpcGwGatewayCreate() *core.Command { }, { Name: "type", - Short: `Gateway type`, + Short: `Gateway type (commercial offer type)`, Required: false, Deprecated: false, Positional: false, @@ -333,28 +333,28 @@ func vpcGwGatewayCreate() *core.Command { }, { Name: "upstream-dns-servers.{index}", - Short: `Override the gateway's default recursive DNS servers, if DNS features are enabled`, + Short: `Array of DNS server IP addresses to override the gateway's default recursive DNS servers`, Required: false, Deprecated: false, Positional: false, }, { Name: "ip-id", - Short: `Attach an existing IP to the gateway`, + Short: `Existing IP address to attach to the gateway`, Required: false, Deprecated: false, Positional: false, }, { Name: "enable-smtp", - Short: `Allow SMTP traffic to pass through the gateway`, + Short: `Defines whether SMTP traffic should be allowed pass through the gateway`, Required: false, Deprecated: false, Positional: false, }, { Name: "enable-bastion", - Short: `Enable SSH bastion on the gateway`, + Short: `Defines whether SSH bastion should be enabled the gateway`, Required: false, Deprecated: false, Positional: false, @@ -381,8 +381,8 @@ func vpcGwGatewayCreate() *core.Command { func vpcGwGatewayUpdate() *core.Command { return &core.Command{ - Short: `Update a VPC Public Gateway`, - Long: `Update a VPC Public Gateway.`, + Short: `Update a Public Gateway`, + Long: `Update the parameters of an existing Public Gateway, for example, its **name**, **tags**, **SSH bastion configuration**, and **DNS servers**.`, Namespace: "vpc-gw", Resource: "gateway", Verb: "update", @@ -398,7 +398,7 @@ func vpcGwGatewayUpdate() *core.Command { }, { Name: "name", - Short: `Name fo the gateway`, + Short: `Name for the gateway`, Required: false, Deprecated: false, Positional: false, @@ -412,14 +412,14 @@ func vpcGwGatewayUpdate() *core.Command { }, { Name: "upstream-dns-servers.{index}", - Short: `Override the gateway's default recursive DNS servers, if DNS features are enabled`, + Short: `Array of DNS server IP addresses to override the gateway's default recursive DNS servers`, Required: false, Deprecated: false, Positional: false, }, { Name: "enable-bastion", - Short: `Enable SSH bastion on the gateway`, + Short: `Defines whether SSH bastion should be enabled the gateway`, Required: false, Deprecated: false, Positional: false, @@ -433,7 +433,7 @@ func vpcGwGatewayUpdate() *core.Command { }, { Name: "enable-smtp", - Short: `Allow SMTP traffic to pass through the gateway`, + Short: `Defines whether SMTP traffic should be allowed to pass through the gateway`, Required: false, Deprecated: false, Positional: false, @@ -453,8 +453,8 @@ func vpcGwGatewayUpdate() *core.Command { func vpcGwGatewayDelete() *core.Command { return &core.Command{ - Short: `Delete a VPC Public Gateway`, - Long: `Delete a VPC Public Gateway.`, + Short: `Delete a Public Gateway`, + Long: `Delete an existing Public Gateway, specified by its gateway ID. This action is irreversible.`, Namespace: "vpc-gw", Resource: "gateway", Verb: "delete", @@ -470,7 +470,7 @@ func vpcGwGatewayDelete() *core.Command { }, { Name: "cleanup-dhcp", - Short: `Whether to cleanup attached DHCP configurations`, + Short: `Defines whether to clean up attached DHCP configurations (if any, and if not attached to another Gateway Network)`, Required: false, Deprecated: false, Positional: false, @@ -496,8 +496,8 @@ func vpcGwGatewayDelete() *core.Command { func vpcGwGatewayUpgrade() *core.Command { return &core.Command{ - Short: `Upgrade a VPC Public Gateway to the latest version`, - Long: `Upgrade a VPC Public Gateway to the latest version.`, + Short: `Upgrade a Public Gateway to the latest version`, + Long: `Upgrade a given Public Gateway to the newest software version. This applies the latest bugfixes and features to your Public Gateway, but its service will be interrupted during the update.`, Namespace: "vpc-gw", Resource: "gateway", Verb: "upgrade", @@ -526,8 +526,8 @@ func vpcGwGatewayUpgrade() *core.Command { func vpcGwGatewayNetworkList() *core.Command { return &core.Command{ - Short: `List gateway connections to Private Networks`, - Long: `List gateway connections to Private Networks.`, + Short: `List Public Gateway connections to Private Networks`, + Long: `List the connections between Public Gateways and Private Networks (a connection = a GatewayNetwork). You can choose to filter by ` + "`" + `gateway-id` + "`" + ` to list all Private Networks attached to the specified Public Gateway, or by ` + "`" + `private_network_id` + "`" + ` to list all Public Gateways attached to the specified Private Network. Other query parameters are also available. The result is an array of GatewayNetwork objects, each giving details of the connection between a given Public Gateway and a given Private Network.`, Namespace: "vpc-gw", Resource: "gateway-network", Verb: "list", @@ -544,35 +544,35 @@ func vpcGwGatewayNetworkList() *core.Command { }, { Name: "gateway-id", - Short: `Filter by gateway`, + Short: `Filter for GatewayNetworks connected to this gateway`, Required: false, Deprecated: false, Positional: false, }, { Name: "private-network-id", - Short: `Filter by private network`, + Short: `Filter for GatewayNetworks connected to this Private Network`, Required: false, Deprecated: false, Positional: false, }, { Name: "enable-masquerade", - Short: `Filter by masquerade enablement`, + Short: `Filter for GatewayNetworks with this ` + "`" + `enable_masquerade` + "`" + ` setting`, Required: false, Deprecated: false, Positional: false, }, { Name: "dhcp-id", - Short: `Filter by DHCP configuration`, + Short: `Filter for GatewayNetworks using this DHCP configuration`, Required: false, Deprecated: false, Positional: false, }, { Name: "status", - Short: `Filter GatewayNetworks by this status (unknown for any)`, + Short: `Filter for GatewayNetworks with this current status this status. Use ` + "`" + `unknown` + "`" + ` to include all statuses`, Required: false, Deprecated: false, Positional: false, @@ -637,8 +637,8 @@ func vpcGwGatewayNetworkList() *core.Command { func vpcGwGatewayNetworkGet() *core.Command { return &core.Command{ - Short: `Get a gateway connection to a Private Network`, - Long: `Get a gateway connection to a Private Network.`, + Short: `Get a Public Gateway connection to a Private Network`, + Long: `Get details of a given connection between a Public Gateway and a Private Network (this connection = a GatewayNetwork), specified by its ` + "`" + `gateway_network_id` + "`" + `. The response object contains details of the connection including the IDs of the Public Gateway and Private Network, the dates the connection was created/updated and its configuration settings.`, Namespace: "vpc-gw", Resource: "gateway-network", Verb: "get", @@ -667,8 +667,8 @@ func vpcGwGatewayNetworkGet() *core.Command { func vpcGwGatewayNetworkCreate() *core.Command { return &core.Command{ - Short: `Attach a gateway to a Private Network`, - Long: `Attach a gateway to a Private Network.`, + Short: `Attach a Public Gateway to a Private Network`, + Long: `Attach a specific Public Gateway to a specific Private Network (create a GatewayNetwork). You can configure parameters for the connection including DHCP settings, whether to enable masquerade (dynamic NAT), and more.`, Namespace: "vpc-gw", Resource: "gateway-network", Verb: "create", @@ -677,7 +677,7 @@ func vpcGwGatewayNetworkCreate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "gateway-id", - Short: `Gateway to connect`, + Short: `Public Gateway to connect`, Required: false, Deprecated: false, Positional: false, @@ -691,14 +691,14 @@ func vpcGwGatewayNetworkCreate() *core.Command { }, { Name: "enable-masquerade", - Short: `Whether to enable masquerade on this network`, + Short: `Defines whether to enable masquerade (dynamic NAT) on this network`, Required: false, Deprecated: false, Positional: false, }, { Name: "dhcp-id", - Short: `Existing configuration`, + Short: `ID of an existing DHCP configuration object to use for this GatewayNetwork`, Required: false, Deprecated: false, Positional: false, @@ -712,7 +712,7 @@ func vpcGwGatewayNetworkCreate() *core.Command { }, { Name: "enable-dhcp", - Short: `Whether to enable DHCP on this Private Network`, + Short: `Defines whether to enable DHCP on this Private Network. Defaults to ` + "`" + `true` + "`" + ` if either ` + "`" + `dhcp_id` + "`" + ` or ` + "`" + `dhcp` + "`" + ` are present. If set to ` + "`" + `true` + "`" + `, either ` + "`" + `dhcp_id` + "`" + ` or ` + "`" + `dhcp` + "`" + ` must be present`, Required: false, Deprecated: false, Positional: false, @@ -732,8 +732,8 @@ func vpcGwGatewayNetworkCreate() *core.Command { func vpcGwGatewayNetworkUpdate() *core.Command { return &core.Command{ - Short: `Update a gateway connection to a Private Network`, - Long: `Update a gateway connection to a Private Network.`, + Short: `Update a Public Gateway's connection to a Private Network`, + Long: `Update the configuration parameters of a connection between a given Public Gateway and Private Network (the connection = a GatewayNetwork). Updatable parameters include DHCP settings and whether to enable traffic masquerade (dynamic NAT).`, Namespace: "vpc-gw", Resource: "gateway-network", Verb: "update", @@ -749,21 +749,21 @@ func vpcGwGatewayNetworkUpdate() *core.Command { }, { Name: "enable-masquerade", - Short: `New masquerade enablement`, + Short: `Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork`, Required: false, Deprecated: false, Positional: false, }, { Name: "dhcp-id", - Short: `New DHCP configuration`, + Short: `ID of the new DHCP configuration object to use with this GatewayNetwork`, Required: false, Deprecated: false, Positional: false, }, { Name: "enable-dhcp", - Short: `Whether to enable DHCP on the connected Private Network`, + Short: `Defines whether to enable DHCP on the connected Private Network`, Required: false, Deprecated: false, Positional: false, @@ -790,8 +790,8 @@ func vpcGwGatewayNetworkUpdate() *core.Command { func vpcGwGatewayNetworkDelete() *core.Command { return &core.Command{ - Short: `Detach a gateway from a Private Network`, - Long: `Detach a gateway from a Private Network.`, + Short: `Detach a Public Gateway from a Private Network`, + Long: `Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id.`, Namespace: "vpc-gw", Resource: "gateway-network", Verb: "delete", @@ -800,14 +800,14 @@ func vpcGwGatewayNetworkDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "gateway-network-id", - Short: `GatewayNetwork to delete`, + Short: `ID of the GatewayNetwork to delete`, Required: true, Deprecated: false, Positional: true, }, { Name: "cleanup-dhcp", - Short: `Whether to cleanup the attached DHCP configuration`, + Short: `Defines whether to clean up attached DHCP configurations (if any, and if not attached to another Gateway Network)`, Required: false, Deprecated: false, Positional: false, @@ -834,7 +834,7 @@ func vpcGwGatewayNetworkDelete() *core.Command { func vpcGwDHCPList() *core.Command { return &core.Command{ Short: `List DHCP configurations`, - Long: `List DHCP configurations.`, + Long: `List DHCP configurations, optionally filtering by Organization, Project, Public Gateway IP address or more. The response is an array of DHCP configuration objects, each identified by a DHCP ID and containing configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the ` + "`" + `List Public Gateway connections to Private Networks` + "`" + ` method for that purpose, filtering on DHCP ID.`, Namespace: "vpc-gw", Resource: "dhcp", Verb: "list", @@ -851,28 +851,28 @@ func vpcGwDHCPList() *core.Command { }, { Name: "project-id", - Short: `Include only DHCPs in this project`, + Short: `Include only DHCP configuration objects in this Project`, Required: false, Deprecated: false, Positional: false, }, { Name: "address", - Short: `Filter on gateway address`, + Short: `Filter for DHCP configuration objects with this DHCP server IP address (the gateway's address in the Private Network)`, Required: false, Deprecated: false, Positional: false, }, { Name: "has-address", - Short: `Filter on subnets containing address`, + Short: `Filter for DHCP configuration objects with subnets containing this IP address`, Required: false, Deprecated: false, Positional: false, }, { Name: "organization-id", - Short: `Include only DHCPs in this organization`, + Short: `Include only DHCP configuration objects in this Organization`, Required: false, Deprecated: false, Positional: false, @@ -961,7 +961,7 @@ func vpcGwDHCPList() *core.Command { func vpcGwDHCPGet() *core.Command { return &core.Command{ Short: `Get a DHCP configuration`, - Long: `Get a DHCP configuration.`, + Long: `Get a DHCP configuration object, identified by its DHCP ID. The response object contains configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the ` + "`" + `List Public Gateway connections to Private Networks` + "`" + ` method for that purpose, filtering on DHCP ID.`, Namespace: "vpc-gw", Resource: "dhcp", Verb: "get", @@ -970,7 +970,7 @@ func vpcGwDHCPGet() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "dhcp-id", - Short: `ID of the DHCP config to fetch`, + Short: `ID of the DHCP configuration to fetch`, Required: true, Deprecated: false, Positional: true, @@ -991,7 +991,7 @@ func vpcGwDHCPGet() *core.Command { func vpcGwDHCPCreate() *core.Command { return &core.Command{ Short: `Create a DHCP configuration`, - Long: `Create a DHCP configuration.`, + Long: `Create a new DHCP configuration object, containing settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. The response object includes the ID of the DHCP configuration object. You can use this ID as part of a call to ` + "`" + `Create a Public Gateway connection to a Private Network` + "`" + ` or ` + "`" + `Update a Public Gateway connection to a Private Network` + "`" + ` to directly apply this DHCP configuration.`, Namespace: "vpc-gw", Resource: "dhcp", Verb: "create", @@ -1008,28 +1008,28 @@ func vpcGwDHCPCreate() *core.Command { }, { Name: "address", - Short: `Address of the DHCP server. This will be the gateway's address in the private network. Defaults to the first address of the subnet`, + Short: `IP address of the DHCP server. This will be the gateway's address in the Private Network. Defaults to the first address of the subnet`, Required: false, Deprecated: false, Positional: false, }, { Name: "pool-low", - Short: `Low IP (included) of the dynamic address pool`, + Short: `Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet. Defaults to the second address of the subnet`, Required: false, Deprecated: false, Positional: false, }, { Name: "pool-high", - Short: `High IP (included) of the dynamic address pool`, + Short: `High IP (inclusive) of the dynamic address pool. Must be in the config's subnet. Defaults to the last address of the subnet`, Required: false, Deprecated: false, Positional: false, }, { Name: "enable-dynamic", - Short: `Whether to enable dynamic pooling of IPs`, + Short: `Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out. Defaults to true`, Required: false, Deprecated: false, Positional: false, @@ -1072,35 +1072,35 @@ func vpcGwDHCPCreate() *core.Command { }, { Name: "push-default-route", - Short: `Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true`, + Short: `Defines whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true`, Required: false, Deprecated: false, Positional: false, }, { Name: "push-dns-server", - Short: `Whether the gateway should push custom DNS servers to clients`, + Short: `Defines whether the gateway should push custom DNS servers to clients. This allows for Instance hostname -> IP resolution. Defaults to true`, Required: false, Deprecated: false, Positional: false, }, { Name: "dns-servers-override.{index}", - Short: `Override the DNS server list pushed to DHCP clients, instead of the gateway itself`, + Short: `Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself`, Required: false, Deprecated: false, Positional: false, }, { Name: "dns-search.{index}", - Short: `Additional DNS search paths`, + Short: `Array of search paths in addition to the pushed DNS configuration`, Required: false, Deprecated: false, Positional: false, }, { Name: "dns-local-name", - Short: `TLD given to hosts in the Private Network`, + Short: `TLD given to hostnames in the Private Network. Allowed characters are ` + "`" + `a-z0-9-.` + "`" + `. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to ` + "`" + `priv` + "`" + ``, Required: false, Deprecated: false, Positional: false, @@ -1121,7 +1121,7 @@ func vpcGwDHCPCreate() *core.Command { func vpcGwDHCPUpdate() *core.Command { return &core.Command{ Short: `Update a DHCP configuration`, - Long: `Update a DHCP configuration.`, + Long: `Update a DHCP configuration object, identified by its DHCP ID.`, Namespace: "vpc-gw", Resource: "dhcp", Verb: "update", @@ -1130,7 +1130,7 @@ func vpcGwDHCPUpdate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "dhcp-id", - Short: `DHCP config to update`, + Short: `DHCP configuration to update`, Required: true, Deprecated: false, Positional: true, @@ -1144,28 +1144,28 @@ func vpcGwDHCPUpdate() *core.Command { }, { Name: "address", - Short: `Address of the DHCP server. This will be the gateway's address in the private network`, + Short: `IP address of the DHCP server. This will be the Public Gateway's address in the Private Network. It must be part of config's subnet`, Required: false, Deprecated: false, Positional: false, }, { Name: "pool-low", - Short: `Low IP (included) of the dynamic address pool`, + Short: `Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet`, Required: false, Deprecated: false, Positional: false, }, { Name: "pool-high", - Short: `High IP (included) of the dynamic address pool`, + Short: `High IP (inclusive) of the dynamic address pool. Must be in the config's subnet`, Required: false, Deprecated: false, Positional: false, }, { Name: "enable-dynamic", - Short: `Whether to enable dynamic pooling of IPs`, + Short: `Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out. Defaults to true`, Required: false, Deprecated: false, Positional: false, @@ -1208,35 +1208,35 @@ func vpcGwDHCPUpdate() *core.Command { }, { Name: "push-default-route", - Short: `Whether the gateway should push a default route to DHCP clients or only hand out IPs`, + Short: `Defines whether the gateway should push a default route to DHCP clients, or only hand out IPs`, Required: false, Deprecated: false, Positional: false, }, { Name: "push-dns-server", - Short: `Whether the gateway should push custom DNS servers to clients`, + Short: `Defines whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution`, Required: false, Deprecated: false, Positional: false, }, { Name: "dns-servers-override.{index}", - Short: `Override the DNS server list pushed to DHCP clients, instead of the gateway itself`, + Short: `Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself`, Required: false, Deprecated: false, Positional: false, }, { Name: "dns-search.{index}", - Short: `Additional DNS search paths`, + Short: `Array of search paths in addition to the pushed DNS configuration`, Required: false, Deprecated: false, Positional: false, }, { Name: "dns-local-name", - Short: `TLD given to hosts in the Private Network`, + Short: `TLD given to hostnames in the Private Networks. If an instance with hostname ` + "`" + `foo` + "`" + ` gets a lease, and this is set to ` + "`" + `bar` + "`" + `, ` + "`" + `foo.bar` + "`" + ` will resolve. Allowed characters are ` + "`" + `a-z0-9-.` + "`" + ``, Required: false, Deprecated: false, Positional: false, @@ -1257,7 +1257,7 @@ func vpcGwDHCPUpdate() *core.Command { func vpcGwDHCPDelete() *core.Command { return &core.Command{ Short: `Delete a DHCP configuration`, - Long: `Delete a DHCP configuration.`, + Long: `Delete a DHCP configuration object, identified by its DHCP ID. Note that you cannot delete a DHCP configuration object that is currently being used by a Gateway Network.`, Namespace: "vpc-gw", Resource: "dhcp", Verb: "delete", @@ -1266,7 +1266,7 @@ func vpcGwDHCPDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "dhcp-id", - Short: `DHCP config id to delete`, + Short: `DHCP configuration ID to delete`, Required: true, Deprecated: false, Positional: true, @@ -1293,7 +1293,7 @@ func vpcGwDHCPDelete() *core.Command { func vpcGwDHCPEntryList() *core.Command { return &core.Command{ Short: `List DHCP entries`, - Long: `List DHCP entries.`, + Long: `List DHCP entries, whether dynamically assigned and/or statically reserved. DHCP entries can be filtered by the Gateway Network they are on, their MAC address, IP address, type or hostname.`, Namespace: "vpc-gw", Resource: "dhcp-entry", Verb: "list", @@ -1310,35 +1310,35 @@ func vpcGwDHCPEntryList() *core.Command { }, { Name: "gateway-network-id", - Short: `Filter entries based on the gateway network they are on`, + Short: `Filter for entries on this GatewayNetwork`, Required: false, Deprecated: false, Positional: false, }, { Name: "mac-address", - Short: `Filter entries on their MAC address`, + Short: `Filter for entries with this MAC address`, Required: false, Deprecated: false, Positional: false, }, { Name: "ip-address", - Short: `Filter entries on their IP address`, + Short: `Filter for entries with this IP address`, Required: false, Deprecated: false, Positional: false, }, { Name: "hostname", - Short: `Filter entries on their hostname substring`, + Short: `Filter for entries with this hostname substring`, Required: false, Deprecated: false, Positional: false, }, { Name: "type", - Short: `Filter entries on their type`, + Short: `Filter for entries of this type`, Required: false, Deprecated: false, Positional: false, @@ -1397,8 +1397,8 @@ func vpcGwDHCPEntryList() *core.Command { func vpcGwDHCPEntryGet() *core.Command { return &core.Command{ - Short: `Get DHCP entries`, - Long: `Get DHCP entries.`, + Short: `Get a DHCP entry`, + Long: `Get a DHCP entry, specified by its DHCP entry ID.`, Namespace: "vpc-gw", Resource: "dhcp-entry", Verb: "get", @@ -1427,8 +1427,8 @@ func vpcGwDHCPEntryGet() *core.Command { func vpcGwDHCPEntryCreate() *core.Command { return &core.Command{ - Short: `Create a static DHCP reservation`, - Long: `Create a static DHCP reservation.`, + Short: `Create a DHCP entry`, + Long: `Create a static DHCP reservation, specifying the Gateway Network for the reservation, the MAC address of the target device and the IP address to assign this device. The response is a DHCP entry object, confirming the ID and configuration details of the static DHCP reservation.`, Namespace: "vpc-gw", Resource: "dhcp-entry", Verb: "create", @@ -1451,7 +1451,7 @@ func vpcGwDHCPEntryCreate() *core.Command { }, { Name: "ip-address", - Short: `IP address to give to the machine`, + Short: `IP address to give to the device`, Required: false, Deprecated: false, Positional: false, @@ -1472,7 +1472,7 @@ func vpcGwDHCPEntryCreate() *core.Command { func vpcGwDHCPEntryUpdate() *core.Command { return &core.Command{ Short: `Update a DHCP entry`, - Long: `Update a DHCP entry.`, + Long: `Update the IP address for a DHCP entry, specified by its DHCP entry ID. You can update an existing DHCP entry of any type (` + "`" + `reservation` + "`" + ` (static), ` + "`" + `lease` + "`" + ` (dynamic) or ` + "`" + `unknown` + "`" + `), but in manually updating the IP address the entry will necessarily be of type ` + "`" + `reservation` + "`" + ` after the update.`, Namespace: "vpc-gw", Resource: "dhcp-entry", Verb: "update", @@ -1481,14 +1481,14 @@ func vpcGwDHCPEntryUpdate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "dhcp-entry-id", - Short: `DHCP entry ID to update`, + Short: `ID of the DHCP entry to update`, Required: true, Deprecated: false, Positional: true, }, { Name: "ip-address", - Short: `New IP address to give to the machine`, + Short: `New IP address to give to the device`, Required: false, Deprecated: false, Positional: false, @@ -1509,7 +1509,7 @@ func vpcGwDHCPEntryUpdate() *core.Command { func vpcGwDHCPEntrySet() *core.Command { return &core.Command{ Short: `Set all DHCP reservations on a Gateway Network`, - Long: `Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries.`, + Long: `Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries accordingly.`, Namespace: "vpc-gw", Resource: "dhcp-entry", Verb: "set", @@ -1518,7 +1518,7 @@ func vpcGwDHCPEntrySet() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "gateway-network-id", - Short: `Gateway Network on which to set DHCP reservation list`, + Short: `ID of the Gateway Network on which to set DHCP reservation list`, Required: false, Deprecated: false, Positional: false, @@ -1532,7 +1532,7 @@ func vpcGwDHCPEntrySet() *core.Command { }, { Name: "dhcp-entries.{index}.ip-address", - Short: `IP address to give to the machine`, + Short: `IP address to give to the device`, Required: false, Deprecated: false, Positional: false, @@ -1552,8 +1552,8 @@ func vpcGwDHCPEntrySet() *core.Command { func vpcGwDHCPEntryDelete() *core.Command { return &core.Command{ - Short: `Delete a DHCP reservation`, - Long: `Delete a DHCP reservation.`, + Short: `Delete a DHCP entry`, + Long: `Delete a static DHCP reservation, identified by its DHCP entry ID. Note that you cannot delete DHCP entries of type ` + "`" + `lease` + "`" + `, these are deleted automatically when their time-to-live expires.`, Namespace: "vpc-gw", Resource: "dhcp-entry", Verb: "delete", @@ -1562,7 +1562,7 @@ func vpcGwDHCPEntryDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "dhcp-entry-id", - Short: `DHCP entry ID to delete`, + Short: `ID of the DHCP entry to delete`, Required: true, Deprecated: false, Positional: true, @@ -1589,7 +1589,7 @@ func vpcGwDHCPEntryDelete() *core.Command { func vpcGwPatRuleList() *core.Command { return &core.Command{ Short: `List PAT rules`, - Long: `List PAT rules.`, + Long: `List PAT rules. You can filter by gateway ID to list all PAT rules for a particular gateway, or filter for PAT rules targeting a specific IP address or using a specific protocol.`, Namespace: "vpc-gw", Resource: "pat-rule", Verb: "list", @@ -1606,21 +1606,21 @@ func vpcGwPatRuleList() *core.Command { }, { Name: "gateway-id", - Short: `Fetch rules for this gateway`, + Short: `Filter for PAT rules on this Gateway`, Required: false, Deprecated: false, Positional: false, }, { Name: "private-ip", - Short: `Fetch rules targeting this private ip`, + Short: `Filter for PAT rules targeting this private ip`, Required: false, Deprecated: false, Positional: false, }, { Name: "protocol", - Short: `Fetch rules for this protocol`, + Short: `Filter for PAT rules with this protocol`, Required: false, Deprecated: false, Positional: false, @@ -1680,7 +1680,7 @@ func vpcGwPatRuleList() *core.Command { func vpcGwPatRuleGet() *core.Command { return &core.Command{ Short: `Get a PAT rule`, - Long: `Get a PAT rule.`, + Long: `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.`, Namespace: "vpc-gw", Resource: "pat-rule", Verb: "get", @@ -1689,7 +1689,7 @@ func vpcGwPatRuleGet() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "pat-rule-id", - Short: `PAT rule to get`, + Short: `ID of the PAT rule to get`, Required: true, Deprecated: false, Positional: true, @@ -1710,7 +1710,7 @@ func vpcGwPatRuleGet() *core.Command { func vpcGwPatRuleCreate() *core.Command { return &core.Command{ Short: `Create a PAT rule`, - Long: `Create a PAT rule.`, + Long: `Create a new PAT rule on a specified Public Gateway, defining the protocol to use, public port to listen on, and private port / IP address to map to.`, Namespace: "vpc-gw", Resource: "pat-rule", Verb: "create", @@ -1719,7 +1719,7 @@ func vpcGwPatRuleCreate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "gateway-id", - Short: `Gateway on which to attach the rule to`, + Short: `ID of the Gateway on which to create the rule`, Required: false, Deprecated: false, Positional: false, @@ -1769,7 +1769,7 @@ func vpcGwPatRuleCreate() *core.Command { func vpcGwPatRuleUpdate() *core.Command { return &core.Command{ Short: `Update a PAT rule`, - Long: `Update a PAT rule.`, + Long: `Update a PAT rule, specified by its PAT rule ID. Configuration settings including private/public port, private IP address and protocol can all be updated.`, Namespace: "vpc-gw", Resource: "pat-rule", Verb: "update", @@ -1778,7 +1778,7 @@ func vpcGwPatRuleUpdate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "pat-rule-id", - Short: `PAT rule to update`, + Short: `ID of the PAT rule to update`, Required: true, Deprecated: false, Positional: true, @@ -1827,8 +1827,8 @@ func vpcGwPatRuleUpdate() *core.Command { func vpcGwPatRuleSet() *core.Command { return &core.Command{ - Short: `Set all PAT rules on a Gateway`, - Long: `Set the list of PAT rules attached to a Gateway. Rules are identified by their public port and protocol. This will sync the current PAT rule list with the givent list, creating, updating or deleting PAT rules.`, + Short: `Set all PAT rules`, + Long: `Set a definitive list of PAT rules attached to a Public Gateway. Each rule is identified by its public port and protocol. This will sync the current PAT rule list on the gateway with the new list, creating, updating or deleting PAT rules accordingly.`, Namespace: "vpc-gw", Resource: "pat-rule", Verb: "set", @@ -1837,7 +1837,7 @@ func vpcGwPatRuleSet() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "gateway-id", - Short: `Gateway on which to set the PAT rules`, + Short: `ID of the gateway on which to set the PAT rules`, Required: false, Deprecated: false, Positional: false, @@ -1887,7 +1887,7 @@ func vpcGwPatRuleSet() *core.Command { func vpcGwPatRuleDelete() *core.Command { return &core.Command{ Short: `Delete a PAT rule`, - Long: `Delete a PAT rule.`, + Long: `Delete a PAT rule, identified by its PAT rule ID. This action is irreversible.`, Namespace: "vpc-gw", Resource: "pat-rule", Verb: "delete", @@ -1896,7 +1896,7 @@ func vpcGwPatRuleDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "pat-rule-id", - Short: `PAT rule to delete`, + Short: `ID of the PAT rule to delete`, Required: true, Deprecated: false, Positional: true, @@ -1922,8 +1922,8 @@ func vpcGwPatRuleDelete() *core.Command { func vpcGwGatewayTypeList() *core.Command { return &core.Command{ - Short: `List VPC Public Gateway types`, - Long: `List VPC Public Gateway types.`, + Short: `List Public Gateway types`, + Long: `List the different Public Gateway commercial offer types available at Scaleway. The response is an array of objects describing the name and technical details of each available gateway type.`, Namespace: "vpc-gw", Resource: "gateway-type", Verb: "list", @@ -1946,7 +1946,7 @@ func vpcGwGatewayTypeList() *core.Command { func vpcGwIPList() *core.Command { return &core.Command{ Short: `List IPs`, - Long: `List IPs.`, + Long: `List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response.`, Namespace: "vpc-gw", Resource: "ip", Verb: "list", @@ -1963,35 +1963,35 @@ func vpcGwIPList() *core.Command { }, { Name: "project-id", - Short: `Include only IPs in this project`, + Short: `Filter for IP addresses in this Project`, Required: false, Deprecated: false, Positional: false, }, { Name: "tags.{index}", - Short: `Filter IPs with these tags`, + Short: `Filter for IP addresses with these tags`, Required: false, Deprecated: false, Positional: false, }, { Name: "reverse", - Short: `Filter by reverse containing this string`, + Short: `Filter for IP addresses that have a reverse containing this string`, Required: false, Deprecated: false, Positional: false, }, { Name: "is-free", - Short: `Filter whether the IP is attached to a gateway or not`, + Short: `Filter based on whether the IP is attached to a gateway or not`, Required: false, Deprecated: false, Positional: false, }, { Name: "organization-id", - Short: `Include only IPs in this organization`, + Short: `Filter for IP addresses in this Organization`, Required: false, Deprecated: false, Positional: false, @@ -2050,7 +2050,7 @@ func vpcGwIPList() *core.Command { func vpcGwIPGet() *core.Command { return &core.Command{ Short: `Get an IP`, - Long: `Get an IP.`, + Long: `Get details of a Public Gateway flexible IP address, identified by its IP ID. The response object contains information including which (if any) Public Gateway using this IP address, the reverse and various other metadata.`, Namespace: "vpc-gw", Resource: "ip", Verb: "get", @@ -2059,7 +2059,7 @@ func vpcGwIPGet() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "ip-id", - Short: `ID of the IP to get`, + Short: `ID of the IP address to get`, Required: true, Deprecated: false, Positional: true, @@ -2080,7 +2080,7 @@ func vpcGwIPGet() *core.Command { func vpcGwIPCreate() *core.Command { return &core.Command{ Short: `Reserve an IP`, - Long: `Reserve an IP.`, + Long: `Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project.`, Namespace: "vpc-gw", Resource: "ip", Verb: "create", @@ -2090,7 +2090,7 @@ func vpcGwIPCreate() *core.Command { core.ProjectIDArgSpec(), { Name: "tags.{index}", - Short: `Tags to give to the IP`, + Short: `Tags to give to the IP address`, Required: false, Deprecated: false, Positional: false, @@ -2111,7 +2111,7 @@ func vpcGwIPCreate() *core.Command { func vpcGwIPUpdate() *core.Command { return &core.Command{ Short: `Update an IP`, - Long: `Update an IP.`, + Long: `Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to.`, Namespace: "vpc-gw", Resource: "ip", Verb: "update", @@ -2120,28 +2120,28 @@ func vpcGwIPUpdate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "ip-id", - Short: `ID of the IP to update`, + Short: `ID of the IP address to update`, Required: true, Deprecated: false, Positional: true, }, { Name: "tags.{index}", - Short: `Tags to give to the IP`, + Short: `Tags to give to the IP address`, Required: false, Deprecated: false, Positional: false, }, { Name: "reverse", - Short: `Reverse to set on the IP. Empty string to unset`, + Short: `Reverse to set on the address. Empty string to unset`, Required: false, Deprecated: false, Positional: false, }, { Name: "gateway-id", - Short: `Gateway to attach the IP to. Empty string to detach`, + Short: `Gateway to attach the IP address to. Empty string to detach`, Required: false, Deprecated: false, Positional: false, @@ -2162,7 +2162,7 @@ func vpcGwIPUpdate() *core.Command { func vpcGwIPDelete() *core.Command { return &core.Command{ Short: `Delete an IP`, - Long: `Delete an IP.`, + Long: `Delete a flexible IP address from your account. This action is irreversible.`, Namespace: "vpc-gw", Resource: "ip", Verb: "delete", @@ -2171,7 +2171,7 @@ func vpcGwIPDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "ip-id", - Short: `ID of the IP to delete`, + Short: `ID of the IP address to delete`, Required: true, Deprecated: false, Positional: true, @@ -2197,8 +2197,8 @@ func vpcGwIPDelete() *core.Command { func vpcGwGatewayRefreshSSHKeys() *core.Command { return &core.Command{ - Short: `Refresh SSH keys of a VPC Public Gateway`, - Long: `Refresh SSH keys of a VPC Public Gateway.`, + Short: `Refresh a Public Gateway's SSH keys`, + Long: `Refresh the SSH keys of a given Public Gateway, specified by its gateway ID. This adds any new SSH keys in the gateway's Scaleway Project to the gateway itself.`, Namespace: "vpc-gw", Resource: "gateway", Verb: "refresh-ssh-keys", @@ -2207,7 +2207,7 @@ func vpcGwGatewayRefreshSSHKeys() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "gateway-id", - Short: `ID of the gateway that needs fresh ssh keys`, + Short: `ID of the gateway to refresh SSH keys on`, Required: true, Deprecated: false, Positional: true,