Skip to main content

Helm Installation

Prerequisites​

Before you begin, make sure your environment meets the following requirements:

info

Persistent Volume Access: Causely requires the ability to create and attach PersistentVolumeClaims (PVCs) for VictoriaMetrics storage.

  • Ensure your account can create PersistentVolume, PersistentVolumeClaim, and StorageClass resources.
  • Check that a default StorageClass is configured (kubectl get storageclass).
  • If dynamic provisioning is disabled, pre-create a PersistentVolume and bind it to the PVC.

If you are using OpenShift, you need to use the group id from the uid-range assigned to the project. Review the section on OpenShift Deployment for more details.

If you are using a custom StorageClass, you can specify the StorageClass to use for persistent volumes. Review the section on Using a custom StorageClass instead of the default one for more details.

1. Install the Causely Agent​

Step 1: Retrieve Your Access Token​

  1. Visit https://portal.causely.app and log in.
  2. Click on the gear icon in the top-right corner and select Integrations
  3. Click the Details 🗝️ button and copy your access token to use in the next step.

Step 2: Install via Helm​

Run the following command by replacing <my_token> with your access token.
You can find the latest version in the Causely Portal > Gear Icon > Integrations > Agents.

helm upgrade --install causely \
  --create-namespace oci://us-docker.pkg.dev/public-causely/public/causely \
  --version <version> \
  --namespace=causely \
  --set image.tag=<version> \
  --set global.cluster_name=<my_cluster_name> \
  --set mediator.gateway.token=<my_token>

Step 3: Wait for the Causely Agent to be Ready​

Run the following command to wait for the Causely agent to be ready:

kubectl wait --for=condition=Ready pod -l app.kubernetes.io/part-of=causely -n causely --timeout=300s
info

If all pods are ready, but you still cannot see any entities in the Causely UI, please check the logs of the mediator pod for errors:

kubectl logs -n causely \
             -l app.kubernetes.io/name=mediator \
             -c mediator \
             --tail=-1 | grep ERROR

For example the following error indicates that the credentials are invalid:

{
  "error": "failed to send update: rpc error: code = Unknown desc = unauthorized"
}

For other errors, please reach out to us at support@causely.app for help.

Step 4: Review Discovery​

To verify the agent is successfully installed navigate to the Integrations Agents view. Once the agent has appeared you have successfully installed Causely!

Navigate to https://portal.causely.app to verify your environment has been discovered. You should see entities populated in the Topology view. As root causes are identified, they will appear in the Root Cause view.

Uninstall the Causely Agent​

Run the following command to uninstall the Causely agent:

helm uninstall causely -n causely

After uninstalling the Causely agent, you can delete the PVCs created by the Causely agent:

kubectl delete pvc -n causely -l app=victoriametrics

Next Steps​

Visit the Customize your installation page to learn more about customizing your installation.

We recommend that you connect additional telemetry sources to help Causely identify root causes in your environment. Visit the Telemetry Sources page to learn more about the data sources that Causely supports.

To push insights into your workflows, visit the Workflow Integrations page.