Skip to content

Commit 7392176

Browse files
yfodilyfodil
committed
bump docs
1 parent 0f013d4 commit 7392176

11 files changed

+143
-18
lines changed

‎cmd/scw/testdata/test-all-usage-datalab-cluster-version-list-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+
List datalab resources.
4+
5+
USAGE:
6+
scw datalab cluster-version list [arg=value ...]
7+
8+
ARGS:
9+
[order-by] The order by field. (name_asc | name_desc)
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)
11+
12+
FLAGS:
13+
-h, --help help for list
14+
--list-sub-commands List all subcommands
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-datalab-cluster-version-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+
Lists the Spark versions available for Data Lab creation.
4+
5+
USAGE:
6+
scw datalab cluster-version <command>
7+
8+
AVAILABLE COMMANDS:
9+
list List datalab resources
10+
11+
FLAGS:
12+
-h, --help help for cluster-version
13+
--list-sub-commands List all subcommands
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
20+
21+
Use "scw datalab cluster-version [command] --help" for more information about a command.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ ARGS:
1313
[main.node-type]
1414
[worker.node-type]
1515
[worker.node-count]
16-
[has-notebook] Whether a JupyterLab notebook shall be created with the Data Lab or not.
16+
[has-notebook] Select this option to include a notebook as part of the Data Lab.
1717
[spark-version] The version of Spark running inside the Data Lab, available options can be viewed at ListClusterVersions.
1818
[total-storage.type] (unknown_type | sbs_5k)
1919
[total-storage.size]
20-
[private-network-id] The private network to which the Data Lab is connected. Important for accessing the Spark Master URL from a private cluster.
20+
[private-network-id] The unique identifier of the private network the Data Lab will be attached to.
2121
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
2222

2323
FLAGS:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ARGS:
99
datalab-id The unique identifier of the Data Lab.
1010
[name] The updated name of the Data Lab.
1111
[description] The updated description of the Data Lab.
12-
[tags.{index}] The updated tags of the Data Lab
12+
[tags.{index}] The updated tags of the Data Lab.
1313
[node-count] The updated node count of the Data Lab. Scale up or down the number of worker nodes.
1414
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1515

‎cmd/scw/testdata/test-all-usage-datalab-datalab-usage.golden‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Manage your Datalab.
3+
Manage your Data Labs.
44

55
USAGE:
66
scw datalab datalab <command>

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
List datalab resources.
4+
5+
USAGE:
6+
scw datalab node-type list [arg=value ...]
7+
8+
ARGS:
9+
[order-by] The order by field. Available fields are `name_asc`, `name_desc`, `vcpus_asc`, `vcpus_desc`, `memory_gigabytes_asc`, `memory_gigabytes_desc`, `vram_bytes_asc`, `vram_bytes_desc`, `gpus_asc`, `gpus_desc`. (name_asc | name_desc | vcpus_asc | vcpus_desc | memory_gigabytes_asc | memory_gigabytes_desc | vram_bytes_asc | vram_bytes_desc | gpus_asc | gpus_desc)
10+
[targets.{index}] Filter based on the target of the nodes. Allows to filter the nodes based on their purpose which can be main or worker node. (unknown_target | notebook | worker)
11+
[resource-type] Filter based on node type ( `cpu`/`gpu`/`all` ). (all | gpu | cpu)
12+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)
13+
14+
FLAGS:
15+
-h, --help help for list
16+
--list-sub-commands List all subcommands
17+
18+
GLOBAL FLAGS:
19+
-c, --config string The path to the config file
20+
-D, --debug Enable debug mode
21+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
22+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-datalab-node-type-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+
List available node types.
4+
5+
USAGE:
6+
scw datalab node-type <command>
7+
8+
AVAILABLE COMMANDS:
9+
list List datalab resources
10+
11+
FLAGS:
12+
-h, --help help for node-type
13+
--list-sub-commands List all subcommands
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
20+
21+
Use "scw datalab node-type [command] --help" for more information about a command.

‎cmd/scw/testdata/test-all-usage-datalab-notebook-version-list-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+
List datalab resources.
4+
5+
USAGE:
6+
scw datalab notebook-version list [arg=value ...]
7+
8+
ARGS:
9+
[order-by] The order by field. Available options are `name_asc` and `name_desc`. (name_asc | name_desc)
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)
11+
12+
FLAGS:
13+
-h, --help help for list
14+
--list-sub-commands List all subcommands
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-datalab-notebook-version-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+
List available notebook versions.
4+
5+
USAGE:
6+
scw datalab notebook-version <command>
7+
8+
AVAILABLE COMMANDS:
9+
list List datalab resources
10+
11+
FLAGS:
12+
-h, --help help for notebook-version
13+
--list-sub-commands List all subcommands
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
20+
21+
Use "scw datalab notebook-version [command] --help" for more information about a command.

‎cmd/scw/testdata/test-all-usage-datalab-usage.golden‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ USAGE:
66
scw datalab <command>
77

88
AVAILABLE COMMANDS:
9-
cluster-versions
10-
datalab
11-
node-types
12-
notebook-versions
9+
cluster-version
10+
datalab
11+
node-type
12+
notebook-version
1313

1414
FLAGS:
1515
-h, --help help for datalab

0 commit comments

Comments
 (0)