grafana job from grafana/13.2.2

Github source: b99d670 or master branch

Properties¶

`grafana`¶

admin_password¶

Password for the initial admin user.

admin_username¶

Username for the initial admin user.

auth¶
anonymous¶
enabled¶

If enabled, users do not have to log in.
Default
false
organization¶

The organization that should be used for unauthenticated users.
Default
Main Org.
organization_role¶

The role to assume for anonymous users.
Default
Viewer
generic_oauth¶
allow_sign_up¶

Permit users to register via Generic OAuth.
Default
true
allowed_domains¶

E-mail address domains to allow. If empty, all are allowed.
Default
[]
api_url¶

Generic OAuth OpenID UserInfo API endpoint.

auth_url¶

Generic OAuth authorization endpoint.

client_id¶

Generic OAuth client ID.

client_secret¶

Generic OAuth client secret.

enabled¶

Permit users to authenticate via Generic OAuth.
Default
false
name¶

Generic OAuth login link display name.
Default
OAuth
scopes¶

Generic OAuth scopes.

tls_client_ca¶

PEM encoded CA certificate for TLS client authentication via Generic OAuth.

tls_client_cert¶

PEM encoded certificate for TLS client authentication via Generic OAuth.

tls_client_key¶

PEM encoded private key for TLS client authentication via Generic OAuth.

token_url¶

Generic OAuth access token endpoint.
github¶
allow_sign_up¶

Permit users to register via GitHub OAuth.
Default
true
allowed_email_domains¶

E-mail address domains to allow. If empty, all are allowed.
Default
[]
allowed_organizations¶

GitHub organizations to allow. If empty, all are allowed.
Default
[]
api_url¶

GitHub users API endpoint.
Default
https://api.github.com/user
auth_url¶

GitHub OAuth authorization endpoint.
Default
https://github.com/login/oauth/authorize
client_id¶

GitHub OAuth client ID.

client_secret¶

GitHub OAuth client secret.

enabled¶

Permit users to authenticate via GitHub OAuth.
Default
false
team_ids¶

GitHub team IDs to allow. If empty, all are allowed.
Default
[]
token_url¶

GitHub OAuth access token endpoint.
Default
https://github.com/login/oauth/access_token
google¶
allow_sign_up¶

Permit users to register via Google OAuth.
Default
true
allowed_email_domains¶

E-mail address domains to allow. If empty, all are allowed.
Default
[]
api_url¶

Google users API endpoint.
Default
https://www.googleapis.com/oauth2/v1/userinfo
auth_url¶

Google OAuth authorization endpoint.
Default
https://accounts.google.com/o/oauth2/auth
client_id¶

Google OAuth client ID.

client_secret¶

Google OAuth client secret.

enabled¶

Permit users to authenticate via Google OAuth.
Default
false
token_url¶

Google OAuth access token endpoint.
Default
https://accounts.google.com/o/oauth2/token
proxy¶

auto_sign_up¶

Enable sign up of users who do not exist in Grafana DB

enabled¶

Handle authentication in a http reverse proxy

header_name¶

The name of the http header used to forward authenticated user

header_property¶

Whether the header contains a user name or an email address (allowed values are ‘username’ or ‘email’).
aws¶
aws_access_key_id¶

access key for AWS cloudwatch data source
Default
""
aws_secret_access_key¶

secret access key for AWS cloudwatch data source
Default
""
region¶

region for AWS cloudwatch data source
Default
""
dashboards¶

List of grafana dasboards, converted to YAML
Default
[]
Example
|+
  - name: frontend (without extension)
    content: <minified JSON content>
datasource¶

Grafana datasource; see http://docs.grafana.org/http_api/data_source/ for details

datasources¶

If you want to configure multiple datasources, you can define an array of hashes here. Each hash must have ‘name’, ‘url’, ‘type’, ‘user’, ‘password’ and ‘database’ defined.

These datasources will be created in addition to the datasource defined in ‘grafana.datasource’. The latter property is for backwards compatibility.

See http://docs.grafana.org/http_api/data_source/ for details
Default
[]
Example
|+
  - name: influxdb
    url: http://1.2.3.4:8086
    type: influxdb
    user: admin
    password: admin123
    database: metrics
external_image_storage¶

s3¶

access_key¶

Access key to use when uploading to the bucket.

bucket¶

S3 Bucket to which images can be uploaded for public visibility (i.e. alerting).

path¶

S3 Bucket path.

region¶

S3 Bucket region.

secret_key¶

Secret key to use when uploading to the bucket.

webdav¶

password¶

WebDAV password.

url¶

WebDAV URL to which images can be uploaded for public visibility (i.e. alerting).

username¶

WebDAV user name.

listen_port¶

TCP port on which the Grafana server should listen.
Default
3000
root_url¶

The full root URL for the instance. Used for OAuth callbacks.

session¶

cookie_name¶

Session cookie name

cookie_secure¶

Use session in https only

session_life_time¶

Session lifetime in seconds

snapshots¶
external_enabled¶

Enable external snapshots sharing (to snapshot.raintank.io)
Default
true
ssl¶

cert¶

SSL cert to use for HTTPS. If not specified, the server will listen in plaintext.

key¶

SSL private key to use for HTTPS. If not specified, the server will listen in plaintext.

users¶
allow_organization_creation¶

If enabled, non-admin users can create organizations.
Default
false
allow_sign_up¶

If enabled, users can create their own accounts.
Default
false
auto_assign_organization¶

If enabled, new users will be automatically added to the default organization (id 1).
Default
true
auto_assign_organization_role¶

The role for new users when automatically added to the default organization.
Default
Viewer

Templates¶

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/grafana/ directory (learn more).

bin/create-update-dashboards (from create-update-dashboards.erb)
bin/create-update-datasources (from create-update-datasources.erb)
bin/grafana_ctl (from grafana_ctl)
bin/post-start (from post-start)
config/cacert.pem (from cacert.pem.erb)
config/client.crt (from client.crt.erb)
config/client.key (from client.key.erb)
config/config.ini (from config.ini.erb)
config/ssl.crt (from ssl.crt.erb)
config/ssl.key (from ssl.key.erb)
home/.aws/credentials (from credentials)

Packages¶

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.

grafana

grafana job from grafana/13.2.2

Properties¶

grafana¶

admin_password¶

admin_username¶

auth¶

anonymous¶

enabled¶

organization¶

organization_role¶

generic_oauth¶

allow_sign_up¶

allowed_domains¶

api_url¶

auth_url¶

client_id¶

client_secret¶

enabled¶

name¶

scopes¶

tls_client_ca¶

tls_client_cert¶

tls_client_key¶

token_url¶

github¶

allow_sign_up¶

allowed_email_domains¶

allowed_organizations¶

api_url¶

auth_url¶

client_id¶

client_secret¶

enabled¶

team_ids¶

token_url¶

google¶

allow_sign_up¶

allowed_email_domains¶

api_url¶

auth_url¶

client_id¶

client_secret¶

enabled¶

token_url¶

proxy¶

auto_sign_up¶

enabled¶

header_name¶

header_property¶

aws¶

aws_access_key_id¶

aws_secret_access_key¶

region¶

dashboards¶

datasource¶

datasources¶

external_image_storage¶

s3¶

access_key¶

bucket¶

path¶

region¶

secret_key¶

webdav¶

password¶

url¶

username¶

listen_port¶

root_url¶

session¶

cookie_name¶

cookie_secure¶

session_life_time¶

snapshots¶

external_enabled¶

ssl¶

cert¶

key¶

users¶

allow_organization_creation¶

`grafana`¶

`admin_password`¶

`admin_username`¶

`auth`¶

`anonymous`¶

`enabled`¶

`organization`¶

`organization_role`¶

`generic_oauth`¶

`allow_sign_up`¶

`allowed_domains`¶

`api_url`¶

`auth_url`¶

`client_id`¶

`client_secret`¶

`enabled`¶

`name`¶

`scopes`¶

`tls_client_ca`¶

`tls_client_cert`¶

`tls_client_key`¶

`token_url`¶

`github`¶

`allow_sign_up`¶

`allowed_email_domains`¶

`allowed_organizations`¶

`api_url`¶

`auth_url`¶

`client_id`¶

`client_secret`¶

`enabled`¶

`team_ids`¶

`token_url`¶

`google`¶

`allow_sign_up`¶

`allowed_email_domains`¶

`api_url`¶

`auth_url`¶

`client_id`¶

`client_secret`¶

`enabled`¶

`token_url`¶

`proxy`¶

`auto_sign_up`¶

`enabled`¶

`header_name`¶

`header_property`¶

`aws`¶

`aws_access_key_id`¶

`aws_secret_access_key`¶

`region`¶

`dashboards`¶

`datasource`¶

`datasources`¶

`external_image_storage`¶

`s3`¶

`access_key`¶

`bucket`¶

`path`¶

`region`¶

`secret_key`¶

`webdav`¶

`password`¶

`url`¶

`username`¶

`listen_port`¶

`root_url`¶

`session`¶

`cookie_name`¶

`cookie_secure`¶

`session_life_time`¶

`snapshots`¶

`external_enabled`¶

`ssl`¶

`cert`¶

`key`¶

`users`¶

`allow_organization_creation`¶

`allow_sign_up`¶

`auto_assign_organization`¶