Skip to content

cf-mysql-broker job from cf-mysql/36.11.0

Github source: dfdf6fd or master branch

Properties

cf

api_url

URL of the CloudFoundry Cloud Controller

Example
https://api.your-domain.example.com

skip_ssl_validation

Determines whether dashboard verifies SSL certificates when communicating with Cloud Controller and UAA

Default
false

cf_mysql

broker

allow_table_locks

When enabled, clients will be able to acquire locks on the node processing the transaction. Note that locks are not replicated across cluster nodes.

Default
false
auth_password

Broker’s basic auth password

auth_username

Broker’s basic auth username

Default
admin
cookie_secret

A unique secret key, used to sign sessions

db_password

The password for the cf-mysql-broker MySQL user

disable_quota_enforcer

Disable the Quota Enforcer process

Default
false
host

Optional, The ip to be registered with the cf router for the broker. Defaults to the ip of the vm

max_user_connections_default

number of user connections to allow in a plan if not specified

Default
40
port

Port for broker

Default
8081
quota_enforcer
ignored_users

Array of users that the quota enforcer will not enforce quotas on

Default
[]
password

The password for the quota-enforcer user

pause

In seconds, the interval that the Quota Enforcer pauses between checks for violators and reformers

Default
1
services

Array of services, each service contains the list of plans the broker of that service provides

Example
|+
  - name: REPLACE-WITH-SERVICE-NAME
    plans:
    - name: 100mb
      id: REPLACE-WITH-A-UNIQUE-GUID
      description: Shared MySQL Server
      max_storage_mb: 100
      max_user_connections: 20
    - name: 1gb
      id: REPLACE-WITH-A-UNIQUE-GUID
      description: Shared MySQL Server
      max_storage_mb: 1000
      max_user_connections: 40
ssl_enabled

Determines use of https in dashboard url and in callback uri for calls to UAA

Default
true

external_host

Host used to register a route for the broker with the router in cf-release via NATS. By registering the broker with Cloud Foundry using this route, and using the router for load balancing, the broker can be horizontally scaled. Domain is typically the same as system domain in cf-release.

host

Host (DNS) or IP address of the load balancer, which sits above the mysql proxy, used by the broker and bound applications to reach the service

mysql

gcache_size

Cache size used by galera (maximum amount of data possible in an IST), in MB

Default
512
ib_log_file_size

Size of the ib_log_file used by innodb, in MB

Default
1024
persistent_disk

Size of the persistent disk allocated to the MySQL node for storage

port

Port used by the broker and bound applications to reach the service

Default
3306

Templates

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

  • bin/cf-mysql-broker_ctl (from cf-mysql-broker_ctl.erb)
  • bin/healthcheck.sh (from healthcheck.sh.erb)
  • bin/quota-enforcer_ctl (from quota-enforcer_ctl.erb)
  • config/database.yml (from database.yml.erb)
  • config/quota_enforcer_config.yml (from quota_enforcer_config.yml.erb)
  • config/settings.yml (from settings.yml.erb)
  • config/unicorn.conf.rb (from unicorn.conf.rb.erb)

Packages

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