diff --git a/cmd/scw/testdata/test-all-usage-rdb-acl-add-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-acl-add-usage.golden index dd39bf4980..fe33acb3ba 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-acl-add-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-acl-add-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Add an additional ACL rule to a database instance. +Add an additional ACL rule to a Database Instance. USAGE: scw rdb acl add [arg=value ...] ARGS: - instance-id UUID of the instance you want to add acl rules to + instance-id UUID of the Database Instance you want to add ACL rules to [rules.{index}.ip] [rules.{index}.description] [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) diff --git a/cmd/scw/testdata/test-all-usage-rdb-acl-delete-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-acl-delete-usage.golden index dbf0c83e26..795c824d9b 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-acl-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-acl-delete-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete ACL rules of a given instance. +Delete one or more ACL rules of a Database Instance. USAGE: scw rdb acl delete [arg=value ...] ARGS: - instance-id UUID of the instance you want to delete an ACL rules from - rules.{index}.ip ACL rules IP present on the instance + instance-id UUID of the Database Instance you want to delete an ACL rule from + rules.{index}.ip IP addresses defined in the ACL rules of the Database Instance [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-acl-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-acl-list-usage.golden index 71caf42c5a..2f398b1b0c 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-acl-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-acl-list-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List ACL rules of a given instance. +List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions. USAGE: scw rdb acl list [arg=value ...] ARGS: - instance-id UUID of the instance + instance-id UUID of the Database Instance [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-acl-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-acl-usage.golden index 74915ea407..635afe00f6 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-acl-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-acl-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Network Access Control List allows to control network in and out traffic by setting up ACL rules. +Network Access Control Lists allow you to control incoming network traffic by setting up ACL rules. USAGE: scw rdb acl AVAILABLE COMMANDS: - add Add an ACL instance to a given instance - delete Delete ACL rules of a given instance - list List ACL rules of a given instance + add Add an ACL rule to a Database Instance + delete Delete ACL rules of a Database Instance + list List ACL rules of a Database Instance FLAGS: -h, --help help for acl diff --git a/cmd/scw/testdata/test-all-usage-rdb-backup-create-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-backup-create-usage.golden index a120f063f6..573010f745 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-backup-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-backup-create-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a database backup. +Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters. USAGE: scw rdb backup create [arg=value ...] ARGS: - [instance-id] UUID of the instance - [database-name] Name of the database you want to make a backup of + [instance-id] UUID of the Database Instance + [database-name] Name of the database you want to back up [name=] Name of the backup - [expires-at] Expiration date (Format ISO 8601) + [expires-at] Expiration date (must follow the ISO 8601 format) [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-backup-delete-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-backup-delete-usage.golden index 5b2b3cd4ca..4b455d5e2e 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-backup-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-backup-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a database backup. +Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone. USAGE: scw rdb backup delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-rdb-backup-export-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-backup-export-usage.golden index e254687789..e5d6cbaecd 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-backup-export-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-backup-export-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Export a database backup. +Export a backup, specified by the `database_backup_id` and the `region` parameters. The download URL is returned in the response. USAGE: scw rdb backup export [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-rdb-backup-get-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-backup-get-usage.golden index f850861891..c766278cda 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-backup-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-backup-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a database backup. +Retrieve information about a given backup, specified by its database backup ID and region. Full details about the backup, like size, URL and expiration date, are returned in the response. USAGE: scw rdb backup get [arg=value ...] 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 454879973a..92f48dcc9a 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 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. USAGE: scw rdb backup list [arg=value ...] @@ -8,9 +8,9 @@ USAGE: ARGS: [name] Name of the database backups [order-by] Criteria to use when ordering database backups listing (created_at_asc | created_at_desc | name_asc | name_desc | status_asc | status_desc) - [instance-id] UUID of the instance - [project-id] Project ID the database backups belongs to - [organization-id] Organization ID the database backups belongs to + [instance-id] UUID of the Database Instance + [project-id] Project ID of the Project the database backups belong to + [organization-id] Organization ID of the Organization the database backups belong to [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-backup-restore-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-backup-restore-usage.golden index bb5da6835f..261e6e15b2 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-backup-restore-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-backup-restore-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Restore a database backup. +Launch the process of restoring database backup. You must specify the `instance_id` of the Database Instance of destination, where the backup will be restored. Note that large database backups can take up to several hours to restore. USAGE: scw rdb backup restore [arg=value ...] ARGS: - [database-name] Defines the destination database in order to restore into a specified database, the default destination is set to the origin database of the backup + [database-name] Defines the destination database to restore into a specified database (the default destination is set to the origin database of the backup) database-backup-id Backup of a logical database - instance-id Defines the rdb instance where the backup has to be restored + instance-id Defines the Database Instance where the backup has to be restored [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-backup-update-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-backup-update-usage.golden index 890d747869..753ad4a8e1 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-backup-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-backup-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a database backup. +Update the parameters of a backup, including name and expiration date. USAGE: scw rdb backup update [arg=value ...] @@ -8,7 +8,7 @@ USAGE: ARGS: database-backup-id UUID of the database backup to update [name] Name of the Database Backup - [expires-at] Expiration date (Format ISO 8601) + [expires-at] Expiration date (must follow the ISO 8601 format) [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-backup-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-backup-usage.golden index 027d7449db..7ab902b5a0 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-backup-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-backup-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Save and restore backups of your database instance. +A database backup is a dated export of a Database Instance stored on an offsite backend located in a different region than your database, by default. Once a backup is created, it can be used to restore the database. Each logical database in a Database Instance is backed up and can be restored separately. USAGE: scw rdb backup diff --git a/cmd/scw/testdata/test-all-usage-rdb-database-create-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-database-create-usage.golden index a7be6f78cb..f384887139 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-database-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-database-create-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a database in a given instance. +Create a new database. You must define the `name` parameter in the request. USAGE: scw rdb database create [arg=value ...] ARGS: - instance-id UUID of the instance where to create the database + instance-id UUID of the Database Instance where to create the database [name] Name of the database [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) diff --git a/cmd/scw/testdata/test-all-usage-rdb-database-delete-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-database-delete-usage.golden index ab87ea7fc0..ab1c9716d4 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-database-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-database-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a database in a given instance. +Delete a given database on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the database you want to delete. USAGE: scw rdb database delete [arg=value ...] ARGS: - instance-id UUID of the instance where to delete the database + instance-id UUID of the Database Instance where to delete the database name Name of the database to delete [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) diff --git a/cmd/scw/testdata/test-all-usage-rdb-database-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-database-list-usage.golden index c414a74650..f18bea8fe7 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-database-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-database-list-usage.golden @@ -1,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all database in a given instance. +List all databases of a given Database Instance. 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. You can define additional parameters for your query, such as `name`, `managed` and `owner`. USAGE: scw rdb database list [arg=value ...] ARGS: [name] Name of the database - [managed] Whether or not the database is managed + [managed] Defines whether or not the database is managed [owner] User that owns this database [order-by] Criteria to use when ordering database listing (name_asc | name_desc | size_asc | size_desc) - instance-id UUID of the instance to list database of + instance-id UUID of the Database Instance to list the databases of [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-database-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-database-usage.golden index 9f5d4ed1ed..ed27fa3055 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-database-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-database-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Manage logical databases on your instance +Databases can be used to store and manage sets of structured information, or data. The interaction between the user and a database is done using a Database Engine, which provides a structured query language to add, modify or delete information from the database. USAGE: scw rdb database AVAILABLE COMMANDS: - create Create a database in a given instance - delete Delete a database in a given instance - list List all database in a given instance + create Create a database in a Database Instance + delete Delete a database in a Database Instance + list List databases in a Database Instance FLAGS: -h, --help help for database diff --git a/cmd/scw/testdata/test-all-usage-rdb-engine-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-engine-list-usage.golden index cbcf312b01..a8f5be372a 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-engine-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-engine-list-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List available database engines. +List the PostgreSQL and MySQL database engines available at Scaleway. USAGE: scw rdb engine list [arg=value ...] ARGS: - [name] Name of the Database Engine - [version] Version of the Database Engine + [name] Name of the database engine + [version] Version of the database engine [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-engine-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-engine-usage.golden index 3f26c66489..30304db53c 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-engine-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-engine-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Software that stores and retrieves data from a database. Each database engine has a name and versions. +A database engine is the software component that stores and retrieves your data from a database. Currently PostgreSQL 11, 12, 13 and 14 are available. MySQL is available in version 8. USAGE: scw rdb engine diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-clone-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-clone-usage.golden index 98f95ff51d..992c25638d 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-clone-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-clone-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Clone an instance. +Clone a given Database Instance, specified by the `region` and `instance_id` parameters. The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users and permissions. You can create a clone on a Database Instance bigger than your current one. USAGE: scw rdb instance clone [arg=value ...] ARGS: - instance-id UUID of the instance you want to clone - [name] Name of the clone instance + instance-id UUID of the Database Instance you want to clone + [name] Name of the Database Instance clone [node-type] Node type of the clone [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-create-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-create-usage.golden index 1d56cdb58b..f6683802ee 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-create-usage.golden @@ -1,27 +1,27 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create an instance. +Create a new Database Instance. You must set the `engine`, `user_name`, `password` and `node_type` parameters. Optionally, you can specify the volume type and size. USAGE: scw rdb instance 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 instance - engine Database engine of the database (PostgreSQL, MySQL, ...) - user-name Name of the user created when the instance is created + [name=] Name of the Database Instance + engine Database engine of the Database Instance (PostgreSQL, MySQL, ...) + user-name Username created when the Database Instance is created password Password of the user - node-type=DB-DEV-S Type of node to use for the instance - [is-ha-cluster] Whether or not High-Availability is enabled - [disable-backup] Whether or not backups are disabled - [tags.{index}] Tags to apply to the instance + node-type=DB-DEV-S Type of node to use for the Database Instance + [is-ha-cluster] Defines whether or not High-Availability is enabled + [disable-backup] Defines whether or not backups are disabled + [tags.{index}] Tags to apply to the Database Instance [init-settings.{index}.name] [init-settings.{index}.value] - [volume-type] Type of volume where data are stored (lssd, bssd, ...) (lssd | bssd) + [volume-type] Type of volume where data is stored (lssd, bssd, ...) (lssd | bssd) [volume-size] Volume size when volume_type is not lssd - [init-endpoints.{index}.private-network.private-network-id] UUID of the private network to be connected to the database instance - [init-endpoints.{index}.private-network.service-ip] Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitation. - [backup-same-region] Store logical backups in the same region as the database instance + [init-endpoints.{index}.private-network.private-network-id] UUID of the Private Network to be connected to the Database Instance + [init-endpoints.{index}.private-network.service-ip] Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. + [backup-same-region] Defines whether to or not to store logical backups in the same region as the Database Instance [organization-id] Organization ID to use. If none is passed the default organization ID will be used [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-delete-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-delete-usage.golden index 71808b7776..b7f476e854 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete an instance. +Delete a given Database Instance, specified by the `region` and `instance_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. USAGE: scw rdb instance delete [arg=value ...] ARGS: - instance-id UUID of the instance to delete + instance-id UUID of the Database Instance to delete [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-get-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-get-certificate-usage.golden index ed797d9374..1f7135283d 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-get-certificate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-get-certificate-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get the TLS certificate of an instance. +Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response. USAGE: scw rdb instance get-certificate [arg=value ...] ARGS: - instance-id UUID of the instance + instance-id UUID of the Database Instance [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-get-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-get-usage.golden index fd8e83838f..64fd0bc618 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get an instance. +Retrieve information about a given Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object. USAGE: scw rdb instance get [arg=value ...] ARGS: - instance-id UUID of the instance + instance-id UUID of the Database Instance [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: 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 16a426760e..4603a45d26 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,16 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List 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. USAGE: scw rdb instance list [arg=value ...] ARGS: - [tags.{index}] List instance that have a given tags - [name] List instance that match a given name pattern - [order-by] Criteria to use when ordering instance listing (created_at_asc | created_at_desc | name_asc | name_desc | region | status_asc | status_desc) - [project-id] Project ID to list the instance of - [organization-id] Please use `project_id` instead + [tags.{index}] List Database Instances that have a given tag + [name] Lists Database Instances that match a name pattern + [order-by] Criteria to use when ordering Database Instance listings (created_at_asc | created_at_desc | name_asc | name_desc | region | status_asc | status_desc) + [project-id] Project ID to list the Database Instance of + [organization-id] Please use project_id instead [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-renew-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-renew-certificate-usage.golden index 4f0142c0ba..e4e80f7f9f 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-renew-certificate-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-renew-certificate-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Renew the TLS certificate of an instance. +Renew a TLS for a Database Instance. 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 rdb instance renew-certificate [arg=value ...] ARGS: - instance-id UUID of the instance you want logs of + instance-id UUID of the Database Instance you want logs of [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-restart-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-restart-usage.golden index d769fdb8b8..a25966be4e 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-restart-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-restart-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Restart an instance. +Restart a given Database Instance, specified by the `region` and `instance_id` parameters. The status of the Database Instance returned in the response. USAGE: scw rdb instance restart [arg=value ...] ARGS: - instance-id UUID of the instance you want to restart + instance-id UUID of the Database Instance you want to restart [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-upgrade-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-upgrade-usage.golden index bdd0622227..e1d58baa91 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-upgrade-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-upgrade-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Upgrade your current instance specifications like node type, high availability, volume, or db engine version. +Upgrade your current Database Instance specifications like node type, high availability, volume, or the database engine version. Note that upon upgrade the `enable_ha` parameter can only be set to `true`. USAGE: scw rdb instance upgrade [arg=value ...] ARGS: - instance-id UUID of the instance you want to upgrade - [node-type] Node type of the instance you want to upgrade to - [enable-ha] Set to true to enable high availability on your instance + instance-id UUID of the Database Instance you want to upgrade + [node-type] Node type of the Database Instance you want to upgrade to + [enable-ha] Defines whether or not high availability should be enabled on the Database Instance [volume-size] Increase your block storage volume size - [volume-type] Change your instance storage type (lssd | bssd) - [upgradable-version-id] Update your instance database engine to a newer version + [volume-type] Change your Database Instance storage type (lssd | bssd) + [upgradable-version-id] Update your database engine to a newer version [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: 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 9e2e8ec061..2dc1db38e2 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-instance-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-instance-usage.golden @@ -1,22 +1,26 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -A Database Instance is composed of one or more Nodes, depending of the is_ha_cluster setting. Autohealing is enabled by default for HA clusters. Database automated backup is enabled by default in order to prevent data loss. +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) + +Read Replicas can be used for certain read-only workflows such as Business Intelligence, or for a read-only scaling of your application. Read Replicas use asynchronous replication to replicate data from the main node. USAGE: scw rdb instance AVAILABLE COMMANDS: - clone Clone an instance + clone Clone a Database Instance connect Connect to an instance using locally installed CLI - create Create an instance - delete Delete an instance - get Get an instance - get-certificate Get the TLS certificate of an instance - list List instances - renew-certificate Renew the TLS certificate of an instance - restart Restart an instance + create Create a Database Instance + delete Delete a Database Instance + get Get a Database Instance + get-certificate Get the TLS certificate of a Database Instance + list List Database Instances + renew-certificate Renew the TLS certificate of a Database Instance + restart Restart Database Instance update Update an instance - upgrade Upgrade an instance + upgrade Upgrade a Database Instance wait Wait for an instance to reach a stable state FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-get-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-get-usage.golden index 2fc34a171f..44c2311ed8 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-log-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-log-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get specific logs of a given instance. +Retrieve information about the logs of a Database Instance. Specify the `instance_log_id` and `region` in your request to get information such as `download_url`, `status`, `expires_at` and `created_at` about your logs in the response. USAGE: scw rdb log get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-list-details-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-list-details-usage.golden index ed5b553e2a..364ecb9c98 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-log-list-details-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-log-list-details-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List remote instances logs details. +List remote log details. 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 log list-details [arg=value ...] ARGS: - instance-id UUID of the instance you want logs of + instance-id UUID of the Database Instance you want logs of [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-list-usage.golden index 059f49cb20..7cf113cabe 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-log-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-log-list-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List available logs of a given instance. +List the available logs of a Database Instance. By default, the logs 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 log list [arg=value ...] ARGS: - instance-id UUID of the instance you want logs of - [order-by] Criteria to use when ordering instance logs listing (created_at_asc | created_at_desc) + instance-id UUID of the Database Instance you want logs of + [order-by] Criteria to use when ordering Database Instance logs listing (created_at_asc | created_at_desc) [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-prepare-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-prepare-usage.golden index f3c559130e..21273dc48d 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-log-prepare-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-log-prepare-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Prepare your instance logs. Logs will be grouped on a minimum interval of a day. +Prepare your Database Instance logs. You can define the `start_date` and `end_date` parameters for your query. The download URL is returned in the response. Logs are recorded from 00h00 to 23h59 and then aggregated in a `.log` file once a day. Therefore, even if you specify a timeframe from which you want to get the logs, you will receive logs from the full 24 hours. USAGE: scw rdb log prepare [arg=value ...] ARGS: - instance-id UUID of the instance you want logs of - [start-date] Start datetime of your log. Format: `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z` - [end-date] End datetime of your log. Format: `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z` + instance-id UUID of the Database Instance you want logs of + [start-date] Start datetime of your log. (RFC 3339 format) + [end-date] End datetime of your log. (RFC 3339 format) [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-purge-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-purge-usage.golden index dfc5a32169..3509c90a96 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-log-purge-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-log-purge-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Purge remote instances logs. +Purge a given remote log from a Database Instance. You can specify the `log_name` of the log you wish to clean from your Database Instance. USAGE: scw rdb log purge [arg=value ...] ARGS: - instance-id UUID of the instance you want logs of - [log-name] Specific log name to purge + instance-id UUID of the Database Instance you want logs of + [log-name] Given log name to purge [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden index 0de668094c..d057a05cb0 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-log-usage.golden @@ -6,11 +6,11 @@ USAGE: scw rdb log AVAILABLE COMMANDS: - get Get specific logs of a given instance - list List available logs of a given instance - list-details List remote instances logs details - prepare Prepare logs of a given instance - purge Purge remote instances logs + get Get given logs of a Database Instance + list List available logs of a Database Instance + list-details List remote Database Instance logs details + prepare Prepare logs of a Database Instance + purge Purge remote Database Instance logs FLAGS: -h, --help help for log 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 c72c4fedda..3fd0dbdf3f 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,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -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. USAGE: scw rdb node-type list [arg=value ...] ARGS: - [include-disabled-types] Whether or not to include disabled types + [include-disabled-types] Defines whether or not to include disabled types [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) FLAGS: 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 648edc6a59..f7ac32b480 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,9 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Node types powering your instance +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. USAGE: scw rdb node-type diff --git a/cmd/scw/testdata/test-all-usage-rdb-privilege-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-privilege-list-usage.golden index 23882af5a1..75f95de60b 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-privilege-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-privilege-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List privileges of a given user for a given database on a given instance. +List privileges of a user on a database. 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. You can define additional parameters for your query, such as `database_name` and `user_name`. USAGE: scw rdb privilege list [arg=value ...] @@ -8,7 +8,7 @@ USAGE: ARGS: [order-by] Criteria to use when ordering privileges listing (user_name_asc | user_name_desc | database_name_asc | database_name_desc) [database-name] Name of the database - instance-id UUID of the instance + instance-id UUID of the Database Instance [user-name] Name of the user [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) diff --git a/cmd/scw/testdata/test-all-usage-rdb-privilege-set-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-privilege-set-usage.golden index 84bbdb3395..904329d919 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-privilege-set-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-privilege-set-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Set privileges of a given user for a given database on a given instance. +Set the privileges of a user on a database. You must define `database_name`, `user_name` and `permission` in the request body. USAGE: scw rdb privilege set [arg=value ...] ARGS: - instance-id UUID of the instance + instance-id UUID of the Database Instance [database-name] Name of the database [user-name] Name of the user [permission] Permission to set (Read, Read/Write, All, Custom) (readonly | readwrite | all | custom | none) diff --git a/cmd/scw/testdata/test-all-usage-rdb-privilege-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-privilege-usage.golden index c0b83b8fd6..d2f8e34216 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-privilege-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-privilege-usage.golden @@ -1,13 +1,20 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Define some privileges to a user on a specific database. +Privileges are permissions that can be granted to database users. You can manage user permissions either via the console, the Scaleway APIs or SQL. Managed Database for PostgreSQL and MySQL provides a simplified and unified permission model through the API and the console to make things easier to manage and understand. + +Each user has associated permissions that give them access to zero or more logical databases. These include: + +* **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. USAGE: scw rdb privilege AVAILABLE COMMANDS: - list List privileges of a given user for a given database on a given instance - set Set privileges of a given user for a given database on a given instance + list List user privileges for a database + set Set user privileges for a database FLAGS: -h, --help help for privilege diff --git a/cmd/scw/testdata/test-all-usage-rdb-read-replica-create-endpoint-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-read-replica-create-endpoint-usage.golden index 7ed0df713a..3df878afe3 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-read-replica-create-endpoint-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-read-replica-create-endpoint-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -A read replica can have at most one direct access and one private network endpoint. +Create a new endpoint for a Read Replica. Read Replicas can have at most one direct access and one Private Network endpoint. USAGE: scw rdb read-replica create-endpoint [arg=value ...] ARGS: - read-replica-id UUID of the read replica - [endpoint-spec.{index}.private-network.private-network-id] UUID of the private network to be connected to the read replica - [endpoint-spec.{index}.private-network.service-ip] Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitations. + read-replica-id UUID of the Read Replica + [endpoint-spec.{index}.private-network.private-network-id] UUID of the Private Network to be connected to the Read Replica + [endpoint-spec.{index}.private-network.service-ip] Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-read-replica-create-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-read-replica-create-usage.golden index fa3abbc0c2..8cb9b42626 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-read-replica-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-read-replica-create-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -You can only create a maximum of 3 read replicas for one instance. +Create a new Read Replica of a Database Instance. You must specify the `region` and the `instance_id`. You can only create a maximum of 3 Read Replicas per Database Instance. USAGE: scw rdb read-replica create [arg=value ...] ARGS: - instance-id UUID of the instance you want a read replica of - [endpoint-spec.{index}.private-network.private-network-id] UUID of the private network to be connected to the read replica - [endpoint-spec.{index}.private-network.service-ip] Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitations. + instance-id UUID of the Database Instance you want to create a Read Replica from + [endpoint-spec.{index}.private-network.private-network-id] UUID of the Private Network to be connected to the Read Replica + [endpoint-spec.{index}.private-network.service-ip] Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-read-replica-delete-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-read-replica-delete-usage.golden index f772107ec8..efa9e16db9 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-read-replica-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-read-replica-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a read replica. +Delete a Read Replica of a Database Instance. You must specify the `region` and `read_replica_id` parameters of the Read Replica you want to delete. USAGE: scw rdb read-replica delete [arg=value ...] ARGS: - read-replica-id UUID of the read replica + read-replica-id UUID of the Read Replica [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-read-replica-get-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-read-replica-get-usage.golden index fe4feec352..256b86ce62 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-read-replica-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-read-replica-get-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a read replica. +Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response. USAGE: scw rdb read-replica get [arg=value ...] ARGS: - read-replica-id UUID of the read replica + read-replica-id UUID of the Read Replica [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-read-replica-reset-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-read-replica-reset-usage.golden index 34f5901d48..1ad0d6b893 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-read-replica-reset-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-read-replica-reset-usage.golden @@ -1,14 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -When you resync a read replica, first it is reset, and then its data is resynchronized from the primary node. -Your read replica will be unavailable during the resync process. The duration of this process is proportional to your Database Instance size. -The configured endpoints will not change. +When you resync a Read Replica, first it is reset, then its data is resynchronized from the primary node. Your Read Replica remains unavailable during the resync process. The duration of this process is proportional to the size of your Database Instance. +The configured endpoints do not change. USAGE: scw rdb read-replica reset [arg=value ...] ARGS: - read-replica-id UUID of the read replica + read-replica-id UUID of the Read Replica [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: 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 10d9c13d5f..692320e138 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,10 +1,16 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -A read replica is a live copy of the main database instance only available for reading. Read replica allows you to scale your database instance for read-heavy database workloads. Read replicas can also be used for Business Intelligence workloads. Listing of read replicas is available in the instance response object. -A read replica can have at most one direct access and one private network endpoint. Loadbalancer endpoint is not available on read replica even if this resource is displayed in the read replica response example. -If you want to remove a read replica endpoint, you can use the instance delete endpoint API call. -Instance Access Control List (ACL) also applies on read replica direct access endpoint. Don't forget to set it to improve the security of your read replica nodes. -Be aware that there can be replication lags between the primary node and its read replica nodes. You can try to reduce this lag with some good practices: +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. + +If you want to remove a Read Replica endpoint, you can use [delete a Database Instance endpoint](https://developers.scaleway.com/en/products/rdb/api/#delete-401f48) API call. + +Instance Access Control Lists (ACL) also apply to Read Replica direct access endpoints. + +**Limitations:** +There might be replication lags between the primary node and its Read Replica nodes. You can try to reduce this lag with some good practices: * All your tables should have a primary key * Don't run large transactions that modify, delete or insert lots of rows. Try to split it into several small transactions. @@ -12,11 +18,11 @@ USAGE: scw rdb read-replica AVAILABLE COMMANDS: - create Create a read replica - create-endpoint Create a new endpoint for a given read replica - delete Delete a read replica - get Get a read replica - reset Resync a read replica + create Create a Read Replica + create-endpoint Create an endpoint for a Read Replica + delete Delete a Read Replica + get Get a Read Replica + reset Resync a Read Replica FLAGS: -h, --help help for read-replica diff --git a/cmd/scw/testdata/test-all-usage-rdb-snapshot-create-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-snapshot-create-usage.golden index f1575ef90a..3fb09f2838 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-snapshot-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-snapshot-create-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create an instance snapshot. +Create a new snapshot of a Database Instance. You must define the `name` parameter in the request. USAGE: scw rdb snapshot create [arg=value ...] ARGS: - instance-id UUID of the instance + instance-id UUID of the Database Instance name= Name of the snapshot - [expires-at] Expiration date (Format ISO 8601) + [expires-at] Expiration date (must follow the ISO 8601 format) [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-snapshot-delete-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-snapshot-delete-usage.golden index 892161a950..036707a217 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-snapshot-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-snapshot-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete an instance snapshot. +Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `region` and `snapshot_id` parameters of the snapshot you want to delete. USAGE: scw rdb snapshot delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-rdb-snapshot-get-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-snapshot-get-usage.golden index f3deea1556..9827fb7351 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-snapshot-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-snapshot-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get an instance snapshot. +Retrieve information about a given snapshot, specified by its `snapshot_id` and `region`. Full details about the snapshot, like size and expiration date, are returned in the response. USAGE: scw rdb snapshot get [arg=value ...] 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 304e0f333b..5d11955859 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 instance 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. USAGE: scw rdb snapshot list [arg=value ...] @@ -8,7 +8,7 @@ USAGE: ARGS: [name] Name of the snapshot [order-by] Criteria to use when ordering snapshot listing (created_at_asc | created_at_desc | name_asc | name_desc | expires_at_asc | expires_at_desc) - [instance-id] UUID of the instance + [instance-id] UUID of the Database Instance [project-id] Project ID the snapshots belongs to [organization-id] Organization ID the snapshots belongs to [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) diff --git a/cmd/scw/testdata/test-all-usage-rdb-snapshot-restore-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-snapshot-restore-usage.golden index a1a95ab5c1..e92af393d5 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-snapshot-restore-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-snapshot-restore-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a new instance from a given snapshot. +Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory. USAGE: scw rdb snapshot restore [arg=value ...] ARGS: - snapshot-id Block snapshot of the instance - [instance-name] Name of the instance created with the snapshot - [is-ha-cluster] Whether or not High-Availability is enabled on the new instance + snapshot-id Block snapshot of the Database Instance + [instance-name] Name of the Database Instance created with the snapshot + [is-ha-cluster] Defines whether or not High-Availability is enabled on the new Database Instance [node-type] The node type used to restore the snapshot [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) diff --git a/cmd/scw/testdata/test-all-usage-rdb-snapshot-update-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-snapshot-update-usage.golden index 7532f69f96..52afa4c627 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-snapshot-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-snapshot-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update an instance snapshot. +Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters. USAGE: scw rdb snapshot update [arg=value ...] @@ -8,7 +8,7 @@ USAGE: ARGS: snapshot-id UUID of the snapshot to update [name] Name of the snapshot - [expires-at] Expiration date (Format ISO 8601) + [expires-at] Expiration date (must follow the ISO 8601 format) [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-snapshot-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-snapshot-usage.golden index fbefc7d308..220178c286 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-snapshot-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-snapshot-usage.golden @@ -1,17 +1,17 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create, restore and manage block snapshot +A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. They are designed to recover your data in case of failure or accidental alterations of the data by a user. They allow you to quickly create a new Instance from a previous state of your database, regardless of the size of the volume. Their limitation is that, unlike backups, snapshots can only be stored in the same location as the original data. USAGE: scw rdb snapshot AVAILABLE COMMANDS: - create Create an instance snapshot - delete Delete an instance snapshot - get Get an instance snapshot - list List instance snapshots - restore Create a new instance from a given snapshot - update Update an instance snapshot + create Create a Database Instance snapshot + delete Delete a Database Instance snapshot + get Get a Database Instance snapshot + list List snapshots + restore Create a new Database Instance from a snapshot + update Update a Database Instance snapshot FLAGS: -h, --help help for snapshot diff --git a/cmd/scw/testdata/test-all-usage-rdb-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-usage.golden index d4eb0b446b..8ff15acb1a 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Database RDB API. +Managed Database for PostgreSQL and MySQL API. USAGE: scw rdb diff --git a/cmd/scw/testdata/test-all-usage-rdb-user-create-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-user-create-usage.golden index 5684cf3965..68c598ce1b 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-user-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-user-create-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a user on a given instance. +Create a new user for a Database Instance. You must define the `name`, `password` and `is_admin` parameters. USAGE: scw rdb user create [arg=value ...] ARGS: - instance-id UUID of the instance you want to create a user in + instance-id UUID of the Database Instance in which you want to create a user [name] Name of the user you want to create [password] Password of the user you want to create - [is-admin] Whether the user you want to create will have administrative privileges + [is-admin] Defines whether the user will have administrative privileges [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-user-delete-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-user-delete-usage.golden index 881c30a8e4..425f24ea66 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-user-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-user-delete-usage.golden @@ -1,12 +1,12 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a user on a given instance. +Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete. USAGE: scw rdb user delete [arg=value ...] ARGS: - instance-id UUID of the instance to delete a user from + instance-id UUID of the Database Instance to delete the user from name Name of the user [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) diff --git a/cmd/scw/testdata/test-all-usage-rdb-user-list-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-user-list-usage.golden index 7caf646200..861f41df3f 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-user-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-user-list-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List users of a given instance. +List all users of a given Database Instance. By default, the users 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 user list [arg=value ...] ARGS: [name] Name of the user - [order-by] Criteria to use when ordering users listing (name_asc | name_desc | is_admin_asc | is_admin_desc) - instance-id UUID of the instance + [order-by] Criteria to use when requesting user listing (name_asc | name_desc | is_admin_asc | is_admin_desc) + instance-id UUID of the Database Instance [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-user-update-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-user-update-usage.golden index 41e7f0806a..dbac7d98b0 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-user-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-user-update-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a user on a given instance. +Update the parameters of a user on a Database Instance. You can update the `password` and `is_admin` parameters, but you cannot change the name of the user. USAGE: scw rdb user update [arg=value ...] ARGS: - instance-id UUID of the instance the user belongs to + instance-id UUID of the Database Instance the user belongs to name Name of the database user [password] Password of the database user - [is-admin] Whether or not this user got administrative privileges + [is-admin] Defines whether or not this user got administrative privileges [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-rdb-user-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-user-usage.golden index 3441df77ef..4722956314 100644 --- a/cmd/scw/testdata/test-all-usage-rdb-user-usage.golden +++ b/cmd/scw/testdata/test-all-usage-rdb-user-usage.golden @@ -1,15 +1,15 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Manage users on your instance +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. USAGE: scw rdb user AVAILABLE COMMANDS: - create Create a user on a given instance - delete Delete a user on a given instance - list List users of a given instance - update Update a user on a given instance + create Create a user for a Database Instance + delete Delete a user on a Database Instance + list List users of a Database Instance + update Update a user on a Database Instance FLAGS: -h, --help help for user diff --git a/cmd/scw/testdata/test-all-usage-webhosting-offer-list-usage.golden b/cmd/scw/testdata/test-all-usage-webhosting-offer-list-usage.golden index c95c3de927..655e3579f9 100644 --- a/cmd/scw/testdata/test-all-usage-webhosting-offer-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-webhosting-offer-list-usage.golden @@ -7,7 +7,7 @@ USAGE: EXAMPLES: List all offers available for purchase - scw webhosting offer list + scw webhosting offer list hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7 List only offers, no options scw webhosting offer list without-options=true diff --git a/cmd/scw/testdata/test-main-usage-usage.golden b/cmd/scw/testdata/test-main-usage-usage.golden index 06ba69ee9d..a08a37f783 100644 --- a/cmd/scw/testdata/test-main-usage-usage.golden +++ b/cmd/scw/testdata/test-main-usage-usage.golden @@ -27,7 +27,7 @@ AVAILABLE COMMANDS: marketplace Marketplace API mnq This API allows you to manage Messaging or Queueing brokers object Object-storage utils - rdb Database RDB API + rdb Managed Database for PostgreSQL and MySQL API redis Managed Database for Redisβ„’ API registry Container registry API secret This API allows you to conveniently store, access and share sensitive data diff --git a/docs/commands/rdb.md b/docs/commands/rdb.md index 56e4c04dbb..f605db0fa0 100644 --- a/docs/commands/rdb.md +++ b/docs/commands/rdb.md @@ -1,11 +1,11 @@ # Documentation for `scw rdb` -Database RDB API. +Managed Database for PostgreSQL and MySQL API. - [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands) - - [Add an ACL instance to a given instance](#add-an-acl-instance-to-a-given-instance) - - [Delete ACL rules of a given instance](#delete-acl-rules-of-a-given-instance) - - [List ACL rules of a given instance](#list-acl-rules-of-a-given-instance) + - [Add an ACL rule to a Database Instance](#add-an-acl-rule-to-a-database-instance) + - [Delete ACL rules of a Database Instance](#delete-acl-rules-of-a-database-instance) + - [List ACL rules of a Database Instance](#list-acl-rules-of-a-database-instance) - [Backup management commands](#backup-management-commands) - [Create a database backup](#create-a-database-backup) - [Delete a database backup](#delete-a-database-backup) @@ -17,65 +17,65 @@ Database RDB API. - [Update a database backup](#update-a-database-backup) - [Wait for a backup to reach a stable state](#wait-for-a-backup-to-reach-a-stable-state) - [Database management commands](#database-management-commands) - - [Create a database in a given instance](#create-a-database-in-a-given-instance) - - [Delete a database in a given instance](#delete-a-database-in-a-given-instance) - - [List all database in a given instance](#list-all-database-in-a-given-instance) + - [Create a database in a Database Instance](#create-a-database-in-a-database-instance) + - [Delete a database in a Database Instance](#delete-a-database-in-a-database-instance) + - [List databases in a Database Instance](#list-databases-in-a-database-instance) - [Database engines commands](#database-engines-commands) - [List available database engines](#list-available-database-engines) - [List available settings from an engine.](#list-available-settings-from-an-engine.) - [Instance management commands](#instance-management-commands) - - [Clone an instance](#clone-an-instance) + - [Clone a Database Instance](#clone-a-database-instance) - [Connect to an instance using locally installed CLI](#connect-to-an-instance-using-locally-installed-cli) - - [Create an instance](#create-an-instance) - - [Delete an instance](#delete-an-instance) - - [Get an instance](#get-an-instance) - - [Get the TLS certificate of an instance](#get-the-tls-certificate-of-an-instance) - - [List instances](#list-instances) - - [Renew the TLS certificate of an instance](#renew-the-tls-certificate-of-an-instance) - - [Restart an instance](#restart-an-instance) + - [Create a Database Instance](#create-a-database-instance) + - [Delete a Database Instance](#delete-a-database-instance) + - [Get a Database Instance](#get-a-database-instance) + - [Get the TLS certificate of a Database Instance](#get-the-tls-certificate-of-a-database-instance) + - [List Database Instances](#list-database-instances) + - [Renew the TLS certificate of a Database Instance](#renew-the-tls-certificate-of-a-database-instance) + - [Restart Database Instance](#restart-database-instance) - [Update an instance](#update-an-instance) - - [Upgrade an instance](#upgrade-an-instance) + - [Upgrade a Database Instance](#upgrade-a-database-instance) - [Wait for an instance to reach a stable state](#wait-for-an-instance-to-reach-a-stable-state) - [Instance logs management commands](#instance-logs-management-commands) - - [Get specific logs of a given instance](#get-specific-logs-of-a-given-instance) - - [List available logs of a given instance](#list-available-logs-of-a-given-instance) - - [List remote instances logs details](#list-remote-instances-logs-details) - - [Prepare logs of a given instance](#prepare-logs-of-a-given-instance) - - [Purge remote instances logs](#purge-remote-instances-logs) + - [Get given logs of a Database Instance](#get-given-logs-of-a-database-instance) + - [List available logs of a Database Instance](#list-available-logs-of-a-database-instance) + - [List remote Database Instance logs details](#list-remote-database-instance-logs-details) + - [Prepare logs of a Database Instance](#prepare-logs-of-a-database-instance) + - [Purge remote Database Instance logs](#purge-remote-database-instance-logs) - [Node types management commands](#node-types-management-commands) - [List available node types](#list-available-node-types) - [User privileges management commands](#user-privileges-management-commands) - - [List privileges of a given user for a given database on a given instance](#list-privileges-of-a-given-user-for-a-given-database-on-a-given-instance) - - [Set privileges of a given user for a given database on a given instance](#set-privileges-of-a-given-user-for-a-given-database-on-a-given-instance) + - [List user privileges for a database](#list-user-privileges-for-a-database) + - [Set user privileges for a database](#set-user-privileges-for-a-database) - [Read replica management](#read-replica-management) - - [Create a read replica](#create-a-read-replica) - - [Create a new endpoint for a given read replica](#create-a-new-endpoint-for-a-given-read-replica) - - [Delete a read replica](#delete-a-read-replica) - - [Get a read replica](#get-a-read-replica) - - [Resync a read replica](#resync-a-read-replica) + - [Create a Read Replica](#create-a-read-replica) + - [Create an endpoint for a Read Replica](#create-an-endpoint-for-a-read-replica) + - [Delete a Read Replica](#delete-a-read-replica) + - [Get a Read Replica](#get-a-read-replica) + - [Resync a Read Replica](#resync-a-read-replica) - [Block snapshot management](#block-snapshot-management) - - [Create an instance snapshot](#create-an-instance-snapshot) - - [Delete an instance snapshot](#delete-an-instance-snapshot) - - [Get an instance snapshot](#get-an-instance-snapshot) - - [List instance snapshots](#list-instance-snapshots) - - [Create a new instance from a given snapshot](#create-a-new-instance-from-a-given-snapshot) - - [Update an instance snapshot](#update-an-instance-snapshot) + - [Create a Database Instance snapshot](#create-a-database-instance-snapshot) + - [Delete a Database Instance snapshot](#delete-a-database-instance-snapshot) + - [Get a Database Instance snapshot](#get-a-database-instance-snapshot) + - [List snapshots](#list-snapshots) + - [Create a new Database Instance from a snapshot](#create-a-new-database-instance-from-a-snapshot) + - [Update a Database Instance snapshot](#update-a-database-instance-snapshot) - [User management commands](#user-management-commands) - - [Create a user on a given instance](#create-a-user-on-a-given-instance) - - [Delete a user on a given instance](#delete-a-user-on-a-given-instance) - - [List users of a given instance](#list-users-of-a-given-instance) - - [Update a user on a given instance](#update-a-user-on-a-given-instance) + - [Create a user for a Database Instance](#create-a-user-for-a-database-instance) + - [Delete a user on a Database Instance](#delete-a-user-on-a-database-instance) + - [List users of a Database Instance](#list-users-of-a-database-instance) + - [Update a user on a Database Instance](#update-a-user-on-a-database-instance) ## Access Control List (ACL) management commands -Network Access Control List allows to control network in and out traffic by setting up ACL rules. +Network Access Control Lists allow you to control incoming network traffic by setting up ACL rules. -### Add an ACL instance to a given instance +### Add an ACL rule to a Database Instance -Add an additional ACL rule to a database instance. +Add an additional ACL rule to a Database Instance. **Usage:** @@ -88,16 +88,16 @@ scw rdb acl add [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want to add acl rules to | +| instance-id | Required | UUID of the Database Instance you want to add ACL rules to | | rules.{index}.ip | | | | rules.{index}.description | | | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Delete ACL rules of a given instance +### Delete ACL rules of a Database Instance -Delete ACL rules of a given instance. +Delete one or more ACL rules of a Database Instance. **Usage:** @@ -110,15 +110,15 @@ scw rdb acl delete [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want to delete an ACL rules from | -| rules.{index}.ip | Required | ACL rules IP present on the instance | +| instance-id | Required | UUID of the Database Instance you want to delete an ACL rule from | +| rules.{index}.ip | Required | IP addresses defined in the ACL rules of the Database Instance | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### List ACL rules of a given instance +### List ACL rules of a Database Instance -List ACL rules of a given instance. +List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions. **Usage:** @@ -131,20 +131,20 @@ scw rdb acl list [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance | +| instance-id | Required | UUID of the Database Instance | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | ## Backup management commands -Save and restore backups of your database instance. +A database backup is a dated export of a Database Instance stored on an offsite backend located in a different region than your database, by default. Once a backup is created, it can be used to restore the database. Each logical database in a Database Instance is backed up and can be restored separately. ### Create a database backup -Create a database backup. +Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters. **Usage:** @@ -157,17 +157,17 @@ scw rdb backup create [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | | UUID of the instance | -| database-name | | Name of the database you want to make a backup of | +| instance-id | | UUID of the Database Instance | +| database-name | | Name of the database you want to back up | | name | Default: `` | Name of the backup | -| expires-at | | Expiration date (Format ISO 8601) | +| expires-at | | Expiration date (must follow the ISO 8601 format) | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | ### Delete a database backup -Delete a database backup. +Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone. **Usage:** @@ -218,7 +218,7 @@ scw rdb backup download 11111111-1111-1111-1111-111111111111 ### Export a database backup -Export a database backup. +Export a backup, specified by the `database_backup_id` and the `region` parameters. The download URL is returned in the response. **Usage:** @@ -238,7 +238,7 @@ scw rdb backup export [arg=value ...] ### Get a database backup -Get a database backup. +Retrieve information about a given backup, specified by its database backup ID and region. Full details about the backup, like size, URL and expiration date, are returned in the response. **Usage:** @@ -258,7 +258,7 @@ scw rdb backup get [arg=value ...] ### List database backups -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. **Usage:** @@ -273,16 +273,16 @@ scw rdb backup list [arg=value ...] |------|---|-------------| | name | | Name of the database backups | | order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `status_asc`, `status_desc` | Criteria to use when ordering database backups listing | -| instance-id | | UUID of the instance | -| project-id | | Project ID the database backups belongs to | -| organization-id | | Organization ID the database backups belongs to | +| instance-id | | UUID of the Database Instance | +| project-id | | Project ID of the Project the database backups belong to | +| organization-id | | Organization ID of the Organization the database backups belong to | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | ### Restore a database backup -Restore a database backup. +Launch the process of restoring database backup. You must specify the `instance_id` of the Database Instance of destination, where the backup will be restored. Note that large database backups can take up to several hours to restore. **Usage:** @@ -295,16 +295,16 @@ scw rdb backup restore [arg=value ...] | Name | | Description | |------|---|-------------| -| database-name | | Defines the destination database in order to restore into a specified database, the default destination is set to the origin database of the backup | +| database-name | | Defines the destination database to restore into a specified database (the default destination is set to the origin database of the backup) | | database-backup-id | Required | Backup of a logical database | -| instance-id | Required | Defines the rdb instance where the backup has to be restored | +| instance-id | Required | Defines the Database Instance where the backup has to be restored | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | ### Update a database backup -Update a database backup. +Update the parameters of a backup, including name and expiration date. **Usage:** @@ -319,7 +319,7 @@ scw rdb backup update [arg=value ...] |------|---|-------------| | database-backup-id | Required | UUID of the database backup to update | | name | | Name of the Database Backup | -| expires-at | | Expiration date (Format ISO 8601) | +| expires-at | | Expiration date (must follow the ISO 8601 format) | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | @@ -356,13 +356,13 @@ scw rdb backup wait 11111111-1111-1111-1111-111111111111 ## Database management commands -Manage logical databases on your instance +Databases can be used to store and manage sets of structured information, or data. The interaction between the user and a database is done using a Database Engine, which provides a structured query language to add, modify or delete information from the database. -### Create a database in a given instance +### Create a database in a Database Instance -Create a database in a given instance. +Create a new database. You must define the `name` parameter in the request. **Usage:** @@ -375,15 +375,15 @@ scw rdb database create [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance where to create the database | +| instance-id | Required | UUID of the Database Instance where to create the database | | name | | Name of the database | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Delete a database in a given instance +### Delete a database in a Database Instance -Delete a database in a given instance. +Delete a given database on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the database you want to delete. **Usage:** @@ -396,15 +396,15 @@ scw rdb database delete [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance where to delete the database | +| instance-id | Required | UUID of the Database Instance where to delete the database | | name | Required | Name of the database to delete | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### List all database in a given instance +### List databases in a Database Instance -List all database in a given instance. +List all databases of a given Database Instance. 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. You can define additional parameters for your query, such as `name`, `managed` and `owner`. **Usage:** @@ -418,23 +418,23 @@ scw rdb database list [arg=value ...] | Name | | Description | |------|---|-------------| | name | | Name of the database | -| managed | | Whether or not the database is managed | +| managed | | Defines whether or not the database is managed | | owner | | User that owns this database | | order-by | One of: `name_asc`, `name_desc`, `size_asc`, `size_desc` | Criteria to use when ordering database listing | -| instance-id | Required | UUID of the instance to list database of | +| instance-id | Required | UUID of the Database Instance to list the databases of | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | ## Database engines commands -Software that stores and retrieves data from a database. Each database engine has a name and versions. +A database engine is the software component that stores and retrieves your data from a database. Currently PostgreSQL 11, 12, 13 and 14 are available. MySQL is available in version 8. ### List available database engines -List available database engines. +List the PostgreSQL and MySQL database engines available at Scaleway. **Usage:** @@ -447,8 +447,8 @@ scw rdb engine list [arg=value ...] | Name | | Description | |------|---|-------------| -| name | | Name of the Database Engine | -| version | | Version of the Database Engine | +| name | | Name of the database engine | +| version | | Version of the database engine | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | @@ -486,13 +486,17 @@ scw rdb engine settings name=MySQL version=8 ## Instance management commands -A Database Instance is composed of one or more Nodes, depending of the is_ha_cluster setting. Autohealing is enabled by default for HA clusters. Database automated backup is enabled by default in order to prevent data loss. +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) + +Read Replicas can be used for certain read-only workflows such as Business Intelligence, or for a read-only scaling of your application. Read Replicas use asynchronous replication to replicate data from the main node. -### Clone an instance +### Clone a Database Instance -Clone an instance. +Clone a given Database Instance, specified by the `region` and `instance_id` parameters. The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users and permissions. You can create a clone on a Database Instance bigger than your current one. **Usage:** @@ -505,8 +509,8 @@ scw rdb instance clone [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want to clone | -| name | | Name of the clone instance | +| instance-id | Required | UUID of the Database Instance you want to clone | +| name | | Name of the Database Instance clone | | node-type | | Node type of the clone | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | @@ -535,9 +539,9 @@ scw rdb instance connect [arg=value ...] -### Create an instance +### Create a Database Instance -Create an instance. +Create a new Database Instance. You must set the `engine`, `user_name`, `password` and `node_type` parameters. Optionally, you can specify the volume type and size. **Usage:** @@ -551,29 +555,29 @@ scw rdb instance 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 instance | -| engine | Required | Database engine of the database (PostgreSQL, MySQL, ...) | -| user-name | Required | Name of the user created when the instance is created | +| name | Default: `` | Name of the Database Instance | +| engine | Required | Database engine of the Database Instance (PostgreSQL, MySQL, ...) | +| user-name | Required | Username created when the Database Instance is created | | password | Required | Password of the user | -| node-type | Required
Default: `DB-DEV-S` | Type of node to use for the instance | -| is-ha-cluster | | Whether or not High-Availability is enabled | -| disable-backup | | Whether or not backups are disabled | -| tags.{index} | | Tags to apply to the instance | +| node-type | Required
Default: `DB-DEV-S` | Type of node to use for the Database Instance | +| is-ha-cluster | | Defines whether or not High-Availability is enabled | +| disable-backup | | Defines whether or not backups are disabled | +| tags.{index} | | Tags to apply to the Database Instance | | init-settings.{index}.name | | | | init-settings.{index}.value | | | -| volume-type | One of: `lssd`, `bssd` | Type of volume where data are stored (lssd, bssd, ...) | +| volume-type | One of: `lssd`, `bssd` | Type of volume where data is stored (lssd, bssd, ...) | | volume-size | | Volume size when volume_type is not lssd | -| init-endpoints.{index}.private-network.private-network-id | | UUID of the private network to be connected to the database instance | -| init-endpoints.{index}.private-network.service-ip | | Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitation. | -| backup-same-region | | Store logical backups in the same region as the database instance | +| init-endpoints.{index}.private-network.private-network-id | | UUID of the Private Network to be connected to the Database Instance | +| init-endpoints.{index}.private-network.service-ip | | Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. | +| backup-same-region | | Defines whether to or not to store logical backups in the same region as the Database Instance | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Delete an instance +### Delete a Database Instance -Delete an instance. +Delete a given Database Instance, specified by the `region` and `instance_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. **Usage:** @@ -586,14 +590,14 @@ scw rdb instance delete [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance to delete | +| instance-id | Required | UUID of the Database Instance to delete | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Get an instance +### Get a Database Instance -Get an instance. +Retrieve information about a given Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object. **Usage:** @@ -606,14 +610,14 @@ scw rdb instance get [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance | +| instance-id | Required | UUID of the Database Instance | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Get the TLS certificate of an instance +### Get the TLS certificate of a Database Instance -Get the TLS certificate of an instance. +Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response. **Usage:** @@ -626,14 +630,14 @@ scw rdb instance get-certificate [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance | +| instance-id | Required | UUID of the Database Instance | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### List instances +### List Database Instances -List 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. **Usage:** @@ -646,18 +650,18 @@ scw rdb instance list [arg=value ...] | Name | | Description | |------|---|-------------| -| tags.{index} | | List instance that have a given tags | -| name | | List instance that match a given name pattern | -| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc`, `status_desc` | Criteria to use when ordering instance listing | -| project-id | | Project ID to list the instance of | -| organization-id | | Please use `project_id` instead | +| tags.{index} | | List Database Instances that have a given tag | +| name | | Lists Database Instances that match a name pattern | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc`, `status_desc` | Criteria to use when ordering Database Instance listings | +| project-id | | Project ID to list the Database Instance of | +| organization-id | | Please use project_id instead | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | -### Renew the TLS certificate of an instance +### Renew the TLS certificate of a Database Instance -Renew the TLS certificate of an instance. +Renew a TLS for a Database Instance. 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:** @@ -670,14 +674,14 @@ scw rdb instance renew-certificate [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want logs of | +| instance-id | Required | UUID of the Database Instance you want logs of | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Restart an instance +### Restart Database Instance -Restart an instance. +Restart a given Database Instance, specified by the `region` and `instance_id` parameters. The status of the Database Instance returned in the response. **Usage:** @@ -690,7 +694,7 @@ scw rdb instance restart [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want to restart | +| instance-id | Required | UUID of the Database Instance you want to restart | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | @@ -745,9 +749,9 @@ scw rdb instance update 11111111-1111-1111-1111-111111111111 settings.0.name=tim -### Upgrade an instance +### Upgrade a Database Instance -Upgrade your current instance specifications like node type, high availability, volume, or db engine version. +Upgrade your current Database Instance specifications like node type, high availability, volume, or the database engine version. Note that upon upgrade the `enable_ha` parameter can only be set to `true`. **Usage:** @@ -760,12 +764,12 @@ scw rdb instance upgrade [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want to upgrade | -| node-type | | Node type of the instance you want to upgrade to | -| enable-ha | | Set to true to enable high availability on your instance | +| instance-id | Required | UUID of the Database Instance you want to upgrade | +| node-type | | Node type of the Database Instance you want to upgrade to | +| enable-ha | | Defines whether or not high availability should be enabled on the Database Instance | | volume-size | | Increase your block storage volume size | -| volume-type | One of: `lssd`, `bssd` | Change your instance storage type | -| upgradable-version-id | | Update your instance database engine to a newer version | +| volume-type | One of: `lssd`, `bssd` | Change your Database Instance storage type | +| upgradable-version-id | | Update your database engine to a newer version | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | @@ -805,9 +809,9 @@ scw rdb instance wait 11111111-1111-1111-1111-111111111111 Instance logs management commands. -### Get specific logs of a given instance +### Get given logs of a Database Instance -Get specific logs of a given instance. +Retrieve information about the logs of a Database Instance. Specify the `instance_log_id` and `region` in your request to get information such as `download_url`, `status`, `expires_at` and `created_at` about your logs in the response. **Usage:** @@ -825,9 +829,9 @@ scw rdb log get [arg=value ...] -### List available logs of a given instance +### List available logs of a Database Instance -List available logs of a given instance. +List the available logs of a Database Instance. By default, the logs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. **Usage:** @@ -840,15 +844,15 @@ scw rdb log list [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want logs of | -| order-by | One of: `created_at_asc`, `created_at_desc` | Criteria to use when ordering instance logs listing | +| instance-id | Required | UUID of the Database Instance you want logs of | +| order-by | One of: `created_at_asc`, `created_at_desc` | Criteria to use when ordering Database Instance logs listing | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### List remote instances logs details +### List remote Database Instance logs details -List remote instances logs details. +List remote log details. 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:** @@ -861,14 +865,14 @@ scw rdb log list-details [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want logs of | +| instance-id | Required | UUID of the Database Instance you want logs of | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Prepare logs of a given instance +### Prepare logs of a Database Instance -Prepare your instance logs. Logs will be grouped on a minimum interval of a day. +Prepare your Database Instance logs. You can define the `start_date` and `end_date` parameters for your query. The download URL is returned in the response. Logs are recorded from 00h00 to 23h59 and then aggregated in a `.log` file once a day. Therefore, even if you specify a timeframe from which you want to get the logs, you will receive logs from the full 24 hours. **Usage:** @@ -881,16 +885,16 @@ scw rdb log prepare [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want logs of | -| start-date | | Start datetime of your log. Format: `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z` | -| end-date | | End datetime of your log. Format: `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z` | +| instance-id | Required | UUID of the Database Instance you want logs of | +| start-date | | Start datetime of your log. (RFC 3339 format) | +| end-date | | End datetime of your log. (RFC 3339 format) | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Purge remote instances logs +### Purge remote Database Instance logs -Purge remote instances logs. +Purge a given remote log from a Database Instance. You can specify the `log_name` of the log you wish to clean from your Database Instance. **Usage:** @@ -903,21 +907,24 @@ scw rdb log purge [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want logs of | -| log-name | | Specific log name to purge | +| instance-id | Required | UUID of the Database Instance you want logs of | +| log-name | | Given log name to purge | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | ## Node types management commands -Node types powering your instance +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. ### List available node types -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. **Usage:** @@ -930,20 +937,27 @@ scw rdb node-type list [arg=value ...] | Name | | Description | |------|---|-------------| -| include-disabled-types | | Whether or not to include disabled types | +| include-disabled-types | | Defines whether or not to include disabled types | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | ## User privileges management commands -Define some privileges to a user on a specific database. +Privileges are permissions that can be granted to database users. You can manage user permissions either via the console, the Scaleway APIs or SQL. Managed Database for PostgreSQL and MySQL provides a simplified and unified permission model through the API and the console to make things easier to manage and understand. + +Each user has associated permissions that give them access to zero or more logical databases. These include: + +* **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. -### List privileges of a given user for a given database on a given instance +### List user privileges for a database -List privileges of a given user for a given database on a given instance. +List privileges of a user on a database. 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. You can define additional parameters for your query, such as `database_name` and `user_name`. **Usage:** @@ -958,15 +972,15 @@ scw rdb privilege list [arg=value ...] |------|---|-------------| | order-by | One of: `user_name_asc`, `user_name_desc`, `database_name_asc`, `database_name_desc` | Criteria to use when ordering privileges listing | | database-name | | Name of the database | -| instance-id | Required | UUID of the instance | +| instance-id | Required | UUID of the Database Instance | | user-name | | Name of the user | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | -### Set privileges of a given user for a given database on a given instance +### Set user privileges for a database -Set privileges of a given user for a given database on a given instance. +Set the privileges of a user on a database. You must define `database_name`, `user_name` and `permission` in the request body. **Usage:** @@ -979,7 +993,7 @@ scw rdb privilege set [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance | +| instance-id | Required | UUID of the Database Instance | | database-name | | Name of the database | | user-name | | Name of the user | | permission | One of: `readonly`, `readwrite`, `all`, `custom`, `none` | Permission to set (Read, Read/Write, All, Custom) | @@ -989,19 +1003,25 @@ scw rdb privilege set [arg=value ...] ## Read replica management -A read replica is a live copy of the main database instance only available for reading. Read replica allows you to scale your database instance for read-heavy database workloads. Read replicas can also be used for Business Intelligence workloads. Listing of read replicas is available in the instance response object. -A read replica can have at most one direct access and one private network endpoint. Loadbalancer endpoint is not available on read replica even if this resource is displayed in the read replica response example. -If you want to remove a read replica endpoint, you can use the instance delete endpoint API call. -Instance Access Control List (ACL) also applies on read replica direct access endpoint. Don't forget to set it to improve the security of your read replica nodes. -Be aware that there can be replication lags between the primary node and its read replica nodes. You can try to reduce this lag with some good practices: +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. + +If you want to remove a Read Replica endpoint, you can use [delete a Database Instance endpoint](https://developers.scaleway.com/en/products/rdb/api/#delete-401f48) API call. + +Instance Access Control Lists (ACL) also apply to Read Replica direct access endpoints. + +**Limitations:** +There might be replication lags between the primary node and its Read Replica nodes. You can try to reduce this lag with some good practices: * All your tables should have a primary key * Don't run large transactions that modify, delete or insert lots of rows. Try to split it into several small transactions. -### Create a read replica +### Create a Read Replica -You can only create a maximum of 3 read replicas for one instance. +Create a new Read Replica of a Database Instance. You must specify the `region` and the `instance_id`. You can only create a maximum of 3 Read Replicas per Database Instance. **Usage:** @@ -1014,16 +1034,16 @@ scw rdb read-replica create [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want a read replica of | -| endpoint-spec.{index}.private-network.private-network-id | | UUID of the private network to be connected to the read replica | -| endpoint-spec.{index}.private-network.service-ip | | Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitations. | +| instance-id | Required | UUID of the Database Instance you want to create a Read Replica from | +| endpoint-spec.{index}.private-network.private-network-id | | UUID of the Private Network to be connected to the Read Replica | +| endpoint-spec.{index}.private-network.service-ip | | Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Create a new endpoint for a given read replica +### Create an endpoint for a Read Replica -A read replica can have at most one direct access and one private network endpoint. +Create a new endpoint for a Read Replica. Read Replicas can have at most one direct access and one Private Network endpoint. **Usage:** @@ -1036,16 +1056,16 @@ scw rdb read-replica create-endpoint [arg=value ...] | Name | | Description | |------|---|-------------| -| read-replica-id | Required | UUID of the read replica | -| endpoint-spec.{index}.private-network.private-network-id | | UUID of the private network to be connected to the read replica | -| endpoint-spec.{index}.private-network.service-ip | | Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitations. | +| read-replica-id | Required | UUID of the Read Replica | +| endpoint-spec.{index}.private-network.private-network-id | | UUID of the Private Network to be connected to the Read Replica | +| endpoint-spec.{index}.private-network.service-ip | | Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Delete a read replica +### Delete a Read Replica -Delete a read replica. +Delete a Read Replica of a Database Instance. You must specify the `region` and `read_replica_id` parameters of the Read Replica you want to delete. **Usage:** @@ -1058,14 +1078,14 @@ scw rdb read-replica delete [arg=value ...] | Name | | Description | |------|---|-------------| -| read-replica-id | Required | UUID of the read replica | +| read-replica-id | Required | UUID of the Read Replica | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Get a read replica +### Get a Read Replica -Get a read replica. +Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response. **Usage:** @@ -1078,16 +1098,15 @@ scw rdb read-replica get [arg=value ...] | Name | | Description | |------|---|-------------| -| read-replica-id | Required | UUID of the read replica | +| read-replica-id | Required | UUID of the Read Replica | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Resync a read replica +### Resync a Read Replica -When you resync a read replica, first it is reset, and then its data is resynchronized from the primary node. -Your read replica will be unavailable during the resync process. The duration of this process is proportional to your Database Instance size. -The configured endpoints will not change. +When you resync a Read Replica, first it is reset, then its data is resynchronized from the primary node. Your Read Replica remains unavailable during the resync process. The duration of this process is proportional to the size of your Database Instance. +The configured endpoints do not change. **Usage:** @@ -1100,20 +1119,20 @@ scw rdb read-replica reset [arg=value ...] | Name | | Description | |------|---|-------------| -| read-replica-id | Required | UUID of the read replica | +| read-replica-id | Required | UUID of the Read Replica | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | ## Block snapshot management -Create, restore and manage block snapshot +A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. They are designed to recover your data in case of failure or accidental alterations of the data by a user. They allow you to quickly create a new Instance from a previous state of your database, regardless of the size of the volume. Their limitation is that, unlike backups, snapshots can only be stored in the same location as the original data. -### Create an instance snapshot +### Create a Database Instance snapshot -Create an instance snapshot. +Create a new snapshot of a Database Instance. You must define the `name` parameter in the request. **Usage:** @@ -1126,16 +1145,16 @@ scw rdb snapshot create [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance | +| instance-id | Required | UUID of the Database Instance | | name | Required
Default: `` | Name of the snapshot | -| expires-at | | Expiration date (Format ISO 8601) | +| expires-at | | Expiration date (must follow the ISO 8601 format) | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Delete an instance snapshot +### Delete a Database Instance snapshot -Delete an instance snapshot. +Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `region` and `snapshot_id` parameters of the snapshot you want to delete. **Usage:** @@ -1153,9 +1172,9 @@ scw rdb snapshot delete [arg=value ...] -### Get an instance snapshot +### Get a Database Instance snapshot -Get an instance snapshot. +Retrieve information about a given snapshot, specified by its `snapshot_id` and `region`. Full details about the snapshot, like size and expiration date, are returned in the response. **Usage:** @@ -1173,9 +1192,9 @@ scw rdb snapshot get [arg=value ...] -### List instance snapshots +### List snapshots -List instance 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. **Usage:** @@ -1190,16 +1209,16 @@ scw rdb snapshot list [arg=value ...] |------|---|-------------| | name | | Name of the snapshot | | order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `expires_at_asc`, `expires_at_desc` | Criteria to use when ordering snapshot listing | -| instance-id | | UUID of the instance | +| instance-id | | UUID of the Database Instance | | project-id | | Project ID the snapshots belongs to | | organization-id | | Organization ID the snapshots belongs to | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | -### Create a new instance from a given snapshot +### Create a new Database Instance from a snapshot -Create a new instance from a given snapshot. +Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory. **Usage:** @@ -1212,17 +1231,17 @@ scw rdb snapshot restore [arg=value ...] | Name | | Description | |------|---|-------------| -| snapshot-id | Required | Block snapshot of the instance | -| instance-name | | Name of the instance created with the snapshot | -| is-ha-cluster | | Whether or not High-Availability is enabled on the new instance | +| snapshot-id | Required | Block snapshot of the Database Instance | +| instance-name | | Name of the Database Instance created with the snapshot | +| is-ha-cluster | | Defines whether or not High-Availability is enabled on the new Database Instance | | node-type | | The node type used to restore the snapshot | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Update an instance snapshot +### Update a Database Instance snapshot -Update an instance snapshot. +Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters. **Usage:** @@ -1237,20 +1256,20 @@ scw rdb snapshot update [arg=value ...] |------|---|-------------| | snapshot-id | Required | UUID of the snapshot to update | | name | | Name of the snapshot | -| expires-at | | Expiration date (Format ISO 8601) | +| expires-at | | Expiration date (must follow the ISO 8601 format) | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | ## User management commands -Manage users on your instance +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. -### Create a user on a given instance +### Create a user for a Database Instance -Create a user on a given instance. +Create a new user for a Database Instance. You must define the `name`, `password` and `is_admin` parameters. **Usage:** @@ -1263,17 +1282,17 @@ scw rdb user create [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance you want to create a user in | +| instance-id | Required | UUID of the Database Instance in which you want to create a user | | name | | Name of the user you want to create | | password | | Password of the user you want to create | -| is-admin | | Whether the user you want to create will have administrative privileges | +| is-admin | | Defines whether the user will have administrative privileges | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### Delete a user on a given instance +### Delete a user on a Database Instance -Delete a user on a given instance. +Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete. **Usage:** @@ -1286,15 +1305,15 @@ scw rdb user delete [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance to delete a user from | +| instance-id | Required | UUID of the Database Instance to delete the user from | | name | Required | Name of the user | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | -### List users of a given instance +### List users of a Database Instance -List users of a given instance. +List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. **Usage:** @@ -1308,15 +1327,15 @@ scw rdb user list [arg=value ...] | Name | | Description | |------|---|-------------| | name | | Name of the user | -| order-by | One of: `name_asc`, `name_desc`, `is_admin_asc`, `is_admin_desc` | Criteria to use when ordering users listing | -| instance-id | Required | UUID of the instance | +| order-by | One of: `name_asc`, `name_desc`, `is_admin_asc`, `is_admin_desc` | Criteria to use when requesting user listing | +| instance-id | Required | UUID of the Database Instance | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config | -### Update a user on a given instance +### Update a user on a Database Instance -Update a user on a given instance. +Update the parameters of a user on a Database Instance. You can update the `password` and `is_admin` parameters, but you cannot change the name of the user. **Usage:** @@ -1329,10 +1348,10 @@ scw rdb user update [arg=value ...] | Name | | Description | |------|---|-------------| -| instance-id | Required | UUID of the instance the user belongs to | +| instance-id | Required | UUID of the Database Instance the user belongs to | | name | Required | Name of the database user | | password | | Password of the database user | -| is-admin | | Whether or not this user got administrative privileges | +| is-admin | | Defines whether or not this user got administrative privileges | | region | Default: `fr-par`
One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config | diff --git a/docs/commands/webhosting.md b/docs/commands/webhosting.md index 5de4e80703..8eed32ce9f 100644 --- a/docs/commands/webhosting.md +++ b/docs/commands/webhosting.md @@ -222,7 +222,7 @@ scw webhosting offer list [arg=value ...] List all offers available for purchase ``` -scw webhosting offer list +scw webhosting offer list hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7 ``` List only offers, no options diff --git a/go.mod b/go.mod index ccc26396c7..c20b317eec 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 + github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230308172750-e6fa6ad07480 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 e38bd63442..c9646c10f6 100644 --- a/go.sum +++ b/go.sum @@ -74,8 +74,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 h1:yFl3jyaSVLNYXlnNYM5z2pagEk1dYQhfr1p20T1NyKY= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230308172750-e6fa6ad07480 h1:NG+457cV++Hm3nB29tX+8a6doqx5VIksxGBnfYQGlIQ= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230308172750-e6fa6ad07480/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/rdb/v1/rdb_cli.go b/internal/namespaces/rdb/v1/rdb_cli.go index ca35dbb032..2a7c04e9cc 100644 --- a/internal/namespaces/rdb/v1/rdb_cli.go +++ b/internal/namespaces/rdb/v1/rdb_cli.go @@ -82,8 +82,8 @@ func GetGeneratedCommands() *core.Commands { } func rdbRoot() *core.Command { return &core.Command{ - Short: `Database RDB API`, - Long: `Database RDB API.`, + Short: `Managed Database for PostgreSQL and MySQL API`, + Long: `Managed Database for PostgreSQL and MySQL API.`, Namespace: "rdb", } } @@ -91,7 +91,7 @@ func rdbRoot() *core.Command { func rdbBackup() *core.Command { return &core.Command{ Short: `Backup management commands`, - Long: `Save and restore backups of your database instance. + Long: `A database backup is a dated export of a Database Instance stored on an offsite backend located in a different region than your database, by default. Once a backup is created, it can be used to restore the database. Each logical database in a Database Instance is backed up and can be restored separately. `, Namespace: "rdb", Resource: "backup", @@ -101,7 +101,7 @@ func rdbBackup() *core.Command { func rdbEngine() *core.Command { return &core.Command{ Short: `Database engines commands`, - Long: `Software that stores and retrieves data from a database. Each database engine has a name and versions. + Long: `A database engine is the software component that stores and retrieves your data from a database. Currently PostgreSQL 11, 12, 13 and 14 are available. MySQL is available in version 8. `, Namespace: "rdb", Resource: "engine", @@ -111,7 +111,11 @@ func rdbEngine() *core.Command { func rdbInstance() *core.Command { return &core.Command{ Short: `Instance management commands`, - Long: `A Database Instance is composed of one or more Nodes, depending of the is_ha_cluster setting. Autohealing is enabled by default for HA clusters. Database automated backup is enabled by default in order to prevent data loss. + Long: `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) + +Read Replicas can be used for certain read-only workflows such as Business Intelligence, or for a read-only scaling of your application. Read Replicas use asynchronous replication to replicate data from the main node. `, Namespace: "rdb", Resource: "instance", @@ -121,7 +125,7 @@ func rdbInstance() *core.Command { func rdbACL() *core.Command { return &core.Command{ Short: `Access Control List (ACL) management commands`, - Long: `Network Access Control List allows to control network in and out traffic by setting up ACL rules. + Long: `Network Access Control Lists allow you to control incoming network traffic by setting up ACL rules. `, Namespace: "rdb", Resource: "acl", @@ -131,7 +135,14 @@ func rdbACL() *core.Command { func rdbPrivilege() *core.Command { return &core.Command{ Short: `User privileges management commands`, - Long: `Define some privileges to a user on a specific database. + Long: `Privileges are permissions that can be granted to database users. You can manage user permissions either via the console, the Scaleway APIs or SQL. Managed Database for PostgreSQL and MySQL provides a simplified and unified permission model through the API and the console to make things easier to manage and understand. + +Each user has associated permissions that give them access to zero or more logical databases. These include: + +* **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. `, Namespace: "rdb", Resource: "privilege", @@ -141,7 +152,7 @@ func rdbPrivilege() *core.Command { func rdbUser() *core.Command { return &core.Command{ Short: `User management commands`, - Long: `Manage users on your instance + Long: `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. `, Namespace: "rdb", Resource: "user", @@ -151,7 +162,7 @@ func rdbUser() *core.Command { func rdbDatabase() *core.Command { return &core.Command{ Short: `Database management commands`, - Long: `Manage logical databases on your instance + Long: `Databases can be used to store and manage sets of structured information, or data. The interaction between the user and a database is done using a Database Engine, which provides a structured query language to add, modify or delete information from the database. `, Namespace: "rdb", Resource: "database", @@ -161,7 +172,10 @@ func rdbDatabase() *core.Command { func rdbNodeType() *core.Command { return &core.Command{ Short: `Node types management commands`, - Long: `Node types powering your instance + Long: `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. `, Namespace: "rdb", Resource: "node-type", @@ -180,7 +194,7 @@ func rdbLog() *core.Command { func rdbSnapshot() *core.Command { return &core.Command{ Short: `Block snapshot management`, - Long: `Create, restore and manage block snapshot + Long: `A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. They are designed to recover your data in case of failure or accidental alterations of the data by a user. They allow you to quickly create a new Instance from a previous state of your database, regardless of the size of the volume. Their limitation is that, unlike backups, snapshots can only be stored in the same location as the original data. `, Namespace: "rdb", Resource: "snapshot", @@ -190,11 +204,17 @@ func rdbSnapshot() *core.Command { func rdbReadReplica() *core.Command { return &core.Command{ Short: `Read replica management`, - Long: `A read replica is a live copy of the main database instance only available for reading. Read replica allows you to scale your database instance for read-heavy database workloads. Read replicas can also be used for Business Intelligence workloads. Listing of read replicas is available in the instance response object. -A read replica can have at most one direct access and one private network endpoint. Loadbalancer endpoint is not available on read replica even if this resource is displayed in the read replica response example. -If you want to remove a read replica endpoint, you can use the instance delete endpoint API call. -Instance Access Control List (ACL) also applies on read replica direct access endpoint. Don't forget to set it to improve the security of your read replica nodes. -Be aware that there can be replication lags between the primary node and its read replica nodes. You can try to reduce this lag with some good practices: + Long: `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. + +If you want to remove a Read Replica endpoint, you can use [delete a Database Instance endpoint](https://developers.scaleway.com/en/products/rdb/api/#delete-401f48) API call. + +Instance Access Control Lists (ACL) also apply to Read Replica direct access endpoints. + +**Limitations:** +There might be replication lags between the primary node and its Read Replica nodes. You can try to reduce this lag with some good practices: * All your tables should have a primary key * Don't run large transactions that modify, delete or insert lots of rows. Try to split it into several small transactions. `, @@ -206,7 +226,7 @@ Be aware that there can be replication lags between the primary node and its rea func rdbEngineList() *core.Command { return &core.Command{ Short: `List available database engines`, - Long: `List available database engines.`, + Long: `List the PostgreSQL and MySQL database engines available at Scaleway.`, Namespace: "rdb", Resource: "engine", Verb: "list", @@ -215,14 +235,14 @@ func rdbEngineList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "name", - Short: `Name of the Database Engine`, + Short: `Name of the database engine`, Required: false, Deprecated: false, Positional: false, }, { Name: "version", - Short: `Version of the Database Engine`, + Short: `Version of the database engine`, Required: false, Deprecated: false, Positional: false, @@ -252,7 +272,7 @@ func rdbEngineList() *core.Command { func rdbNodeTypeList() *core.Command { return &core.Command{ Short: `List available node types`, - Long: `List available node types.`, + Long: `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.`, Namespace: "rdb", Resource: "node-type", Verb: "list", @@ -261,7 +281,7 @@ func rdbNodeTypeList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "include-disabled-types", - Short: `Whether or not to include disabled types`, + Short: `Defines whether or not to include disabled types`, Required: false, Deprecated: false, Positional: false, @@ -291,7 +311,7 @@ func rdbNodeTypeList() *core.Command { func rdbBackupList() *core.Command { return &core.Command{ Short: `List database backups`, - Long: `List database backups.`, + Long: `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.`, Namespace: "rdb", Resource: "backup", Verb: "list", @@ -315,21 +335,21 @@ func rdbBackupList() *core.Command { }, { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: false, Deprecated: false, Positional: false, }, { Name: "project-id", - Short: `Project ID the database backups belongs to`, + Short: `Project ID of the Project the database backups belong to`, Required: false, Deprecated: false, Positional: false, }, { Name: "organization-id", - Short: `Organization ID the database backups belongs to`, + Short: `Organization ID of the Organization the database backups belong to`, Required: false, Deprecated: false, Positional: false, @@ -359,7 +379,7 @@ func rdbBackupList() *core.Command { func rdbBackupCreate() *core.Command { return &core.Command{ Short: `Create a database backup`, - Long: `Create a database backup.`, + Long: `Create a new backup. You must set the ` + "`" + `instance_id` + "`" + `, ` + "`" + `database_name` + "`" + `, ` + "`" + `name` + "`" + ` and ` + "`" + `expires_at` + "`" + ` parameters.`, Namespace: "rdb", Resource: "backup", Verb: "create", @@ -368,14 +388,14 @@ func rdbBackupCreate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: false, Deprecated: false, Positional: false, }, { Name: "database-name", - Short: `Name of the database you want to make a backup of`, + Short: `Name of the database you want to back up`, Required: false, Deprecated: false, Positional: false, @@ -390,7 +410,7 @@ func rdbBackupCreate() *core.Command { }, { Name: "expires-at", - Short: `Expiration date (Format ISO 8601)`, + Short: `Expiration date (must follow the ISO 8601 format)`, Required: false, Deprecated: false, Positional: false, @@ -411,7 +431,7 @@ func rdbBackupCreate() *core.Command { func rdbBackupGet() *core.Command { return &core.Command{ Short: `Get a database backup`, - Long: `Get a database backup.`, + Long: `Retrieve information about a given backup, specified by its database backup ID and region. Full details about the backup, like size, URL and expiration date, are returned in the response.`, Namespace: "rdb", Resource: "backup", Verb: "get", @@ -441,7 +461,7 @@ func rdbBackupGet() *core.Command { func rdbBackupUpdate() *core.Command { return &core.Command{ Short: `Update a database backup`, - Long: `Update a database backup.`, + Long: `Update the parameters of a backup, including name and expiration date.`, Namespace: "rdb", Resource: "backup", Verb: "update", @@ -464,7 +484,7 @@ func rdbBackupUpdate() *core.Command { }, { Name: "expires-at", - Short: `Expiration date (Format ISO 8601)`, + Short: `Expiration date (must follow the ISO 8601 format)`, Required: false, Deprecated: false, Positional: false, @@ -485,7 +505,7 @@ func rdbBackupUpdate() *core.Command { func rdbBackupDelete() *core.Command { return &core.Command{ Short: `Delete a database backup`, - Long: `Delete a database backup.`, + Long: `Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone.`, Namespace: "rdb", Resource: "backup", Verb: "delete", @@ -515,7 +535,7 @@ func rdbBackupDelete() *core.Command { func rdbBackupRestore() *core.Command { return &core.Command{ Short: `Restore a database backup`, - Long: `Restore a database backup.`, + Long: `Launch the process of restoring database backup. You must specify the ` + "`" + `instance_id` + "`" + ` of the Database Instance of destination, where the backup will be restored. Note that large database backups can take up to several hours to restore.`, Namespace: "rdb", Resource: "backup", Verb: "restore", @@ -524,7 +544,7 @@ func rdbBackupRestore() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "database-name", - Short: `Defines the destination database in order to restore into a specified database, the default destination is set to the origin database of the backup`, + Short: `Defines the destination database to restore into a specified database (the default destination is set to the origin database of the backup)`, Required: false, Deprecated: false, Positional: false, @@ -538,7 +558,7 @@ func rdbBackupRestore() *core.Command { }, { Name: "instance-id", - Short: `Defines the rdb instance where the backup has to be restored`, + Short: `Defines the Database Instance where the backup has to be restored`, Required: true, Deprecated: false, Positional: false, @@ -559,7 +579,7 @@ func rdbBackupRestore() *core.Command { func rdbBackupExport() *core.Command { return &core.Command{ Short: `Export a database backup`, - Long: `Export a database backup.`, + Long: `Export a backup, specified by the ` + "`" + `database_backup_id` + "`" + ` and the ` + "`" + `region` + "`" + ` parameters. The download URL is returned in the response.`, Namespace: "rdb", Resource: "backup", Verb: "export", @@ -588,8 +608,8 @@ func rdbBackupExport() *core.Command { func rdbInstanceUpgrade() *core.Command { return &core.Command{ - Short: `Upgrade an instance`, - Long: `Upgrade your current instance specifications like node type, high availability, volume, or db engine version.`, + Short: `Upgrade a Database Instance`, + Long: `Upgrade your current Database Instance specifications like node type, high availability, volume, or the database engine version. Note that upon upgrade the ` + "`" + `enable_ha` + "`" + ` parameter can only be set to ` + "`" + `true` + "`" + `.`, Namespace: "rdb", Resource: "instance", Verb: "upgrade", @@ -598,21 +618,21 @@ func rdbInstanceUpgrade() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want to upgrade`, + Short: `UUID of the Database Instance you want to upgrade`, Required: true, Deprecated: false, Positional: true, }, { Name: "node-type", - Short: `Node type of the instance you want to upgrade to`, + Short: `Node type of the Database Instance you want to upgrade to`, Required: false, Deprecated: false, Positional: false, }, { Name: "enable-ha", - Short: `Set to true to enable high availability on your instance`, + Short: `Defines whether or not high availability should be enabled on the Database Instance`, Required: false, Deprecated: false, Positional: false, @@ -626,7 +646,7 @@ func rdbInstanceUpgrade() *core.Command { }, { Name: "volume-type", - Short: `Change your instance storage type`, + Short: `Change your Database Instance storage type`, Required: false, Deprecated: false, Positional: false, @@ -634,7 +654,7 @@ func rdbInstanceUpgrade() *core.Command { }, { Name: "upgradable-version-id", - Short: `Update your instance database engine to a newer version`, + Short: `Update your database engine to a newer version`, Required: false, Deprecated: false, Positional: false, @@ -654,8 +674,8 @@ func rdbInstanceUpgrade() *core.Command { func rdbInstanceList() *core.Command { return &core.Command{ - Short: `List instances`, - Long: `List instances.`, + Short: `List Database Instances`, + Long: `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.`, Namespace: "rdb", Resource: "instance", Verb: "list", @@ -664,21 +684,21 @@ func rdbInstanceList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "tags.{index}", - Short: `List instance that have a given tags`, + Short: `List Database Instances that have a given tag`, Required: false, Deprecated: false, Positional: false, }, { Name: "name", - Short: `List instance that match a given name pattern`, + Short: `Lists Database Instances that match a name pattern`, Required: false, Deprecated: false, Positional: false, }, { Name: "order-by", - Short: `Criteria to use when ordering instance listing`, + Short: `Criteria to use when ordering Database Instance listings`, Required: false, Deprecated: false, Positional: false, @@ -686,14 +706,14 @@ func rdbInstanceList() *core.Command { }, { Name: "project-id", - Short: `Project ID to list the instance of`, + Short: `Project ID to list the Database Instance of`, Required: false, Deprecated: false, Positional: false, }, { Name: "organization-id", - Short: `Please use ` + "`" + `project_id` + "`" + ` instead`, + Short: `Please use project_id instead`, Required: false, Deprecated: false, Positional: false, @@ -754,8 +774,8 @@ func rdbInstanceList() *core.Command { func rdbInstanceGet() *core.Command { return &core.Command{ - Short: `Get an instance`, - Long: `Get an instance.`, + Short: `Get a Database Instance`, + Long: `Retrieve information about a given Database Instance, specified by the ` + "`" + `region` + "`" + ` and ` + "`" + `instance_id` + "`" + ` parameters. Its full details, including name, status, IP address and port, are returned in the response object.`, Namespace: "rdb", Resource: "instance", Verb: "get", @@ -764,7 +784,7 @@ func rdbInstanceGet() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: true, Deprecated: false, Positional: true, @@ -784,8 +804,8 @@ func rdbInstanceGet() *core.Command { func rdbInstanceCreate() *core.Command { return &core.Command{ - Short: `Create an instance`, - Long: `Create an instance.`, + Short: `Create a Database Instance`, + Long: `Create a new Database Instance. You must set the ` + "`" + `engine` + "`" + `, ` + "`" + `user_name` + "`" + `, ` + "`" + `password` + "`" + ` and ` + "`" + `node_type` + "`" + ` parameters. Optionally, you can specify the volume type and size.`, Namespace: "rdb", Resource: "instance", Verb: "create", @@ -795,7 +815,7 @@ func rdbInstanceCreate() *core.Command { core.ProjectIDArgSpec(), { Name: "name", - Short: `Name of the instance`, + Short: `Name of the Database Instance`, Required: false, Deprecated: false, Positional: false, @@ -803,14 +823,14 @@ func rdbInstanceCreate() *core.Command { }, { Name: "engine", - Short: `Database engine of the database (PostgreSQL, MySQL, ...)`, + Short: `Database engine of the Database Instance (PostgreSQL, MySQL, ...)`, Required: true, Deprecated: false, Positional: false, }, { Name: "user-name", - Short: `Name of the user created when the instance is created`, + Short: `Username created when the Database Instance is created`, Required: true, Deprecated: false, Positional: false, @@ -824,28 +844,28 @@ func rdbInstanceCreate() *core.Command { }, { Name: "node-type", - Short: `Type of node to use for the instance`, + Short: `Type of node to use for the Database Instance`, Required: true, Deprecated: false, Positional: false, }, { Name: "is-ha-cluster", - Short: `Whether or not High-Availability is enabled`, + Short: `Defines whether or not High-Availability is enabled`, Required: false, Deprecated: false, Positional: false, }, { Name: "disable-backup", - Short: `Whether or not backups are disabled`, + Short: `Defines whether or not backups are disabled`, Required: false, Deprecated: false, Positional: false, }, { Name: "tags.{index}", - Short: `Tags to apply to the instance`, + Short: `Tags to apply to the Database Instance`, Required: false, Deprecated: false, Positional: false, @@ -864,7 +884,7 @@ func rdbInstanceCreate() *core.Command { }, { Name: "volume-type", - Short: `Type of volume where data are stored (lssd, bssd, ...)`, + Short: `Type of volume where data is stored (lssd, bssd, ...)`, Required: false, Deprecated: false, Positional: false, @@ -879,21 +899,21 @@ func rdbInstanceCreate() *core.Command { }, { Name: "init-endpoints.{index}.private-network.private-network-id", - Short: `UUID of the private network to be connected to the database instance`, + Short: `UUID of the Private Network to be connected to the Database Instance`, Required: false, Deprecated: false, Positional: false, }, { Name: "init-endpoints.{index}.private-network.service-ip", - Short: `Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitation.`, + Short: `Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations.`, Required: false, Deprecated: false, Positional: false, }, { Name: "backup-same-region", - Short: `Store logical backups in the same region as the database instance`, + Short: `Defines whether to or not to store logical backups in the same region as the Database Instance`, Required: false, Deprecated: false, Positional: false, @@ -914,8 +934,8 @@ func rdbInstanceCreate() *core.Command { func rdbInstanceUpdate() *core.Command { return &core.Command{ - Short: `Update an instance`, - Long: `Update an instance.`, + Short: `Update a Database Instance`, + Long: `Update the parameters of a Database Instance, including name, tags and backup schedule details.`, Namespace: "rdb", Resource: "instance", Verb: "update", @@ -938,49 +958,49 @@ func rdbInstanceUpdate() *core.Command { }, { Name: "is-backup-schedule-disabled", - Short: `Whether or not the backup schedule is disabled`, + Short: `Defines whether or not the backup schedule is disabled`, Required: false, Deprecated: false, Positional: false, }, { Name: "name", - Short: `Name of the instance`, + Short: `Name of the Database Instance`, Required: false, Deprecated: false, Positional: false, }, { Name: "instance-id", - Short: `UUID of the instance to update`, + Short: `UUID of the Database Instance to update`, Required: true, Deprecated: false, Positional: true, }, { Name: "tags.{index}", - Short: `Tags of a given instance`, + Short: `Tags of a Database Instance`, Required: false, Deprecated: false, Positional: false, }, { Name: "logs-policy.max-age-retention", - Short: `Max age (in day) of remote logs to keep on the database instance`, + Short: `Max age (in days) of remote logs to keep on the Database Instance`, Required: false, Deprecated: false, Positional: false, }, { Name: "logs-policy.total-disk-retention", - Short: `Max disk size of remote logs to keep on the database instance`, + Short: `Max disk size of remote logs to keep on the Database Instance`, Required: false, Deprecated: false, Positional: false, }, { Name: "backup-same-region", - Short: `Store logical backups in the same region as the database instance`, + Short: `Store logical backups in the same region as the Database Instance`, Required: false, Deprecated: false, Positional: false, @@ -1000,8 +1020,8 @@ func rdbInstanceUpdate() *core.Command { func rdbInstanceDelete() *core.Command { return &core.Command{ - Short: `Delete an instance`, - Long: `Delete an instance.`, + Short: `Delete a Database Instance`, + Long: `Delete a given Database Instance, specified by the ` + "`" + `region` + "`" + ` and ` + "`" + `instance_id` + "`" + ` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.`, Namespace: "rdb", Resource: "instance", Verb: "delete", @@ -1010,7 +1030,7 @@ func rdbInstanceDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance to delete`, + Short: `UUID of the Database Instance to delete`, Required: true, Deprecated: false, Positional: true, @@ -1030,8 +1050,8 @@ func rdbInstanceDelete() *core.Command { func rdbInstanceClone() *core.Command { return &core.Command{ - Short: `Clone an instance`, - Long: `Clone an instance.`, + Short: `Clone a Database Instance`, + Long: `Clone a given Database Instance, specified by the ` + "`" + `region` + "`" + ` and ` + "`" + `instance_id` + "`" + ` parameters. The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users and permissions. You can create a clone on a Database Instance bigger than your current one.`, Namespace: "rdb", Resource: "instance", Verb: "clone", @@ -1040,14 +1060,14 @@ func rdbInstanceClone() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want to clone`, + Short: `UUID of the Database Instance you want to clone`, Required: true, Deprecated: false, Positional: true, }, { Name: "name", - Short: `Name of the clone instance`, + Short: `Name of the Database Instance clone`, Required: false, Deprecated: false, Positional: false, @@ -1074,8 +1094,8 @@ func rdbInstanceClone() *core.Command { func rdbInstanceRestart() *core.Command { return &core.Command{ - Short: `Restart an instance`, - Long: `Restart an instance.`, + Short: `Restart Database Instance`, + Long: `Restart a given Database Instance, specified by the ` + "`" + `region` + "`" + ` and ` + "`" + `instance_id` + "`" + ` parameters. The status of the Database Instance returned in the response.`, Namespace: "rdb", Resource: "instance", Verb: "restart", @@ -1084,7 +1104,7 @@ func rdbInstanceRestart() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want to restart`, + Short: `UUID of the Database Instance you want to restart`, Required: true, Deprecated: false, Positional: true, @@ -1104,8 +1124,8 @@ func rdbInstanceRestart() *core.Command { func rdbInstanceGetCertificate() *core.Command { return &core.Command{ - Short: `Get the TLS certificate of an instance`, - Long: `Get the TLS certificate of an instance.`, + Short: `Get the TLS certificate of a Database Instance`, + Long: `Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response.`, Namespace: "rdb", Resource: "instance", Verb: "get-certificate", @@ -1114,7 +1134,7 @@ func rdbInstanceGetCertificate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: true, Deprecated: false, Positional: true, @@ -1134,8 +1154,8 @@ func rdbInstanceGetCertificate() *core.Command { func rdbInstanceRenewCertificate() *core.Command { return &core.Command{ - Short: `Renew the TLS certificate of an instance`, - Long: `Renew the TLS certificate of an instance.`, + Short: `Renew the TLS certificate of a Database Instance`, + Long: `Renew a TLS for a Database Instance. 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.`, Namespace: "rdb", Resource: "instance", Verb: "renew-certificate", @@ -1144,7 +1164,7 @@ func rdbInstanceRenewCertificate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want logs of`, + Short: `UUID of the Database Instance you want logs of`, Required: true, Deprecated: false, Positional: true, @@ -1170,8 +1190,8 @@ func rdbInstanceRenewCertificate() *core.Command { func rdbReadReplicaCreate() *core.Command { return &core.Command{ - Short: `Create a read replica`, - Long: `You can only create a maximum of 3 read replicas for one instance.`, + Short: `Create a Read Replica`, + Long: `Create a new Read Replica of a Database Instance. You must specify the ` + "`" + `region` + "`" + ` and the ` + "`" + `instance_id` + "`" + `. You can only create a maximum of 3 Read Replicas per Database Instance.`, Namespace: "rdb", Resource: "read-replica", Verb: "create", @@ -1180,21 +1200,21 @@ func rdbReadReplicaCreate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want a read replica of`, + Short: `UUID of the Database Instance you want to create a Read Replica from`, Required: true, Deprecated: false, Positional: true, }, { Name: "endpoint-spec.{index}.private-network.private-network-id", - Short: `UUID of the private network to be connected to the read replica`, + Short: `UUID of the Private Network to be connected to the Read Replica`, Required: false, Deprecated: false, Positional: false, }, { Name: "endpoint-spec.{index}.private-network.service-ip", - Short: `Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitations.`, + Short: `Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations.`, Required: false, Deprecated: false, Positional: false, @@ -1214,8 +1234,8 @@ func rdbReadReplicaCreate() *core.Command { func rdbReadReplicaGet() *core.Command { return &core.Command{ - Short: `Get a read replica`, - Long: `Get a read replica.`, + Short: `Get a Read Replica`, + Long: `Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like ` + "`" + `endpoints` + "`" + `, ` + "`" + `status` + "`" + ` and ` + "`" + `region` + "`" + ` are returned in the response.`, Namespace: "rdb", Resource: "read-replica", Verb: "get", @@ -1224,7 +1244,7 @@ func rdbReadReplicaGet() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "read-replica-id", - Short: `UUID of the read replica`, + Short: `UUID of the Read Replica`, Required: true, Deprecated: false, Positional: true, @@ -1244,8 +1264,8 @@ func rdbReadReplicaGet() *core.Command { func rdbReadReplicaDelete() *core.Command { return &core.Command{ - Short: `Delete a read replica`, - Long: `Delete a read replica.`, + Short: `Delete a Read Replica`, + Long: `Delete a Read Replica of a Database Instance. You must specify the ` + "`" + `region` + "`" + ` and ` + "`" + `read_replica_id` + "`" + ` parameters of the Read Replica you want to delete.`, Namespace: "rdb", Resource: "read-replica", Verb: "delete", @@ -1254,7 +1274,7 @@ func rdbReadReplicaDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "read-replica-id", - Short: `UUID of the read replica`, + Short: `UUID of the Read Replica`, Required: true, Deprecated: false, Positional: true, @@ -1274,10 +1294,9 @@ func rdbReadReplicaDelete() *core.Command { func rdbReadReplicaReset() *core.Command { return &core.Command{ - Short: `Resync a read replica`, - Long: `When you resync a read replica, first it is reset, and then its data is resynchronized from the primary node. -Your read replica will be unavailable during the resync process. The duration of this process is proportional to your Database Instance size. -The configured endpoints will not change.`, + Short: `Resync a Read Replica`, + Long: `When you resync a Read Replica, first it is reset, then its data is resynchronized from the primary node. Your Read Replica remains unavailable during the resync process. The duration of this process is proportional to the size of your Database Instance. +The configured endpoints do not change.`, Namespace: "rdb", Resource: "read-replica", Verb: "reset", @@ -1286,7 +1305,7 @@ The configured endpoints will not change.`, ArgSpecs: core.ArgSpecs{ { Name: "read-replica-id", - Short: `UUID of the read replica`, + Short: `UUID of the Read Replica`, Required: true, Deprecated: false, Positional: true, @@ -1306,8 +1325,8 @@ The configured endpoints will not change.`, func rdbReadReplicaCreateEndpoint() *core.Command { return &core.Command{ - Short: `Create a new endpoint for a given read replica`, - Long: `A read replica can have at most one direct access and one private network endpoint.`, + Short: `Create an endpoint for a Read Replica`, + Long: `Create a new endpoint for a Read Replica. Read Replicas can have at most one direct access and one Private Network endpoint.`, Namespace: "rdb", Resource: "read-replica", Verb: "create-endpoint", @@ -1316,21 +1335,21 @@ func rdbReadReplicaCreateEndpoint() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "read-replica-id", - Short: `UUID of the read replica`, + Short: `UUID of the Read Replica`, Required: true, Deprecated: false, Positional: true, }, { Name: "endpoint-spec.{index}.private-network.private-network-id", - Short: `UUID of the private network to be connected to the read replica`, + Short: `UUID of the Private Network to be connected to the Read Replica`, Required: false, Deprecated: false, Positional: false, }, { Name: "endpoint-spec.{index}.private-network.service-ip", - Short: `Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and subnet limitations.`, + Short: `Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations.`, Required: false, Deprecated: false, Positional: false, @@ -1350,8 +1369,8 @@ func rdbReadReplicaCreateEndpoint() *core.Command { func rdbLogPrepare() *core.Command { return &core.Command{ - Short: `Prepare logs of a given instance`, - Long: `Prepare your instance logs. Logs will be grouped on a minimum interval of a day.`, + Short: `Prepare logs of a Database Instance`, + Long: `Prepare your Database Instance logs. You can define the ` + "`" + `start_date` + "`" + ` and ` + "`" + `end_date` + "`" + ` parameters for your query. The download URL is returned in the response. Logs are recorded from 00h00 to 23h59 and then aggregated in a ` + "`" + `.log` + "`" + ` file once a day. Therefore, even if you specify a timeframe from which you want to get the logs, you will receive logs from the full 24 hours.`, Namespace: "rdb", Resource: "log", Verb: "prepare", @@ -1360,21 +1379,21 @@ func rdbLogPrepare() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want logs of`, + Short: `UUID of the Database Instance you want logs of`, Required: true, Deprecated: false, Positional: false, }, { Name: "start-date", - Short: `Start datetime of your log. Format: ` + "`" + `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z` + "`" + ``, + Short: `Start datetime of your log. (RFC 3339 format)`, Required: false, Deprecated: false, Positional: false, }, { Name: "end-date", - Short: `End datetime of your log. Format: ` + "`" + `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z` + "`" + ``, + Short: `End datetime of your log. (RFC 3339 format)`, Required: false, Deprecated: false, Positional: false, @@ -1394,8 +1413,8 @@ func rdbLogPrepare() *core.Command { func rdbLogList() *core.Command { return &core.Command{ - Short: `List available logs of a given instance`, - Long: `List available logs of a given instance.`, + Short: `List available logs of a Database Instance`, + Long: `List the available logs of a Database Instance. By default, the logs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.`, Namespace: "rdb", Resource: "log", Verb: "list", @@ -1404,14 +1423,14 @@ func rdbLogList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want logs of`, + Short: `UUID of the Database Instance you want logs of`, Required: true, Deprecated: false, Positional: false, }, { Name: "order-by", - Short: `Criteria to use when ordering instance logs listing`, + Short: `Criteria to use when ordering Database Instance logs listing`, Required: false, Deprecated: false, Positional: false, @@ -1432,8 +1451,8 @@ func rdbLogList() *core.Command { func rdbLogGet() *core.Command { return &core.Command{ - Short: `Get specific logs of a given instance`, - Long: `Get specific logs of a given instance.`, + Short: `Get given logs of a Database Instance`, + Long: `Retrieve information about the logs of a Database Instance. Specify the ` + "`" + `instance_log_id` + "`" + ` and ` + "`" + `region` + "`" + ` in your request to get information such as ` + "`" + `download_url` + "`" + `, ` + "`" + `status` + "`" + `, ` + "`" + `expires_at` + "`" + ` and ` + "`" + `created_at` + "`" + ` about your logs in the response.`, Namespace: "rdb", Resource: "log", Verb: "get", @@ -1462,8 +1481,8 @@ func rdbLogGet() *core.Command { func rdbLogPurge() *core.Command { return &core.Command{ - Short: `Purge remote instances logs`, - Long: `Purge remote instances logs.`, + Short: `Purge remote Database Instance logs`, + Long: `Purge a given remote log from a Database Instance. You can specify the ` + "`" + `log_name` + "`" + ` of the log you wish to clean from your Database Instance.`, Namespace: "rdb", Resource: "log", Verb: "purge", @@ -1472,14 +1491,14 @@ func rdbLogPurge() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want logs of`, + Short: `UUID of the Database Instance you want logs of`, Required: true, Deprecated: false, Positional: false, }, { Name: "log-name", - Short: `Specific log name to purge`, + Short: `Given log name to purge`, Required: false, Deprecated: false, Positional: false, @@ -1505,8 +1524,8 @@ func rdbLogPurge() *core.Command { func rdbLogListDetails() *core.Command { return &core.Command{ - Short: `List remote instances logs details`, - Long: `List remote instances logs details.`, + Short: `List remote Database Instance logs details`, + Long: `List remote log details. 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.`, Namespace: "rdb", Resource: "log", Verb: "list-details", @@ -1515,7 +1534,7 @@ func rdbLogListDetails() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want logs of`, + Short: `UUID of the Database Instance you want logs of`, Required: true, Deprecated: false, Positional: false, @@ -1535,8 +1554,8 @@ func rdbLogListDetails() *core.Command { func rdbACLList() *core.Command { return &core.Command{ - Short: `List ACL rules of a given instance`, - Long: `List ACL rules of a given instance.`, + Short: `List ACL rules of a Database Instance`, + Long: `List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions.`, Namespace: "rdb", Resource: "acl", Verb: "list", @@ -1545,7 +1564,7 @@ func rdbACLList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: true, Deprecated: false, Positional: false, @@ -1574,8 +1593,8 @@ func rdbACLList() *core.Command { func rdbACLAdd() *core.Command { return &core.Command{ - Short: `Add an ACL instance to a given instance`, - Long: `Add an additional ACL rule to a database instance.`, + Short: `Add an ACL rule to a Database Instance`, + Long: `Add an additional ACL rule to a Database Instance.`, Namespace: "rdb", Resource: "acl", Verb: "add", @@ -1584,7 +1603,7 @@ func rdbACLAdd() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want to add acl rules to`, + Short: `UUID of the Database Instance you want to add ACL rules to`, Required: true, Deprecated: false, Positional: false, @@ -1616,8 +1635,8 @@ func rdbACLAdd() *core.Command { func rdbACLDelete() *core.Command { return &core.Command{ - Short: `Delete ACL rules of a given instance`, - Long: `Delete ACL rules of a given instance.`, + Short: `Delete ACL rules of a Database Instance`, + Long: `Delete one or more ACL rules of a Database Instance.`, Namespace: "rdb", Resource: "acl", Verb: "delete", @@ -1626,14 +1645,14 @@ func rdbACLDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want to delete an ACL rules from`, + Short: `UUID of the Database Instance you want to delete an ACL rule from`, Required: true, Deprecated: false, Positional: false, }, { Name: "acl-rule-ips.{index}", - Short: `ACL rules IP present on the instance`, + Short: `IP addresses defined in the ACL rules of the Database Instance`, Required: true, Deprecated: false, Positional: false, @@ -1653,8 +1672,8 @@ func rdbACLDelete() *core.Command { func rdbUserList() *core.Command { return &core.Command{ - Short: `List users of a given instance`, - Long: `List users of a given instance.`, + Short: `List users of a Database Instance`, + Long: `List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.`, Namespace: "rdb", Resource: "user", Verb: "list", @@ -1670,7 +1689,7 @@ func rdbUserList() *core.Command { }, { Name: "order-by", - Short: `Criteria to use when ordering users listing`, + Short: `Criteria to use when requesting user listing`, Required: false, Deprecated: false, Positional: false, @@ -1678,7 +1697,7 @@ func rdbUserList() *core.Command { }, { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: true, Deprecated: false, Positional: false, @@ -1707,8 +1726,8 @@ func rdbUserList() *core.Command { func rdbUserCreate() *core.Command { return &core.Command{ - Short: `Create a user on a given instance`, - Long: `Create a user on a given instance.`, + Short: `Create a user for a Database Instance`, + Long: `Create a new user for a Database Instance. You must define the ` + "`" + `name` + "`" + `, ` + "`" + `password` + "`" + ` and ` + "`" + `is_admin` + "`" + ` parameters.`, Namespace: "rdb", Resource: "user", Verb: "create", @@ -1717,7 +1736,7 @@ func rdbUserCreate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance you want to create a user in`, + Short: `UUID of the Database Instance in which you want to create a user`, Required: true, Deprecated: false, Positional: false, @@ -1738,7 +1757,7 @@ func rdbUserCreate() *core.Command { }, { Name: "is-admin", - Short: `Whether the user you want to create will have administrative privileges`, + Short: `Defines whether the user will have administrative privileges`, Required: false, Deprecated: false, Positional: false, @@ -1758,8 +1777,8 @@ func rdbUserCreate() *core.Command { func rdbUserUpdate() *core.Command { return &core.Command{ - Short: `Update a user on a given instance`, - Long: `Update a user on a given instance.`, + Short: `Update a user on a Database Instance`, + Long: `Update the parameters of a user on a Database Instance. You can update the ` + "`" + `password` + "`" + ` and ` + "`" + `is_admin` + "`" + ` parameters, but you cannot change the name of the user.`, Namespace: "rdb", Resource: "user", Verb: "update", @@ -1768,7 +1787,7 @@ func rdbUserUpdate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance the user belongs to`, + Short: `UUID of the Database Instance the user belongs to`, Required: true, Deprecated: false, Positional: false, @@ -1789,7 +1808,7 @@ func rdbUserUpdate() *core.Command { }, { Name: "is-admin", - Short: `Whether or not this user got administrative privileges`, + Short: `Defines whether or not this user got administrative privileges`, Required: false, Deprecated: false, Positional: false, @@ -1809,8 +1828,8 @@ func rdbUserUpdate() *core.Command { func rdbUserDelete() *core.Command { return &core.Command{ - Short: `Delete a user on a given instance`, - Long: `Delete a user on a given instance.`, + Short: `Delete a user on a Database Instance`, + Long: `Delete a given user on a Database Instance. You must specify, in the endpoint, the ` + "`" + `region` + "`" + `, ` + "`" + `instance_id` + "`" + ` and ` + "`" + `name` + "`" + ` parameters of the user you want to delete.`, Namespace: "rdb", Resource: "user", Verb: "delete", @@ -1819,7 +1838,7 @@ func rdbUserDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance to delete a user from`, + Short: `UUID of the Database Instance to delete the user from`, Required: true, Deprecated: false, Positional: false, @@ -1852,8 +1871,8 @@ func rdbUserDelete() *core.Command { func rdbDatabaseList() *core.Command { return &core.Command{ - Short: `List all database in a given instance`, - Long: `List all database in a given instance.`, + Short: `List databases in a Database Instance`, + Long: `List all databases of a given Database Instance. 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. You can define additional parameters for your query, such as ` + "`" + `name` + "`" + `, ` + "`" + `managed` + "`" + ` and ` + "`" + `owner` + "`" + `.`, Namespace: "rdb", Resource: "database", Verb: "list", @@ -1869,7 +1888,7 @@ func rdbDatabaseList() *core.Command { }, { Name: "managed", - Short: `Whether or not the database is managed`, + Short: `Defines whether or not the database is managed`, Required: false, Deprecated: false, Positional: false, @@ -1891,7 +1910,7 @@ func rdbDatabaseList() *core.Command { }, { Name: "instance-id", - Short: `UUID of the instance to list database of`, + Short: `UUID of the Database Instance to list the databases of`, Required: true, Deprecated: false, Positional: false, @@ -1920,8 +1939,8 @@ func rdbDatabaseList() *core.Command { func rdbDatabaseCreate() *core.Command { return &core.Command{ - Short: `Create a database in a given instance`, - Long: `Create a database in a given instance.`, + Short: `Create a database in a Database Instance`, + Long: `Create a new database. You must define the ` + "`" + `name` + "`" + ` parameter in the request.`, Namespace: "rdb", Resource: "database", Verb: "create", @@ -1930,7 +1949,7 @@ func rdbDatabaseCreate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance where to create the database`, + Short: `UUID of the Database Instance where to create the database`, Required: true, Deprecated: false, Positional: false, @@ -1957,8 +1976,8 @@ func rdbDatabaseCreate() *core.Command { func rdbDatabaseDelete() *core.Command { return &core.Command{ - Short: `Delete a database in a given instance`, - Long: `Delete a database in a given instance.`, + Short: `Delete a database in a Database Instance`, + Long: `Delete a given database on a Database Instance. You must specify, in the endpoint, the ` + "`" + `region` + "`" + `, ` + "`" + `instance_id` + "`" + ` and ` + "`" + `name` + "`" + ` parameters of the database you want to delete.`, Namespace: "rdb", Resource: "database", Verb: "delete", @@ -1967,7 +1986,7 @@ func rdbDatabaseDelete() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance where to delete the database`, + Short: `UUID of the Database Instance where to delete the database`, Required: true, Deprecated: false, Positional: false, @@ -2000,8 +2019,8 @@ func rdbDatabaseDelete() *core.Command { func rdbPrivilegeList() *core.Command { return &core.Command{ - Short: `List privileges of a given user for a given database on a given instance`, - Long: `List privileges of a given user for a given database on a given instance.`, + Short: `List user privileges for a database`, + Long: `List privileges of a user on a database. 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. You can define additional parameters for your query, such as ` + "`" + `database_name` + "`" + ` and ` + "`" + `user_name` + "`" + `.`, Namespace: "rdb", Resource: "privilege", Verb: "list", @@ -2025,7 +2044,7 @@ func rdbPrivilegeList() *core.Command { }, { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: true, Deprecated: false, Positional: false, @@ -2061,8 +2080,8 @@ func rdbPrivilegeList() *core.Command { func rdbPrivilegeSet() *core.Command { return &core.Command{ - Short: `Set privileges of a given user for a given database on a given instance`, - Long: `Set privileges of a given user for a given database on a given instance.`, + Short: `Set user privileges for a database`, + Long: `Set the privileges of a user on a database. You must define ` + "`" + `database_name` + "`" + `, ` + "`" + `user_name` + "`" + ` and ` + "`" + `permission` + "`" + ` in the request body.`, Namespace: "rdb", Resource: "privilege", Verb: "set", @@ -2071,7 +2090,7 @@ func rdbPrivilegeSet() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: true, Deprecated: false, Positional: false, @@ -2113,8 +2132,8 @@ func rdbPrivilegeSet() *core.Command { func rdbSnapshotList() *core.Command { return &core.Command{ - Short: `List instance snapshots`, - Long: `List instance snapshots.`, + Short: `List snapshots`, + Long: `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.`, Namespace: "rdb", Resource: "snapshot", Verb: "list", @@ -2138,7 +2157,7 @@ func rdbSnapshotList() *core.Command { }, { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: false, Deprecated: false, Positional: false, @@ -2181,8 +2200,8 @@ func rdbSnapshotList() *core.Command { func rdbSnapshotGet() *core.Command { return &core.Command{ - Short: `Get an instance snapshot`, - Long: `Get an instance snapshot.`, + Short: `Get a Database Instance snapshot`, + Long: `Retrieve information about a given snapshot, specified by its ` + "`" + `snapshot_id` + "`" + ` and ` + "`" + `region` + "`" + `. Full details about the snapshot, like size and expiration date, are returned in the response.`, Namespace: "rdb", Resource: "snapshot", Verb: "get", @@ -2211,8 +2230,8 @@ func rdbSnapshotGet() *core.Command { func rdbSnapshotCreate() *core.Command { return &core.Command{ - Short: `Create an instance snapshot`, - Long: `Create an instance snapshot.`, + Short: `Create a Database Instance snapshot`, + Long: `Create a new snapshot of a Database Instance. You must define the ` + "`" + `name` + "`" + ` parameter in the request.`, Namespace: "rdb", Resource: "snapshot", Verb: "create", @@ -2221,7 +2240,7 @@ func rdbSnapshotCreate() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "instance-id", - Short: `UUID of the instance`, + Short: `UUID of the Database Instance`, Required: true, Deprecated: false, Positional: false, @@ -2236,7 +2255,7 @@ func rdbSnapshotCreate() *core.Command { }, { Name: "expires-at", - Short: `Expiration date (Format ISO 8601)`, + Short: `Expiration date (must follow the ISO 8601 format)`, Required: false, Deprecated: false, Positional: false, @@ -2256,8 +2275,8 @@ func rdbSnapshotCreate() *core.Command { func rdbSnapshotUpdate() *core.Command { return &core.Command{ - Short: `Update an instance snapshot`, - Long: `Update an instance snapshot.`, + Short: `Update a Database Instance snapshot`, + Long: `Update the parameters of a snapshot of a Database Instance. You can update the ` + "`" + `name` + "`" + ` and ` + "`" + `expires_at` + "`" + ` parameters.`, Namespace: "rdb", Resource: "snapshot", Verb: "update", @@ -2280,7 +2299,7 @@ func rdbSnapshotUpdate() *core.Command { }, { Name: "expires-at", - Short: `Expiration date (Format ISO 8601)`, + Short: `Expiration date (must follow the ISO 8601 format)`, Required: false, Deprecated: false, Positional: false, @@ -2300,8 +2319,8 @@ func rdbSnapshotUpdate() *core.Command { func rdbSnapshotDelete() *core.Command { return &core.Command{ - Short: `Delete an instance snapshot`, - Long: `Delete an instance snapshot.`, + Short: `Delete a Database Instance snapshot`, + Long: `Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the ` + "`" + `region` + "`" + ` and ` + "`" + `snapshot_id` + "`" + ` parameters of the snapshot you want to delete.`, Namespace: "rdb", Resource: "snapshot", Verb: "delete", @@ -2330,8 +2349,8 @@ func rdbSnapshotDelete() *core.Command { func rdbSnapshotRestore() *core.Command { return &core.Command{ - Short: `Create a new instance from a given snapshot`, - Long: `Create a new instance from a given snapshot.`, + Short: `Create a new Database Instance from a snapshot`, + Long: `Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory.`, Namespace: "rdb", Resource: "snapshot", Verb: "restore", @@ -2340,21 +2359,21 @@ func rdbSnapshotRestore() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "snapshot-id", - Short: `Block snapshot of the instance`, + Short: `Block snapshot of the Database Instance`, Required: true, Deprecated: false, Positional: true, }, { Name: "instance-name", - Short: `Name of the instance created with the snapshot`, + Short: `Name of the Database Instance created with the snapshot`, Required: false, Deprecated: false, Positional: false, }, { Name: "is-ha-cluster", - Short: `Whether or not High-Availability is enabled on the new instance`, + Short: `Defines whether or not High-Availability is enabled on the new Database Instance`, Required: false, Deprecated: false, Positional: false,