pxc-mysql job from pxc/0.11.0
Github source:
50d2e88
or
master branch
Properties¶
admin_password
¶
Required. Password for the MySQL server admin user
admin_username
¶
Username for the MySQL server admin user
- Default
root
cli_history
¶
When set to false, disables cli history on the mysql vms.
- Default
true
cluster_probe_timeout
¶
The maximum time, in seconds, that a new node will search for an existing cluster.
- Default
10
engine_config
¶
audit_logs
¶
audit_log_exclude_accounts
¶Database users to exclude from audit logging
- Default
[]- Example
|+ - monitoring_user - other_excluded_user - bot_user
audit_log_exclude_accounts_csv
¶Optional. Additional database users to exclude from audit logging, will be combined with uses specified in engine_config.audit_logs.audit_log_exclude_accounts
enabled
¶Enable audit logging
- Default
false
file_rotations
¶Number of audit file rotations to keep
- Default
30
rotate_size_in_mb
¶Size in MB of each audit log file
- Default
100
binlog
¶
enabled
¶Enable binlogs across all nodes
- Default
true
expire_logs_days
¶Time in days to store binlogs before purging
- Default
7
character_set_server
¶Default character set. Note that while the MySQL default is latin1, we default to utf8.
- Default
utf8
collation_server
¶Default collation. Use SHOW COLLATION to view the valid collations for your character set.
- Default
utf8_unicode_ci
event_scheduler
¶Events are named database objects containing SQL statements that are to be executed at a later stage, either once off, or at regular intervals.
- Default
false
galera
¶
cluster_name
¶A unique name for this cluster. ONLY set before first deployment. DO NOT attempt to change an existing multi-node cluster.
- Default
galera-cluster
enabled
¶Enable this when deploying a galera cluster
- Default
false
gcache_size
¶Cache size used by galera (maximum amount of data possible in an IST), in MB
- Default
512
port
¶Port which Galera Cluster uses for communication across nodes
- Default
4567
wsrep_debug
¶Enables additional debugging output for the database server error log.
- Default
false
wsrep_log_conflicts
¶Defines whether the node logs additional information about conflicts. The values that were in conflict are logged, so it is possible for user data to end up in the logs.
- Default
true
wsrep_max_ws_rows
¶Maximum permitted number of rows per writeset.
- Default
0
wsrep_max_ws_size
¶Maximum permitted size in bytes per writeset.
- Default
1.073741824e+09
innodb_buffer_pool_instances
¶Optional. Number of buffer pool instances for InnoDB
innodb_buffer_pool_size
¶Optional. The size in bytes of the memory buffer InnoDB uses to cache data and indexes of its tables
innodb_buffer_pool_size_percent
¶Set this to an integer which represents the percentage of system RAM to reserve for the InnoDB buffer pool
- Default
50
innodb_flush_log_at_trx_commit
¶Control balance between performance and full ACID compliance. Valid values are: 0, 1, 2
- Default
1
innodb_flush_method
¶Advanced configuration variable, consult the documentation before changing. Controls how MySQL opens data files; by default uses fsync(). Set to O_DIRECT if innodb_buffer_pool is sufficiently large that you can use O_DIRECT thus avoiding double-buffering.
- Default
fsync
innodb_large_prefix
¶Whether innodb_large_prefix is enabled
- Default
true
innodb_lock_wait_timeout
¶Time in seconds that an InnoDB transaction waits for an InnoDB row lock
- Default
50
innodb_log_buffer_size
¶Size in bytes of the buffer for writing log files to disk. Increasing this means larger transactions can run without needing to perform disk I/O before committing.
- Default
32M
innodb_log_file_size
¶Size of the ib_log_file used by innodb, in MB
- Default
1024
innodb_strict_mode
¶Whether innodb_strict_mode is enabled
- Default
false
local_infile
¶Allow or disallow clients to access local files
- Default
true
log_queries_not_using_indexes
¶Queries that do not use an index, or that perform a full index scan where the index does not limit the number of rows, will be logged to the slow query log.
- Default
false
long_query_time
¶Threshold in seconds above which SQL queries get logged in the slow query log file
- Default
10
max_allowed_packet
¶The maximum size in bytes of a packet or a generated/intermediate string
- Default
256M
max_connections
¶Maximum total number of database connections for the node
- Default
1500
max_heap_table_size
¶The maximum size (in rows) to which user-created MEMORY tables are permitted to grow
- Default
1.6777216e+07
table_definition_cache
¶Set this to a number relative to the number of tables the server will manage.
- Default
8192
table_open_cache
¶Configure the number of table handles to keep open
- Default
2000
tmp_table_size
¶The maximum size (in bytes) of internal in-memory temporary tables
- Default
3.3554432e+07
userstat
¶Enables user statistics, adding several new information schema tables and new FLUSH and SHOW commands.
- Default
false
max_open_files
¶
Configure this number to be comfortably larger than the maximum number of tables you expect the database to support.
- Default
65536
monit_startup_timeout
¶
Number of seconds that monit should wait for mysql to start before giving up
- Default
60
port
¶
Port the mysql server should bind to
- Default
3306
previous_admin_username
¶
Optional. Previous username of the MySQL server admin user to be removed. Use this when changing the admin_username to avoid leaving around an unused user with root access.
pxc_enabled
¶
Used for disabling the job. Useful if co-locating the cf-mysql release mysql job and migrating
- Default
true
remote_admin_access
¶
When set to true, admin and roadmin will be able to connect from any remote host.
- Default
false
roadmin_enabled
¶
When set to true, a read-only admin user called roadmin is added
- Default
false
roadmin_password
¶
Required when roadmin_enabled is true. Password for the MySQL server read-only admin user.
seeded_databases
¶
Set of databases to seed
- Default
{}
- Example
-
|+ - name: db1 username: user1 password: pw1 - name: db2 username: user2 password: pw2
tls
¶
galera
¶Required if engine_config.galera.enabled is true. TLS certificate for galera cluster encryption
server
¶Required. TLS certificate for client-server encryption
Templates¶
Templates are rendered and placed onto corresponding
instances during the deployment process. This job's templates
will be placed into /var/vcap/jobs/pxc-mysql/
directory
(learn more).
bin/drain
(fromdrain.sh.erb
)bin/pre-start
(frompre-start.sh.erb
)bin/pre-start-execution
(frompre-start-execution.sh.erb
)bin/pxc-ctl
(frompxc-ctl.erb
)config/db_init
(fromdb_init.erb
)config/disable_mysql_cli_history.sh
(fromdisable_mysql_cli_history.sh.erb
)config/galera-init-config.yml
(fromgalera-init-config.yml.erb
)config/my.cnf
(frommy.cnf.erb
)config/mylogin.cnf
(frommylogin.cnf.erb
)config/mysql_clustered_audit_logs.logrotate
(fromaudit_logs.logrotate.erb
)config/pxc-sudoers
(frompxc-sudoers
)certificates/galera-ca.pem
(fromgalera-ca.pem.erb
)certificates/galera-cert.pem
(fromgalera-cert.pem.erb
)certificates/galera-key.pem
(fromgalera-key.pem.erb
)certificates/server-ca.pem
(fromserver-ca.pem.erb
)certificates/server-cert.pem
(fromserver-cert.pem.erb
)certificates/server-key.pem
(fromserver-key.pem.erb
)
Packages¶
Packages are compiled and placed onto corresponding
instances during the deployment process. Packages will be
placed into /var/vcap/packages/
directory.