replication-canary job from mysql-monitoring/10.11.0
Github source:
ade29df2
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
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
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
tls
¶
ca
¶PEM-encoded authority certificate for replication-canary
- Default
""
certificate
¶PEM-encoded certificate for securing TLS communication to replication-canary
- Default
""
enabled
¶Enable TLS for client connections to replication-canary
- Default
false
private_key
¶PEM-encoded key for securing TLS communication to replication-canary
- Default
""
server_name
¶ServerName is used to advertise the expected hostname on the replication-canary certificate
- Default
""
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
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
(frommanual-read
)bin/manual-write
(frommanual-write
)config/bpm.yml
(frombpm.yml.erb
)config/replication-canary.yml
(fromreplication-canary.yml.erb
)
Packages¶
Packages are compiled and placed onto corresponding
instances during the deployment process. Packages will be
placed into /var/vcap/packages/
directory.