Provisioning: sync datasources/sample.yaml with docs (#80894)

Provisioning: datasources/sample.yaml with docs
This commit is contained in:
Clemens Korner 2024-01-23 09:51:12 +01:00 committed by GitHub
parent 51f5e1af39
commit 6a387aa1c5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,50 +1,71 @@
# # config file version
# Configuration file version
apiVersion: 1
# # list of datasources that should be deleted from the database
#deleteDatasources:
# # List of data sources to delete from the database.
# deleteDatasources:
# - name: Graphite
# orgId: 1
# # list of datasources to insert/update depending
# # on what's available in the database
#datasources:
# # <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 user, if used
# user:
# # <string> database name, if used
# database:
# # <bool> enable/disable basic auth
# basicAuth:
# # <string> basic auth username
# basicAuthUser:
# # <bool> enable/disable with credentials headers
# withCredentials:
# # <bool> mark as default datasource. Max one per org
# isDefault:
# # <map> fields that will be converted to json and stored in json_data
# jsonData:
# graphiteVersion: "1.1"
# tlsAuth: true
# tlsAuthWithCACert: true
# httpHeaderName1: "Authorization"
# # <string> json object of data that will be encrypted.
# secureJsonData:
# tlsCACert: "..."
# tlsClientCert: "..."
# tlsClientKey: "..."
# # <openshift\kubernetes token example>
# httpHeaderValue1: "Bearer xf5yhfkpsnmgo"
# version: 1
# # <bool> allow users to edit datasources from the UI.
# editable: false
# # List of data sources to insert/update depending on what's
# # available in the database.
# datasources:
# # <string, required> Sets the name you use to refer to
# # the data source in panels and queries.
# - name: Graphite
# # <string, required> Sets the data source type.
# type: graphite
# # <string, required> Sets the access mode, either
# # proxy or direct (Server or Browser in the UI).
# # Some data sources are incompatible with any setting
# # but proxy (Server).
# access: proxy
# # <int> Sets the organization id. Defaults to orgId 1.
# orgId: 1
# # <string> Sets a custom UID to reference this
# # data source in other parts of the configuration.
# # If not specified, Grafana generates one.
# uid: my_unique_uid
# # <string> Sets the data source's URL, including the
# # port.
# url: http://localhost:8080
# # <string> Sets the database user, if necessary.
# user:
# # <string> Sets the database name, if necessary.
# database:
# # <bool> Enables basic authorization.
# basicAuth:
# # <string> Sets the basic authorization username.
# basicAuthUser:
# # <bool> Enables credential headers.
# withCredentials:
# # <bool> Toggles whether the data source is pre-selected
# # for new panels. You can set only one default
# # data source per organization.
# isDefault:
# # <map> Fields to convert to JSON and store in jsonData.
# jsonData:
# # <string> Defines the Graphite service's version.
# graphiteVersion: '1.1'
# # <bool> Enables TLS authentication using a client
# # certificate configured in secureJsonData.
# tlsAuth: true
# # <bool> Enables TLS authentication using a CA
# # certificate.
# tlsAuthWithCACert: true
# # <map> Fields to encrypt before storing in jsonData.
# secureJsonData:
# # <string> Defines the CA cert, client cert, and
# # client key for encrypted authentication.
# tlsCACert: '...'
# tlsClientCert: '...'
# tlsClientKey: '...'
# # <string> Sets the database password, if necessary.
# password:
# # <string> Sets the basic authorization password.
# basicAuthPassword:
# # <int> Sets the version. Used to compare versions when
# # updating. Ignored when creating a new data source.
# version: 1
# # <bool> Allows users to edit data sources from the
# # Grafana UI.
# editable: false