Skip to main content

Nomad Installation

This installation method enables Causely on HashiCorp Nomad clusters, providing telemetry collection and root‑cause analysis for services running on Nomad.

Prerequisites​

  • HashiCorp Nomad cluster running
  • Consul cluster for service discovery
  • NFS server for persistent storage
  • Docker driver enabled in Nomad
  • Linux kernel with eBPF support (5.4+ recommended)

1. Install Causely on Nomad​

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: Download the Nomad bundle​

git clone https://github.com/causely-oss/causely-deploy.git
cd causely-deploy/nomad

This directory contains the Nomad job specifications and configuration files needed to run Causely on Nomad.

Step 3: Configure your environment​

Set your Causely gateway token as an environment variable:

export CAUSELY_GATEWAY_TOKEN="your-gateway-token-here"

Edit the configuration files to match your environment. You'll need to update the datacenters, NFS settings, and Causely specific variables:

datacenters = ["dc1"]  # Update to match your Nomad datacenters
# Token can be provided via environment variable $CAUSELY_GATEWAY_TOKEN
# If not set, you can specify it here:
# gateway_token = "your-gateway-token-here"

nfs_server = "nfs.example.com"  # Update to your NFS server
nfs_path = "/exported/path"     # Update to your NFS path
datacenters = ["dc1"]  # Update to match your Nomad datacenters

nfs_server = "nfs.example.com"  # Update to your NFS server
nfs_path = "/exported/path"     # Update to your NFS path

Step 4: Deploy the jobs​

Deploy the Causely jobs to your Nomad cluster:

# Deploy VictoriaMetrics first
nomad job run -var-file=victoriametrics.hcl victoriametrics.nomad

# Deploy the mediator
nomad job run -var-file=mediator.hcl mediator.nomad

# Deploy the executor
nomad job run -var-file=executor.hcl executor.nomad

Step 5: 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.

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.