Skip to content

proxy job from pxc/1.0.22

Github source: 6b4895f6 or master branch

Properties

api_aggregator_port

Port for the proxy aggregator API to listen on

Default
8082

api_force_https

Redirect all HTTP requests to the API to HTTPS

Default
true

api_password

Password for Basic Auth used to secure API

api_port

Port for the proxy API to listen on

Default
8080

api_tls

certificate

PEM-encoded certificate for securing TLS communication to the proxy API

Default
""

enabled

Enable TLS for client connections to the proxy’s api endpoints

Default
false

private_key

PEM-encoded key for securing TLS communication to the proxy API

Default
""

api_uri

Optional, Base URI registered to the proxies. Used by the proxy aggregator.

Example
proxy-cf-mysql.my-system-domain.com

api_username

Username for Basic Auth used to secure API

Default
proxy

health_port

Port for checking the health of the proxy process

Default
1936

healthcheck_timeout_millis

Timeout (milliseconds) before assuming a backend is unhealthy

Default
5000

inactive_mysql_port

If configured, listens on this port and routes traffic to an inactive mysql node. Useful for queries you do not want to impact other clients

logging

format

timestamp

Format for timestamp in component logs. Valid values are ‘rfc3339’, ‘unix-epoch’. ‘rfc3339’ is the recommended format. It will result in all timestamps controlled by this job to be in RFC3339 format, which is human readable. This includes stdout, pre-start, and post-start logs. This does not include stderr logs from golang libraries. ‘unix-epoch’ will result in all timestamps being in the format they were before the rfc3339 flag was introduced. This format is different for different logs. We do not recommend using this flag unless you have scripts that expect a particular timestamp format.

Default
rfc3339

metrics

enabled

Enable proxy metrics using prometheus

Default
false

labels

A map of labels that will be added to all proxy metrics

Default
{}

port

Port for the prometheus API to listen on

Default
9999

server_name

Required for HTTPS targets. Prom scraper uses this to set the server name for cert verification despite using localhost to resolve the request.

source_id

The source ID to set on scraped metrics

Default
pxc-proxy

port

Port for the proxy to listen on

Default
3306

shutdown_delay

If using a load balancer above the proxies, enter your load balancer’s unhealthy total threshold time here in seconds. E.g., if your LB polls every 30 seconds, and immediately fails over upon failure, then set this property to 30 seconds.

Default
45

startup_delay

If using a load balancer above the proxies, enter your load balancer’s healthy total threshold time here in seconds. E.g., if your LB polls every 30 seconds and requires 3 successful attempts, then set this property to 90 seconds.

Default
45

type

Used by consumers of the database link to configure database properties

Default
mysql

Templates

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

  • bin/drain (from drain.erb)
  • bin/healthcheck (from healthcheck.erb)
  • bin/post-start (from post-start.erb)
  • config/bpm.yml (from bpm.yml.erb)
  • config/prom_scraper_config.yml (from prom_scraper_config.yml.erb)
  • config/proxy.yml (from proxy.yml.erb)

Packages

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