Skip to main content

CLI 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 CLI​

Run the following command to download and install the Causely CLI:

bash -c "$(curl -fksSL https://install.causely.ai/install.sh)"
info

The Causely CLI simply wraps Helm. If you prefer, you can alternatively run Helm commands directly. See Helm Installation

2. 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 CLI​

Run the following command by replacing <my_token> with your access token.

causely agent install --token <my_token>
note

If you have not installed the CLI in your PATH, make sure to run the command from absolute path, for example ~/bin/causely.

This installs Causely agents into the cluster defined by your current kubectx context. To specify a custom cluster name, see CLI Options below.

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

CLI Options​

You can see a complete list of options for customizing the installation by using the --help option.

causely agent --help

Here's a list of possible options:

causely agent install --namespace <namespace> --repository <repo> --tag <version> --cluster-name <my_cluster_name> --kube-context <my_kubectx> --values <causely-values.yaml>

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.