docs(mongodb): add documentation (scaleway#4228)

scaleway-bot · yfodil · web-flow · commit f2b6218b8a99 · 2024-10-25T15:43:57.000Z
Co-authored-by: Yacine Fodil &lt;105779815+yfodil@users.noreply.github.com&gt;
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-create-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-create-usage.golden
@@ -1,22 +1,22 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create a new MongoDB™ Database Instance.
+Create a new MongoDB® Database Instance.
 
 USAGE:
   scw mongodb instance create [arg=value ...]
 
 ARGS:
   [project-id]                                             Project ID to use. If none is passed the default project ID will be used
   [name=<generated>]                                       Name of the Database Instance
-  version                                                  Version of the MongoDB™ engine
+  version                                                  Version of the MongoDB® engine
   [tags.{index}]                                           Tags to apply to the Database Instance
   node-number                                              Number of node to use for the Database Instance
   node-type                                                Type of node to use for the Database Instance
   user-name                                                Username created when the Database Instance is created
   password                                                 Password of the initial user
   [volume.volume-size]                                     Volume size
   [volume.volume-type]                                     Type of volume where data is stored (unknown_type | sbs_5k | sbs_15k)
-  [endpoints.{index}.private-network.private-network-id]   UUID of the private network
+  [endpoints.{index}.private-network.private-network-id]   UUID of the Private Network
   [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-mongodb-instance-delete-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-delete-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete a given MongoDB™ Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB™ Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
+Delete a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
 
 USAGE:
   scw mongodb instance delete <instance-id ...> [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-get-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-get-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Retrieve information about a given MongoDB™ 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.
+Retrieve information about a given MongoDB® 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 mongodb instance get <instance-id ...> [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-list-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-list-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all MongoDB™ Database Instances in the specified region, for a given Scaleway Project. By default, the MongoDB™ Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
+List all MongoDB® Database Instances in the specified region. By default, the MongoDB® 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 mongodb instance list [arg=value ...]
@@ -9,8 +9,8 @@ ARGS:
   [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 | status_asc | status_desc)
-  [project-id]        Project ID to list the Database Instance of
-  [organization-id]   Organization ID the Database Instance belongs to
+  [project-id]        Project ID
+  [organization-id]   Organization ID 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-mongodb-instance-update-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-update-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update the parameters of a MongoDB™ Database Instance.
+Update the parameters of a MongoDB® Database Instance.
 
 USAGE:
   scw mongodb instance update <instance-id ...> [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-instance-upgrade-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-upgrade-usage.golden
@@ -7,7 +7,7 @@ USAGE:
 
 ARGS:
   instance-id       UUID of the Database Instance you want to upgrade
-  [volume-size]     Increase your block storage volume size
+  [volume-size]     Increase your Block Storage volume size
   [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-mongodb-instance-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-instance-usage.golden
@@ -1,17 +1,17 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-A Managed Database for MongoDB instance is composed of one or multiple dedicated compute nodes running a single database engine.
+A Managed Database for MongoDB® Database Instance is composed of one or multiple dedicated compute nodes running a single database engine.
 
 USAGE:
   scw mongodb instance <command>
 
 AVAILABLE COMMANDS:
-  create          Create a MongoDB™ Database Instance
-  delete          Delete a MongoDB™ Database Instance
-  get             Get a MongoDB™ Database Instance
+  create          Create a MongoDB® Database Instance
+  delete          Delete a MongoDB® Database Instance
+  get             Get a MongoDB® Database Instance
   get-certificate Get the certificate of a Database Instance
-  list            List MongoDB™ Database Instances
-  update          Update a MongoDB™ Database Instance
+  list            List MongoDB® Database Instances
+  update          Update a MongoDB® Database Instance
   upgrade         Upgrade a Database Instance
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-node-type-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-node-type-usage.golden
@@ -1,6 +1,9 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Node types powering your instance.
+Two node type ranges are available:
+
+* **Cost-Optimized:** a complete and highly reliable node range with shared resources that is made for scaling from development to production needs, at affordable prices.
+* **Production-Optimized:** database nodes with dedicated vCPU for the most demanding workloads and mission-critical applications.
 
 USAGE:
   scw mongodb node-type <command>
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-snapshot-delete-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-snapshot-delete-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete a given snapshot of a Database Instance. You must specify, in the endpoint,  the `snapshot_id` parameter of the snapshot you want to delete.
+Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete.
 
 USAGE:
   scw mongodb snapshot delete <snapshot-id ...> [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-snapshot-list-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-snapshot-list-usage.golden
@@ -7,7 +7,7 @@ USAGE:
 
 ARGS:
   [instance-id]       Instance ID the snapshots belongs to
-  [name]              Lists Database snapshots that match a name pattern
+  [name]              Lists database snapshots that match a name pattern
   [order-by]          Criteria to use when ordering snapshot listings (created_at_asc | created_at_desc | name_asc | name_desc | expires_at_asc | expires_at_desc)
   [project-id]        Project ID to list the snapshots of
   [organization-id]   Organization ID the snapshots belongs to
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-snapshot-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-snapshot-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Snapshots of your instance.
+A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time.
 
 USAGE:
   scw mongodb snapshot <command>
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-This API allows you to manage your Managed Databases for MongoDB.
+This API allows you to manage your Managed Databases for MongoDB®.
 
 USAGE:
   scw mongodb <command>
@@ -10,7 +10,7 @@ AVAILABLE COMMANDS:
   node-type   Node types management commands
   snapshot    Snapshot management commands
   user        User management commands
-  version     MongoDB™ version management commands
+  version     MongoDB® version management commands
 
 FLAGS:
   -h, --help   help for mongodb
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-version-list-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-version-list-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List available MongoDB™ versions.
+List available MongoDB® versions.
 
 USAGE:
   scw mongodb version list [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-mongodb-version-usage.golden b/cmd/scw/testdata/test-all-usage-mongodb-version-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-MongoDB™ versions powering your instance.
+A database engine is the core software that handles the storage, retrieval, and management of data in your Database Instance.
 
 USAGE:
   scw mongodb version <command>
 
 AVAILABLE COMMANDS:
-  list        List available MongoDB™ versions
+  list        List available MongoDB® versions
 
 FLAGS:
   -h, --help   help for version
diff --git a/cmd/scw/testdata/test-main-usage-usage.golden b/cmd/scw/testdata/test-main-usage-usage.golden
@@ -29,7 +29,7 @@ AVAILABLE COMMANDS:
   lb            This API allows you to manage your Scaleway Load Balancer services
   marketplace   This API allows you to find available images for use when launching a Scaleway Instance
   mnq           These APIs allow you to manage your Messaging and Queuing NATS, SQS and SNS services
-  mongodb       This API allows you to manage your Managed Databases for MongoDB
+  mongodb       This API allows you to manage your Managed Databases for MongoDB®
   object        Object-storage utils
   rdb           This API allows you to manage your Managed Databases for PostgreSQL and MySQL
   redis         This API allows you to manage your Managed Databases for Redis™
diff --git a/docs/commands/mongodb.md b/docs/commands/mongodb.md
@@ -1,14 +1,14 @@
 <!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
 # Documentation for `scw mongodb`
-This API allows you to manage your Managed Databases for MongoDB.
+This API allows you to manage your Managed Databases for MongoDB®.
   
 - [Instance management commands](#instance-management-commands)
-  - [Create a MongoDB™ Database Instance](#create-a-mongodb™-database-instance)
-  - [Delete a MongoDB™ Database Instance](#delete-a-mongodb™-database-instance)
-  - [Get a MongoDB™ Database Instance](#get-a-mongodb™-database-instance)
+  - [Create a MongoDB® Database Instance](#create-a-mongodb®-database-instance)
+  - [Delete a MongoDB® Database Instance](#delete-a-mongodb®-database-instance)
+  - [Get a MongoDB® Database Instance](#get-a-mongodb®-database-instance)
   - [Get the certificate of a Database Instance](#get-the-certificate-of-a-database-instance)
-  - [List MongoDB™ Database Instances](#list-mongodb™-database-instances)
-  - [Update a MongoDB™ Database Instance](#update-a-mongodb™-database-instance)
+  - [List MongoDB® Database Instances](#list-mongodb®-database-instances)
+  - [Update a MongoDB® Database Instance](#update-a-mongodb®-database-instance)
   - [Upgrade a Database Instance](#upgrade-a-database-instance)
 - [Node types management commands](#node-types-management-commands)
   - [List available node types](#list-available-node-types)
@@ -22,18 +22,18 @@ This API allows you to manage your Managed Databases for MongoDB.
 - [User management commands](#user-management-commands)
   - [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)
-- [MongoDB™ version management commands](#mongodb™-version-management-commands)
-  - [List available MongoDB™ versions](#list-available-mongodb™-versions)
+- [MongoDB® version management commands](#mongodb®-version-management-commands)
+  - [List available MongoDB® versions](#list-available-mongodb®-versions)
 
   
 ## Instance management commands
 
-A Managed Database for MongoDB instance is composed of one or multiple dedicated compute nodes running a single database engine.
+A Managed Database for MongoDB® Database Instance is composed of one or multiple dedicated compute nodes running a single database engine.
 
 
-### Create a MongoDB™ Database Instance
+### Create a MongoDB® Database Instance
 
-Create a new MongoDB™ Database Instance.
+Create a new MongoDB® Database Instance.
 
 **Usage:**
 
@@ -48,22 +48,22 @@ scw mongodb instance create [arg=value ...]
 |------|---|-------------|
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
 | name | Default: `<generated>` | Name of the Database Instance |
-| version | Required | Version of the MongoDB™ engine |
+| version | Required | Version of the MongoDB® engine |
 | tags.{index} |  | Tags to apply to the Database Instance |
 | node-number | Required | Number of node to use for the Database Instance |
 | node-type | Required | Type of node to use for the Database Instance |
 | user-name | Required | Username created when the Database Instance is created |
 | password | Required | Password of the initial user |
 | volume.volume-size |  | Volume size |
 | volume.volume-type | One of: `unknown_type`, `sbs_5k`, `sbs_15k` | Type of volume where data is stored |
-| endpoints.{index}.private-network.private-network-id |  | UUID of the private network |
+| endpoints.{index}.private-network.private-network-id |  | UUID of the Private Network |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
 
-### Delete a MongoDB™ Database Instance
+### Delete a MongoDB® Database Instance
 
-Delete a given MongoDB™ Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB™ Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
+Delete a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
 
 **Usage:**
 
@@ -81,9 +81,9 @@ scw mongodb instance delete <instance-id ...> [arg=value ...]
 
 
 
-### Get a MongoDB™ Database Instance
+### Get a MongoDB® Database Instance
 
-Retrieve information about a given MongoDB™ 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.
+Retrieve information about a given MongoDB® 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:**
 
@@ -121,9 +121,9 @@ scw mongodb instance get-certificate <instance-id ...> [arg=value ...]
 
 
 
-### List MongoDB™ Database Instances
+### List MongoDB® Database Instances
 
-List all MongoDB™ Database Instances in the specified region, for a given Scaleway Project. By default, the MongoDB™ Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
+List all MongoDB® Database Instances in the specified region. By default, the MongoDB® 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:**
 
@@ -139,15 +139,15 @@ scw mongodb instance list [arg=value ...]
 | 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`, `status_asc`, `status_desc` | Criteria to use when ordering Database Instance listings |
-| project-id |  | Project ID to list the Database Instance of |
-| organization-id |  | Organization ID the Database Instance belongs to |
+| project-id |  | Project ID |
+| organization-id |  | Organization ID of the Database Instance |
 | region | Default: `fr-par`<br />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 MongoDB™ Database Instance
+### Update a MongoDB® Database Instance
 
-Update the parameters of a MongoDB™ Database Instance.
+Update the parameters of a MongoDB® Database Instance.
 
 **Usage:**
 
@@ -183,14 +183,17 @@ scw mongodb instance upgrade <instance-id ...> [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | instance-id | Required | UUID of the Database Instance you want to upgrade |
-| volume-size |  | Increase your block storage volume size |
+| volume-size |  | Increase your Block Storage volume size |
 | region | Default: `fr-par`<br />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:
+
+* **Cost-Optimized:** a complete and highly reliable node range with shared resources that is made for scaling from development to production needs, at affordable prices.
+* **Production-Optimized:** database nodes with dedicated vCPU for the most demanding workloads and mission-critical applications.
 
 
 ### List available node types
@@ -215,7 +218,7 @@ scw mongodb node-type list [arg=value ...]
 
 ## Snapshot management commands
 
-Snapshots of your instance.
+A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time.
 
 
 ### Create a Database Instance snapshot
@@ -242,7 +245,7 @@ scw mongodb snapshot create <instance-id ...> [arg=value ...]
 
 ### Delete a Database Instance snapshot
 
-Delete a given snapshot of a Database Instance. You must specify, in the endpoint,  the `snapshot_id` parameter of the snapshot you want to delete.
+Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete.
 
 **Usage:**
 
@@ -296,7 +299,7 @@ scw mongodb snapshot list [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | instance-id |  | Instance ID the snapshots belongs to |
-| name |  | Lists Database snapshots that match a name pattern |
+| name |  | Lists database snapshots that match a name pattern |
 | 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 listings |
 | project-id |  | Project ID to list the snapshots of |
 | organization-id |  | Organization ID the snapshots belongs to |
@@ -399,14 +402,14 @@ scw mongodb user update [arg=value ...]
 
 
 
-## MongoDB™ version management commands
+## MongoDB® version management commands
 
-MongoDB™ versions powering your instance.
+A database engine is the core software that handles the storage, retrieval, and management of data in your Database Instance.
 
 
-### List available MongoDB™ versions
+### List available MongoDB® versions
 
-List available MongoDB™ versions.
+List available MongoDB® versions.
 
 **Usage:**
 
diff --git a/internal/namespaces/mongodb/v1alpha1/mongodb_cli.go b/internal/namespaces/mongodb/v1alpha1/mongodb_cli.go
