From 15ad9a23cdc54b9d31b1e1630c2b9682f37e694e Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Tue, 21 Mar 2023 13:18:02 +0000 Subject: [PATCH] feat: update generated APIs --- ...est-all-usage-rdb-backup-list-usage.golden | 2 +- ...t-all-usage-rdb-instance-list-usage.golden | 2 +- .../test-all-usage-rdb-instance-usage.golden | 2 +- ...-all-usage-rdb-node-type-list-usage.golden | 2 +- .../test-all-usage-rdb-node-type-usage.golden | 2 +- ...st-all-usage-rdb-read-replica-usage.golden | 2 +- ...t-all-usage-rdb-snapshot-list-usage.golden | 2 +- .../test-all-usage-redis-acl-add-usage.golden | 4 +- ...st-all-usage-redis-acl-delete-usage.golden | 4 +- .../test-all-usage-redis-acl-get-usage.golden | 4 +- .../test-all-usage-redis-acl-set-usage.golden | 4 +- .../test-all-usage-redis-acl-usage.golden | 8 +- ...ll-usage-redis-cluster-create-usage.golden | 18 +- ...ll-usage-redis-cluster-delete-usage.golden | 4 +- ...redis-cluster-get-certificate-usage.golden | 2 +- ...t-all-usage-redis-cluster-get-usage.golden | 2 +- ...-all-usage-redis-cluster-list-usage.golden | 14 +- ...l-usage-redis-cluster-metrics-usage.golden | 6 +- ...l-usage-redis-cluster-migrate-usage.golden | 10 +- ...dis-cluster-renew-certificate-usage.golden | 2 +- ...ll-usage-redis-cluster-update-usage.golden | 12 +- .../test-all-usage-redis-cluster-usage.golden | 16 +- ...-all-usage-redis-endpoint-add-usage.golden | 8 +- ...l-usage-redis-endpoint-delete-usage.golden | 2 +- ...-all-usage-redis-endpoint-get-usage.golden | 2 +- ...-all-usage-redis-endpoint-set-usage.golden | 8 +- ...test-all-usage-redis-endpoint-usage.golden | 8 +- ...ll-usage-redis-node-type-list-usage.golden | 2 +- ...est-all-usage-redis-node-type-usage.golden | 2 +- ...t-all-usage-redis-setting-add-usage.golden | 4 +- ...ll-usage-redis-setting-delete-usage.golden | 4 +- ...t-all-usage-redis-setting-set-usage.golden | 4 +- .../test-all-usage-redis-setting-usage.golden | 10 +- ...-all-usage-redis-version-list-usage.golden | 2 +- .../test-all-usage-redis-version-usage.golden | 2 +- ...age-webhosting-hosting-delete-usage.golden | 23 ++ ...sting-hosting-get-dns-records-usage.golden | 23 ++ ...ge-webhosting-hosting-restore-usage.golden | 23 ++ ...-all-usage-webhosting-hosting-usage.golden | 11 +- .../test-all-usage-webhosting-usage.golden | 1 - docs/commands/rdb.md | 18 +- docs/commands/redis.md | 200 +++++++++--------- docs/commands/webhosting.md | 111 +++++++--- go.mod | 2 +- go.sum | 4 +- .../webhosting/v1alpha1/webhosting_cli.go | 95 +++++++-- 46 files changed, 443 insertions(+), 250 deletions(-) create mode 100644 cmd/scw/testdata/test-all-usage-webhosting-hosting-delete-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-webhosting-hosting-get-dns-records-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-webhosting-hosting-restore-usage.golden diff --git a/cmd/scw/testdata/test-all-usage-rdb-backup-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-backup-list-usage.golden index 92f48dcc9a..37125b537b 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-backup-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-backup-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -List all backups in a specified zone, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. +List all backups in a specified region, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. USAGE: scw rdb backup list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-list-usage.golden index 4603a45d26..9c1a516108 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -List all Database Instances in the specified zone, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. +List all Database Instances in the specified region, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. USAGE: scw rdb instance list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-usage.golden index 02687c2b5e..be1128e0fd 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -A Database Instance is made up of one or multiple dedicated compute nodes running a single database engine. Two node settings are available: **High-Availability (HA)**, with a main node and one replica, and **standalone** with a main node. The HA standby node is linked to the main node, using synchronous replication. Synchronous replication offers the ability to confirm that all changes intended by a transaction have been transferred and applied to the synchronous replica node, providing durability to the data. +A Database Instance is made up of one or multiple dedicated compute nodes running a single database engine. Two node settings are available: **High-Availability (HA)**, with a main node and one replica, and **standalone** with a main node. The HA standby node is linked to the main node, using synchronous replication. Synchronous replication offers the ability to confirm that all changes intended by a transaction have been transferred and applied to the synchronous replica node, providing durability to the data. **Note**: HA standby nodes are not accessible to users unless the main node becomes unavailable and the standby takes over. If you wish to run queries on a read-only node, you can use [Read Replicas](https://developers.scaleway.com/en/products/rdb/api/#read-replicas-8e2cf2) diff --git a/cmd/scw/testdata/test-all-usage-rdb-node-type-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-node-type-list-usage.golden index 3fd0dbdf3f..6293f9b3ae 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-node-type-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-node-type-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -List all available node types. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. +List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. USAGE: scw rdb node-type list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-rdb-node-type-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-node-type-usage.golden index f7ac32b480..df3b22485f 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-node-type-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-node-type-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Two node type ranges are available: +Two node type ranges are available: * **General Purpose:** production-grade nodes designed for scalable database infrastructures. * **Development:** sandbox environments and reliable performance for development and testing purposes. diff --git a/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden index 692320e138..da603f4830 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-read-replica-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -A Read Replica is a live copy of a Database Instance that behaves like an Instance, but that only allows read-only connections. +A Read Replica is a live copy of a Database Instance that behaves like an Instance, but that only allows read-only connections. The replica mirrors the data of the primary Database node and any changes made are replicated to the replica asynchronously. Read Replicas allow you to scale your Database Instance for read-heavy database workloads. They can also be used for business intelligence workloads. A Read Replica can have at most one direct access and one Private Network endpoint. `Loadbalancer` endpoints are not available on Read Replicas even if this resource is displayed in the Read Replica response example. diff --git a/cmd/scw/testdata/test-all-usage-rdb-snapshot-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-snapshot-list-usage.golden index 5d11955859..fd07c39147 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-snapshot-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-snapshot-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snaphots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. +List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. USAGE: scw rdb snapshot list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-redis-acl-add-usage.golden b/cmd/scw/testdata/test-all-usage-redis-acl-add-usage.golden index 35545d0a6f..75dce08ccb 100644 --- a/cmd/scw/testdata/test-all-usage-redis-acl-add-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-acl-add-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Add ACL rules for a given cluster. +Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster). USAGE: scw redis acl add [arg=value ...] ARGS: - cluster-id UUID of the cluster you want to add acl rules to + cluster-id UUID of the Database Instance you want to add ACL rules to [acl-rules.{index}.ip-cidr] IPv4 network address of the rule [acl-rules.{index}.description] Description of the rule [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-redis-acl-delete-usage.golden b/cmd/scw/testdata/test-all-usage-redis-acl-delete-usage.golden index 39043dd340..8656df5a3f 100644 --- a/cmd/scw/testdata/test-all-usage-redis-acl-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-acl-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Delete an ACL rule for a given cluster. +Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule you want to delete in your request. USAGE: scw redis acl delete [arg=value ...] ARGS: - acl-id UUID of the acl rule you want to delete + acl-id UUID of the ACL rule you want 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-redis-acl-get-usage.golden b/cmd/scw/testdata/test-all-usage-redis-acl-get-usage.golden index 299b75a3a5..40e8173484 100644 --- a/cmd/scw/testdata/test-all-usage-redis-acl-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-acl-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Get an ACL rule. +Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule in your request. USAGE: scw redis acl get [arg=value ...] ARGS: - acl-id UUID of the acl rule you want to get + acl-id UUID of the ACL rule you want 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-redis-acl-set-usage.golden b/cmd/scw/testdata/test-all-usage-redis-acl-set-usage.golden index 23e288de02..987a2ab9d7 100644 --- a/cmd/scw/testdata/test-all-usage-redis-acl-set-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-acl-set-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Set ACL rules for a given cluster. +Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster). USAGE: scw redis acl set [arg=value ...] ARGS: - cluster-id UUID of the cluster where the ACL rules has to be set + cluster-id UUID of the Database Instance where the ACL rules have to be set [acl-rules.{index}.ip-cidr] IPv4 network address of the rule [acl-rules.{index}.description] Description of the rule [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-redis-acl-usage.golden b/cmd/scw/testdata/test-all-usage-redis-acl-usage.golden index c6e6682d79..8d836fecba 100644 --- a/cmd/scw/testdata/test-all-usage-redis-acl-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-acl-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Network Access Control List allows to control network inbound traffic allowed by setting up ACL rules. ACL rules could be created, edited, deleted. +Network Access Control Lists (ACLs) allow you to manage network inbound traffic by setting up ACL rules. USAGE: scw redis acl AVAILABLE COMMANDS: - add Add ACL rules for a given cluster - delete Delete an ACL rule for a given cluster + add Add ACL rules for a cluster + delete Delete an ACL rule for a cluster get Get an ACL rule - set Set ACL rules for a given cluster + set Set ACL rules for a cluster FLAGS: -h, --help help for acl diff --git a/cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden index 7f83ac85d9..b93e0c0fa1 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden @@ -1,23 +1,23 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Create a cluster. +Create a new Redis™ Database Instance (Redis™ cluster). You must set the `zone`, `project_id`, `version`, `node_type`, `user_name` and `password` parameters. Optionally you can define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`. USAGE: scw redis cluster 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 cluster - version Redis™ engine version of the cluster - [tags.{index}] Tags to apply to the cluster - node-type Type of node to use for the cluster - user-name Name of the user created when the cluster is created + [name=] Name of the Database Instance + version Redis™ engine version of the Database Instance + [tags.{index}] Tags to apply to the Database Instance + node-type Type of node to use for the Database Instance + user-name Name of the user created upon Database Instance creation password Password of the user - [cluster-size] Number of nodes for the cluster + [cluster-size] Number of nodes in the Redis™ cluster [acl-rules.{index}.ip-cidr] IPv4 network address of the rule [acl-rules.{index}.description] Description of the rule - [endpoints.{index}.private-network.id] UUID of the private network to be connected to the cluster - [endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 adress with a CIDR notation. You must provide at least one IPv4 per node. Check documentation about IP and subnet limitation. + [endpoints.{index}.private-network.id] UUID of the Private Network to connect to the Database Instance + [endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. [tls-enabled] Whether or not TLS is enabled [cluster-settings.{index}.value] Value of the setting [cluster-settings.{index}.name] Name of the setting diff --git a/cmd/scw/testdata/test-all-usage-redis-cluster-delete-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-delete-usage.golden index 20f083f915..7fdb80834e 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Delete a cluster. +Delete a Redis™ Database Instance (Redis™ cluster), specified by the `region` and `cluster_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. USAGE: scw redis cluster delete [arg=value ...] ARGS: - cluster-id UUID of the cluster to delete + cluster-id UUID of the Database Instance 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-redis-cluster-get-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-get-certificate-usage.golden index 529bccb9cc..ed44379625 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-get-certificate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-get-certificate-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Get the TLS certificate of a cluster. +Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response. USAGE: scw redis cluster get-certificate [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-redis-cluster-get-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-get-usage.golden index 6f8c549e87..46b46f05d2 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Get a cluster. +Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the `cluster_id` and `region` in your request to get information such as `id`, `status`, `version`, `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints` about your cluster in the response. USAGE: scw redis cluster get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-redis-cluster-list-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-list-usage.golden index 27d543b7d9..797eea46f3 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-list-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -List clusters. +List all Redis™ Database Instances (Redis™ cluster) in the specified zone. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags`, `name`, `organization_id` and `version`. USAGE: scw redis cluster list [arg=value ...] ARGS: - [tags.{index}] Tags of the clusters to filter upon - [name] Name of the clusters to filter upon - [order-by] Criteria to use when ordering cluster listing (created_at_asc | created_at_desc | name_asc | name_desc) - [project-id] Project ID to list the cluster of - [version] Version of the clusters to filter upon - [organization-id] Organization ID to list the cluster of + [tags.{index}] Filter by Database Instance tags + [name] Filter by Database Instance names + [order-by] Criteria to use when ordering the list (created_at_asc | created_at_desc | name_asc | name_desc) + [project-id] Filter by Project ID + [version] Filter by Redis™ engine version + [organization-id] Filter by Organization ID [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-redis-cluster-metrics-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-metrics-usage.golden index f2d519b73c..aee1033d56 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-metrics-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-metrics-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Get metrics of a cluster. +Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`. USAGE: scw redis cluster metrics [arg=value ...] ARGS: cluster-id UUID of the cluster - [start-at] Start date to gather metrics from - [end-at] End date to gather metrics from + [start-at] Start date + [end-at] End date [metric-name] Name of the metric to gather [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-redis-cluster-migrate-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-migrate-usage.golden index 7a69a5307a..17d65983f4 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-migrate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-migrate-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Upgrade your Database for Redis® cluster to a new version or scale it vertically / horizontally. Please note: scaling horizontally your Database for Redis® cluster won't renew its TLS certificate. In order to refresh the SSL certificate, you have to use the dedicated api route. +Upgrade your standalone Redis™ Database Instance node, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint. USAGE: scw redis cluster migrate [arg=value ...] ARGS: - [version] Redis™ engine version of the cluster - [node-type] Type of node to use for the cluster - [cluster-size] Number of nodes for the cluster - cluster-id UUID of the cluster to update + [version] Redis™ engine version of the Database Instance + [node-type] Type of node to use for the Database Instance + [cluster-size] Number of nodes for the Database Instance + cluster-id UUID of the Database Instance to update [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-redis-cluster-renew-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-renew-certificate-usage.golden index 8798fd8a81..94a02b088f 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-renew-certificate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-renew-certificate-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Renew the TLS certificate of a cluster. +Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients. USAGE: scw redis cluster renew-certificate [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-redis-cluster-update-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-update-usage.golden index b790e10ede..03048f2e71 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-update-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Update a cluster. +Update the parameters of a Redis™ Database Instance (Redis™ cluster), including `name`, `tags`, `user_name` and `password`. USAGE: scw redis cluster update [arg=value ...] ARGS: - [name] Name of the cluster - [tags.{index}] Tags of a given cluster - [user-name] Name of the cluster user - [password] Password of the cluster user - cluster-id UUID of the cluster to update + [name] Name of the Database Instance + [tags.{index}] Database Instance tags + [user-name] Name of the Database Instance user + [password] Password of the Database Instance user + cluster-id UUID of the Database Instance to update [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-redis-cluster-usage.golden b/cmd/scw/testdata/test-all-usage-redis-cluster-usage.golden index 1f486ae7a5..da75e98d84 100644 --- a/cmd/scw/testdata/test-all-usage-redis-cluster-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-cluster-usage.golden @@ -1,20 +1,20 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -A Managed Database for Redis™ cluster is composed of one or more Nodes depending of the cluster_size setting. +A Redis™ Database Instance, also known as a Redis™ cluster, consists of either one standalone node or a cluster composed of three to six nodes. The cluster uses partitioning to split the keyspace. Each partition is replicated and can be reassigned or elected as the primary when necessary. Standalone mode creates a standalone database provisioned on a single node. USAGE: scw redis cluster AVAILABLE COMMANDS: - create Create a cluster - delete Delete a cluster - get Get a cluster + create Create a Redis™ Database Instance + delete Delete a Redis™ Database Instance + get Get a Redis™ Database Instance get-certificate Get the TLS certificate of a cluster - list List clusters - metrics Get metrics of a cluster - migrate Migrate your cluster architecture + list List Redis™ Database Instances + metrics Get metrics of a Redis™ Database Instance + migrate Scale up a Redis™ Database Instance renew-certificate Renew the TLS certificate of a cluster - update Update a cluster + update Update a Redis™ Database Instance FLAGS: -h, --help help for cluster diff --git a/cmd/scw/testdata/test-all-usage-redis-endpoint-add-usage.golden b/cmd/scw/testdata/test-all-usage-redis-endpoint-add-usage.golden index b759e26a8d..1b618efdb0 100644 --- a/cmd/scw/testdata/test-all-usage-redis-endpoint-add-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-endpoint-add-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Add endpoints for a given cluster. +Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add `private_network` or `public_network` specifications to the body of the request. USAGE: scw redis endpoint add [arg=value ...] ARGS: - cluster-id UUID of the cluster you want to add endpoints to - [endpoints.{index}.private-network.id] UUID of the private network to be connected to the cluster - [endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 adress with a CIDR notation. You must provide at least one IPv4 per node. Check documentation about IP and subnet limitation. + cluster-id UUID of the Database Instance you want to add endpoints to + [endpoints.{index}.private-network.id] UUID of the Private Network to connect to the Database Instance + [endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. [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-redis-endpoint-delete-usage.golden b/cmd/scw/testdata/test-all-usage-redis-endpoint-delete-usage.golden index d5601da8b5..c2819c485e 100644 --- a/cmd/scw/testdata/test-all-usage-redis-endpoint-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-endpoint-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Delete an endpoint for a given cluster. +Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). You must specify the `region` and `endpoint_id` parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint. USAGE: scw redis endpoint delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-redis-endpoint-get-usage.golden b/cmd/scw/testdata/test-all-usage-redis-endpoint-get-usage.golden index 3a0628e863..b3d18444dc 100644 --- a/cmd/scw/testdata/test-all-usage-redis-endpoint-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-endpoint-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Get an endpoint. +Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response. USAGE: scw redis endpoint get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-redis-endpoint-set-usage.golden b/cmd/scw/testdata/test-all-usage-redis-endpoint-set-usage.golden index 9ff42cee8e..a4ab4f7c07 100644 --- a/cmd/scw/testdata/test-all-usage-redis-endpoint-set-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-endpoint-set-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Set endpoints for a given cluster. +Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the `cluster_id` and the `endpoints` parameters in your request. USAGE: scw redis endpoint set [arg=value ...] ARGS: - cluster-id UUID of the cluster where the endpoints has to be set - [endpoints.{index}.private-network.id] UUID of the private network to be connected to the cluster - [endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 adress with a CIDR notation. You must provide at least one IPv4 per node. Check documentation about IP and subnet limitation. + cluster-id UUID of the Database Instance where the endpoints have to be set + [endpoints.{index}.private-network.id] UUID of the Private Network to connect to the Database Instance + [endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. [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-redis-endpoint-usage.golden b/cmd/scw/testdata/test-all-usage-redis-endpoint-usage.golden index f919985c6c..252d8255b3 100644 --- a/cmd/scw/testdata/test-all-usage-redis-endpoint-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-endpoint-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Manage endpoints to access to your cluster trough Public or Private networks +Manage endpoint access to your Redis™ Database Instance through Public or Private Networks USAGE: scw redis endpoint AVAILABLE COMMANDS: - add Add endpoints for a given cluster - delete Delete an endpoint for a given cluster + add Add endpoints for a cluster + delete Delete an endpoint for a cluster get Get an endpoint - set Set endpoints for a given cluster + set Set endpoints for a cluster FLAGS: -h, --help help for endpoint diff --git a/cmd/scw/testdata/test-all-usage-redis-node-type-list-usage.golden b/cmd/scw/testdata/test-all-usage-redis-node-type-list-usage.golden index 506b62deaa..6e0c105dc9 100644 --- a/cmd/scw/testdata/test-all-usage-redis-node-type-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-node-type-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -List available node types. +List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. USAGE: scw redis node-type list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-redis-node-type-usage.golden b/cmd/scw/testdata/test-all-usage-redis-node-type-usage.golden index 738188fb33..92804771d7 100644 --- a/cmd/scw/testdata/test-all-usage-redis-node-type-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-node-type-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Node types powering your cluster. +Nodes are the compute units that make up your Redis™ Database Instance. Different node types are available with varying amounts of RAM and vCPU. USAGE: scw redis node-type diff --git a/cmd/scw/testdata/test-all-usage-redis-setting-add-usage.golden b/cmd/scw/testdata/test-all-usage-redis-setting-add-usage.golden index 52c8094947..2e5883286c 100644 --- a/cmd/scw/testdata/test-all-usage-redis-setting-add-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-setting-add-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Add cluster settings. +Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the `name` and the `value` of each setting. USAGE: scw redis setting add [arg=value ...] ARGS: - cluster-id UUID of the cluster you want to add settings to + cluster-id UUID of the Database Instance you want to add settings to [settings.{index}.value] Value of the setting [settings.{index}.name] Name of the setting [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-redis-setting-delete-usage.golden b/cmd/scw/testdata/test-all-usage-redis-setting-delete-usage.golden index 0f9c300794..5c0de4f774 100644 --- a/cmd/scw/testdata/test-all-usage-redis-setting-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-setting-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Delete a cluster setting. +Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body. USAGE: scw redis setting delete [arg=value ...] ARGS: - cluster-id UUID of the cluster where the settings has to be set + cluster-id UUID of the Database Instance where the settings must be set setting-name Setting name 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) diff --git a/cmd/scw/testdata/test-all-usage-redis-setting-set-usage.golden b/cmd/scw/testdata/test-all-usage-redis-setting-set-usage.golden index 82dadc92b6..9290621822 100644 --- a/cmd/scw/testdata/test-all-usage-redis-setting-set-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-setting-set-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Set cluster settings. +Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated. USAGE: scw redis setting set [arg=value ...] ARGS: - cluster-id UUID of the cluster where the settings has to be set + cluster-id UUID of the Database Instance where the settings must be set [settings.{index}.value] Value of the setting [settings.{index}.name] Name of the setting [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-redis-setting-usage.golden b/cmd/scw/testdata/test-all-usage-redis-setting-usage.golden index fcc753013c..9c81cc7738 100644 --- a/cmd/scw/testdata/test-all-usage-redis-setting-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-setting-usage.golden @@ -1,14 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Available Redis™ settings. Available settings depend on the Redis™ version. +Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](https://developers.scaleway.com/en/products/redis/api/v1/#get-209533) endpoint. + +Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform. USAGE: scw redis setting AVAILABLE COMMANDS: - add Add cluster settings - delete Delete a cluster setting - set Set cluster settings + add Add advanced settings + delete Delete advanced setting + set Set advanced settings FLAGS: -h, --help help for setting diff --git a/cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden b/cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden index 5bb74e13c6..5ee18150b3 100644 --- a/cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -List available Redis™ versions. +List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`. USAGE: scw redis version list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-redis-version-usage.golden b/cmd/scw/testdata/test-all-usage-redis-version-usage.golden index f4789261dc..8bf12a68d7 100644 --- a/cmd/scw/testdata/test-all-usage-redis-version-usage.golden +++ b/cmd/scw/testdata/test-all-usage-redis-version-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ -Redis™ versions powering your cluster. +The Redis™ database engine versions available at Scaleway for your clusters. USAGE: scw redis version diff --git a/cmd/scw/testdata/test-all-usage-webhosting-hosting-delete-usage.golden b/cmd/scw/testdata/test-all-usage-webhosting-hosting-delete-usage.golden new file mode 100644 index 0000000000..f0938f4635 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-webhosting-hosting-delete-usage.golden @@ -0,0 +1,23 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +🟥🟥🟥 STDERR️️ 🟥🟥🟥️ +Delete a hosting with the given ID. + +USAGE: + scw webhosting hosting delete [arg=value ...] + +EXAMPLES: + Delete a Hosting with the given ID + scw webhosting hosting delete hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7 + +ARGS: + hosting-id Hosting ID + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for delete + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-webhosting-hosting-get-dns-records-usage.golden b/cmd/scw/testdata/test-all-usage-webhosting-hosting-get-dns-records-usage.golden new file mode 100644 index 0000000000..ba1a176383 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-webhosting-hosting-get-dns-records-usage.golden @@ -0,0 +1,23 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +🟥🟥🟥 STDERR️️ 🟥🟥🟥️ +The set of DNS record of a specific domain associated to a hosting. + +USAGE: + scw webhosting hosting get-dns-records [arg=value ...] + +EXAMPLES: + Get DNS records associated to the given domain + scw webhosting hosting get-dns-records domain=foo.com + +ARGS: + domain Domain associated to the DNS records + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for get-dns-records + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-webhosting-hosting-restore-usage.golden b/cmd/scw/testdata/test-all-usage-webhosting-hosting-restore-usage.golden new file mode 100644 index 0000000000..bbae5d4719 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-webhosting-hosting-restore-usage.golden @@ -0,0 +1,23 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +🟥🟥🟥 STDERR️️ 🟥🟥🟥️ +Restore a hosting with the given ID. + +USAGE: + scw webhosting hosting restore [arg=value ...] + +EXAMPLES: + Restore a Hosting with the given ID + scw webhosting hosting restore hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7 + +ARGS: + hosting-id Hosting ID + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for restore + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-webhosting-hosting-usage.golden b/cmd/scw/testdata/test-all-usage-webhosting-hosting-usage.golden index 6da2a2b422..fa3abca784 100644 --- a/cmd/scw/testdata/test-all-usage-webhosting-hosting-usage.golden +++ b/cmd/scw/testdata/test-all-usage-webhosting-hosting-usage.golden @@ -6,10 +6,13 @@ USAGE: scw webhosting hosting AVAILABLE COMMANDS: - create Create a hosting - get Get a hosting - list List all hostings - update Update a hosting + create Create a hosting + delete Delete a hosting + get Get a hosting + get-dns-records Get the DNS records + list List all hostings + restore Restore a hosting + update Update a hosting FLAGS: -h, --help help for hosting diff --git a/cmd/scw/testdata/test-all-usage-webhosting-usage.golden b/cmd/scw/testdata/test-all-usage-webhosting-usage.golden index 2960a745a3..97e6b82288 100644 --- a/cmd/scw/testdata/test-all-usage-webhosting-usage.golden +++ b/cmd/scw/testdata/test-all-usage-webhosting-usage.golden @@ -6,7 +6,6 @@ USAGE: scw webhosting AVAILABLE COMMANDS: - dns-record DNS record management commands hosting Hosting management commands offer Offer management commands diff --git a/docs/commands/rdb.md b/docs/commands/rdb.md index f605db0fa0..ef24ae6626 100644 --- a/docs/commands/rdb.md +++ b/docs/commands/rdb.md @@ -258,7 +258,7 @@ scw rdb backup get [arg=value ...] ### List database backups -List all backups in a specified zone, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. +List all backups in a specified region, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. **Usage:** @@ -486,7 +486,7 @@ scw rdb engine settings name=MySQL version=8 ## Instance management commands -A Database Instance is made up of one or multiple dedicated compute nodes running a single database engine. Two node settings are available: **High-Availability (HA)**, with a main node and one replica, and **standalone** with a main node. The HA standby node is linked to the main node, using synchronous replication. Synchronous replication offers the ability to confirm that all changes intended by a transaction have been transferred and applied to the synchronous replica node, providing durability to the data. +A Database Instance is made up of one or multiple dedicated compute nodes running a single database engine. Two node settings are available: **High-Availability (HA)**, with a main node and one replica, and **standalone** with a main node. The HA standby node is linked to the main node, using synchronous replication. Synchronous replication offers the ability to confirm that all changes intended by a transaction have been transferred and applied to the synchronous replica node, providing durability to the data. **Note**: HA standby nodes are not accessible to users unless the main node becomes unavailable and the standby takes over. If you wish to run queries on a read-only node, you can use [Read Replicas](https://developers.scaleway.com/en/products/rdb/api/#read-replicas-8e2cf2) @@ -637,7 +637,7 @@ scw rdb instance get-certificate [arg=value ...] ### List Database Instances -List all Database Instances in the specified zone, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. +List all Database Instances in the specified region, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. **Usage:** @@ -915,7 +915,7 @@ scw rdb log purge [arg=value ...] ## Node types management commands -Two node type ranges are available: +Two node type ranges are available: * **General Purpose:** production-grade nodes designed for scalable database infrastructures. * **Development:** sandbox environments and reliable performance for development and testing purposes. @@ -924,7 +924,7 @@ Two node type ranges are available: ### List available node types -List all available node types. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. +List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. **Usage:** @@ -951,7 +951,7 @@ Each user has associated permissions that give them access to zero or more logic * **None:** No access to the database * **Read:** Allow users to read tables and fields in a database * **Write:** Allow users to write content in databases. -* **Admin:** Read and write access to the data, and extended privileges depending on the database engine. +* **Admin:** Read and write access to the data, and extended privileges depending on the database engine. @@ -1003,7 +1003,7 @@ scw rdb privilege set [arg=value ...] ## Read replica management -A Read Replica is a live copy of a Database Instance that behaves like an Instance, but that only allows read-only connections. +A Read Replica is a live copy of a Database Instance that behaves like an Instance, but that only allows read-only connections. The replica mirrors the data of the primary Database node and any changes made are replicated to the replica asynchronously. Read Replicas allow you to scale your Database Instance for read-heavy database workloads. They can also be used for business intelligence workloads. A Read Replica can have at most one direct access and one Private Network endpoint. `Loadbalancer` endpoints are not available on Read Replicas even if this resource is displayed in the Read Replica response example. @@ -1194,7 +1194,7 @@ scw rdb snapshot get [arg=value ...] ### List snapshots -List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snaphots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. +List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. **Usage:** @@ -1263,7 +1263,7 @@ scw rdb snapshot update [arg=value ...] ## User management commands -Users are profiles to which you can attribute database-level permissions. They allow you to define permissions specific to each type of database usage. For example, users with an `admin` role can create new databases and users. +Users are profiles to which you can attribute database-level permissions. They allow you to define permissions specific to each type of database usage. For example, users with an `admin` role can create new databases and users. diff --git a/docs/commands/redis.md b/docs/commands/redis.md index 76a372c394..cf38fc68f1 100644 --- a/docs/commands/redis.md +++ b/docs/commands/redis.md @@ -3,44 +3,44 @@ Managed Database for Redis™ API. - [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands) - - [Add ACL rules for a given cluster](#add-acl-rules-for-a-given-cluster) - - [Delete an ACL rule for a given cluster](#delete-an-acl-rule-for-a-given-cluster) + - [Add ACL rules for a cluster](#add-acl-rules-for-a-cluster) + - [Delete an ACL rule for a cluster](#delete-an-acl-rule-for-a-cluster) - [Get an ACL rule](#get-an-acl-rule) - - [Set ACL rules for a given cluster](#set-acl-rules-for-a-given-cluster) + - [Set ACL rules for a cluster](#set-acl-rules-for-a-cluster) - [Cluster management commands](#cluster-management-commands) - - [Create a cluster](#create-a-cluster) - - [Delete a cluster](#delete-a-cluster) - - [Get a cluster](#get-a-cluster) + - [Create a Redis™ Database Instance](#create-a-redis™-database-instance) + - [Delete a Redis™ Database Instance](#delete-a-redis™-database-instance) + - [Get a Redis™ Database Instance](#get-a-redis™-database-instance) - [Get the TLS certificate of a cluster](#get-the-tls-certificate-of-a-cluster) - - [List clusters](#list-clusters) - - [Get metrics of a cluster](#get-metrics-of-a-cluster) - - [Migrate your cluster architecture](#migrate-your-cluster-architecture) + - [List Redis™ Database Instances](#list-redis™-database-instances) + - [Get metrics of a Redis™ Database Instance](#get-metrics-of-a-redis™-database-instance) + - [Scale up a Redis™ Database Instance](#scale-up-a-redis™-database-instance) - [Renew the TLS certificate of a cluster](#renew-the-tls-certificate-of-a-cluster) - - [Update a cluster](#update-a-cluster) + - [Update a Redis™ Database Instance](#update-a-redis™-database-instance) - [Endpoints management commands](#endpoints-management-commands) - - [Add endpoints for a given cluster](#add-endpoints-for-a-given-cluster) - - [Delete an endpoint for a given cluster](#delete-an-endpoint-for-a-given-cluster) + - [Add endpoints for a cluster](#add-endpoints-for-a-cluster) + - [Delete an endpoint for a cluster](#delete-an-endpoint-for-a-cluster) - [Get an endpoint](#get-an-endpoint) - - [Set endpoints for a given cluster](#set-endpoints-for-a-given-cluster) + - [Set endpoints for a cluster](#set-endpoints-for-a-cluster) - [Node Types management commands](#node-types-management-commands) - [List available node types](#list-available-node-types) - [Settings management commands](#settings-management-commands) - - [Add cluster settings](#add-cluster-settings) - - [Delete a cluster setting](#delete-a-cluster-setting) - - [Set cluster settings](#set-cluster-settings) + - [Add advanced settings](#add-advanced-settings) + - [Delete advanced setting](#delete-advanced-setting) + - [Set advanced settings](#set-advanced-settings) - [Redis™ version management commands](#redis™-version-management-commands) - [List available Redis™ versions](#list-available-redis™-versions) ## Access Control List (ACL) management commands -Network Access Control List allows to control network inbound traffic allowed by setting up ACL rules. ACL rules could be created, edited, deleted. +Network Access Control Lists (ACLs) allow you to manage network inbound traffic by setting up ACL rules. -### Add ACL rules for a given cluster +### Add ACL rules for a cluster -Add ACL rules for a given cluster. +Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster). **Usage:** @@ -53,16 +53,16 @@ scw redis acl add [arg=value ...] | Name | | Description | |------|---|-------------| -| cluster-id | Required | UUID of the cluster you want to add acl rules to | +| cluster-id | Required | UUID of the Database Instance you want to add ACL rules to | | acl-rules.{index}.ip-cidr | | IPv4 network address of the rule | | acl-rules.{index}.description | | Description of the rule | | 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 ACL rule for a given cluster +### Delete an ACL rule for a cluster -Delete an ACL rule for a given cluster. +Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule you want to delete in your request. **Usage:** @@ -75,14 +75,14 @@ scw redis acl delete [arg=value ...] | Name | | Description | |------|---|-------------| -| acl-id | Required | UUID of the acl rule you want to delete | +| acl-id | Required | UUID of the ACL rule you want 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 ACL rule -Get an ACL rule. +Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule in your request. **Usage:** @@ -95,14 +95,14 @@ scw redis acl get [arg=value ...] | Name | | Description | |------|---|-------------| -| acl-id | Required | UUID of the acl rule you want to get | +| acl-id | Required | UUID of the ACL rule you want 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 | -### Set ACL rules for a given cluster +### Set ACL rules for a cluster -Set ACL rules for a given cluster. +Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster). **Usage:** @@ -115,7 +115,7 @@ scw redis acl set [arg=value ...] | Name | | Description | |------|---|-------------| -| cluster-id | Required | UUID of the cluster where the ACL rules has to be set | +| cluster-id | Required | UUID of the Database Instance where the ACL rules have to be set | | acl-rules.{index}.ip-cidr | | IPv4 network address of the rule | | acl-rules.{index}.description | | Description of the rule | | 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 | @@ -124,13 +124,13 @@ scw redis acl set [arg=value ...] ## Cluster management commands -A Managed Database for Redis™ cluster is composed of one or more Nodes depending of the cluster_size setting. +A Redis™ Database Instance, also known as a Redis™ cluster, consists of either one standalone node or a cluster composed of three to six nodes. The cluster uses partitioning to split the keyspace. Each partition is replicated and can be reassigned or elected as the primary when necessary. Standalone mode creates a standalone database provisioned on a single node. -### Create a cluster +### Create a Redis™ Database Instance -Create a cluster. +Create a new Redis™ Database Instance (Redis™ cluster). You must set the `zone`, `project_id`, `version`, `node_type`, `user_name` and `password` parameters. Optionally you can define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`. **Usage:** @@ -144,17 +144,17 @@ scw redis cluster 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 cluster | -| version | Required | Redis™ engine version of the cluster | -| tags.{index} | | Tags to apply to the cluster | -| node-type | Required | Type of node to use for the cluster | -| user-name | Required | Name of the user created when the cluster is created | +| name | Default: `` | Name of the Database Instance | +| version | Required | Redis™ engine version of the Database Instance | +| tags.{index} | | Tags to apply to the Database Instance | +| node-type | Required | Type of node to use for the Database Instance | +| user-name | Required | Name of the user created upon Database Instance creation | | password | Required | Password of the user | -| cluster-size | | Number of nodes for the cluster | +| cluster-size | | Number of nodes in the Redis™ cluster | | acl-rules.{index}.ip-cidr | | IPv4 network address of the rule | | acl-rules.{index}.description | | Description of the rule | -| endpoints.{index}.private-network.id | | UUID of the private network to be connected to the cluster | -| endpoints.{index}.private-network.service-ips.{index} | | Endpoint IPv4 adress with a CIDR notation. You must provide at least one IPv4 per node. Check documentation about IP and subnet limitation. | +| endpoints.{index}.private-network.id | | UUID of the Private Network to connect to the Database Instance | +| endpoints.{index}.private-network.service-ips.{index} | | Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. | | tls-enabled | | Whether or not TLS is enabled | | cluster-settings.{index}.value | | Value of the setting | | cluster-settings.{index}.name | | Name of the setting | @@ -162,9 +162,9 @@ scw redis cluster create [arg=value ...] -### Delete a cluster +### Delete a Redis™ Database Instance -Delete a cluster. +Delete a Redis™ Database Instance (Redis™ cluster), specified by the `region` and `cluster_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. **Usage:** @@ -177,14 +177,14 @@ scw redis cluster delete [arg=value ...] | Name | | Description | |------|---|-------------| -| cluster-id | Required | UUID of the cluster to delete | +| cluster-id | Required | UUID of the Database Instance 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 cluster +### Get a Redis™ Database Instance -Get a cluster. +Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the `cluster_id` and `region` in your request to get information such as `id`, `status`, `version`, `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints` about your cluster in the response. **Usage:** @@ -204,7 +204,7 @@ scw redis cluster get [arg=value ...] ### Get the TLS certificate of a cluster -Get the TLS certificate of a cluster. +Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response. **Usage:** @@ -222,9 +222,9 @@ scw redis cluster get-certificate [arg=value ...] -### List clusters +### List Redis™ Database Instances -List clusters. +List all Redis™ Database Instances (Redis™ cluster) in the specified zone. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags`, `name`, `organization_id` and `version`. **Usage:** @@ -237,19 +237,19 @@ scw redis cluster list [arg=value ...] | Name | | Description | |------|---|-------------| -| tags.{index} | | Tags of the clusters to filter upon | -| name | | Name of the clusters to filter upon | -| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Criteria to use when ordering cluster listing | -| project-id | | Project ID to list the cluster of | -| version | | Version of the clusters to filter upon | -| organization-id | | Organization ID to list the cluster of | +| tags.{index} | | Filter by Database Instance tags | +| name | | Filter by Database Instance names | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Criteria to use when ordering the list | +| project-id | | Filter by Project ID | +| version | | Filter by Redis™ engine version | +| organization-id | | Filter by Organization ID | | 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 | -### Get metrics of a cluster +### Get metrics of a Redis™ Database Instance -Get metrics of a cluster. +Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`. **Usage:** @@ -263,16 +263,16 @@ scw redis cluster metrics [arg=value ...] | Name | | Description | |------|---|-------------| | cluster-id | Required | UUID of the cluster | -| start-at | | Start date to gather metrics from | -| end-at | | End date to gather metrics from | +| start-at | | Start date | +| end-at | | End date | | metric-name | | Name of the metric to gather | | 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 | -### Migrate your cluster architecture +### Scale up a Redis™ Database Instance -Upgrade your Database for Redis® cluster to a new version or scale it vertically / horizontally. Please note: scaling horizontally your Database for Redis® cluster won't renew its TLS certificate. In order to refresh the SSL certificate, you have to use the dedicated api route. +Upgrade your standalone Redis™ Database Instance node, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint. **Usage:** @@ -285,17 +285,17 @@ scw redis cluster migrate [arg=value ...] | Name | | Description | |------|---|-------------| -| version | | Redis™ engine version of the cluster | -| node-type | | Type of node to use for the cluster | -| cluster-size | | Number of nodes for the cluster | -| cluster-id | Required | UUID of the cluster to update | +| version | | Redis™ engine version of the Database Instance | +| node-type | | Type of node to use for the Database Instance | +| cluster-size | | Number of nodes for the Database Instance | +| cluster-id | Required | UUID of the Database Instance to update | | 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 | ### Renew the TLS certificate of a cluster -Renew the TLS certificate of a cluster. +Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients. **Usage:** @@ -313,9 +313,9 @@ scw redis cluster renew-certificate [arg=value ...] -### Update a cluster +### Update a Redis™ Database Instance -Update a cluster. +Update the parameters of a Redis™ Database Instance (Redis™ cluster), including `name`, `tags`, `user_name` and `password`. **Usage:** @@ -328,24 +328,24 @@ scw redis cluster update [arg=value ...] | Name | | Description | |------|---|-------------| -| name | | Name of the cluster | -| tags.{index} | | Tags of a given cluster | -| user-name | | Name of the cluster user | -| password | | Password of the cluster user | -| cluster-id | Required | UUID of the cluster to update | +| name | | Name of the Database Instance | +| tags.{index} | | Database Instance tags | +| user-name | | Name of the Database Instance user | +| password | | Password of the Database Instance user | +| cluster-id | Required | UUID of the Database Instance to update | | 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 | ## Endpoints management commands -Manage endpoints to access to your cluster trough Public or Private networks +Manage endpoint access to your Redis™ Database Instance through Public or Private Networks -### Add endpoints for a given cluster +### Add endpoints for a cluster -Add endpoints for a given cluster. +Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add `private_network` or `public_network` specifications to the body of the request. **Usage:** @@ -358,16 +358,16 @@ scw redis endpoint add [arg=value ...] | Name | | Description | |------|---|-------------| -| cluster-id | Required | UUID of the cluster you want to add endpoints to | -| endpoints.{index}.private-network.id | | UUID of the private network to be connected to the cluster | -| endpoints.{index}.private-network.service-ips.{index} | | Endpoint IPv4 adress with a CIDR notation. You must provide at least one IPv4 per node. Check documentation about IP and subnet limitation. | +| cluster-id | Required | UUID of the Database Instance you want to add endpoints to | +| endpoints.{index}.private-network.id | | UUID of the Private Network to connect to the Database Instance | +| endpoints.{index}.private-network.service-ips.{index} | | Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. | | 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 endpoint for a given cluster +### Delete an endpoint for a cluster -Delete an endpoint for a given cluster. +Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). You must specify the `region` and `endpoint_id` parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint. **Usage:** @@ -387,7 +387,7 @@ scw redis endpoint delete [arg=value ...] ### Get an endpoint -Get an endpoint. +Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response. **Usage:** @@ -405,9 +405,9 @@ scw redis endpoint get [arg=value ...] -### Set endpoints for a given cluster +### Set endpoints for a cluster -Set endpoints for a given cluster. +Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the `cluster_id` and the `endpoints` parameters in your request. **Usage:** @@ -420,22 +420,22 @@ scw redis endpoint set [arg=value ...] | Name | | Description | |------|---|-------------| -| cluster-id | Required | UUID of the cluster where the endpoints has to be set | -| endpoints.{index}.private-network.id | | UUID of the private network to be connected to the cluster | -| endpoints.{index}.private-network.service-ips.{index} | | Endpoint IPv4 adress with a CIDR notation. You must provide at least one IPv4 per node. Check documentation about IP and subnet limitation. | +| cluster-id | Required | UUID of the Database Instance where the endpoints have to be set | +| endpoints.{index}.private-network.id | | UUID of the Private Network to connect to the Database Instance | +| endpoints.{index}.private-network.service-ips.{index} | | Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. | | 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 | ## Node Types management commands -Node types powering your cluster. +Nodes are the compute units that make up your Redis™ Database Instance. Different node types are available with varying amounts of RAM and vCPU. ### List available node types -List available node types. +List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. **Usage:** @@ -455,13 +455,15 @@ scw redis node-type list [arg=value ...] ## Settings management commands -Available Redis™ settings. Available settings depend on the Redis™ version. +Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](https://developers.scaleway.com/en/products/redis/api/v1/#get-209533) endpoint. +Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform. -### Add cluster settings -Add cluster settings. +### Add advanced settings + +Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the `name` and the `value` of each setting. **Usage:** @@ -474,16 +476,16 @@ scw redis setting add [arg=value ...] | Name | | Description | |------|---|-------------| -| cluster-id | Required | UUID of the cluster you want to add settings to | +| cluster-id | Required | UUID of the Database Instance you want to add settings to | | settings.{index}.value | | Value of the setting | | settings.{index}.name | | Name of the setting | | 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 cluster setting +### Delete advanced setting -Delete a cluster setting. +Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body. **Usage:** @@ -496,15 +498,15 @@ scw redis setting delete [arg=value ...] | Name | | Description | |------|---|-------------| -| cluster-id | Required | UUID of the cluster where the settings has to be set | +| cluster-id | Required | UUID of the Database Instance where the settings must be set | | setting-name | Required | Setting name 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 | -### Set cluster settings +### Set advanced settings -Set cluster settings. +Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated. **Usage:** @@ -517,7 +519,7 @@ scw redis setting set [arg=value ...] | Name | | Description | |------|---|-------------| -| cluster-id | Required | UUID of the cluster where the settings has to be set | +| cluster-id | Required | UUID of the Database Instance where the settings must be set | | settings.{index}.value | | Value of the setting | | settings.{index}.name | | Name of the setting | | 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 | @@ -526,12 +528,12 @@ scw redis setting set [arg=value ...] ## Redis™ version management commands -Redis™ versions powering your cluster. +The Redis™ database engine versions available at Scaleway for your clusters. ### List available Redis™ versions -List available Redis™ versions. +List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`. **Usage:** diff --git a/docs/commands/webhosting.md b/docs/commands/webhosting.md index 8eed32ce9f..a0fbf387f1 100644 --- a/docs/commands/webhosting.md +++ b/docs/commands/webhosting.md @@ -2,31 +2,32 @@ # Documentation for `scw webhosting` Webhosting API. -- [DNS record management commands](#dns-record-management-commands) - - [Get the DNS records](#get-the-dns-records) - [Hosting management commands](#hosting-management-commands) - [Create a hosting](#create-a-hosting) + - [Delete a hosting](#delete-a-hosting) - [Get a hosting](#get-a-hosting) + - [Get the DNS records](#get-the-dns-records) - [List all hostings](#list-all-hostings) + - [Restore a hosting](#restore-a-hosting) - [Update a hosting](#update-a-hosting) - [Offer management commands](#offer-management-commands) - [List all offers](#list-all-offers) -## DNS record management commands +## Hosting management commands -The set of DNS record of a specific domain associated to a hosting. +A Scaleway web hosting associated with a domain name. -### Get the DNS records +### Create a hosting -Get the DNS records of a specified domain. +Create a hosting. **Usage:** ``` -scw webhosting dns-record get [arg=value ...] +scw webhosting hosting create [arg=value ...] ``` @@ -34,35 +35,54 @@ scw webhosting dns-record get [arg=value ...] | Name | | Description | |------|---|-------------| -| domain | Required | Domain associated to the DNS records | +| offer-id | | ID of the selected offer for the hosting | +| project-id | | Project ID to use. If none is passed the default project ID will be used | +| email | | Contact email of the client for the hosting | +| tags.{index} | | The tags of the hosting | +| domain | | The domain name of the hosting | +| option-ids.{index} | | IDs of the selected options for the hosting | | region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | -**Examples:** +### Delete a hosting + +Delete a hosting with the given ID. + +**Usage:** -Get DNS records associated to the given domain ``` -scw webhosting dns-record get domain=foo.com +scw webhosting hosting delete [arg=value ...] ``` +**Args:** + +| Name | | Description | +|------|---|-------------| +| hosting-id | Required | Hosting ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + +**Examples:** -## Hosting management commands -A Scaleway web hosting associated with a domain name. +Delete a Hosting with the given ID +``` +scw webhosting hosting delete hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7 +``` -### Create a hosting -Create a hosting. +### Get a hosting + +Get the details of a Hosting with the given ID. **Usage:** ``` -scw webhosting hosting create [arg=value ...] +scw webhosting hosting get [arg=value ...] ``` @@ -70,24 +90,29 @@ scw webhosting hosting create [arg=value ...] | Name | | Description | |------|---|-------------| -| offer-id | | ID of the selected offer for the hosting | -| project-id | | Project ID to use. If none is passed the default project ID will be used | -| email | | Contact email of the client for the hosting | -| tags.{index} | | The tags of the hosting | -| domain | | The domain name of the hosting | -| option-ids.{index} | | IDs of the selected options for the hosting | +| hosting-id | Required | Hosting ID | | region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | +**Examples:** -### Get a hosting -Get the details of a Hosting with the given ID. +Get a Hosting with the given ID +``` +scw webhosting hosting get hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7 +``` + + + + +### Get the DNS records + +The set of DNS record of a specific domain associated to a hosting. **Usage:** ``` -scw webhosting hosting get [arg=value ...] +scw webhosting hosting get-dns-records [arg=value ...] ``` @@ -95,16 +120,16 @@ scw webhosting hosting get [arg=value ...] | Name | | Description | |------|---|-------------| -| hosting-id | Required | Hosting ID | +| domain | Required | Domain associated to the DNS records | | region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | **Examples:** -Get a Hosting with the given ID +Get DNS records associated to the given domain ``` -scw webhosting hosting get hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7 +scw webhosting hosting get-dns-records domain=foo.com ``` @@ -145,6 +170,36 @@ scw webhosting hosting list project-id=a3244331-5d32-4e36-9bf9-b60233e201c7 orga +### Restore a hosting + +Restore a hosting with the given ID. + +**Usage:** + +``` +scw webhosting hosting restore [arg=value ...] +``` + + +**Args:** + +| Name | | Description | +|------|---|-------------| +| hosting-id | Required | Hosting ID | +| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | + + +**Examples:** + + +Restore a Hosting with the given ID +``` +scw webhosting hosting restore hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7 +``` + + + + ### Update a hosting Update a hosting. diff --git a/go.mod b/go.mod index 5252ab39c0..37b3a96678 100644 --- a/go.mod +++ b/go.mod @@ -21,7 +21,7 @@ require ( github.com/moby/buildkit v0.11.4 github.com/opencontainers/go-digest v1.0.0 github.com/pkg/errors v0.9.1 - github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230318120603-8df14b12fd02 + github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230320173444-ec31c4c2c56f 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 22e18948b5..2afaacf321 100644 --- a/go.sum +++ b/go.sum @@ -192,8 +192,8 @@ github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1: github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ= github.com/russross/blackfriday v1.6.0/go.mod h1:ti0ldHuxg49ri4ksnFxlkCfN+hvslNlmVHqNRXXJNAY= 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.20230318120603-8df14b12fd02 h1:Ipdjm5oXQtzoHxsc1Pj7LqOlNJh5HrVb4R9TRpFiwKM= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230318120603-8df14b12fd02/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230320173444-ec31c4c2c56f h1:OcUTyHd7G47ZrgeSrKzm/FrBZNYV9vWiX309XWTecQ0= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230320173444-ec31c4c2c56f/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= github.com/secure-systems-lab/go-securesystemslib v0.4.0 h1:b23VGrQhTA8cN2CbBw7/FulN9fTtqYUdS5+Oxzt+DUE= 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= diff --git a/internal/namespaces/webhosting/v1alpha1/webhosting_cli.go b/internal/namespaces/webhosting/v1alpha1/webhosting_cli.go index 4baa7ff49a..b16345b702 100644 --- a/internal/namespaces/webhosting/v1alpha1/webhosting_cli.go +++ b/internal/namespaces/webhosting/v1alpha1/webhosting_cli.go @@ -21,13 +21,14 @@ func GetGeneratedCommands() *core.Commands { return core.NewCommands( webhostingRoot(), webhostingHosting(), - webhostingDNSRecord(), webhostingOffer(), webhostingHostingCreate(), webhostingHostingList(), webhostingHostingGet(), webhostingHostingUpdate(), - webhostingDNSRecordGet(), + webhostingHostingDelete(), + webhostingHostingRestore(), + webhostingHostingGetDNSRecords(), webhostingOfferList(), ) } @@ -49,16 +50,6 @@ func webhostingHosting() *core.Command { } } -func webhostingDNSRecord() *core.Command { - return &core.Command{ - Short: `DNS record management commands`, - Long: `The set of DNS record of a specific domain associated to a hosting. -`, - Namespace: "webhosting", - Resource: "dns-record", - } -} - func webhostingOffer() *core.Command { return &core.Command{ Short: `Offer management commands`, @@ -318,13 +309,85 @@ func webhostingHostingUpdate() *core.Command { } } -func webhostingDNSRecordGet() *core.Command { +func webhostingHostingDelete() *core.Command { + return &core.Command{ + Short: `Delete a hosting`, + Long: `Delete a hosting with the given ID.`, + Namespace: "webhosting", + Resource: "hosting", + Verb: "delete", + // Deprecated: false, + ArgsType: reflect.TypeOf(webhosting.DeleteHostingRequest{}), + ArgSpecs: core.ArgSpecs{ + { + Name: "hosting-id", + Short: `Hosting ID`, + Required: true, + Deprecated: false, + Positional: false, + }, + core.RegionArgSpec(scw.RegionFrPar), + }, + Run: func(ctx context.Context, args interface{}) (i interface{}, e error) { + request := args.(*webhosting.DeleteHostingRequest) + + client := core.ExtractClient(ctx) + api := webhosting.NewAPI(client) + return api.DeleteHosting(request) + + }, + Examples: []*core.Example{ + { + Short: "Delete a Hosting with the given ID", + ArgsJSON: `{"hosting_id":"a3244331-5d32-4e36-9bf9-b60233e201c7"}`, + }, + }, + } +} + +func webhostingHostingRestore() *core.Command { + return &core.Command{ + Short: `Restore a hosting`, + Long: `Restore a hosting with the given ID.`, + Namespace: "webhosting", + Resource: "hosting", + Verb: "restore", + // Deprecated: false, + ArgsType: reflect.TypeOf(webhosting.RestoreHostingRequest{}), + ArgSpecs: core.ArgSpecs{ + { + Name: "hosting-id", + Short: `Hosting ID`, + Required: true, + Deprecated: false, + Positional: false, + }, + core.RegionArgSpec(scw.RegionFrPar), + }, + Run: func(ctx context.Context, args interface{}) (i interface{}, e error) { + request := args.(*webhosting.RestoreHostingRequest) + + client := core.ExtractClient(ctx) + api := webhosting.NewAPI(client) + return api.RestoreHosting(request) + + }, + Examples: []*core.Example{ + { + Short: "Restore a Hosting with the given ID", + ArgsJSON: `{"hosting_id":"a3244331-5d32-4e36-9bf9-b60233e201c7"}`, + }, + }, + } +} + +func webhostingHostingGetDNSRecords() *core.Command { return &core.Command{ Short: `Get the DNS records`, - Long: `Get the DNS records of a specified domain.`, + Long: `The set of DNS record of a specific domain associated to a hosting.`, Namespace: "webhosting", - Resource: "dns-record", - Verb: "get", + Resource: "hosting", + Verb: "get-dns-records", // Deprecated: false, ArgsType: reflect.TypeOf(webhosting.GetDomainDNSRecordsRequest{}), ArgSpecs: core.ArgSpecs{