dataset/seed/grafana/README.md

Table of Contents

• grafana
• Synopsis
• Example
• Basic variables
• General
• Reverse proxy
• Clients configuration
• OAuth2 client
• external
• Variables
• General
• Reverse proxy
• Clients configuration
• OAuth2 client
• external
• Requirements services
• Mandatories
• Optionals
• Dependances

Return to the list of application services.

grafana

Synopsis

Grafana is an analytics and interactive visualization web application.

Example

Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.

grafana:
  applicationservice: grafana
  zones_name:
    - localdns
    - oauth2
    - postgresql
    - reverseproxy
    - smtp
  values:
    general.revprox.revprox_client.revprox_client_external_domainnames:
      - service.example.net
    general.oauth2_client.oauth2_email_domain: example.net

Basic variables

General

Reverse proxy

Clients configuration

This family is a leadership.

Parameter	Comment
general.revprox.revprox_client.revprox_client_external_domainnames mandatory, multiple Type: domainname	Service external domain name. Example: service.example.net
general.revprox.revprox_client.revprox_client_location mandatory Type: filename	URI to route request to the correct service. Default: /

OAuth2 client

external

Parameter	Comments
general.oauth2_client.oauth2_email_domain mandatory Type: domainname	Domain name allowed to log on Grafana. Example: example.net

Variables

General

Reverse proxy

Clients configuration

This family is a leadership.

Parameter	Comment
general.revprox.revprox_client.revprox_client_max_body_size Type: string	The maximum allowed size of the client request body.

OAuth2 client

Parameter	Comment
general.oauth2_client.oauth2_client_name mandatory Type: string	OAuth2 client name. Default: Grafana Example: example
general.oauth2_client.oauth2_client_description mandatory Type: string	OAuth2 client description. Default: Visualisation de données Example: Example description
general.oauth2_client.oauth2_client_login Type: web_address	OAuth2 URL to valid login.

external

Parameter	Comments
general.oauth2_client.external.oauth2_client_external mandatory, multiple Type: web_address	OAuth2 client external. Default: calculated
general.oauth2_client.external.oauth2_client_family mandatory Type: string	OAuth2 family. Default: users

Parameter	Comments
general.oauth2_client.oauth2_client_category mandatory Type: string	OAuth2 category. Default: Administration
general.oauth2_client.oauth2_client_logo mandatory Type: string	OAuth2 logo. Default: silique_note.png

Requirements services

Mandatories

• LocalDNS: DNS forwarder for local domain name.
• SMTP: Create a SMTP relay account and authorize sending email.
• ReverseProxy: Register to service to a reverse proxy server.
• Postgresql: Create account and connexion to a PostgreSQL server.
• OAuth2: Remote clients needing to verify OAuth2 account.

Optionals

• Journald: Concentrate journal messages on one host.

Dependances

• base-fedora-38: Base information of a Fedora 38.
  • base-fedora: Base information of a Fedora.
    • systemd: Systemd, a system and service manager.
      • base-machine: Base information for a machine.
        • base: Base of all application services.
        • dns-local: DNS client with access to local zones.
        • pki-tls: Autosign PKI or Let's encrypt support for TLS certificates.
      • journald: Journald.
      • resolved: Resolved.
• postgresql-client: Application service needs interact with a Postgresql server.
• oauth2-client: Application service needs interact with a Oauth2 server.
• reverse-proxy-client: Application service needs interact with a a reverse proxy server.
• relay-mail-client: Client SMTP.