Search…
Installation
1 minute installation.
Before diving in let's make sure groundcover fully supports your stack. Check out the Requirements and Supported Technologies sections for more details.
This guide explains how to install groundcover in a single cluster, if you are interested in installing groundcover in multiple clusters and wish to use the same databases for those installations, please refer to the multi-cluster installation docs

Sign up to groundcover

Visit the groundcover product page and sign up.

Install groundcover CLI

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

# Login to your groundcover account
groundcover auth login
​
# List deployment options
groundcover deploy --help
​
groundcover deploy

Using Helm

# (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.

Start using groundcover

Refresh our product page and start your journey with groundcover.
Experiencing issues with the installation process? let us know over Slack.

Upgrading groundcover

To upgrade to groundcover agent to the latest version, run:

Using CLI

# List deployment options
groundcover deploy --help
​
groundcover deploy

Using Helm

# Update groundcover Helm repository to fetch latest charts
helm repo update groundcover
​
# Upgrade groundcover release
helm upgrade groundcover groundcover/groundcover -n groundcover --reuse-values
​
Copy link
On this page
Sign up to groundcover
Install groundcover CLI
Deploy groundcover
Start using groundcover
Upgrading groundcover