Skip to content

ClusterPulse Documentation

Quickstart:

ClusterPulse/clusterpulse

Quickstart:¶

Get ClusterPulse running and monitoring a cluster in 5 minutes.

Prerequisites¶

Kubernetes cluster with oc access
Helm 3.x installed
Redis instance (or use the bundled one)

Step 1: Install ClusterPulse¶

OperatorHub¶

ClusterPulse can be deployed through OLM in the OperatorHub. It is currently inside the community operator index!

Helm¶

git clone https://github.com/ClusterPulse/operator.git
cd operator/
make install                            # Will install CRDs
helm install clusterpulse ./helm-charts/clusterpulse        # Will install ClusterPulse

Step 2: Connect a Cluster¶

Visit this this guide for more information.

Step 3: Create an Access Policy¶

Allow your team to view the cluster:

apiVersion: clusterpulse.io/v1alpha1
kind: MonitorAccessPolicy
metadata:
  name: dev-team-access
  namespace: clusterpulse
spec:
  identity:
    priority: 100
    subjects:
      groups: ["developers"]
  access:
    effect: Allow
    enabled: true
  scope:
    clusters:
      default: none
      rules:
        - selector:
            names: ["my-cluster"]
          permissions:
            view: true
            viewMetrics: true

oc apply -f policy.yaml

Step 4: Create MetricSources¶

More of an optional step, but if you want to reconcile additional metrics, you can visit this guide for more information.

Step 5: Access the UI¶

# Get the route ClusterPulse created
oc get routes -n <clusterpulse_ns>

Next Steps¶