Skip to main content

Grafana

Overview​

Grafana is available as an add-on within Ankra's platform, allowing you to visualize, query, and alert on metrics from multiple data sources. Grafana enables you to create and share dashboards with your team to foster a data-driven culture, making it easier to monitor your Kubernetes cluster and services.

Configuration Options​

The Grafana add-on offers configurable inputs that allow you to customize the deployment for your organization’s specific needs. Below are the available inputs:

Inputs​

  • Helm Chart Version
    This input sets the version of the Grafana Helm chart to deploy.

    • Default: 8.5.2
    • Options:
      • 8.5.2 (default)
      • 8.5.1

    Example:

    helm_chart_version: "8.5.2"

  • Replicas
    This input sets the number of Grafana replicas to deploy.

    • Default: 1
    • Options:
      • 1 (default)
      • 2, 3, 4, 5, 6

    Example:

    replicas: "1"

  • Ingress Hostname
    This input defines the hostname for the Grafana ingress. When set, it enables the ingress for Grafana.

    • Default: ""

    Example:

    ingress_hostname: "grafana.example.com"

  • Ingress TLS Provider
    This input specifies the TLS provider for securing the Grafana ingress.

    • Default: letsencrypt
    • Options:
      • letsencrypt (default)
      • cloudflare

    Example:

    ingress_tls_provider: "letsencrypt"

  • Ingress DNS Target
    This input sets the DNS target for the Grafana ingress, typically pointing to the cluster load balancer DNS name.

    • Default: $LOAD_BALANCER_DNS_NAME

    Example:

    ingress_dns_target: "$LOAD_BALANCER_DNS_NAME"

  • Cert Manager Dashboard
    This input determines whether to apply the Cert Manager Grafana dashboards.

    • Default: false
    • Options:
      • true
      • false (default)

    Example:

    cert_manager_dashboard: "false"

  • Kubernetes Dashboards
    This input specifies whether to apply the Kubernetes dashboards.

    • Default: true
    • Options:
      • true (default)
      • false

    Example:

    kubernetes_dashboards: "true"

  • Nginx Dashboards
    This input specifies whether to apply the Nginx dashboards.

    • Default: false
    • Options:
      • true
      • false (default)

    Example:

    nginx_dashboards: "false"

  • Node Dashboards
    This input specifies whether to apply the Node dashboards.

    • Default: true
    • Options:
      • true (default)
      • false

    Example:

    node_dashboards: "true"

  • Alerting Dashboards
    This input specifies whether to apply the Alerting dashboards.

    • Default: false
    • Options:
      • true
      • false (default)

    Example:

    alerting_dashboards: "false"

  • CoreDNS Dashboards
    This input specifies whether to apply the CoreDNS dashboards.

    • Default: false
    • Options:
      • true
      • false (default)

    Example:

    coredns_dashboards: "false"

Usage​

Deploying Grafana​

To deploy Grafana in your Kubernetes cluster using Ankra, follow these steps:

  1. Access the Add-ons Section
    In Ankra's platform, navigate to the Add-ons section and select Grafana from the list of available add-ons.

  2. Configure Inputs
    You will be prompted to configure the following inputs:

    • Helm Chart Version: Set the version of the Grafana Helm chart.
    • Replicas: Set the number of Grafana replicas.
    • Ingress Hostname: Define the ingress hostname.
    • Ingress TLS Provider: Choose the TLS provider (e.g., Let's Encrypt or Cloudflare).
    • Ingress DNS Target: Set the DNS target for the ingress.
    • Cert Manager Dashboard: Optionally enable the Cert Manager Grafana dashboards.
    • Kubernetes Dashboards: Enable or disable the Kubernetes dashboards.
    • Nginx Dashboards: Enable or disable the Nginx dashboards.
    • Node Dashboards: Enable or disable the Node dashboards.
    • Alerting Dashboards: Enable or disable the Alerting dashboards.
    • CoreDNS Dashboards: Enable or disable the CoreDNS dashboards.

    Example configuration:

    helm_chart_version: "8.5.2"
    replicas: "1"
    ingress_hostname: "grafana.example.com"
    ingress_tls_provider: "letsencrypt"
    ingress_dns_target: "$LOAD_BALANCER_DNS_NAME"
    cert_manager_dashboard: "false"
    kubernetes_dashboards: "true"
    nginx_dashboards: "false"
    node_dashboards: "true"
    alerting_dashboards: "false"
    coredns_dashboards: "false"

  3. Access
    You can gain access from the URL you have provided during setup. You can get started with the admin account by extracting the admin-credentials secret and decode the secret data.