Installation
Zero code instrumentation; Install in no time; Start free
Follow the instructions in our guided installation for a quick set up.
copy the command to install the groundcover CLI, and quickly set up your first cluster
Once the installation is finished, just press to get started.
Press the get start, and jump right in to see data from your cluster
Didn't get to this page? try refreshing the groundcover app, since in some cases installation may take longer than expected.
Still experiencing issues with the installation process? join our Slack support channel.
Hit the Share button on the top of the screen to copy the invite link and share with anyone in your organization.
Note: if you registered with a personal email such as gmail, or using "Continue with Email" authentication - you won't be able to share your experience with others, therefore we recommend you log in with your corporate mail.
Please contact our Slack support where we can help figure out any sharing problems. The easiest way to install groundcover's CLI is using the install script:
sh -c "$(curl -fsSL https://groundcover.com/install.sh)"
First, choose the relevant cluster on which you want to deploy groundcover.
Using CLI
Using Helm
# Login to your groundcover account
groundcover auth login
# List deployment options
groundcover deploy --help
groundcover deploy
# (1) Fetch groundcover api-key
groundcover auth print-api-key
# (2) Add groundcover Helm repoistory (once)
helm repo add groundcover https://helm.groundcover.com
# (3) Update groundcover Helm repository to fetch latest charts
helm repo update groundcover
# (4) Deploy groundcover release
helm upgrade \
groundcover \
groundcover/groundcover \
-i \
--create-namespace \
-n groundcover \
--set global.groundcover_token=<api-key from step (1)>,clusterId=my_cluster
Check out the the Custom Deployment page for more details on how to customize groundcover to your specific K8s needs.
Using CLI
Using Helm
# List deployment options
groundcover deploy --help
# if you have helm overrides file, you can pass it using `-f <overrides>.yaml`
groundcover deploy
# Make sure groundcover Helm repoistory is present (once)
helm repo add groundcover https://helm.groundcover.com
# Update groundcover Helm repository to fetch latest charts
helm repo update groundcover
# Upgrade groundcover release
helm get values -n groundcover groundcover -o yaml | helm upgrade groundcover groundcover/groundcover -n groundcover -f -
groundcover can be deployed in one of three modes:
- stable (default)
- experimental - nightly features
- legacy - previous generation agent, relevant on per-customer basis or for linux kernels < 5.3
In case you want to change the release mode, follow these instructions
Using CLI
Using Helm
groundcover deploy --mode=[stable|experimental|legacy]
# In your overrides.yaml
mode: #[stable|experimental|legacy]
MODE=#[stable|experimental|legacy]
helm get values -n groundcover groundcover -o yaml | helm upgrade groundcover groundcover/groundcover -n groundcover --set mode="${MODE}" -f -
Using CLI
Using Helm
groundcover delete
helm uninstall groundcover -n groundcover
# delete the namespace in order to remove the PVCs as well
kubectl delete ns groundcover
Last modified 1mo ago