Skip to content

cf-kibana job from logsearch-for-cloudfoundry/211.0.1

This job pushes Kibana UI as a Cloud Foundry application

Github source: 9b68916 or master branch

Properties

cf-kibana

app_instances

Count of Kibana instances

Default
1

app_memory

Kibana app memory

Default
2048M

app_name

Kibana dashboard app name

Default
logs

cloudfoundry

api_security_group

CF security group with API access

apps_domain

The CF apps domain ( eg: apps.10.244.0.34.xip.io )

logsearch_space

CF space where Kibana will be deployed

Default
logsearch
system_domain

The CF system domain ( eg: system.10.244.0.34.xip.io )

system_org

The organisation that owns the CF system domain

Default
admin
uaa_admin_client_id

The UAA admin client id (required scope is uaa.admin). The admin client is used to manage the UAA Kibana oauth2 client.

Default
admin
uaa_admin_client_secret

The UAA admin client’s secret

config_options

Additional options to append to kibana configuration (YAML format).

console_enabled

Enable Kibana development console; should be set to false in a multi-tenant deployment.

Default
false

default_app_id

The default application to load

Default
dashboard/App-Overview

disk_quota

Kibana disk quota

Default
2GB

elasticsearch

host

ElasticSearch master endpoint

port

ElasticSearch master port

Default
9200

kibana_index

Kibana uses an index in Elasticsearch to store saved searches, visualizations and dashboards

Default
.kibana

logging_quiet

Set to true to suppress all logging output other than error messages

Default
true

oauth2_client_id

The UAA Kibana oauth2 client id

Default
cf-kibana_oauth2_client

oauth2_client_secret

Password to be used for the UAA kibana oauth2 client

oauth2_use_existing_client

Set true to use existing UAA oauth2 client for Kibana. Note the client required scopes: openid,oauth.approvals,scim.userids,cloud_controller.read.

Default
false

plugins

a list of key-value pairs of plugins. e.g. Kibana-auth: /var/vcap/packagaes/kibana/kibana-auth

Default
[]

request_timeout

Time in milliseconds to wait for responses from the back end or elasticsearch. This must be > 0

Default
300000

session_expiration_ms

Kibana user session expiration period in milliseconds (default to 12h)

Default
4.32e+07

session_key

Session cookie encryption passphrase; must be >=32 bytes long

shard_timeout

Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable

Default
30000

use_https

A boolean indicating whether or not you want the redirect_uri to be forced to https

Default
true

cloudfoundry

admin_password

Password of the admin user

admin_user

Username of the admin user

Default
admin

api_endpoint

The CF API URL

skip_ssl_validation

Toggles cli verification of the CF API SSL certificate

Default
true

redis

host

Redis endpoint

port

Redis port

Default
6379

Templates

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

  • bin/run (from errand.sh.erb)
  • config/allow-logsearch-access.json (from allow-logsearch-access.json.erb)
  • config/kibana.yml (from kibana.yml.erb)
  • config/manifest.yml (from manifest.yml.erb)

Packages

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