Skip to content

locket job from diego/2.18.0

Github source: 34678ec or master branch

Properties

bpm

enabled

Experimental: use the BOSH Process Manager to manage the Locket process.

Default
false

database

max_open_connections

maximum number of open connections to the database

Default
200

diego

locket

debug_addr

address at which to serve debug info

Default
127.0.0.1:17018
listen_addr

address at which to serve API requests

Default
0.0.0.0:8891
log_level

Log level

Default
info
sql
ca_cert

Bundle of CA certificates for the Locket to verify the SQL server SSL certificate when connecting via SSL

db_driver

Database driver to use for SQL backend (for example: mysql,postgres)

Default
mysql
db_host

Host for SQL backend

Default
""
db_password

Password to use for connecting to SQL backend

Default
""
db_port

Port for SQL backend

Default
""
db_schema

Database name to use for connecting to SQL backend

Default
""
db_username

Username to use for connecting to SQL backend

Default
""
require_ssl

Whether to require SSL for Locket communication to the SQL backend

Default
false

enable_consul_service_registration

Enable the Locket server to register itself as a service with Consul, for client discovery via Consul DNS. Do not disable without arranging alternate service discovery.

Default
true

logging

format

timestamp

Format for timestamp in component logs. Valid values are ‘unix-epoch’ and ‘rfc3339’.

Default
unix-epoch

loggregator

ca_cert

CA Cert used to communicate with local metron agent over gRPC

cert

Cert used to communicate with local metron agent over gRPC

key

Key used to communicate with local metron agent over gRPC

use_v2_api

True to use local metron agent gRPC v2 API. False to use UDP v1 API.

Default
false

v2_api_port

Local metron agent gRPC port

Default
3458

set_kernel_parameters

Enable tuning /proc/sys kernel parameters. NOTE: set this property to ‘false’ when deploying to BOSH-Lite or other containerized BOSH clouds.

Default
true

tls

ca_cert

ca cert for locket server mutual auth tls

cert

server cert for locket server mutual auth tls

key

server key for locket server mutual auth tls

Templates

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

  • bin/bpm-pre-start (from bpm-pre-start.erb)
  • bin/locket_as_vcap (from locket_as_vcap.erb)
  • bin/locket_ctl (from locket_ctl.erb)
  • bin/set-locket-kernel-params (from set-locket-kernel-params.erb)
  • config/bpm.yml (from bpm.yml.erb)
  • config/certs/ca.crt (from locket_ca.crt.erb)
  • config/certs/loggregator/ca.crt (from loggregator_ca.crt.erb)
  • config/certs/loggregator/client.crt (from loggregator_client.crt.erb)
  • config/certs/loggregator/client.key (from loggregator_client.key.erb)
  • config/certs/server.crt (from locket_server.crt.erb)
  • config/certs/server.key (from locket_server.key.erb)
  • config/certs/sql/ca.crt (from sql_ca.crt.erb)
  • config/locket.json (from locket.json.erb)

Packages

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