> For the complete documentation index, see [llms.txt](https://docs.apolo.us/index/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apolo.us/index/apolo-cli/commands/admin.md). # admin Cluster administration commands ## Usage ```bash apolo admin [OPTIONS] COMMAND [ARGS]... ``` Cluster administration commands. **Commands:** | Usage | Description | | ------------------------------------------------------- | --------------------------------------------- | | [*add-cluster*](#add-cluster) | Create a new cluster | | [*add-cluster-user*](#add-cluster-user) | Add user access to a specified cluster | | [*add-org*](#add-org) | Create a new org | | [*add-org-cluster*](#add-org-cluster) | Add org access to specified cluster | | [*add-org-credits*](#add-org-credits) | Add given values to org balance | | [*add-org-user*](#add-org-user) | Add user access to specified org | | [*add-project*](#add-project) | Add new project to specified cluster | | [*add-project-user*](#add-project-user) | Add user access to specified project | | [*add-resource-preset*](#add-resource-preset) | Add new resource preset | | [*add-user-credits*](#add-user-credits) | Add given values to user credits | | [*get-cluster-orgs*](#get-cluster-orgs) | Print the list of all orgs in the cluster | | [*get-cluster-users*](#get-cluster-users) | List users in specified cluster | | [*get-clusters*](#get-clusters) | Print the list of available clusters | | [*get-org-cluster-quota*](#get-org-cluster-quota) | Get info about org quota in given cluster | | [*get-org-users*](#get-org-users) | List users in specified org | | [*get-orgs*](#get-orgs) | Print the list of available orgs | | [*get-project-users*](#get-project-users) | List users in specified project | | [*get-projects*](#get-projects) | Print the list of all projects in the cluster | | [*get-user-quota*](#get-user-quota) | Get info about user quota in given cluster | | [*remove-cluster*](#remove-cluster) | Drop a cluster | | [*remove-cluster-user*](#remove-cluster-user) | Remove user access from the cluster | | [*remove-org*](#remove-org) | Drop an org | | [*remove-org-cluster*](#remove-org-cluster) | Drop an org cluster | | [*remove-org-user*](#remove-org-user) | Remove user access from the org | | [*remove-project*](#remove-project) | Drop a project | | [*remove-project-user*](#remove-project-user) | Remove user access from the project | | [*remove-resource-preset*](#remove-resource-preset) | Remove resource preset | | [*set-org-cluster-defaults*](#set-org-cluster-defaults) | Set org cluster defaults to given value | | [*set-org-cluster-quota*](#set-org-cluster-quota) | Set org cluster quota to given values | | [*set-org-credits*](#set-org-credits) | Set org credits to given value | | [*set-org-defaults*](#set-org-defaults) | Set org defaults to a given value | | [*set-user-credits*](#set-user-credits) | Set user credits to given value | | [*set-user-quota*](#set-user-quota) | Set user quota to given values | | [*update-cluster*](#update-cluster) | Update a cluster | | [*update-cluster-user*](#update-cluster-user) | | | [*update-org-cluster*](#update-org-cluster) | Update org cluster quotas | | [*update-project*](#update-project) | Update project settings | | [*update-project-user*](#update-project-user) | Update user access to specified project | | [*update-resource-preset*](#update-resource-preset) | Update existing resource preset | ### add-cluster Create a new cluster #### Usage ```bash 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 a specified cluster #### Usage ```bash apolo admin add-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME [ROLE] ``` Add user access to a specified cluster. The command supports one of three user roles: admin, manager or user. #### Options | Name | Description | | ------------------- | ------------------------------------------------------------- | | *--help* | Show this message and exit. | | *-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 ```bash 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 ```bash 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-credits Add given values to org balance #### Usage ```bash apolo admin add-org-credits [OPTIONS] ORG ``` Add given values to org 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 ```bash apolo admin add-org-user [OPTIONS] ORG_NAME USER_NAME [ROLE] ``` Add user access to specified org. The command supports one of three 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) | ### add-project Add new project to specified cluster #### Usage ```bash 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]* | | *--no-virtual-kube / --has-virtual-kube* | Has this project virtual kubernetes support (no vkube by default) | | *--org ORG* | org name for org-cluster projects | ### add-project-user Add user access to specified project #### Usage ```bash 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 ```bash 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 | | *--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 | | *--nvidia-mig NVIDIA\_MIG* | Nvidia MIG configuration in format PROFILE\_\[:MODEL]\_=COUNT | | *--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 credits #### Usage ```bash apolo admin add-user-credits [OPTIONS] ORG USER_NAME ``` Add given values to user credits #### Options | Name | Description | | ---------------------- | ----------------------------------- | | *--help* | Show this message and exit. | | *-c, --credits AMOUNT* | Credits amount to add *\[required]* | ### get-cluster-orgs Print the list of all orgs in the cluster #### Usage ```bash 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 ```bash 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 ```bash 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 ```bash 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 ```bash 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 ```bash 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 ```bash 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 ```bash 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 ```bash apolo admin get-user-quota [OPTIONS] CLUSTER_NAME USER_NAME ORG ``` Get info about user quota in given cluster #### Options | Name | Description | | -------- | --------------------------- | | *--help* | Show this message and exit. | ### remove-cluster Drop a cluster #### Usage ```bash 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 ```bash 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 ```bash 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 ```bash 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 ```bash 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 ```bash 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 ```bash 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 ```bash apolo admin remove-resource-preset [OPTIONS] PRESET_NAME ``` Remove resource preset #### Options | Name | Description | | -------- | --------------------------- | | *--help* | Show this message and exit. | ### set-org-cluster-defaults Set org cluster defaults to given value #### Usage ```bash 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 ```bash 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-org-credits Set org credits to given value #### Usage ```bash apolo admin set-org-credits [OPTIONS] ORG ``` Set org 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-defaults Set org defaults to a given value #### Usage ```bash apolo admin set-org-defaults [OPTIONS] ORG_NAME ``` Set org defaults to a given value #### Options | Name | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------ | | *--help* | Show this message and exit. | | *--user-default-credits AMOUNT* | Default credits amount to set for org users (\`unlimited' stands for no limit) *\[default: unlimited]* | ### set-user-credits Set user credits to given value #### Usage ```bash apolo admin set-user-credits [OPTIONS] ORG 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]* | ### set-user-quota Set user quota to given values #### Usage ```bash 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 | ### update-cluster Update a cluster #### Usage ```bash 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 ```bash 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-org-cluster Update org cluster quotas #### Usage ```bash 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 ```bash 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 ```bash 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 ```bash 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 | | *--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 | | *--nvidia-mig NVIDIA\_MIG* | Nvidia MIG configuration, PROFILE\_\[:MODEL]\_=COUNT | | *--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 |