Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List datalab resources.

USAGE:
scw datalab cluster-version list [arg=value ...]

ARGS:
[order-by] The order by field. (name_asc | name_desc)
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)

FLAGS:
-h, --help help for list
--list-sub-commands List all subcommands

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Lists the Spark versions available for Data Lab creation.

USAGE:
scw datalab cluster-version <command>

AVAILABLE COMMANDS:
list List datalab resources

FLAGS:
-h, --help help for cluster-version
--list-sub-commands List all subcommands

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use

Use "scw datalab cluster-version [command] --help" for more information about a command.
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ ARGS:
[main.node-type]
[worker.node-type]
[worker.node-count]
[has-notebook] Whether a JupyterLab notebook shall be created with the Data Lab or not.
[has-notebook] Select this option to include a notebook as part of the Data Lab.
[spark-version] The version of Spark running inside the Data Lab, available options can be viewed at ListClusterVersions.
[total-storage.type] (unknown_type | sbs_5k)
[total-storage.size]
[private-network-id] The private network to which the Data Lab is connected. Important for accessing the Spark Master URL from a private cluster.
[private-network-id] The unique identifier of the private network the Data Lab will be attached to.
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ARGS:
datalab-id The unique identifier of the Data Lab.
[name] The updated name of the Data Lab.
[description] The updated description of the Data Lab.
[tags.{index}] The updated tags of the Data Lab
[tags.{index}] The updated tags of the Data Lab.
[node-count] The updated node count of the Data Lab. Scale up or down the number of worker nodes.
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Manage your Datalab.
Manage your Data Labs.

USAGE:
scw datalab datalab <command>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List datalab resources.

USAGE:
scw datalab node-type list [arg=value ...]

ARGS:
[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)
[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)
[resource-type] Filter based on node type ( `cpu`/`gpu`/`all` ). (all | gpu | cpu)
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)

FLAGS:
-h, --help help for list
--list-sub-commands List all subcommands

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
21 changes: 21 additions & 0 deletions cmd/scw/testdata/test-all-usage-datalab-node-type-usage.golden
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List available node types.

USAGE:
scw datalab node-type <command>

AVAILABLE COMMANDS:
list List datalab resources

FLAGS:
-h, --help help for node-type
--list-sub-commands List all subcommands

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use

Use "scw datalab node-type [command] --help" for more information about a command.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List datalab resources.

USAGE:
scw datalab notebook-version list [arg=value ...]

ARGS:
[order-by] The order by field. Available options are `name_asc` and `name_desc`. (name_asc | name_desc)
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)

FLAGS:
-h, --help help for list
--list-sub-commands List all subcommands

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List available notebook versions.

USAGE:
scw datalab notebook-version <command>

AVAILABLE COMMANDS:
list List datalab resources

FLAGS:
-h, --help help for notebook-version
--list-sub-commands List all subcommands

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use

Use "scw datalab notebook-version [command] --help" for more information about a command.
8 changes: 4 additions & 4 deletions cmd/scw/testdata/test-all-usage-datalab-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ USAGE:
scw datalab <command>

AVAILABLE COMMANDS:
cluster-versions
datalab
node-types
notebook-versions
cluster-version
datalab
node-type
notebook-version

FLAGS:
-h, --help help for datalab
Expand Down
20 changes: 10 additions & 10 deletions docs/commands/datalab.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ List datalab resources.
**Usage:**

```
scw datalab cluster-versions list [arg=value ...]
scw datalab cluster-version list [arg=value ...]
```


Expand All @@ -43,7 +43,7 @@ scw datalab cluster-versions list [arg=value ...]

##

Manage your Datalab.
Manage your Data Labs.


### Create datalab resources
Expand All @@ -68,11 +68,11 @@ scw datalab datalab create [arg=value ...]
| main.node-type | | |
| worker.node-type | | |
| worker.node-count | | |
| has-notebook | | Whether a JupyterLab notebook shall be created with the Data Lab or not. |
| has-notebook | | Select this option to include a notebook as part of the Data Lab. |
| spark-version | | The version of Spark running inside the Data Lab, available options can be viewed at ListClusterVersions. |
| total-storage.type | One of: `unknown_type`, `sbs_5k` | |
| total-storage.size | | |
| private-network-id | | The private network to which the Data Lab is connected. Important for accessing the Spark Master URL from a private cluster. |
| private-network-id | | The unique identifier of the private network the Data Lab will be attached to. |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -159,15 +159,15 @@ scw datalab datalab update [arg=value ...]
| datalab-id | Required | The unique identifier of the Data Lab. |
| name | | The updated name of the Data Lab. |
| description | | The updated description of the Data Lab. |
| tags.{index} | | The updated tags of the Data Lab |
| tags.{index} | | The updated tags of the Data Lab. |
| node-count | | The updated node count of the Data Lab. Scale up or down the number of worker nodes. |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



##

List available node types. These are the possible compute units that can host the Spark cluster.
List available node types.


### List datalab resources
Expand All @@ -177,7 +177,7 @@ List datalab resources.
**Usage:**

```
scw datalab node-types list [arg=value ...]
scw datalab node-type list [arg=value ...]
```


Expand All @@ -186,15 +186,15 @@ scw datalab node-types list [arg=value ...]
| Name | | Description |
|------|---|-------------|
| order-by | One of: `name_asc`, `name_desc`, `vcpus_asc`, `vcpus_desc`, `memory_gigabytes_asc`, `memory_gigabytes_desc`, `vram_bytes_asc`, `vram_bytes_desc`, `gpus_asc`, `gpus_desc` | 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`. |
| targets.{index} | One of: `unknown_target`, `notebook`, `worker` | Filter on the wanted targets, whether it's for main node or worker. |
| targets.{index} | One of: `unknown_target`, `notebook`, `worker` | Filter based on the target of the nodes. Allows to filter the nodes based on their purpose which can be main or worker node. |
| resource-type | One of: `all`, `gpu`, `cpu` | Filter based on node type ( `cpu`/`gpu`/`all` ). |
| region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |



##

List available notebook versions. Currently it includes JupyterLab.
List available notebook versions.


### List datalab resources
Expand All @@ -204,7 +204,7 @@ List datalab resources.
**Usage:**

```
scw datalab notebook-versions list [arg=value ...]
scw datalab notebook-version list [arg=value ...]
```


Expand Down
Loading
Loading