Skip to main content

Helm Installation

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

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

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: Review Discovery​

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 Observe > Topology view. As root causes are identified, they will appear in the Diagnose and Prevent menus.

Custom Installation Options​

Use a Custom Values File​

To specify additional configurations - like a specific image tag, integrations, webhook notifications, etc - you can do this by creating a causely-values.yaml file. Below is an example of common values used for installation.

global:
  cluster_name: <my_cluster_name>
image:
  tag: <version> # Locate latest version in Causely Portal > Integrations > Agents
mediator:
  gateway:
    token: <my_token> # Locate your token in Causely Portal > Integrations > Details

Now specify the --values parameter for to the previous helm command.

Custom Labels​

You can scope the Causely interface to specific components out-of-the-box (clusters, namespaces, services). Causely can also use labels to provide users with additional scopes - this can be accomplished by adding the following to your causely-values.yaml.

label_semconv:
  scopes:
    geography:
      - 'app.kubernetes.io/geography'
    environment:
      - 'app.kubernetes.io/environment'
    customer:
      - 'app.kubernetes.io/customer'
    team:
      - 'app.kubernetes.io/team'
    product:
      - 'app.kubernetes.io/product'
    project:
      - 'app.kubernetes.io/project'
    service:
      - 'app.kubernetes.io/service'

Integrations​

You can add additional data sources to Causely which expands Causely's causality map to help identify root causes. Some integrations require you to update your causely-values.yaml file. For more details on Integrations, see Integrations

Webhooks​

Causely can send information on root causes that are identified to your existing notification platforms. Enabling webhooks requires you to update your causely-values.yaml file. To enable webhooks, see Webhook Configuration