forked from stove/dataset
126 lines
10 KiB
Markdown
126 lines
10 KiB
Markdown
---
|
|
gitea: none
|
|
include_toc: true
|
|
---
|
|
|
|
# grafana
|
|
|
|
## Synopsis
|
|
|
|
Grafana is an analytics and interactive visualization web application.
|
|
|
|
[Software's website.](https://grafana.com/)
|
|
|
|
## Basic variables
|
|
|
|
### Général
|
|
|
|
#### Reverse proxy
|
|
|
|
##### Point d'entrée des clients
|
|
|
|
This family is a leadership.
|
|
|
|
| Parameter | Comments |
|
|
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
|
|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine exterieur du serveur.<br/>**Example:** service.example.net |
|
|
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de l'arborescence racine du site. |
|
|
|
|
#### OAuth2 client
|
|
|
|
##### external
|
|
|
|
| Parameter | Comments |
|
|
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
|
|
| **[general.oauth2_client.oauth2_email_domain](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domain name allowed to log on Grafana.<br/>**Example:** example.net |
|
|
|
|
|
|
## Variables for expert
|
|
|
|
### Général
|
|
|
|
#### Reverse proxy
|
|
|
|
##### Point d'entrée des clients
|
|
|
|
This family is a leadership.
|
|
|
|
| Parameter | Comments |
|
|
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
|
|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximum du corps. |
|
|
|
|
#### PostgreSQL
|
|
|
|
| Parameter | Comments |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
|
|
| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.<br/>**Default:** *calculated* |
|
|
| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.<br/>**Default:** *calculated* |
|
|
| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.<br/>**Default:** *calculated* |
|
|
|
|
#### OAuth2 client
|
|
|
|
| Parameter | Comments |
|
|
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
|
|
| **[general.oauth2_client.oauth2_client_name](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Grafana<br/>**Example:** example |
|
|
| **[general.oauth2_client.oauth2_client_description](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Visualisation de données<br/>**Example:** Example description |
|
|
| **[general.oauth2_client.oauth2_client_login](dictionaries/30_oauth2_client.xml)**<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 URL to valid login. |
|
|
|
|
##### external
|
|
|
|
| Parameter | Comments |
|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
|
|
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/30_oauth2_client.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
|
|
| **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users |
|
|
|
|
| Parameter | Comments |
|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
|
|
| **[general.oauth2_client.oauth2_client_category](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Administration |
|
|
| **[general.oauth2_client.oauth2_client_logo](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_note.png |
|
|
|
|
## Requirements services
|
|
|
|
- **LocalDNS**
|
|
- Journald
|
|
- **SMTP**
|
|
- **ReverseProxy**
|
|
- **Postgresql**
|
|
- **OAuth2**
|
|
|
|
**bold**: provider is mandatory
|
|
|
|
## 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
|
|
- reverseproxy
|
|
- smtp
|
|
- oauth2
|
|
- postgresql
|
|
values:
|
|
general.revprox.revprox_client.revprox_client_external_domainnames:
|
|
- service.example.net
|
|
general.oauth2_client.oauth2_email_domain: example.net
|
|
```
|
|
|
|
## Dependances
|
|
|
|
- [base-fedora-38](../base-fedora-38/README.md)
|
|
- [base-fedora](../base-fedora/README.md)
|
|
- [systemd](../systemd/README.md)
|
|
- [base-machine](../base-machine/README.md)
|
|
- [base](../base/README.md)
|
|
- [dns-local](../dns-local/README.md)
|
|
- [pki-tls](../pki-tls/README.md)
|
|
- [journald](../journald/README.md)
|
|
- [resolved](../resolved/README.md)
|
|
- [postgresql-client](../postgresql-client/README.md)
|
|
- [oauth2-client](../oauth2-client/README.md)
|
|
- [reverse-proxy-client](../reverse-proxy-client/README.md)
|
|
- [relay-mail-client](../relay-mail-client/README.md)
|
|
|
|
[All applications services for this dataset.](../README.md)
|