Search
⌃K

Installation

Zero code instrumentation; Install in no time; Start free

Step 1: Sign up to groundcover

First, sign up to groundcover using your Google or Microsoft account.

Step 2: Add your first cluster

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

Step 3: Start using groundcover

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.
​

Install directly with the groundcover CLI or Helm

The easiest way to install groundcover's CLI is using the install script:
sh -c "$(curl -fsSL https://groundcover.com/install.sh)"
For alternate install options see the GitHub page.

Deploy groundcover
🚀
​

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.
​

Upgrading groundcover

To upgrade to groundcover agent to the latest version, run:
Using CLI
Using Helm
# List deployment options
groundcover deploy --help
​
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 -

Uninstall

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
​