Install with ArgoCDΒΆ

This tutorial installs Robusta with ArgoCD.

PrerequisitesΒΆ

  • A Kubernetes cluster with ArgoCD

  • A generated_values.yaml file. Follow the Generate a Config tutorial to generate this.

Have questions?

Ask on Slack or open a GitHub issue

Preparing Robusta's configΒΆ

Prepare your generated_values.yaml file for ArgoCD:

  • If it's not already present, add clusterName: <YOUR-CLUSTER-NAME>

  • If installing on a test cluster like KIND, add isSmallCluster: true

Example generated_values.yaml:

clusterName: my_cluster_name # <- This is the line to be added
isSmallCluster: false        # <- Optional. Set this on test clusters to lower Robusta's resource usage.
globalConfig:
  signing_key: xxxxxx
  account_id: xxxxxx
sinksConfig:
- slack_sink:
    name: main_slack_sink
    slack_channel: robusta-staging-alerts
    api_key: xxxxxx
- robusta_sink:
    name: robusta_ui_sink
    token: xxxxxx
enablePrometheusStack: true
enablePlatformPlaybooks: true
runner:
  sendAdditionalTelemetry: true
rsa:
  prv: xxxxxx
  pub: xxxxxx

Secrets handling

Read this guide about Managing Secrets.

Configure ArgoCDΒΆ

Create a NEW APP in ArgoCD and fill in the following settings.

General settingsΒΆ

  • Application name: Your choice (e.g "robusta")

  • Project name: Your choice (e.g "default")

  • Sync Policy: Your choice (we recommend starting with Manual)

Source settingsΒΆ

Destination settingsΒΆ

  • To install robusta in the same cluster as ArgoCD, use the default https://kubernetes.default.svc option

  • Namespace: Your choice ("default" or "robusta" is recommended)

Here is a screenshot of all settings so far:

Directory settingsΒΆ

Change the "Directory" category to "Helm" by clicking the dropdown box.

Then paste the contents of generated_values.yaml into the values option.

Warning

Make sure you fill in values, not values files

Finish installingΒΆ

Click the create button. Then choose all and press the sync button.

Finally, run robusta logs from your cli and make sure there is no error.

Sync fails

On some Robusta versions, the sync might fail with CustomResourceDefinition.apiextensions.k8s.io β€œprometheuses.monitoring.coreos.com” is invalid: metadata.annotations: Too long: must have at most 262144 bytes.

To solve it, use the workaround proposed here

For faster Kubernetes troubleshooting, add Robusta links to ArgoCD.

Add an annotation to each Kubernetes resource with Robusta's URL:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-deployment
  annotations:
    link.argocd.argoproj.io/external-link: "https://platform.robusta.dev/"

Or link applications to their specific Robusta pages:

apiVersion: apps/v1
kind: Deployment #workload type
metadata:
  name: my-deployment #workload name
  annotations:
    link.argocd.argoproj.io/external-link: "https://platform.robusta.dev/?namespace=%22default%22&type=%22Deployment%22&name=%22some-deployment%22&cluster=%22robusta-cluster-name%22"
What is the right Robusta URL for each application?

It's easiest to open the workload in RobustaUI and copy the URL from the browser.

You can also build the URL by hand. Edit the above URL, replacing:

  • default with the workload's namespace

  • Deployment with the workload type. Ex: StatefulSets

  • some-deployment with the workload's name. Ex: my-deployment

  • robusta-cluster-name with your cluster's name, as defined in the Robusta Helm value clusterName

For more details, refer to the Argo Documentation on External URLs.