Provisioning Grafana

Config file

Checkout the configuration page for more information on what you can configure in grafana.ini

Config file locations

  • Default configuration from $WORKING_DIR/conf/defaults.ini
  • Custom configuration from $WORKING_DIR/conf/custom.ini
  • The custom configuration file path can be overridden using the --config parameter

Note. If you have installed Grafana using the deb or rpm packages, then your configuration file is located at /etc/grafana/grafana.ini. This path is specified in the Grafana init.d script using --config file parameter.

Using environment variables

All options in the configuration file (listed below) can be overridden using environment variables using the syntax:


Where the section name is the text within the brackets. Everything should be upper case and . should be replaced by _. For example, given these configuration settings:

# default section
instance_name = ${HOSTNAME}

admin_user = admin

client_secret = 0ldS3cretKey

Overriding will be done like so:

export GF_DEFAULT_INSTANCE_NAME=my-instance

Configuration management tools

Currently we do not provide any scripts/manifests for configuring Grafana. Rather than spending time learning and creating scripts/manifests for each tool, we think our time is better spent making Grafana easier to provision. Therefore, we heavily relay on the expertise of the community.



This feature is available from v5.0

It’s possible to manage datasources in Grafana by adding one or more yaml config files in the provisioning/datasources directory. Each config file can contain a list of datasources that will be added or updated during start up. If the datasource already exists, Grafana will update it to match the configuration file. The config file can also contain a list of datasources that should be deleted. That list is called delete_datasources. Grafana will delete datasources listed in delete_datasources before inserting/updating those in the datasource list.

Running multiple Grafana instances.

If you are running multiple instances of Grafana you might run into problems if they have different versions of the datasource.yaml configuration file. The best way to solve this problem is to add a version number to each datasource in the configuration and increase it when you update the config. Grafana will only update datasources with the same or lower version number than specified in the config. That way, old configs cannot overwrite newer configs if they restart at the same time.

Example datasource config file

# config file version
apiVersion: 1

# list of datasources that should be deleted from the database
  - name: Graphite
    orgId: 1

# list of datasources to insert/update depending
# whats available in the database
  # <string, required> name of the datasource. Required
- name: Graphite
  # <string, required> datasource type. Required
  type: graphite
  # <string, required> access mode. direct or proxy. Required
  access: proxy
  # <int> org id. will default to orgId 1 if not specified
  orgId: 1
  # <string> url
  url: http://localhost:8080
  # <string> database password, if used
  # <string> database user, if used
  # <string> database name, if used
  # <bool> enable/disable basic auth
  # <string> basic auth username
  # <string> basic auth password
  # <bool> enable/disable with credentials headers
  # <bool> mark as default datasource. Max one per org
  # <map> fields that will be converted to json and stored in json_data
     graphiteVersion: "1.1"
     tlsAuth: true
     tlsAuthWithCACert: true
  # <string> json object of data that will be encrypted.
    tlsCACert: "..."
    tlsClientCert: "..."
    tlsClientKey: "..."
  version: 1
  # <bool> allow users to edit datasources from the UI.
  editable: false

Json data

Since not all datasources have the same configuration settings we only have the most common ones as fields. The rest should be stored as a json blob in the json_data field. Here are the most common settings that the core datasources use.

tlsAuthbooleanAllEnable TLS authentication using client cert configured in secure json data
tlsAuthWithCACertbooleanAllEnable TLS authtication using CA cert
tlsSkipVerifybooleanAllControls whether a client verifies the server’s certificate chain and host name.
graphiteVersionstringGraphiteGraphite version
timeIntervalstringElastic, Influxdb & PrometheusLowest interval/step value that should be used for this data source
esVersionstringElasticElasticsearch version as an number (2/5/56)
timeFieldstringElasticWhich field that should be used as timestamp
intervalstringElasticIndex date time format
authTypestringCloudwatchAuth provider. keys/credentials/arn
assumeRoleArnstringCloudwatchARN of Assume Role
defaultRegionstringCloudwatchAWS region
customMetricsNamespacesstringCloudwatchNamespaces of Custom Metrics
sslmodestringPostgreSSLmode. ‘disable’, ‘require’, ‘verify-ca’ or ‘verify-full’

Secure Json data


Secure json data is a map of settings that will be encrypted with secret key from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional.

tlsCACertstringAllCA cert for out going requests
tlsClientCertstringAllTLS Client cert for outgoing requests
tlsClientKeystringAllTLS Client key for outgoing requests
accessKeystringCloudwatchAccess key for connecting to Cloudwatch
secretKeystringCloudwatchSecret key for connecting to Cloudwatch


It’s possible to manage dashboards in Grafana by adding one or more yaml config files in the provisioning/dashboards directory. Each config file can contain a list of dashboards providers that will load dashboards into Grafana from the local filesystem.

The dashboard provider config file looks somewhat like this:

apiVersion: 1

- name: 'default'
  orgId: 1
  folder: ''
  type: file
  disableDeletion: false
  editable: false
    path: /var/lib/grafana/dashboards

When Grafana starts, it will update/insert all dashboards available in the configured path. Then later on poll that path and look for updated json files and insert those update/insert those into the database.

Reuseable dashboard urls

If the dashboard in the json file contains an uid, Grafana will force insert/update on that uid. This allows you to migrate dashboards betweens Grafana instances and provisioning Grafana from configuration without breaking the urls given since the new dashboard url uses the uid as identifer. When Grafana starts, it will update/insert all dashboards available in the configured folders. If you modify the file, the dashboard will also be updated. By default Grafana will delete dashboards in the database if the file is removed. You can disable this behavior using the disableDeletion setting.

Note. Provisioning allows you to overwrite existing dashboards which leads to problems if you re-use settings that are supposed to be unique. Be careful not to re-use the same title multiple times within a folder or uid within the same installation as this will cause weird behaviours.