ChristianLempa_Boilerplates/library/compose/grafana/template.yaml

---
kind: compose
metadata:
  name: Grafana
  description: 'Grafana is an open-source platform for monitoring and observability that allows you to visualize and analyze
    metrics, logs, and traces from various data

    sources. It provides a powerful and flexible dashboarding solution for IT infrastructure and application monitoring.

    ## Prerequisites

    - **Project:** https://grafana.com/

    - **Documentation:** https://grafana.com/docs/grafana/latest/

    - **GitHub:** https://github.com/grafana/grafana'
  icon:
    provider: selfh
    id: grafana
  next_steps: 'Log in with the initial admin user:

    ```bash

    Username: admin

    Password: admin

    ```'
  version: 12.3.3
  author: Christian Lempa
  date: '2026-02-12'
  tags:
    - traefik
    - authentik
schema: '1.2'
spec:
  general:
    vars:
      service_name:
        default: grafana
      restart_policy:
        type: enum
        options:
          - unless-stopped
          - always
          - on-failure
          - 'no'
        default: unless-stopped
        required: true
  ports:
    vars:
      ports_http:
        default: 3000
  authentik:
    toggle: authentik_enabled
    vars:
      authentik_enabled:
        type: bool
        default: false
        description: Enable Authentik SSO integration
      authentik_url:
        type: url
        default: https://auth.home.arpa
        required: true
        needs: authentik_enabled=true
      authentik_slug:
        type: hostname
        default: grafana
        required: true
        needs: authentik_enabled=true
      authentik_client_id:
        type: str
        sensitive: true
        required: true
        needs: authentik_enabled=true
      authentik_client_secret:
        type: str
        sensitive: true
        required: true
        needs: authentik_enabled=true
  traefik:
    vars:
      traefik_host:
        default: grafana
      traefik_network:
        default: traefik
        type: str
        required: true
      traefik_domain:
        default: home.arpa
        type: str
        required: true
      traefik_enabled:
        type: bool
        default: false
        description: Enable Traefik integration
  traefik_tls:
    vars:
      traefik_tls_certresolver:
        type: str
        default: cloudflare
        required: true
      traefik_tls_enabled:
        type: bool
        default: false
        description: Enable Traefik TLS
  database:
    vars:
      database_type:
        type: enum
        options:
          - sqlite
          - postgres
      database_external:
        type: bool
        default: false
        description: Use external database
        needs: database_type=postgres
      database_name:
        type: str
        default: grafana
        needs: database_type=postgres
      database_user:
        type: str
        default: grafana
        needs: database_type=postgres
      database_password:
        type: str
        sensitive: true
        required: true
        needs: database_type=postgres
      database_host:
        type: str
        required: true
        needs: ["database_type=postgres", "database_external=true"]
  swarm:
    toggle: swarm_enabled
    vars:
      swarm_enabled:
        type: bool
        default: false
        description: Enable Docker Swarm mode
      swarm_placement_mode:
        type: str
        default: replicated
        description: The placement mode
        needs:
          - swarm_enabled=true
      swarm_replicas:
        type: int
        default: 1
        description: The number of replicas
        needs:
          - swarm_placement_mode=replicated
      swarm_placement_host:
        type: str
        default: ''
        description: The placement host
        needs:
          - swarm_placement_mode=replicated