Skip to content

Commit 452b95a

Browse files
scaleway-botremyleone
scaleway-bot
and
remyleone
authored
feat(mongodb): add support for CLI generation (#4203)
Co-authored-by: Rémy Léone <[email protected]>
1 parent 7ae177a commit 452b95a

31 files changed

+1377
-3
lines changed

‎cmd/scw/testdata/test-all-usage-mongodb-instance-create-usage.golden

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Create a new MongoDB™ Database Instance.
4+
5+
USAGE:
6+
scw mongodb instance create [arg=value ...]
7+
8+
ARGS:
9+
[project-id] Project ID to use. If none is passed the default project ID will be used
10+
[name] Name of the Database Instance
11+
version Version of the MongoDB™ engine
12+
[tags.{index}] Tags to apply to the Database Instance
13+
node-number Number of node to use for the Database Instance
14+
node-type Type of node to use for the Database Instance
15+
user-name Username created when the Database Instance is created
16+
password Password of the initial user
17+
[volume.volume-size] Volume size
18+
[volume.volume-type] Type of volume where data is stored (unknown_type | sbs_5k | sbs_15k)
19+
[endpoints.{index}.private-network.private-network-id] UUID of the private network
20+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
21+
22+
FLAGS:
23+
-h, --help help for create
24+
25+
GLOBAL FLAGS:
26+
-c, --config string The path to the config file
27+
-D, --debug Enable debug mode
28+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
29+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-mongodb-instance-delete-usage.golden

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
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.
4+
5+
USAGE:
6+
scw mongodb instance delete <instance-id ...> [arg=value ...]
7+
8+
ARGS:
9+
instance-id UUID of the Database Instance to delete
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for delete
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-mongodb-instance-get-certificate-usage.golden

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Retrieve the certificate of a given Database Instance, specified by the `instance_id` parameter.
4+
5+
USAGE:
6+
scw mongodb instance get-certificate <instance-id ...> [arg=value ...]
7+
8+
ARGS:
9+
instance-id UUID of the Database Instance
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for get-certificate
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-mongodb-instance-get-usage.golden

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Retrieve 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.
4+
5+
USAGE:
6+
scw mongodb instance get <instance-id ...> [arg=value ...]
7+
8+
ARGS:
9+
instance-id UUID of the Database Instance
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
11+
12+
FLAGS:
13+
-h, --help help for get
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-mongodb-instance-list-usage.golden

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
List all 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.
4+
5+
USAGE:
6+
scw mongodb instance list [arg=value ...]
7+
8+
ARGS:
9+
[tags.{index}] List Database Instances that have a given tag
10+
[name] Lists Database Instances that match a name pattern
11+
[order-by] Criteria to use when ordering Database Instance listings (created_at_asc | created_at_desc | name_asc | name_desc | status_asc | status_desc)
12+
[project-id] Project ID to list the Database Instance of
13+
[organization-id] Organization ID the Database Instance belongs to
14+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
15+
16+
FLAGS:
17+
-h, --help help for list
18+
19+
GLOBAL FLAGS:
20+
-c, --config string The path to the config file
21+
-D, --debug Enable debug mode
22+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
23+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-mongodb-instance-update-usage.golden

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Update the parameters of a MongoDB™ Database Instance.
4+
5+
USAGE:
6+
scw mongodb instance update <instance-id ...> [arg=value ...]
7+
8+
ARGS:
9+
instance-id UUID of the Database Instance to update
10+
[name] Name of the Database Instance
11+
[tags.{index}] Tags of a Database Instance
12+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
13+
14+
FLAGS:
15+
-h, --help help for update
16+
17+
GLOBAL FLAGS:
18+
-c, --config string The path to the config file
19+
-D, --debug Enable debug mode
20+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
21+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-mongodb-instance-upgrade-usage.golden

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Upgrade your current Database Instance specifications like volume size.
4+
5+
USAGE:
6+
scw mongodb instance upgrade <instance-id ...> [arg=value ...]
7+
8+
ARGS:
9+
instance-id UUID of the Database Instance you want to upgrade
10+
[volume-size] Increase your block storage volume size
11+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
12+
13+
FLAGS:
14+
-h, --help help for upgrade
15+
16+
GLOBAL FLAGS:
17+
-c, --config string The path to the config file
18+
-D, --debug Enable debug mode
19+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
20+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-mongodb-instance-usage.golden

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
A Managed Database for MongoDB instance is composed of one or multiple dedicated compute nodes running a single database engine.
4+
5+
USAGE:
6+
scw mongodb instance <command>
7+
8+
AVAILABLE COMMANDS:
9+
create Create a MongoDB™ Database Instance
10+
delete Delete a MongoDB™ Database Instance
11+
get Get a MongoDB™ Database Instance
12+
get-certificate Get the certificate of a Database Instance
13+
list List MongoDB™ Database Instances
14+
update Update a MongoDB™ Database Instance
15+
upgrade Upgrade a Database Instance
16+
17+
FLAGS:
18+
-h, --help help for instance
19+
20+
GLOBAL FLAGS:
21+
-c, --config string The path to the config file
22+
-D, --debug Enable debug mode
23+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
24+
-p, --profile string The config profile to use
25+
26+
Use "scw mongodb instance [command] --help" for more information about a command.

‎cmd/scw/testdata/test-all-usage-mongodb-node-type-list-usage.golden

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
List available node types.
4+
5+
USAGE:
6+
scw mongodb node-type list [arg=value ...]
7+
8+
ARGS:
9+
[include-disabled-types] Defines whether or not to include disabled types
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
11+
12+
FLAGS:
13+
-h, --help help for list
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-mongodb-node-type-usage.golden

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Node types powering your instance.
4+
5+
USAGE:
6+
scw mongodb node-type <command>
7+
8+
AVAILABLE COMMANDS:
9+
list List available node types
10+
11+
FLAGS:
12+
-h, --help help for node-type
13+
14+
GLOBAL FLAGS:
15+
-c, --config string The path to the config file
16+
-D, --debug Enable debug mode
17+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
18+
-p, --profile string The config profile to use
19+
20+
Use "scw mongodb node-type [command] --help" for more information about a command.

0 commit comments

Comments
 (0)