gorouter job from cf/243
The Router maintains a list of live routes for the applications running on each DEA. The Router load balances requests (based on their Host header) between each application instance registered for a specific route. It requires to be behind a load balancer that can terminate SSL connections.
Github source:
ee7d0088 or
master branch
Properties¶
metron¶
port¶The port used to emit dropsonde messages to the Metron agent.
- Default
nats¶
machines¶IP of each NATS cluster member.
password¶
port¶
user¶
request_timeout_in_seconds¶
Timeout in seconds for Router -> Endpoint roundtrip.
- Default
900
router¶
cipher_suites¶An ordered list of supported SSL cipher suites containing golang tls constants separated by colons The cipher suite will be chosen according to this order during SSL handshake
- Default
debug_address¶Address at which to serve debug info
- Default
dns_health_check_host¶Host to ping for confirmation of DNS resolution, only used when Routing API is enabled
- Default
drain_wait¶Delay in seconds after drain begins before server stops listening. During this time the server will respond with 503 Service Unavailable to requests having header User-Agent: {Value of router.healthcheck_user_agent}. This accommodates requests in transit sent during the time the health check responded with
ok.
- Default
enable_access_log_streaming¶Enables streaming of access log to syslog. Warning: this comes with a performance cost; due to higher I/O, max request rate is reduced.
- Default
enable_proxy¶Enables support for the popular PROXY protocol, allowing downstream load balancers that do not support HTTP to pass along client information.
- Default
enable_ssl¶Enable ssl termination on the router
- Default
extra_headers_to_log¶A list of headers that log events will be annotated with
- Default
healthcheck_user_agent¶User-Agent for the health check agent (usually the Load Balancer).
- Default
- Example
load_balancer_healthy_threshold¶
- Default
logging_level¶Log level for router
- Default
logrotate¶
freq_min¶The frequency in minutes which logrotate will rotate VM logs
- Default
rotate¶The number of files that logrotate will keep around on the VM
- Default
size¶The size at which logrotate will decide to rotate the log file
- Default
number_of_cpus¶Number of CPUs to utilize, the default (-1) will equal the number of available CPUs
- Default
offset¶
- Default
port¶Listening Port for Router.
- Default
requested_route_registration_interval_in_seconds¶On startup, the router will delay listening for requests by this duration to increase likelihood that it has a complete routing table before serving requests. The router also broadcasts the same duration as a recommended interval to registering clients via NATS.
- Default
route_services_recommend_https¶Route Services are told where to send requests after processing using the X-CF-Forwarded-Url header. When this property is true, the scheme for this URL is https. When false, the scheme is http. As requests from Route Services to applications on CF transit load balancers and gorouter, disable this property for deployments that have TLS termination disabled.
- Default
route_services_secret¶Support for route services is disabled when no value is configured. A robust passphrase is recommended.
- Default
route_services_secret_decrypt_only¶To rotate keys, add your new key here and deploy. Then swap this key with the value of route_services_secret and deploy again.
- Default
route_services_timeout¶Expiry time of a route service signature in seconds
- Default
secure_cookies¶Set secure flag on http cookies
- Default
ssl_cert¶The public ssl cert for ssl termination
- Default
ssl_key¶The private ssl key for ssl termination
- Default
ssl_skip_validation¶Skip SSL client cert validation
- Default
status¶
password¶Password for HTTP basic auth to the varz/status endpoint.
port¶Port for the Router varz/status endpoint.
- Default
user¶Username for HTTP basic auth to the varz/status endpoint.
suspend_pruning_if_nats_unavailable¶Suspend pruning of routes when NATs is unavailable and maintain the current routing table. WARNING: This strategy favors availability over consistency and there is a possibility of routing to an incorrect endpoint in the case of port re-use. To be used with caution.”
- Default
trace_key¶If the X-Vcap-Trace request header is set and has this value, trace headers are added to the response.
- Default
tracing¶
enable_zipkin¶Enables the addition of the X-B3-Trace-Id header to incoming requests. If the header already exists on the incoming request, it will not be overwritten.
- Default
routing_api¶
auth_disabled¶When false, Routing API requires OAuth tokens for authentication.
- Default
enabled¶When enabled, GoRouter will fetch HTTP routes from the Routing API in addition to routes obtained via NATS.
- Default
port¶Port on which Routing API is running.
- Default
uaa¶
ca_cert¶
- Default
clients¶
gorouter¶
secret¶Password for UAA client for the gorouter.
port¶Port on which UAA is running.
- Default
ssl¶
port¶Secure Port on which UAA is running.
Templates¶
Templates are rendered and placed onto corresponding
instances during the deployment process. This job's templates
will be placed into /var/vcap/jobs/gorouter/ directory
(learn more).
bin/dns_health_check(fromdns_health_check.erb)bin/drain(fromdrain)bin/gorouter_ctl(fromgorouter_ctl)bin/run_gorouter(fromrun_gorouter.erb)config/cert.pem(fromcert.pem.erb)config/certs/uaa/ca.crt(fromuaa_ca.crt.erb)config/gorouter.yml(fromgorouter.yml.erb)config/gorouter_logrotate.cron(fromgorouter_logrotate.cron.erb)config/key.pem(fromkey.pem.erb)config/logrotate.conf(fromlogrotate.conf.erb)
Packages¶
Packages are compiled and placed onto corresponding
instances during the deployment process. Packages will be
placed into /var/vcap/packages/ directory.