Skip to content

route_emitter job from diego/2.42.0

Github source: d66622e or master branch

Properties

bpm

enabled

use the BOSH Process Manager to manage the route-emitter process.

Default
false

diego

route_emitter

bbs
api_location

Address to the BBS Server

Default
bbs.service.cf.internal:8889
ca_cert

REQUIRED: PEM-encoded CA certificate

client_cert

REQUIRED: PEM-encoded client certificate

client_key

REQUIRED: PEM-encoded client key

client_session_cache_size

capacity of the tls client cache

max_idle_conns_per_host

maximum number of idle http connections

debug_addr

address at which to serve debug info

Default
127.0.0.1:17009
healthcheck_address

address for the route_emitter health endpoint.

Default
127.0.0.1:17011
job_name

The name of the Diego job referenced by this spec (DO NOT override)

Default
route_emitter
local_mode

Enable cell-local mode for the route-emitter. In this mode, the route-emitter emits route registrations only for the instances associated to its cell, as determined by the BOSH-assigned VM identifier spec.id.

Default
false
log_level

Log level

Default
info
nats
machines

IP of each NATS cluster member.

password

Password for server authentication.

port

The port for the NATS server to listen on.

Default
4222
tls
client_cert

PEM-encoded certificate for the route-emitter to present to NATS for verification when connecting via TLS.

client_key

PEM-encoded private key for the route-emitter to present to NATS for verification when connecting via TLS.

enabled

Enable connecting to NATS server via TLS.

Default
false
user

Username for server authentication.

sync_interval_in_seconds

Interval to sync routes to the router in seconds.

Default
60

internal_routes

enabled

Experimental: Enable the route-emitter to emit registrations for internal DNS-based service discovery.

Default
false

locks

consul

enabled

Whether the route-emitter in global mode should attempt to claim its activity lock via the Consul API.

Default
true

locket

enabled

Whether the route-emitter in global mode should attempt to claim its activity lock via the Locket API.

Default
true
hostname

Hostname at which to discover the Locket API server. The route-emitter will use its BBS client credentials to authenticate to the Locket API.

Default
locket.service.cf.internal
port

Port of the Locket API server.

Default
8891

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

register_direct_instance_routes

Use the container IP address and internal port instead of the host IP address and external port when registering route endpoints. Suitable only for deployments in which the gorouters and TCP routers can route directly to the container IP of instances.

Default
false

routing_api

auth_enabled

Enable UAA authentication when communicating with the Routing API

Default
true

port

Routing API port to be used by the tcp route-emitter

Default
3000

url

Routing API uri to be used by the tcp route-emitter

Default
http://routing-api.service.cf.internal

tcp

enabled

Enable the route-emitter in cell-local mode to emit TCP routes for instances to the Routing API.

Default
false

uaa

ca_cert

UAA ca certificate

client_name

UAA client id

Default
tcp_emitter

client_secret

UAA client secret

hostname

UAA hostname

Default
uaa.service.cf.internal

port

The port on which UAA accepts TLS connections

Default
8443

skip_cert_verify

Skip certificate verification when communicating with UAA

Default
false

Templates

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

  • bin/post-start (from post-start.erb)
  • bin/route_emitter_as_vcap (from route_emitter_as_vcap.erb)
  • bin/route_emitter_ctl (from route_emitter_ctl.erb)
  • config/bpm.yml (from bpm.yml.erb)
  • config/certs/bbs/ca.crt (from bbs_ca.crt.erb)
  • config/certs/bbs/client.crt (from bbs_client.crt.erb)
  • config/certs/bbs/client.key (from bbs_client.key.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/nats/ca.crt (from nats_ca.crt.erb)
  • config/certs/nats/client.crt (from nats_client.crt.erb)
  • config/certs/nats/client.key (from nats_client.key.erb)
  • config/certs/routing_api/ca.crt (from routing_api_ca.crt.erb)
  • config/certs/routing_api/client.crt (from routing_api_client.crt.erb)
  • config/certs/routing_api/client.key (from routing_api_client.key.erb)
  • config/certs/uaa/ca.crt (from uaa_ca.crt.erb)
  • config/indicators.yml (from indicators.yml.erb)
  • config/route_emitter.json (from route_emitter.json.erb)

Packages

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