Skip to main content
The chkk command-line interface (CLI) offers a developer-first way to explore the Chkk universe.
1

Download Chkk CLI

Follow the steps in the Installation guide to download the Chkk CLI.
2

Run chkk start

Run the interactive starter to authenticate and register clusters:
chkk start
The chkk start command will get you started in the Chkk universe.The command will lead you through registering one or more Kubernetes Clusters with Chkk and request a Chkk upgrade assessment for those registered Kubernetes Clusters.Registering a Kubernetes Cluster with Chkk is the process of collecting resources from the Kubernetes Cluster and submitting those collected results to Chkk.Type chkk start in a terminal to begin.
> chkk start
        __    __    __
  .----|  |--|  |--|  |--.
  |  __|     |    <|    <
  |____|__|__|__|__|__|__|

Welcome to Chkk!

This command will help you get started with Chkk.

It will guide you through the process of logging in to your Chkk account and
registering any Kubernetes Clusters if desired.

You may also request an upgrade assessment for any of your registered Kubernetes
Clusters.

────────────────────────────────────────────────────────────────────────────────────────────────────────
Let's get you logged in to your Chkk account.
please confirm the code LCZS-DKDB at https://auth.chkk.io/activate?user_code=LCZS-DKDB
Click on the link and a browser window will appear asking you to confirm a code.
3

Register a Kubernetes Cluster

After clicking “Confirm”, in your terminal you will see a successful login message and a prompt to register a Kubernetes Cluster with Chkk:
successfully logged in as "Jane Doe" (jane.doe@example.com) into organization "demo-org" (org_3c2732f7-9328-477d-910b-54cd94ade5c0).

Do you want to register any Kubernetes Clusters with Chkk? (Y/n)
Hit Enter or “Y” to start the registration process. We will look in your kubeconfig for Kubernetes Clusters and ask you to select one or more of those Kubernetes Clusters to register with Chkk.
Found 1 total Kubernetes Clusters in your kubeconfig.

Select the clusters you would like to register. Resources from the selected
clusters will be collected and submitted to Chkk for analysis.

Use the arrow keys to navigate: ↓ ↑ → ←
Select "Submit" to submit choices.
    Submit
  → ✔   kind-charlie (https://127.0.0.1:39775)
Use the arrow keys to navigate, hit Enter to select one or more of the Kubernetes Clusters and navigate up to the Submit line and hit Enter again.We will ask you to confirm your selection:
You made the following 1 selections:

1: kind-charlie (https://127.0.0.1:39775)

Are you sure you want to submit these? Enter 'n' to select again. (Y/n)
Hit Enter or “Y” to collect resources from the selected Kubernetes Clusters and register them with Chkk.
Registering 1 Kubernetes Cluster(s) with Chkk...

  registering kind-charlie (https://127.0.0.1:39775)...

✅ cluster "kind-charlie" resource collection successful. 49 resource groups collected.

To view information about your cluster, do:

  chkk cluster get k8scl_13673ce4-1cbd-454a-aa31-67b722fadc99
Your newly-registered Kubernetes Cluster will then be displayed along with a prompt asking if you would like to request a Chkk upgrade assessment for this Kubernetes Cluster:
The following 1 Kubernetes Clusters are active in your Chkk account:

┌────────────────────────────────────────────┬──────────────┬────────┬─────────────┬──────────┬──────────────┬──────────┐
│                     ID                     │     NAME     │ STATUS │ ENVIRONMENT │ PROVIDER │ KUBE VERSION │ #  NODES │
├────────────────────────────────────────────┼──────────────┼────────┼─────────────┼──────────┼──────────────┼──────────┤
│ k8scl_13673ce4-1cbd-454a-aa31-67b722fadc99 │ kind-charlie │ active │             │ KinD     │ 1.28         │ 2        │
└────────────────────────────────────────────┴──────────────┴────────┴─────────────┴──────────┴──────────────┴──────────┘
showing 1-1 of 1 records.

Would you like to request an upgrade assessment for any of these Kubernetes Clusters? (Y/n)
4

Review the Upgrade Assessment

A Chkk upgrade assessment is a report that alerts you to potential issues with an upgrade of your Kubernetes Cluster and recommends upgrade versions for your Kubernetes Add-ons and Application Services.Hit Enter or “Y” to select one or more Kubernetes Clusters for an upgrade assessment.
Use the arrow keys to navigate: ↓ ↑ → ←
? Select a cluster to request an upgrade assessment for:
  ▸ kind-charlie (1.28) (KinD)
select a Kubernetes Cluster and hit Enter.
You selected "kind-charlie (1.28) (KinD)". Is this correct? Enter 'n' to select again. (Y/n)

Requesting upgrade assessment for kind-charlie (1.28) (KinD)...

(required) enter the name for the upgrade assessment
charlie
✅ request for upgrade assessement for cluster "k8scl_13673ce4-1cbd-454a-aa31-67b722fadc99" successful.
... waiting for upgrade assessment to complete. this will take a few minutes ...
The upgrade assessment will take a few minutes to generate and then you will see:
completed!

To view your upgrade assessment, do:

  chkk upgradeassessment get ua_a59a7fff-f3c2-4443-9f26-fe97cd187def

Learn more about Chkk upgrade assessments at: https://docs.chkk.io/product/upgrade-copilot/assessments

​
Need Help?

Email us at support@chkk.io for assistance.
⌘I