92 lines
3.3 KiB
YAML
92 lines
3.3 KiB
YAML
---
|
|
|
|
argument_specs:
|
|
main:
|
|
short_description: Grafana
|
|
description: "Sets up a grafana docker container"
|
|
options:
|
|
grafana_oauth_enabled:
|
|
description: Enables generic OAuth2 authentication.
|
|
type: bool
|
|
required: false
|
|
default: false
|
|
grafana_oauth_name:
|
|
description: Name that refers to the generic OAuth2 authentication from the Grafana user interface.
|
|
type: str
|
|
required: false
|
|
grafana_oauth_client_id:
|
|
description: Client ID provided by your OAuth2 app.
|
|
type: str
|
|
required: "{{ grafana_oauth_enabled }}"
|
|
grafana_oauth_client_secret:
|
|
description: Client secret provided by your OAuth2 app.
|
|
type: str
|
|
required: "{{ grafana_oauth_enabled }}"
|
|
grafana_oauth_auth_url:
|
|
description: Authorization endpoint of your OAuth2 provider.
|
|
type: str
|
|
required: "{{ grafana_oauth_enabled }}"
|
|
grafana_oauth_token_url:
|
|
description: Endpoint used to obtain the OAuth2 access token.
|
|
type: str
|
|
required: "{{ grafana_oauth_enabled }}"
|
|
grafana_oauth_api_url:
|
|
description: Endpoint used to obtain user information compatible with OpenID UserInfo.
|
|
type: str
|
|
required: "{{ grafana_oauth_enabled }}"
|
|
grafana_oauth_scopes:
|
|
description: List of OAuth2 scopes.
|
|
type: list
|
|
required: false
|
|
items: str
|
|
default:
|
|
- openid
|
|
- profile
|
|
- email
|
|
grafana_oauth_role_attribute_path:
|
|
description: JMESPath expression to use for Grafana role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (Viewer, Editor, Admin or GrafanaAdmin).
|
|
type: str
|
|
required: false
|
|
grafana_oauth_allow_sign_up:
|
|
description: Controls Grafana user creation through the generic OAuth2 login. Only existing Grafana users can log in with generic OAuth if set to false.
|
|
type: bool
|
|
required: false
|
|
default: true
|
|
grafana_oauth_auto_login:
|
|
description: Set to true to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login.
|
|
type: bool
|
|
required: false
|
|
default: false
|
|
|
|
database_passwords:
|
|
description: "Passed to container role"
|
|
required: true
|
|
type: dict
|
|
docker_vhost_domains:
|
|
description: "Passed to container role"
|
|
required: true
|
|
type: dict
|
|
|
|
# All options after this will be passed directly to the container role
|
|
docker_host_user:
|
|
description: "Passed to container role"
|
|
required: false
|
|
|
|
docker_additional_services:
|
|
description: "Passed to container role"
|
|
required: false
|
|
|
|
docker_volume_type:
|
|
description: "Passed to container role"
|
|
required: false
|
|
reverse_proxy_type:
|
|
description: "Passed to container role"
|
|
required: false
|
|
ports:
|
|
description: "Passed to container role"
|
|
required: false
|
|
docker_entrypoint:
|
|
description: "Passed to container role"
|
|
required: false
|
|
|