# 📖 `clever k8s` command reference

> [!NOTE]
> 🧪 **Experimental**: This command may change or be removed in future versions.
> Enable with: `clever features enable k8s`

## ➡️ `clever k8s` <kbd>Since 4.3.0</kbd>

Manage Kubernetes clusters

```bash
clever k8s
```

## ➡️ `clever k8s activity` <kbd>Since 4.9.0</kbd>

Show recent deployment events of a Kubernetes cluster

```bash
clever k8s activity <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
|`--limit` `<limit>`|Number of events to fetch (1 to 1000) (default: 50)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s add-persistent-storage` <kbd>Since 4.3.0</kbd>

Activate persistent storage to a deployed Kubernetes cluster

```bash
clever k8s add-persistent-storage <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s create` <kbd>Since 4.3.0</kbd>

Create a Kubernetes cluster

```bash
clever k8s create <cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-name`|Kubernetes cluster name|

### ⚙️ Options

|Name|Description|
|---|---|
|`--autoscaling`|Enable the cluster autoscaler|
|`--cluster-version` `<cluster-version>`|Kubernetes version to deploy (e.g.: 1.36)|
|`--description` `<description>`|Free-form cluster description|
|`--flavor` `<flavor>`|Control plane flavor|
|`--nodegroup` `<flavor:count>`|Initial node group (format: <flavor>:<count>, e.g.: XS:3)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
|`--persistent-storage`|Enable persistent storage (Ceph CSI)|
|`--replication-factor` `<replication-factor>`|Control plane replication factor|
|`--tag` `<tag[,tag...]>`|Semantic tags (comma-separated, e.g.: env:prod,team:platform)|
|`--topology` `<topology>`|Cluster topology (must be set with --flavor and --replication-factor)|
|`-w`, `--watch`|Watch the deployment until the cluster is deployed|
|`-y`, `--yes`|Skip confirmation prompts|

## ➡️ `clever k8s delete` <kbd>Since 4.3.0</kbd>

Delete a Kubernetes cluster

```bash
clever k8s delete <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
|`-y`, `--yes`|Skip confirmation prompts|

## ➡️ `clever k8s get` <kbd>Since 4.3.0</kbd>

Get information about a Kubernetes cluster

```bash
clever k8s get <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s get-kubeconfig` <kbd>Since 4.3.0</kbd>

Get configuration of a Kubernetes cluster

```bash
clever k8s get-kubeconfig <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s list` <kbd>Since 4.3.0</kbd>

List Kubernetes clusters

```bash
clever k8s list [options]
```

### ⚙️ Options

|Name|Description|
|---|---|
|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s nodegroups` <kbd>Since 4.9.0</kbd>

Manage Kubernetes node groups

```bash
clever k8s nodegroups
```

## ➡️ `clever k8s nodegroups create` <kbd>Since 4.9.0</kbd>

Create a node group on a Kubernetes cluster

```bash
clever k8s nodegroups create <cluster-id|cluster-name> <nodegroup-name> <flavor:count> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
|`nodegroup-name`|Node group name (lowercase RFC 1123, max 63 chars)|
|`flavor:count`|Node group flavor and target node count (format: <flavor>:<count>, e.g.: XS:3)|

### ⚙️ Options

|Name|Description|
|---|---|
|`--autoscaling`|Enable cluster autoscaler for this node group (requires --min and --max)|
|`--description` `<description>`|Free-form node group description|
|`--max` `<max>`|Maximum node count when autoscaling is enabled|
|`--min` `<min>`|Minimum node count when autoscaling is enabled|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
|`--tag` `<tag>`|Arbitrary tag attached to the node group|

## ➡️ `clever k8s nodegroups delete` <kbd>Since 4.9.0</kbd>

Delete a node group from a Kubernetes cluster

```bash
clever k8s nodegroups delete <cluster-id|cluster-name> <nodegroup-id|nodegroup-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
|`nodegroup-id|nodegroup-name`|Kubernetes node group ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
|`-y`, `--yes`|Skip confirmation prompts|

## ➡️ `clever k8s nodegroups get` <kbd>Since 4.9.0</kbd>

Get information about a Kubernetes node group

```bash
clever k8s nodegroups get <cluster-id|cluster-name> <nodegroup-id|nodegroup-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
|`nodegroup-id|nodegroup-name`|Kubernetes node group ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s nodegroups list` <kbd>Since 4.9.0</kbd>

List the node groups of a Kubernetes cluster

```bash
clever k8s nodegroups list <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s nodegroups update` <kbd>Since 4.9.0</kbd>

Update a node group on a Kubernetes cluster

```bash
clever k8s nodegroups update <cluster-id|cluster-name> <nodegroup-id|nodegroup-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|
|`nodegroup-id|nodegroup-name`|Kubernetes node group ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`--autoscaling`|Enable the cluster autoscaler|
|`--count` `<count>`|Target node count|
|`--description` `<description>`|Free-form node group description|
|`--disable-autoscaling`|Disable the cluster autoscaler|
|`--max` `<max>`|Maximum node count (autoscaling bound)|
|`--min` `<min>`|Minimum node count (autoscaling bound)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
|`--tag` `<tag>`|Arbitrary tag attached to the node group|

## ➡️ `clever k8s quota` <kbd>Since 4.9.0</kbd>

Get the Kubernetes quota, usage and remaining of an organisation

```bash
clever k8s quota [options]
```

### ⚙️ Options

|Name|Description|
|---|---|
|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s update` <kbd>Since 4.9.0</kbd>

Update a Kubernetes cluster metadata or features

```bash
clever k8s update <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`--autoscaling`|Enable the cluster autoscaler|
|`--description` `<description>`|Free-form cluster description|
|`--disable-autoscaling`|Disable the cluster autoscaler|
|`--name` `<name>`|Rename the cluster|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
|`--tag` `<tag[,tag...]>`|Replace tags (comma-separated, e.g.: env:prod,team:platform)|

## ➡️ `clever k8s version` <kbd>Since 4.9.0</kbd>

Check a Kubernetes cluster deployed version

```bash
clever k8s version <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s version check` <kbd>Since 4.9.0</kbd>

Check a Kubernetes cluster deployed version

```bash
clever k8s version check <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-F`, `--format` `<format>`|Output format (human, json) (default: human)|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|

## ➡️ `clever k8s version update` <kbd>Since 4.9.0</kbd>

Update a Kubernetes cluster to a target version

```bash
clever k8s version update <cluster-id|cluster-name> [options]
```

### 📥 Arguments

|Name|Description|
|---|---|
|`cluster-id|cluster-name`|Kubernetes cluster ID or name|

### ⚙️ Options

|Name|Description|
|---|---|
|`-o`, `--org`, `--owner` `<org-id\|org-name>`|Organisation to target by its ID (or name, if unambiguous)|
|`--target` `<version>`|Target version to upgrade to (e.g.: 24, 2.4, 2.4.1)|