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: Get Allowlisted for Chkk Access
Your organization must be allowlisted in order to access and use Chkk SaaS. To request access, contact Chkk Support to get an Organization provisioned for you: https://www.chkk.io/
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 and add-ons running in your fleet.
Next Steps:
- Learn more about the Chkk Kubernetes Connector.
- Learn more about the Risk Ledger and the Artifact Register.
Step 3: 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.
Next Steps: Learn more about the Chkk Cloud Connector.
Step 4: Install the Chkk Slack App
Stay informed with real-time alerts from Chkk by integrating Slack.
Setup Steps
- Click “Integrations” in the left menu.
- Select Slack and follow the guided installation steps.
- Once installed, Chkk will send real-time notifications for:
- New Operational Risks detected in clusters.
- Published Upgrade Templates and Plans.
Need Help?
- Use Slack Connect to bring Chkk into your workspace for direct collaboration.
- Email Support: support@chkk.io
Was this page helpful?