Cluster Onboarding

nctl provides an easy way to add new clusters to Nirmata Control Hub, and also to interact with existing clusters.

Note: You must be logged in to your Nirmata Control Hub account before performing any of the below actions. View the steps to login here.

Add a new cluster to Nirmata Control Hub

To onboard an existing cluster to the Nirmata Control Hub, use the add command.

nctl add cluster --cluster-name <cluster-name>
```text

This will install the Kyverno Operator, and also deploy the following PolicySets:
* Pod Security Standards (Baseline)
* Pod Security Standards (Restricted)
* RBAC Best Practices

If you wish to only onboard the cluster without deploying the Kyverno Operator and related components, use the `--register-only` flag.


## List all clusters
To get a list of all clusters that are onboarded to Nirmata Control Hub, use the `get` command.

```bash
nctl get cluster
```text

## Get cluster details
To view more details about a cluster:

```bash
nctl get cluster <cluster-name>
```text

## Remove cluster from Nirmata Control Hub
To remove a cluster from Nirmata Control Hub:

```bash
nctl remove cluster --cluster-name <cluster-name>

This deregisters the cluster from Nirmata Control Hub and removes the Kyverno Operator, related components, and policysets that were installed during cluster registration.