Getting Started
This Quick Start Guide provides a streamlined, step-by-step process for onboarding to Chkk, ensuring users can quickly start leveraging its risk detection, artifact tracking, and upgrade planning capabilities.
Step 1: Sign in
Visit https://app.chkk.io and sign in using one of the given methods.
Interested in upgrading? View our Pricing page to compare plans, or email us at support@chkk.io for assistance.
Step 2: Onboard Your Kubernetes Clusters
Installing the Chkk Kubernetes Connector on your clusters enables real-time risk detection, artifact tracking, and upgrade planning.
Install Chkk Kubernetes Connector
- Log in to Chkk Dashboard.
- Navigate to Risk Ledger → Clusters and click “Add Cluster”.
- Choose your preferred installation method:
- Helm
- Kubernetes YAML
- Terraform
- Follow the installation instructions to deploy the Chkk Kubernetes Connector.
What Happens Next?
- Automated Risk Scan: A Risk Ledger scan runs immediately upon onboarding. Within 15 minutes, the scan will be completed and by clicking on the Cluster card, you will be able to see all the Operational Risks detected in your environment, broken by risk categories.
- Cluster Insights:
- Risk Ledger: View all Operational Risks detected in your clusters.
- Artifact Register: Get a version-first inventory of the control-planes, add-ons, application services, and Kubernetes operators running in your fleet.
Learn More:
Step 3: Request an Upgrade Assessment
Once your cluster has been successfully onboarded, you can generate an Upgrade Assessment to understand the changes involved in upgrading your Kubernetes cluster.
To request an Upgrade Assessment:
- Navigate to Upgrade Copilot → Upgrade Assessments in the left-hand sidebar.
- Click Request Upgrade Assessment.
- Select the cluster to generate the Upgrade Assessment for.
You will only be able to request Upgrade Assessments after a Kubernetes Cluster has been onboarded.
What Happens Next?
- Upgrade Assessment Generation: After a few minutes, the Upgrade Assessment will be generated and appear with a status of Available.
- Review the Upgrade Assessment: Click the assessment row to review the control-plane version changes, required add-on upgrades, and any potential breaking changes.
- Download the Upgrade Assessment: You can also download the Upgrade Assessment as a Markdown file to share with your team.
Learn More:
Step 4: Connect Your Cloud Accounts
Chkk integrates with your AWS, GCP, and Azure Cloud Accounts to facilitate in the creation of holistic Upgrade Template and Upgrade Plans that are tailored to your environment.
Install Chkk Cloud Connector
- Navigate to Configure → Cloud Accounts.
- Click “Add Cloud Account” and select your provider (AWS, GCP, or Azure).
- Follow the guided steps to create a read-only IAM role or service account.
Once connected, your Cloud Account should show as “Connected” in the Chkk Dashboard.
Learn More:
Need Help?
Email us at support@chkk.io for assistance.