admin
Last updated
Last updated
Cluster administration commands
Cluster administration commands.
Commands:
| Usage | Description |
|---|---|
Create a new cluster
Create a new cluster.
Creates cluster entry on admin side and then start its provisioning using provided config.
Add user access to specified cluster
Add user access to specified cluster.
The command supports one of 3 user roles: admin, manager or user.
Create a new org
Create a new org.
Add org access to specified cluster
Add org access to specified cluster.
Add given values to org cluster balance
Add given values to org cluster balance
Add user access to specified org
Add user access to specified org.
The command supports one of 3 user roles: admin, manager or user.
Add new project to specified cluster
Add new project to specified cluster.
Add user access to specified project
Add user access to specified project.
The command supports one of 4 user roles: reader, writer, manager or admin.
Add new resource preset
Add new resource preset
Add given values to user quota
Add given values to user quota
Create a cluster configuration file
Create a cluster configuration file.
Print the list of all orgs in the cluster
Print the list of all orgs in the cluster
List users in specified cluster
List users in specified cluster
Print the list of available clusters
Print the list of available clusters.
Get info about org quota in given cluster
Get info about org quota in given cluster
List users in specified org
List users in specified org
Print the list of available orgs
Print the list of available orgs.
List users in specified project
List users in specified project
Print the list of all projects in the cluster
Print the list of all projects in the cluster
Get info about user quota in given cluster
Get info about user quota in given cluster
Drop a cluster
Drop a cluster
Completely removes cluster from the system.
Remove user access from the cluster
Remove user access from the cluster.
Drop an org
Drop an org
Completely removes org from the system.
Drop an org cluster
Drop an org cluster
Completely removes org from the cluster.
Remove user access from the org
Remove user access from the org.
Drop a project
Drop a project
Completely removes project from the cluster.
Remove user access from the project
Remove user access from the project.
Remove resource preset
Remove resource preset
Set org cluster credits to given value
Set org cluster credits to given value
Set org cluster defaults to given value
Set org cluster defaults to given value
Set org cluster quota to given values
Set org cluster quota to given values
Set user credits to given value
Set user credits to given value
Set user quota to given values
Set user quota to given values
Show available cluster options
Show available cluster options.
Update a cluster
Update a cluster.
Update cluster node pool
Update cluster node pool.
Update org cluster quotas
Update org cluster quotas.
Update project settings
Update project settings.
Update user access to specified project
Update user access to specified project.
The command supports one of 4 user roles: reader, writer, manager or admin.
Update existing resource preset
Update existing resource preset
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
Create a new cluster
Add user access to specified cluster
Create a new org
Add org access to specified cluster
Add given values to org cluster balance
Add user access to specified org
Add new project to specified cluster
Add user access to specified project
Add new resource preset
Add given values to user quota
Create a cluster configuration file
Print the list of all orgs in the cluster
List users in specified cluster
Print the list of available clusters
Get info about org quota in given cluster
List users in specified org
Print the list of available orgs
List users in specified project
Print the list of all projects in the cluster
Get info about user quota in given cluster
Drop a cluster
Remove user access from the cluster
Drop an org
Drop an org cluster
Remove user access from the org
Drop a project
Remove user access from the project
Remove resource preset
Set org cluster credits to given value
Set org cluster defaults to given value
Set org cluster quota to given values
Set user credits to given value
Set user quota to given values
Show available cluster options
Update a cluster
Update cluster node pool
Update org cluster quotas
Update project settings
Update user access to specified project
Update existing resource preset
--help
Show this message and exit.
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to cluster [default: user]
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit)
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit)
--org ORG
org name for org-cluster users
--help
Show this message and exit.
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to org cluster [default: user]
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--storage-size AMOUNT
Storage size, ignored for storage types with elastic storage size
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to add
--help
Show this message and exit.
--help
Show this message and exit.
--default
Is this project is default, e.g. new cluster users will be automatically added to it
--default-role [ROLE]
Default role for new users added to project [default: writer]
--org ORG
org name for org-cluster projects
--help
Show this message and exit.
--org ORG
org name for org-cluster projects
--help
Show this message and exit.
--amd-gpu NUMBER
Number of AMD GPUs
--amd-gpu-model GPU_MODEL_FREE_TEXT
AMD GPU model
-c, --cpu NUMBER
Number of CPUs [default: 0.1]
--credits-per-hour AMOUNT
Price of running job of this preset for an hour in credits [default: 0]
--intel-gpu NUMBER
Number of Intel GPUs
--intel-gpu-model GPU_MODEL_FREE_TEXT
Intel GPU model
-m, --memory AMOUNT
Memory amount [default: 1GB]
-g, --nvidia-gpu NUMBER
Number of Nvidia GPUs
--nvidia-gpu-model GPU_MODEL_FREE_TEXT
Nvidia GPU model
--preemptible-node / --non-preemptible-node
Use a lower-cost preemptible instance [default: non-preemptible-node]
-r, --resource-pool TEXT
Name of the resource pool where job will be scheduled (multiple values are supported)
-p, --scheduler / -P, --no-scheduler
Use round robin scheduler for jobs [default: no-scheduler]
--tpu-sw-version VERSION
TPU software version
--tpu-type TYPE
TPU type
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to add [required]
--org ORG
org name for org-cluster users
--help
Show this message and exit.
--type [aws | gcp | azure | vcd]
--help
Show this message and exit.
--help
Show this message and exit.
--details / --no-details
Include detailed user info
--org ORG
org name for org-cluster users
--help
Show this message and exit.
--help
Show this message and exit.
--help
Show this message and exit.
--help
Show this message and exit.
--help
Show this message and exit.
--org ORG
org name for org-cluster projects
--help
Show this message and exit.
--org ORG
org name for org-cluster projects
--help
Show this message and exit.
--org ORG
org name for org-cluster users
--help
Show this message and exit.
--force
Skip prompt
--help
Show this message and exit.
--org ORG
org name for org-cluster users
--help
Show this message and exit.
--force
Skip prompt
--help
Show this message and exit.
--force
Skip prompt
--help
Show this message and exit.
--help
Show this message and exit.
--force
Skip prompt
--org ORG
org name for org-cluster projects
--help
Show this message and exit.
--org ORG
org name for org-cluster projects
--help
Show this message and exit.
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit) [required]
--help
Show this message and exit.
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to org cluster [default: user]
--help
Show this message and exit.
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit) [required]
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit) [required]
--org ORG
org name for org-cluster users
--help
Show this message and exit.
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit) [required]
--org ORG
org name for org-cluster users
--help
Show this message and exit.
--type [aws | gcp | azure]
--help
Show this message and exit.
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to cluster [default: user]
--help
Show this message and exit.
--org ORG
org name for org-cluster users
--help
Show this message and exit.
--idle-size NUMBER
Number of idle nodes in the node pool.
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to org cluster [default: user]
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--help
Show this message and exit.
--default
Is this project is default, e.g. new cluster users will be automatically added to it
--default-role [ROLE]
Default role for new users added to project [default: writer]
--org ORG
org name for org-cluster projects
--help
Show this message and exit.
--org ORG
org name for org-cluster projects
--help
Show this message and exit.
--amd-gpu NUMBER
Number of AMD GPUs
--amd-gpu-model GPU_MODEL_FREE_TEXT
AMD GPU model
-c, --cpu NUMBER
Number of CPUs
--credits-per-hour AMOUNT
Price of running job of this preset for an hour in credits
--intel-gpu NUMBER
Number of Intel GPUs
--intel-gpu-model GPU_MODEL_FREE_TEXT
Intel GPU model
-m, --memory AMOUNT
Memory amount
-g, --nvidia-gpu NUMBER
Number of Nvidia GPUs
--nvidia-gpu-model GPU_MODEL_FREE_TEXT
Nvidia GPU model
--preemptible-node / --non-preemptible-node
Use a lower-cost preemptible instance
-r, --resource-pool TEXT
Name of the resource pool where job will be scheduled (multiple values are supported)
-p, --scheduler / -P, --no-scheduler
Use round robin scheduler for jobs
--tpu-sw-version VERSION
TPU software version
--tpu-type TYPE
TPU type