admin

Cluster administration commands

Usage

apolo admin [OPTIONS] COMMAND [ARGS]...

Cluster administration commands.

Commands:

Usage	Description
add-cluster	Create a new cluster
add-cluster-user	Add user access to specified cluster
add-org	Create a new org
add-org-cluster	Add org access to specified cluster
add-org-cluster-credits	Add given values to org cluster balance
add-org-user	Add user access to specified org
add-project	Add new project to specified cluster
add-project-user	Add user access to specified project
add-resource-preset	Add new resource preset
add-user-credits	Add given values to user quota
generate-cluster-config	Create a cluster configuration file
get-cluster-orgs	Print the list of all orgs in the cluster
get-cluster-users	List users in specified cluster
get-clusters	Print the list of available clusters
get-org-cluster-quota	Get info about org quota in given cluster
get-org-users	List users in specified org
get-orgs	Print the list of available orgs
get-project-users	List users in specified project
get-projects	Print the list of all projects in the cluster
get-user-quota	Get info about user quota in given cluster
remove-cluster	Drop a cluster
remove-cluster-user	Remove user access from the cluster
remove-org	Drop an org
remove-org-cluster	Drop an org cluster
remove-org-user	Remove user access from the org
remove-project	Drop a project
remove-project-user	Remove user access from the project
remove-resource-preset	Remove resource preset
set-org-cluster-credits	Set org cluster credits to given value
set-org-cluster-defaults	Set org cluster defaults to given value
set-org-cluster-quota	Set org cluster quota to given values
set-user-credits	Set user credits to given value
set-user-quota	Set user quota to given values
show-cluster-options	Show available cluster options
update-cluster	Update a cluster
update-cluster-user
update-node-pool	Update cluster node pool
update-org-cluster	Update org cluster quotas
update-project	Update project settings
update-project-user	Update user access to specified project
update-resource-preset	Update existing resource preset

add-cluster

Create a new cluster

Usage

apolo 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.

Options

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-cluster-user

Add user access to specified cluster

Usage

apolo 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.

Options

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

add-org

Create a new org

Usage

apolo admin add-org [OPTIONS] ORG_NAME

Create a new org.

Options

Name	Description
--help	Show this message and exit.

add-org-cluster

Add org access to specified cluster

Usage

apolo admin add-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME

Add org access to specified cluster.

Options

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-org-cluster-credits

Add given values to org cluster balance

Usage

apolo admin add-org-cluster-credits [OPTIONS] CLUSTER_NAME ORG_NAME

Add given values to org cluster balance

Options

Name	Description
--help	Show this message and exit.
-c, --credits AMOUNT	Credits amount to add

add-org-user

Add user access to specified org

Usage

apolo 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.

Options

Name	Description
--help	Show this message and exit.

add-project

Add new project to specified cluster

Usage

apolo admin add-project [OPTIONS] CLUSTER_NAME NAME

Add new project to specified cluster.

Options

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-project-user

Add user access to specified project

Usage

apolo 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.

Options

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

add-resource-preset

Add new resource preset

Usage

apolo admin add-resource-preset [OPTIONS] PRESET_NAME

Add new resource preset

Options

Name	Description
--help	Show this message and exit.
--amd-gpu NUMBER	Number of AMD GPUs
-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
-m, --memory AMOUNT	Memory amount [default: 1GB]
-g, --nvidia-gpu NUMBER	Number of Nvidia GPUs
--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

add-user-credits

Add given values to user quota

Usage

apolo admin add-user-credits [OPTIONS] CLUSTER_NAME USER_NAME

Add given values to user quota

Options

Name	Description
--help	Show this message and exit.
-c, --credits AMOUNT	Credits amount to add [required]
--org ORG	org name for org-cluster users

generate-cluster-config

Create a cluster configuration file

Usage

apolo admin generate-cluster-config [OPTIONS] [CONFIG]

Create a cluster configuration file.

Options

Name	Description
--help	Show this message and exit.
--type [aws | gcp | azure | vcd]

get-cluster-orgs

Print the list of all orgs in the cluster

Usage

apolo admin get-cluster-orgs [OPTIONS] CLUSTER_NAME

Print the list of all orgs in the cluster

Options

Name	Description
--help	Show this message and exit.

get-cluster-users

List users in specified cluster

Usage

apolo admin get-cluster-users [OPTIONS] [CLUSTER_NAME]

List users in specified cluster

Options

Name	Description
--help	Show this message and exit.
--details / --no-details	Include detailed user info
--org ORG	org name for org-cluster users

get-clusters

Print the list of available clusters

Usage

apolo admin get-clusters [OPTIONS]

Print the list of available clusters.

Options

Name	Description
--help	Show this message and exit.

get-org-cluster-quota

Get info about org quota in given cluster

Usage

apolo admin get-org-cluster-quota [OPTIONS] CLUSTER_NAME ORG_NAME

Get info about org quota in given cluster

Options

Name	Description
--help	Show this message and exit.

get-org-users

List users in specified org

Usage

apolo admin get-org-users [OPTIONS] ORG_NAME

List users in specified org

Options

Name	Description
--help	Show this message and exit.

get-orgs

Print the list of available orgs

Usage

apolo admin get-orgs [OPTIONS]

Print the list of available orgs.

Options

Name	Description
--help	Show this message and exit.

get-project-users

List users in specified project

Usage

apolo admin get-project-users [OPTIONS] CLUSTER_NAME PROJECT_NAME

List users in specified project

Options

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

get-projects

Print the list of all projects in the cluster

Usage

apolo admin get-projects [OPTIONS] CLUSTER_NAME

Print the list of all projects in the cluster

Options

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

get-user-quota

Get info about user quota in given cluster

Usage

apolo admin get-user-quota [OPTIONS] CLUSTER_NAME USER_NAME

Get info about user quota in given cluster

Options

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster users

remove-cluster

Drop a cluster

Usage

apolo admin remove-cluster [OPTIONS] CLUSTER_NAME

Drop a cluster

Completely removes cluster from the system.

Options

Name	Description
--help	Show this message and exit.
--force	Skip prompt

remove-cluster-user

Remove user access from the cluster

Usage

apolo admin remove-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME

Remove user access from the cluster.

Options

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster users

remove-org

Drop an org

Usage

apolo admin remove-org [OPTIONS] ORG_NAME

Drop an org

Completely removes org from the system.

Options

Name	Description
--help	Show this message and exit.
--force	Skip prompt

remove-org-cluster

Drop an org cluster

Usage

apolo admin remove-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME

Drop an org cluster

Completely removes org from the cluster.

Options

Name	Description
--help	Show this message and exit.
--force	Skip prompt

remove-org-user

Remove user access from the org

Usage

apolo admin remove-org-user [OPTIONS] ORG_NAME USER_NAME

Remove user access from the org.

Options

Name	Description
--help	Show this message and exit.

remove-project

Drop a project

Usage

apolo admin remove-project [OPTIONS] CLUSTER_NAME NAME

Drop a project

Completely removes project from the cluster.

Options

Name	Description
--help	Show this message and exit.
--force	Skip prompt
--org ORG	org name for org-cluster projects

remove-project-user

Remove user access from the project

Usage

apolo admin remove-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME USER_NAME

Remove user access from the project.

Options

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

remove-resource-preset

Remove resource preset

Usage

apolo admin remove-resource-preset [OPTIONS] PRESET_NAME

Remove resource preset

Options

Name	Description
--help	Show this message and exit.

set-org-cluster-credits

Set org cluster credits to given value

Usage

apolo admin set-org-cluster-credits [OPTIONS] CLUSTER_NAME ORG_NAME

Set org cluster credits to given value

Options

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

Set org cluster defaults to given value

Usage

apolo admin set-org-cluster-defaults [OPTIONS] CLUSTER_NAME ORG_NAME

Set org cluster defaults to given value

Options

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

Set org cluster quota to given values

Usage

apolo admin set-org-cluster-quota [OPTIONS] CLUSTER_NAME ORG_NAME

Set org cluster quota to given values

Options

Name	Description
--help	Show this message and exit.
-j, --jobs AMOUNT	Maximum running jobs quota (`unlimited' stands for no limit) [required]

set-user-credits

Set user credits to given value

Usage

apolo admin set-user-credits [OPTIONS] CLUSTER_NAME USER_NAME

Set user credits to given value

Options

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

Set user quota to given values

Usage

apolo admin set-user-quota [OPTIONS] CLUSTER_NAME USER_NAME

Set user quota to given values

Options

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-cluster-options

Show available cluster options

Usage

apolo admin show-cluster-options [OPTIONS]

Show available cluster options.

Options

Name	Description
--help	Show this message and exit.
--type [aws | gcp | azure]

update-cluster

Update a cluster

Usage

apolo admin update-cluster [OPTIONS] CLUSTER_NAME

Update a cluster.

Options

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]

update-cluster-user

Usage

apolo admin update-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME [ROLE]

Options

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster users

update-node-pool

Update cluster node pool

Usage

apolo admin update-node-pool [OPTIONS] CLUSTER_NAME NODE_POOL_NAME

Update cluster node pool.

Options

Name	Description
--help	Show this message and exit.
--idle-size NUMBER	Number of idle nodes in the node pool.

update-org-cluster

Update org cluster quotas

Usage

apolo admin update-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME

Update org cluster quotas.

Options

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]

update-project

Update project settings

Usage

apolo admin update-project [OPTIONS] CLUSTER_NAME NAME

Update project settings.

Options

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

update-project-user

Update user access to specified project

Usage

apolo admin update-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME USER_NAME [ROLE]

Update user access to specified project.

The command supports one of 4 user roles: reader, writer, manager or admin.

Options

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

update-resource-preset

Update existing resource preset

Usage

apolo admin update-resource-preset [OPTIONS] PRESET_NAME

Update existing resource preset

Options

Name	Description
--help	Show this message and exit.
--amd-gpu NUMBER	Number of AMD GPUs
-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
-m, --memory AMOUNT	Memory amount
-g, --nvidia-gpu NUMBER	Number of Nvidia GPUs
--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