Skip to content

Commit

Permalink
updated documentstion
Browse files Browse the repository at this point in the history
  • Loading branch information
mykhailo kozlovskyi committed Jun 13, 2024
1 parent aa348c1 commit fd5c8d0
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 152 deletions.
171 changes: 19 additions & 152 deletions CLI.md
View file
Original file line number Diff line number Diff line change
@@ -1,156 +1,4 @@


# Table of Contents
* [neuro](#neuro)
* [neuro acl](#neuro-acl)
* [neuro acl add-role](#neuro-acl-add-role)
* [neuro acl grant](#neuro-acl-grant)
* [neuro acl list-roles](#neuro-acl-list-roles)
* [neuro acl ls](#neuro-acl-ls)
* [neuro acl remove-role](#neuro-acl-remove-role)
* [neuro acl revoke](#neuro-acl-revoke)
* [neuro admin](#neuro-admin)
* [neuro admin add-cluster](#neuro-admin-add-cluster)
* [neuro admin add-cluster-user](#neuro-admin-add-cluster-user)
* [neuro admin add-org](#neuro-admin-add-org)
* [neuro admin add-org-cluster](#neuro-admin-add-org-cluster)
* [neuro admin add-org-cluster-credits](#neuro-admin-add-org-cluster-credits)
* [neuro admin add-org-user](#neuro-admin-add-org-user)
* [neuro admin add-project](#neuro-admin-add-project)
* [neuro admin add-project-user](#neuro-admin-add-project-user)
* [neuro admin add-resource-preset](#neuro-admin-add-resource-preset)
* [neuro admin add-user-credits](#neuro-admin-add-user-credits)
* [neuro admin generate-cluster-config](#neuro-admin-generate-cluster-config)
* [neuro admin get-cluster-orgs](#neuro-admin-get-cluster-orgs)
* [neuro admin get-cluster-users](#neuro-admin-get-cluster-users)
* [neuro admin get-clusters](#neuro-admin-get-clusters)
* [neuro admin get-org-cluster-quota](#neuro-admin-get-org-cluster-quota)
* [neuro admin get-org-users](#neuro-admin-get-org-users)
* [neuro admin get-orgs](#neuro-admin-get-orgs)
* [neuro admin get-project-users](#neuro-admin-get-project-users)
* [neuro admin get-projects](#neuro-admin-get-projects)
* [neuro admin get-user-quota](#neuro-admin-get-user-quota)
* [neuro admin remove-cluster](#neuro-admin-remove-cluster)
* [neuro admin remove-cluster-user](#neuro-admin-remove-cluster-user)
* [neuro admin remove-org](#neuro-admin-remove-org)
* [neuro admin remove-org-cluster](#neuro-admin-remove-org-cluster)
* [neuro admin remove-org-user](#neuro-admin-remove-org-user)
* [neuro admin remove-project](#neuro-admin-remove-project)
* [neuro admin remove-project-user](#neuro-admin-remove-project-user)
* [neuro admin remove-resource-preset](#neuro-admin-remove-resource-preset)
* [neuro admin set-org-cluster-credits](#neuro-admin-set-org-cluster-credits)
* [neuro admin set-org-cluster-defaults](#neuro-admin-set-org-cluster-defaults)
* [neuro admin set-org-cluster-quota](#neuro-admin-set-org-cluster-quota)
* [neuro admin set-user-credits](#neuro-admin-set-user-credits)
* [neuro admin set-user-quota](#neuro-admin-set-user-quota)
* [neuro admin show-cluster-options](#neuro-admin-show-cluster-options)
* [neuro admin update-cluster](#neuro-admin-update-cluster)
* [neuro admin update-node-pool](#neuro-admin-update-node-pool)
* [neuro admin update-org-cluster](#neuro-admin-update-org-cluster)
* [neuro admin update-project](#neuro-admin-update-project)
* [neuro admin update-project-user](#neuro-admin-update-project-user)
* [neuro admin update-resource-preset](#neuro-admin-update-resource-preset)
* [neuro blob](#neuro-blob)
* [neuro blob cp](#neuro-blob-cp)
* [neuro blob du](#neuro-blob-du)
* [neuro blob glob](#neuro-blob-glob)
* [neuro blob importbucket](#neuro-blob-importbucket)
* [neuro blob ls](#neuro-blob-ls)
* [neuro blob lsbucket](#neuro-blob-lsbucket)
* [neuro blob lscredentials](#neuro-blob-lscredentials)
* [neuro blob mkbucket](#neuro-blob-mkbucket)
* [neuro blob mkcredentials](#neuro-blob-mkcredentials)
* [neuro blob rm](#neuro-blob-rm)
* [neuro blob rmbucket](#neuro-blob-rmbucket)
* [neuro blob rmcredentials](#neuro-blob-rmcredentials)
* [neuro blob set-bucket-publicity](#neuro-blob-set-bucket-publicity)
* [neuro blob sign-url](#neuro-blob-sign-url)
* [neuro blob statbucket](#neuro-blob-statbucket)
* [neuro blob statcredentials](#neuro-blob-statcredentials)
* [neuro completion](#neuro-completion)
* [neuro completion generate](#neuro-completion-generate)
* [neuro completion patch](#neuro-completion-patch)
* [neuro config](#neuro-config)
* [neuro config aliases](#neuro-config-aliases)
* [neuro config docker](#neuro-config-docker)
* [neuro config get-clusters](#neuro-config-get-clusters)
* [neuro config login](#neuro-config-login)
* [neuro config login-headless](#neuro-config-login-headless)
* [neuro config login-with-token](#neuro-config-login-with-token)
* [neuro config logout](#neuro-config-logout)
* [neuro config show](#neuro-config-show)
* [neuro config show-token](#neuro-config-show-token)
* [neuro config switch-cluster](#neuro-config-switch-cluster)
* [neuro config switch-org](#neuro-config-switch-org)
* [neuro config switch-project](#neuro-config-switch-project)
* [neuro disk](#neuro-disk)
* [neuro disk create](#neuro-disk-create)
* [neuro disk get](#neuro-disk-get)
* [neuro disk ls](#neuro-disk-ls)
* [neuro disk rm](#neuro-disk-rm)
* [neuro image](#neuro-image)
* [neuro image digest](#neuro-image-digest)
* [neuro image ls](#neuro-image-ls)
* [neuro image pull](#neuro-image-pull)
* [neuro image push](#neuro-image-push)
* [neuro image rm](#neuro-image-rm)
* [neuro image size](#neuro-image-size)
* [neuro image tags](#neuro-image-tags)
* [neuro job](#neuro-job)
* [neuro job attach](#neuro-job-attach)
* [neuro job browse](#neuro-job-browse)
* [neuro job bump-life-span](#neuro-job-bump-life-span)
* [neuro job exec](#neuro-job-exec)
* [neuro job generate-run-command](#neuro-job-generate-run-command)
* [neuro job kill](#neuro-job-kill)
* [neuro job logs](#neuro-job-logs)
* [neuro job ls](#neuro-job-ls)
* [neuro job port-forward](#neuro-job-port-forward)
* [neuro job run](#neuro-job-run)
* [neuro job save](#neuro-job-save)
* [neuro job status](#neuro-job-status)
* [neuro job top](#neuro-job-top)
* [neuro secret](#neuro-secret)
* [neuro secret add](#neuro-secret-add)
* [neuro secret ls](#neuro-secret-ls)
* [neuro secret rm](#neuro-secret-rm)
* [neuro service-account](#neuro-service-account)
* [neuro service-account create](#neuro-service-account-create)
* [neuro service-account get](#neuro-service-account-get)
* [neuro service-account ls](#neuro-service-account-ls)
* [neuro service-account rm](#neuro-service-account-rm)
* [neuro storage](#neuro-storage)
* [neuro storage cp](#neuro-storage-cp)
* [neuro storage df](#neuro-storage-df)
* [neuro storage glob](#neuro-storage-glob)
* [neuro storage ls](#neuro-storage-ls)
* [neuro storage mkdir](#neuro-storage-mkdir)
* [neuro storage mv](#neuro-storage-mv)
* [neuro storage rm](#neuro-storage-rm)
* [neuro storage tree](#neuro-storage-tree)
* [neuro attach](#neuro-attach)
* [neuro cp](#neuro-cp)
* [neuro exec](#neuro-exec)
* [neuro help](#neuro-help)
* [neuro images](#neuro-images)
* [neuro kill](#neuro-kill)
* [neuro login](#neuro-login)
* [neuro logout](#neuro-logout)
* [neuro logs](#neuro-logs)
* [neuro ls](#neuro-ls)
* [neuro mkdir](#neuro-mkdir)
* [neuro mv](#neuro-mv)
* [neuro port-forward](#neuro-port-forward)
* [neuro ps](#neuro-ps)
* [neuro pull](#neuro-pull)
* [neuro push](#neuro-push)
* [neuro rm](#neuro-rm)
* [neuro run](#neuro-run)
* [neuro save](#neuro-save)
* [neuro share](#neuro-share)
* [neuro status](#neuro-status)
* [neuro top](#neuro-top)

# neuro

**Usage:**
Expand Down Expand Up @@ -486,6 +334,7 @@ Name | Description|
| _[neuro admin set\-user-quota](#neuro-admin-set-user-quota)_| Set user quota to given values |
| _[neuro admin show\-cluster-options](#neuro-admin-show-cluster-options)_| Show available cluster options |
| _[neuro admin update-cluster](#neuro-admin-update-cluster)_| Update a cluster |
| _[neuro admin update\-cluster-user](#neuro-admin-update-cluster-user)_| |
| _[neuro admin update\-node-pool](#neuro-admin-update-node-pool)_| Update cluster node pool |
| _[neuro admin update\-org-cluster](#neuro-admin-update-org-cluster)_| Update org cluster quotas |
| _[neuro admin update-project](#neuro-admin-update-project)_| Update project settings |
Expand Down Expand Up @@ -1218,6 +1067,23 @@ Name | Description|



### neuro admin update-cluster-user

**Usage:**

```bash
neuro admin update-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME [ROLE]
```

**Options:**

Name | Description|
|----|------------|
|_--help_|Show this message and exit.|




### neuro admin update-node-pool

Update cluster node pool.
Expand Down Expand Up @@ -4073,3 +3939,4 @@ Name | Description|
|_--until DATE\_OR_TIMEDELTA_|Show jobs created before a specific date \(including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.|



22 changes: 22 additions & 0 deletions neuro-cli/docs/admin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Cluster administration commands.
| [_set-user-quota_](admin.md#set-user-quota) | Set user quota to given values |
| [_show-cluster-options_](admin.md#show-cluster-options) | Show available cluster options |
| [_update-cluster_](admin.md#update-cluster) | Update a cluster |
| [_update-cluster-user_](admin.md#update-cluster-user) | |
| [_update-node-pool_](admin.md#update-node-pool) | Update cluster node pool |
| [_update-org-cluster_](admin.md#update-org-cluster) | Update org cluster quotas |
| [_update-project_](admin.md#update-project) | Update project settings |
Expand Down Expand Up @@ -867,6 +868,27 @@ Update a cluster.



### update-cluster-user




#### Usage

```bash
neuro admin update-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME [ROLE]
```



#### Options

| Name | Description |
| :--- | :--- |
| _--help_ | Show this message and exit. |



### update-node-pool

Update cluster node pool
Expand Down

0 comments on commit fd5c8d0

Please sign in to comment.