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:

• UI

• CLI

• Helm

• ArgoCD

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

Creating helm values file

Sensor deployment requires installation values similar to these stored in a values.yaml file

global:
  backend:
    enabled: false
  ingress:
    site: {BYOC_ENDPOINT}

clusterId: "your-cluster-name" # CLI will automatically detect cluster name
env: "your-environment-name" # Add it to differnciate between different environments

{BYOC_ENDPOINT} is your unique groundcover ingestion endpoint, you can locate it in the ingestion keys tab.

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.

The CLI will automatically use existing ingestion keys or provision a new one if none exist

Installing groundcover CLI

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

Deploying groundcover using the CLI

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 - Install groundcover CLI

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

Step 2 - Generate Installation Key

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

groundcover auth get-ingestion-key sensor

Step 3 - Add Sensor Ingestion Key to Values File

Add the recently created sensor key and your BYOC endpoint to the values.yaml file. Find your BYOC endpoint in the ingestion keys tab.

global:
  groundcover_token: {sensor_key}
  backend:
    enabled: false
  ingress:
    site: {BYOC_ENDPOINT}
    
clusterId: "your-cluster-name"
env: "your-environment-name"

Step 4 - Add Helm Repository

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

Step 5 - Install groundcover

Initial installation:

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

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