admin
Cluster administration commands
neuro admin [OPTIONS] COMMAND [ARGS]...
Cluster administration commands.
Commands:
Usage | 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 |
Create a new cluster
neuro admin add-cluster [OPTIONS] CLUSTER_NAME CONFIG
Create a new cluster.
Creates cluster entry on admin side and then start its provisioning using provided config.
Name | Description |
---|---|
--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] |
Add user access to specified cluster
neuro admin add-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME [ROLE]
Add user access to specified cluster.
The command supports one of 3 user roles: admin, manager or user.
Name | Description |
---|---|
--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 |
Create a new org
neuro admin add-org [OPTIONS] ORG_NAME
Create a new org.
Name | Description |
---|---|
--help | Show this message and exit. |
Add org access to specified cluster
neuro admin add-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME
Add org access to specified cluster.
Name | Description |
---|---|
--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 |
Add given values to org cluster balance
neuro admin add-org-cluster-credits [OPTIONS] CLUSTER_NAME ORG_NAME
Add given values to org cluster balance
Name | Description |
---|---|
--help | Show this message and exit. |
-c, --credits AMOUNT | Credits amount to add |
Add user access to specified org
neuro admin add-org-user [OPTIONS] ORG_NAME USER_NAME [ROLE]
Add user access to specified org.
The command supports one of 3 user roles: admin, manager or user.
Name | Description |
---|---|
--help | Show this message and exit. |
Add new project to specified cluster
neuro admin add-project [OPTIONS] CLUSTER_NAME NAME
Add new project to specified cluster.
Name | Description |
---|---|
--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 |
Add user access to specified project
neuro admin add-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME USER_NAME [ROLE]
Add user access to specified project.
The command supports one of 4 user roles: reader, writer, manager or admin.
Name | Description |
---|---|
--help | Show this message and exit. |
--org ORG | org name for org-cluster projects |
Add new resource preset
neuro admin add-resource-preset [OPTIONS] PRESET_NAME
Add new resource preset
Name | Description |
---|---|
--help | Show this message and exit. |
-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] |
-g, --gpu NUMBER | Number of GPUs |
--gpu-model MODEL | GPU model |
-m, --memory AMOUNT | Memory amount [default: 1GB] |
--preemptible-node / --non-preemptible-node | Use a lower-cost preemptible instance [default: non-preemptible-node] |
-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 |
Add given values to user quota
neuro admin add-user-credits [OPTIONS] CLUSTER_NAME USER_NAME
Add given values to user quota
Name | Description |
---|---|
--help | Show this message and exit. |
-c, --credits AMOUNT | Credits amount to add [required] |
--org ORG | org name for org-cluster users |
Create a cluster configuration file
neuro admin generate-cluster-config [OPTIONS] [CONFIG]
Create a cluster configuration file.
Name | Description |
---|---|
--help | Show this message and exit. |
--type [aws | gcp | azure | vcd] | ​ |
Print the list of all orgs in the cluster
neuro admin get-cluster-orgs [OPTIONS] CLUSTER_NAME
Print the list of all orgs in the cluster
Name | Description |
---|---|
--help | Show this message and exit. |
List users in specified cluster
neuro admin get-cluster-users [OPTIONS] [CLUSTER_NAME]
List users in specified cluster
Name | Description |
---|---|
--help | Show this message and exit. |
--details / --no-details | Include detailed user info |
--org ORG | org name for org-cluster users |
Print the list of available clusters
neuro admin get-clusters [OPTIONS]
Print the list of available clusters.
Name | Description |
---|---|
--help | Show this message and exit. |
Get info about org quota in given cluster
neuro admin get-org-cluster-quota [OPTIONS] CLUSTER_NAME ORG_NAME
Get info about org quota in given cluster
Name | Description |
---|---|
--help | Show this message and exit. |
List users in specified org
neuro admin get-org-users [OPTIONS] ORG_NAME
List users in specified org
Name | Description |
---|---|
--help | Show this message and exit. |
Print the list of available orgs
neuro admin get-orgs [OPTIONS]
Print the list of available orgs.
Name | Description |
---|---|
--help | Show this message and exit. |
List users in specified project
neuro admin get-project-users [OPTIONS] CLUSTER_NAME PROJECT_NAME
List users in specified project
Name | Description |
---|---|
--help | Show this message and exit. |
--org ORG | org name for org-cluster projects |
Print the list of all projects in the cluster
neuro admin get-projects [OPTIONS] CLUSTER_NAME
Print the list of all projects in the cluster
Name | Description |
---|---|
--help | Show this message and exit. |
--org ORG | org name for org-cluster projects |
Get info about user quota in given cluster
neuro admin get-user-quota [OPTIONS] CLUSTER_NAME USER_NAME
Get info about user quota in given cluster
Name | Description |
---|---|
--help | Show this message and exit. |
--org ORG | org name for org-cluster users |
Drop a cluster
neuro admin remove-cluster [OPTIONS] CLUSTER_NAME
Drop a cluster
Completely removes cluster from the system.
Name | Description |
---|---|
--help | Show this message and exit. |
--force | Skip prompt |
Remove user access from the cluster
neuro admin remove-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME
Remove user access from the cluster.
Name | Description |
---|---|
--help | Show this message and exit. |
--org ORG | org name for org-cluster users |
Drop an org
neuro admin remove-org [OPTIONS] ORG_NAME
Drop an org
Completely removes org from the system.
Name | Description |
---|---|
--help | Show this message and exit. |
--force | Skip prompt |
Drop an org cluster
neuro admin remove-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME
Drop an org cluster
Completely removes org from the cluster.
Name | Description |
---|---|
--help | Show this message and exit. |
--force | Skip prompt |
Remove user access from the org
neuro admin remove-org-user [OPTIONS] ORG_NAME USER_NAME
Remove user access from the org.
Name | Description |
---|---|
--help | Show this message and exit. |
Drop a project
neuro admin remove-project [OPTIONS] CLUSTER_NAME NAME
Drop a project
Completely removes project from the cluster.
Name | Description |
---|---|
--help | Show this message and exit. |
--force | Skip prompt |
--org ORG | org name for org-cluster projects |
Remove user access from the project
neuro admin remove-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME USER_NAME
Remove user access from the project.
Name | Description |
---|---|
--help | Show this message and exit. |
--org ORG | org name for org-cluster projects |
Remove resource preset
neuro admin remove-resource-preset [OPTIONS] PRESET_NAME
Remove resource preset
Name | Description |
---|---|
--help | Show this message and exit. |
Set org cluster credits to given value
neuro admin set-org-cluster-credits [OPTIONS] CLUSTER_NAME ORG_NAME
Set org cluster credits to given value
Name | Description |
---|---|
--help | Show this message and exit. |
-c, --credits AMOUNT | Credits amount to set (`unlimited' stands for no limit) [required] |
Set org cluster defaults to given value
neuro admin set-org-cluster-defaults [OPTIONS] CLUSTER_NAME ORG_NAME
Set org cluster defaults to given value
Name | Description |
---|---|
--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] |
Set org cluster quota to given values
neuro admin set-org-cluster-quota [OPTIONS] CLUSTER_NAME ORG_NAME
Set org cluster quota to given values
Name | Description |
---|---|
--help | Show this message and exit. |
-j, --jobs AMOUNT | Maximum running jobs quota (`unlimited' stands for no limit) [required] |
Set user credits to given value
neuro admin set-user-credits [OPTIONS] CLUSTER_NAME USER_NAME
Set user credits to given value
Name | Description |
---|---|
--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 |
Set user quota to given values
neuro admin set-user-quota [OPTIONS] CLUSTER_NAME USER_NAME
Set user quota to given values
Name | Description |
---|---|
--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 |
Show available cluster options
neuro admin show-cluster-options [OPTIONS]
Show available cluster options.