Skip to main content

Installation Guide

The Metrics module enhances data gathering, observability, and metric analysis within the ArconQ ecosystem. It is bundled with the ArconQ installation package.

Prerequisite: Installing Node-Exporter and Kube-State-Metrics and CRDs​

Before installing ArconQ, you must first install node-exporter, kube-state-metrics to enable proper metric collection and operation within your cluster.
Both of these resources are needed only once per cluster. They can be installed in a workspace different than your ArconQ installation.

Steps to install node-exporter and kube-state-metrics:​

  1. Add Prometheus Helm repository:
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
  1. Install node-exporter: 
helm install prometheus-node-exporter --namespace prometheus --create-namespace --atomic prometheus-community/prometheus-node-exporter
  1. Install kube-metrics: 
helm install prometheus-kube-metrics --namespace prometheus --create-namespace --atomic prometheus-community/kube-state-metrics

Enabling metrics during installation​

The Metrics module is disabled by default. To enable it, add --set 'metrics.enabled=true' to the installation script. For more information please refer to ArconQ installation guide

Accessing Grafana​

Grafana is seamlessly integrated with ArconQ, allowing its charts to be viewed directly within ArconQ's UI.

Additionally, Grafana can be directly accessed via the ArconQ URL with the /grafana suffix. For example, if ArconQ is hosted at https://arconq.prod, Grafana can be reached at https://arconq.prod/grafana.

For detailed guidance on using Grafana and understanding its dashboards, refer to the next page.

⚠️ Hosting multiple ArconQ Metrics instances in a single cluster​

Deploying multiple ArconQ Metrics instances within a single cluster comes with a following constraints:

  • Unique Release Name & Unique Namespace: Each instance must be installed in a distinct namespace. Furthermore, it is imperative to use a cluster-wide unique release name and unique namespace for every installation.