stove/dataset
3
0
Fork 1
Code Issues 2 Pull requests Projects Releases Wiki Activity
dataset/seed/grafana/README.md

121 lines
9 KiB
Markdown
Raw Normal View History

doc: update README files
2023-06-29 18:56:46 +02:00
---
gitea: none
include_toc: true
---
update doc
2023-08-11 09:38:05 +02:00
[Return to the list of application services.](../README.md)
doc: update README files
2023-06-29 18:56:46 +02:00
# grafana
update doc
2023-08-02 09:26:54 +02:00
## Synopsis
doc: update README files
2023-06-29 18:56:46 +02:00
update doc
2023-08-11 09:38:05 +02:00
[Grafana is an analytics and interactive visualization web application.](https://grafana.com/)
doc: update README files
2023-06-29 18:56:46 +02:00
update doc
2023-08-02 09:26:54 +02:00
## Basic variables
update doc
2023-08-01 15:13:17 +02:00
update doc
2023-08-11 09:38:05 +02:00
### General
update doc
2023-08-01 15:13:17 +02:00
update doc
2023-08-02 09:26:54 +02:00
#### Reverse proxy
update doc
2023-08-01 15:13:17 +02:00
update doc
2023-08-11 09:38:05 +02:00
##### Clients configuration
update doc
2023-08-02 09:26:54 +02:00
update doc
2023-08-10 21:55:46 +02:00
This family is a leadership.
update doc
2023-08-02 09:26:54 +02:00
update doc
2023-08-11 09:38:05 +02:00
| 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) | Service external domain name.<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) | URI to route request to the correct service.<br/>**Default:** / |
update doc
2023-08-02 09:26:54 +02:00
#### 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
update doc
2023-08-11 09:38:05 +02:00
### General
update doc
2023-08-02 09:26:54 +02:00
#### Reverse proxy
update doc
2023-08-11 09:38:05 +02:00
##### Clients configuration
update doc
2023-08-02 09:26:54 +02:00
update doc
2023-08-10 21:55:46 +02:00
This family is a leadership.
update doc
2023-08-02 09:26:54 +02:00
update doc
2023-08-11 09:38:05 +02:00
| 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) | The maximum allowed size of the client request body. |
update doc
2023-08-02 09:26:54 +02:00
#### 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
update doc
2023-08-11 09:38:05 +02:00
### Mandatories
- [LocalDNS](../README.LocalDNS.md)
- [SMTP](../README.SMTP.md)
- [ReverseProxy](../README.ReverseProxy.md)
- [Postgresql](../README.Postgresql.md)
- [OAuth2](../README.OAuth2.md)
### Optionals
update doc
2023-08-02 09:26:54 +02:00
update doc
2023-08-11 09:38:05 +02:00
- [Journald](../README.Journald.md)
update doc
2023-08-02 09:26:54 +02:00
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
update doc
2023-08-01 15:13:17 +02:00
```
grafana:
applicationservice: grafana
zones_name:
- localdns
- oauth2
- postgresql
update doc
2023-08-11 09:38:05 +02:00
- reverseproxy
- smtp
update doc
2023-08-02 09:26:54 +02:00
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.oauth2_client.oauth2_email_domain: example.net
update doc
2023-08-01 15:13:17 +02:00
```
doc: update README files
2023-06-29 18:56:46 +02:00
## 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)
update doc
2023-07-31 18:41:59 +02:00
- [resolved](../resolved/README.md)
doc: update README files
2023-06-29 18:56:46 +02:00
- [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)
Reference in a new issue Copy permalink