Cluster Onboarding

Cluster Onboarding

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

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

Add a new cluster to NCH

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

nctl add cluster --cluster-name <cluster-name>

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 NCH, use the get command.

nctl get cluster

Get cluster details

To view more details about a cluster:

nctl get cluster <cluster-name>

Remove cluster from NCH

To remove a cluster from NCH:

nctl remove cluster --cluster-name <cluster-name>

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