Log in|Playground

Connect Kubernetes clusters

Get up and running in minutes in Kubernetes

Before installing groundcover in Kubernetes, please make sure your cluster meets the requirements.

After ensuring your cluster meets the requirements, complete the login and workspace setup, then choose your preferred installation method:

Coverage policy covers all nodes excluding control plane and fargate. See details here.

Installing using UI

  1. Copy the displayed command and run it in your CLI (ensure your kubectl context points to the desired cluster)

  2. The installation screen will open automatically and will let you know on-screen when the installation has completed.

Within 10 minutes after installation completes, all of your cluster's data will appear in your workspace.

To add more clusters, click on the cluster picker in the top right corner and then on the + Add Cluster option.

Installing using CLI

Use groundcover CLI to automate the installation process. The main advantages of using this installation method are:

  • Auto-detection of cluster incompatibility issues

  • Tolerations setup automation

  • Tuning of resources according to cluster size

  • Supports passing helm overrides

  • Automated detection of new versions and upgrades suggestions

Read more here.

Installing groundcover CLI

sh -c "$(curl -fsSL https://groundcover.com/install.sh)"

Deploying groundcover using the CLI

# If you need to provide helm overrides 
# (for example when deploying in BYOC mode)
groundcover deploy # -f values.yaml

To upgrade groundcover to the latest version, simply re-run the groundcover deploy command with your desired overrides (such as -f values.yaml). The CLI will automatically detect and apply the latest available version during the deployment process.

Installing using Helm

Step 1 - Generate Installation Key

For more details about ingestion keys, refer to our ingestion key documentation.

BYOC

groundcover auth get-ingestion-key sensor

Self-Managed

groundcover auth print-api-key

Add Helm Repository

# Add groundcover Helm repository and fetch latest chart
helm repo add groundcover https://helm.groundcover.com && helm repo update groundcover

Step 2 - Install groundcover

Create a values.yaml file with your configuration:

Self-Managed

global:
  groundcover_token: "your-token-from-above"  
clusterId: "your-cluster-name"

BYOC

More about BYOC installation here

global:
  groundcover_token: "your-token-from-above"  
  ingress:
    site: "your-custom-domain.com"
  backend:
    enabled: false

clusterId: "your-cluster-name"

Deploy groundcover:

helm upgrade \
    groundcover \
    groundcover/groundcover \
    -i \
    --create-namespace \
    -n groundcover \
    -f values.yaml

Upgrade groundcover:

helm repo update groundcover && helm upgrade \
    groundcover \
    groundcover/groundcover \
    -n groundcover \
    -f values.yaml

Installing using ArgoCD

For CI/CD deployments using ArgoCD, refer to our ArgoCD deployment guide.

What can you do next?

Check out our 5 quick steps to get you started

Adding more clusters

Our free plan limits the use of groundcover on only one cluster. Check out our Team and Enterprise plans to install on an unlimited number of clusters.

Uninstalling

CLI

groundcover delete

Helm

helm uninstall groundcover -n groundcover
# delete the namespace in order to remove the PVCs as well
kubectl delete ns groundcover

Last updated