Skip to content

replication-canary job from mysql-monitoring/8.11.0

Github source: 466071c or master branch

Properties

cf

skip_ssl_validation

Determines whether replication-canary verifies SSL certificates when communicating with Cloud Controller and UAA

Default
false

cf_mysql

external_host

Domain of the route registered for the UI via NATS (with the router in cf-release)

domain

Domain reserved for CF operator, base URL where the login, uaa, and other non-user apps listen

mysql-monitoring

cluster_identifier

The cluster identifier will be included in the subject of replication notification e-mails. It should be a unique identifier.

notify_only

When true, replication failure will not shut traffic off at the proxy

Default
false

recipient_email

The email address to send mysql monitoring notifications to

replication-canary

api_port

Port number for interrogating the canary via HTTP

Default
8111
canary_database

Canary database

Default
canary_db
canary_password

Canary user password

canary_username

Canary username

Default
repcanary
cluster_ips

Optional. List of IP addresses of servers used to read data from

mysql_port

Database port for contacting mysql

Default
3306
notifications_client_secret

Secret of the UAA client used to send mysql monitoring notifications. This will be used when creating the client.

notifications_client_username

Username of the UAA client used to send mysql monitoring notifications. This will be created using the uaa admin client.

Default
mysql-monitoring
poll_frequency

Configure how frequently the canary polls the cluster for replication failure (in seconds)

Default
30
switchboard_count

Optional. The number of switchboard proxies

switchboard_password

Basic Auth password to contact the Switchboard API

switchboard_username

Basic Auth username to contact the Switchboard API

Default
proxy
uaa_admin_client_secret

Secret of the UAA client used to create the notifications client

uaa_admin_client_username

Username of the UAA client used to create the notifications client

Default
admin
write_read_delay

This property configures how long the canary waits to read the chirps after writing (in seconds)

Default
20

syslog_aggregator

address

IP address for syslog aggregator

all

Define whether forwarders should also send non-mysql syslog activity to the aggregator.

Default
false

port

TCP port of syslog aggregator

transport

Transport to be used when forwarding logs (tcp|udp|relp).

Default
tcp

Templates

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

  • bin/manual-read (from manual-read)
  • bin/manual-write (from manual-write)
  • bin/replication-canary_ctl (from replication-canary_ctl.sh.erb)
  • config/replication-canary.yml (from replication-canary.yml.erb)
  • config/syslog_forwarder.conf (from syslog_forwarder.conf.erb)

Packages

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