File size: 2,305 Bytes
76d9c4f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
---
title: Cluster
version: EN
---
### create_cluster
```python
vessl.create_cluster(
param: CreateClusterParam
)
```
Create a VESSL cluster by installing VESSL agent to given Kubernetes
namespace. If you want to override the default organization, then pass
`organization_name` to `param`.
**Args**
* `param` (CreateClusterParam) : Create cluster parameter.
**Example**
```python
vessl.install_cluster(
param=vessl.CreateClusterParam(
cluster_name="foo",
...
),
)
```
----
## read_cluster
```python
vessl.read_cluster(
cluster_name: str, **kwargs
)
```
Read cluster in the default organization. If you want to override the
default organization, then pass `organization_name` as `**kwargs`.
**Args**
* `cluster_name` (str) : Cluster name.
**Example**
```python
vessl.read_cluster(
cluster_name="seoul-cluster",
)
```
----
## list_clusters
```python
vessl.list_clusters(
**kwargs
)
```
List clusters in the default organization. If you want to override the
default organization, then pass `organization_name` as `**kwargs`.
**Example**
```python
vessl.list_clusters()
```
----
## delete_cluster
```python
vessl.delete_cluster(
cluster_id: int, **kwargs
)
```
Delete custom cluster in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Args**
* `cluster_id` (int) : Cluster ID.
**Example**
```python
vessl.delete_cluster(
cluster_id=1,
)
```
----
## rename_cluster
```python
vessl.rename_cluster(
cluster_id: int, new_cluster_name: str, **kwargs
)
```
Rename custom cluster in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Args**
* `cluster_id` (int) : Cluster ID.
* `new_cluster_name` (str) : Cluster name to change.
**Example**
```python
vessl.rename_cluster(
cluster_id=1,
new_cluster_name="seoul-cluster-2",
)
```
----
## list_cluster_nodes
```python
vessl.list_cluster_nodes(
cluster_id: int, **kwargs
)
```
List custom cluster nodes in the default organization. If you want to
override the default organization, then pass `organization_name` as
`**kwargs`.
**Args**
* `cluster_id` (int) : Cluster ID.
**Example**
```python
vessl.list_cluster_nodes(
cluster_id=1,
)
```
|