| --- |
| title: vessl cluster |
| version: EN |
| --- |
| |
| ### Overview |
|
|
| Run `vessl cluster --help` to view the list of commands, or `vessl cluster [COMMAND] --help` to view individual command instructions. |
|
|
| <Note>Certain commands only apply to custom kernel clusters.</Note> |
|
|
| ### Create a custom kernel cluster |
|
|
| ``` |
| vessl cluster create [OPTIONS] |
| ``` |
|
|
| | Argument | Description | |
| | ---------------------- | ----------------------------------------------------------------------------------- | |
| | `--name` | Name of the cluster. (e.g. 'seoul-cluster') [required] | |
| | `--kubernetes-namespace` | Kubernetes namespace to install VESSL agent (default: vessl) | |
| | `--provider` | [aws\|gcp\|on-premise] Cluster provider; aws\|gcp\|on-premise (default: on-premise) | |
| | `--extra-helm-values` | Extra Helm values to pass when installing VESSL agent. | |
|
|
| ### Delete a custom kernel cluster |
|
|
| ``` |
| vessl cluster delete NAME |
| ``` |
|
|
| | Argument | Description | |
| | -------- | -------------------------- | |
| | `NAME` | Custom kernel cluster name | |
|
|
| ### List all kernel clusters |
|
|
| ``` |
| vessl cluster list |
| ``` |
|
|
| ### List nodes in a kernel cluster |
|
|
| ``` |
| vessl cluster list-nodes NAME |
| ``` |
|
|
| | Argument | Description | |
| | -------- | -------------------------- | |
| | `NAME` | Custom kernel cluster name | |
|
|
| ### View information on a kernel cluster |
|
|
| ``` |
| vessl cluster read NAME |
| ``` |
|
|
| | Argument | Description | |
| | -------- | ------------------- | |
| | `NAME` | Kernel cluster name | |
|
|
| ### Rename a custom kernel cluster |
|
|
| ``` |
| vessl cluster rename NAME NEW_NAME |
| ``` |
|
|
| | Argument | Description | |
| | ---------- | -------------------------- | |
| | `NAME` | Custom kernel cluster name | |
| | `NEW_NAME` | New kernel cluster name | |
|
|
| ### Create a local sandbox cluser |
|
|
| ``` |
| vessl cluster init-local |
| ``` |
|
|
