grafana4_datasource
¶
Manage Grafana v4.0 data sources
Added in version 2017.7.0.
- configuration:
This state requires a configuration profile to be configured in the minion config, minion pillar, or master config. The module will use the ‘grafana’ key by default, if defined.
Example configuration using basic authentication:
grafana: grafana_url: http://grafana.localhost grafana_user: admin grafana_password: admin grafana_timeout: 3
Example configuration using token based authentication:
grafana: grafana_url: http://grafana.localhost grafana_token: token grafana_timeout: 3
The behavior of this module is to create data sources if the do not exists, and to update data sources if the already exists.
Ensure influxdb data source is present:
grafana4_datasource.present:
- name: influxdb
- type: influxdb
- url: http://localhost:8086
- access: proxy
- basic_auth: true
- basic_auth_user: myuser
- basic_auth_password: mypass
- is_default: true
- saltext.grafana.states.grafana4_datasource.__virtual__()[source]¶
Only load if grafana4 module is available
- saltext.grafana.states.grafana4_datasource.present(name, type, url, access=None, user=None, password=None, database=None, basic_auth=None, basic_auth_user=None, basic_auth_password=None, tls_auth=None, json_data=None, is_default=None, with_credentials=None, type_logo_url=None, orgname=None, profile='grafana')[source]¶
Ensure that a data source is present.
- name
Name of the data source.
- type
Type of the datasource (‘graphite’, ‘influxdb’ etc.).
- access
Use proxy or direct. Default: proxy
- url
The URL to the data source API.
- user
Optional - user to authenticate with the data source.
- password
Optional - password to authenticate with the data source.
- database
Optional - database to use with the data source.
- basic_auth
Optional - set to True to use HTTP basic auth to authenticate with the data source.
- basic_auth_user
Optional - HTTP basic auth username.
- basic_auth_password
Optional - HTTP basic auth password.
- json_data
Optional - additional json data to post (eg. “timeInterval”).
- is_default
Optional - set data source as default.
- with_credentials
Optional - Whether credentials such as cookies or auth headers should be sent with cross-site requests.
- type_logo_url
Optional - Logo to use for this datasource.
- orgname
Name of the organization in which the data source should be present.
- profile
Configuration profile used to connect to the Grafana instance. Default is ‘grafana’.
- saltext.grafana.states.grafana4_datasource.absent(name, orgname=None, profile='grafana')[source]¶
Ensure that a data source is present.
- name
Name of the data source to remove.
- orgname
Name of the organization from which the data source should be absent.
- profile
Configuration profile used to connect to the Grafana instance. Default is ‘grafana’.