1
=====================================================
2
Setting up PXC reference architecture with HAProxy
3
=====================================================
5
This tutorial is a step-by-step guide to set up *Percona XtraDB Cluster*, in a virtualized test sandbox. This example uses Amazon EC2 micro instances, but the content here is applicable for any kind of virtualization technology (for example VirtualBox).
6
You will need 4 virtual machines. 3 for |PXC| and 1 for the client, which will have |HAProxy|. In this how-to CentOS 6 is used as the operating system, the instructions are similar for any Linux distribution.
8
The client node will have HAProxy installed and it will redirect requests to |PXC| nodes. This approach works well in real-world scenarios too. Running HAProxy on the application servers instead of having them as dedicated entities gives you benefits like no need for an extra network roundtrip, because loadbalancer and scalability of |PXC|'s load balancing layer scales simply with application servers.
10
We'll use `Percona <http://www.percona.com/docs/wiki/repositories:yum>`_ and `EPEL <http://fedoraproject.org/wiki/EPEL>`_ repositories for software installation.
12
After configuring the repositories you'll be able to install software that will be used. First, install |PXC| on the database nodes. ::
14
# yum -y install Percona-XtraDB-Cluster-server Percona-XtraDB-Cluster-client percona-xtrabackup
16
Install |HAProxy| and |sysbench| on the client node. ::
18
# yum -y install haproxy sysbench
20
After installing everything, we'll configure |PXC| first. On the first node, :file:`my.cnf` should look something like this on a relatively weak machine. ::
26
wsrep_cluster_address=gcomm://
27
wsrep_provider=/usr/lib/libgalera_smm.so
28
datadir=/var/lib/mysql
31
wsrep_cluster_name=pxctest
32
wsrep_sst_method=xtrabackup
33
wsrep_node_name=ip-10-112-39-98
37
innodb_autoinc_lock_mode=2
38
innodb_buffer_pool_size=400M
39
innodb_log_file_size=64M
41
You can start your first node now. Make sure that you only start second and third nodes when the first node is up and running (it will serve as a donor for |SST|).
43
This configuration is for the first node. For the second and third node, you need to change :option:`wsrep_cluster_address` (alternatively, you can use :option:`wsrep_urls` in [mysqld_safe] section), which should point to a node in the cluster which is already up, so it will join the cluster. The :option:`server_id` and :option:`wsrep_node_name` variables have to be different on each host, for :option:`wsrep_node_name`, you can use the output of `hostname` command.
45
Based on that, for the second node, the differences in the configuration should be the following. ::
48
wsrep_cluster_address=gcomm://10.116.39.76 # replace this with the IP of your first node
49
wsrep_node_name=ip-10-244-33-92
51
For the third node, the differences look like this. ::
54
wsrep_cluster_address=gcomm://10.116.39.76 # replace this with the IP of your first node
55
wsrep_node_name=ip-10-194-10-179
57
For |SST| we use |xtrabackup|. This means at startup time, the new node will connect to an existing node in the cluster and it takes a backup of that node with xtrabackup and copies it to the new node with `netcat`. After a successful |SST|, you should see this in the error log. ::
59
120619 13:20:17 [Note] WSREP: State transfer required:
60
Group state: 77c9da88-b965-11e1-0800-ea53b7b12451:97
61
Local state: 00000000-0000-0000-0000-000000000000:-1
62
120619 13:20:17 [Note] WSREP: New cluster view: global state: 77c9da88-b965-11e1-0800-ea53b7b12451:97, view# 18: Primary, number of nodes: 3, my index: 0, protocol version 2
63
120619 13:20:17 [Warning] WSREP: Gap in state sequence. Need state transfer.
64
120619 13:20:19 [Note] WSREP: Running: 'wsrep_sst_xtrabackup 'joiner' '10.195.206.117' '' '/var/lib/mysql/' '/etc/my.cnf' '20758' 2>sst.err'
65
120619 13:20:19 [Note] WSREP: Prepared |SST| request: xtrabackup|10.195.206.117:4444/xtrabackup_sst
66
120619 13:20:19 [Note] WSREP: wsrep_notify_cmd is not defined, skipping notification.
67
120619 13:20:19 [Note] WSREP: Assign initial position for certification: 97, protocol version: 2
68
120619 13:20:19 [Warning] WSREP: Failed to prepare for incremental state transfer: Local state UUID (00000000-0000-0000-0000-000000000000) does not match group state UUID (77c9da88-b965-11e1-0800-ea53b7b12451): 1 (Operation not permitted)
69
at galera/src/replicator_str.cpp:prepare_for_IST():439. IST will be unavailable.
70
120619 13:20:19 [Note] WSREP: Node 0 (ip-10-244-33-92) requested state transfer from '*any*'. Selected 1 (ip-10-112-39-98)(SYNCED) as donor.
71
120619 13:20:19 [Note] WSREP: Shifting PRIMARY -> JOINER (TO: 102)
72
120619 13:20:19 [Note] WSREP: Requesting state transfer: success, donor: 1
73
120619 13:20:59 [Note] WSREP: 1 (ip-10-112-39-98): State transfer to 0 (ip-10-244-33-92) complete.
74
120619 13:20:59 [Note] WSREP: Member 1 (ip-10-112-39-98) synced with group.
75
120619 13:21:17 [Note] WSREP: |SST| complete, seqno: 105
76
120619 13:21:17 [Note] Plugin 'FEDERATED' is disabled.
77
120619 13:21:17 InnoDB: The InnoDB memory heap is disabled
78
120619 13:21:17 InnoDB: Mutexes and rw_locks use GCC atomic builtins
79
120619 13:21:17 InnoDB: Compressed tables use zlib 1.2.3
80
120619 13:21:17 InnoDB: Using Linux native AIO
81
120619 13:21:17 InnoDB: Initializing buffer pool, size = 400.0M
82
120619 13:21:17 InnoDB: Completed initialization of buffer pool
83
120619 13:21:18 InnoDB: highest supported file format is Barracuda.
84
120619 13:21:18 InnoDB: Waiting for the background threads to start
85
120619 13:21:19 Percona XtraDB (http://www.percona.com) 1.1.8-rel25.3 started; log sequence number 246661644
86
120619 13:21:19 [Note] Recovering after a crash using mysql-bin
87
120619 13:21:19 [Note] Starting crash recovery...
88
120619 13:21:19 [Note] Crash recovery finished.
89
120619 13:21:19 [Note] Server hostname (bind-address): '(null)'; port: 3306
90
120619 13:21:19 [Note] - '(null)' resolves to '0.0.0.0';
91
120619 13:21:19 [Note] - '(null)' resolves to '::';
92
120619 13:21:19 [Note] Server socket created on IP: '0.0.0.0'.
93
120619 13:21:19 [Note] Event Scheduler: Loaded 0 events
94
120619 13:21:19 [Note] WSREP: Signalling provider to continue.
95
120619 13:21:19 [Note] WSREP: Received |SST|: 77c9da88-b965-11e1-0800-ea53b7b12451:105
96
120619 13:21:19 [Note] WSREP: |SST| received: 77c9da88-b965-11e1-0800-ea53b7b12451:105
97
120619 13:21:19 [Note] WSREP: 0 (ip-10-244-33-92): State transfer from 1 (ip-10-112-39-98) complete.
98
120619 13:21:19 [Note] WSREP: Shifting JOINER -> JOINED (TO: 105)
99
120619 13:21:19 [Note] /usr/sbin/mysqld: ready for connections.
100
Version: '5.5.24-log' socket: '/var/lib/mysql/mysql.sock' port: 3306 Percona XtraDB Cluster (GPL), wsrep_23.6.r340
101
120619 13:21:19 [Note] WSREP: Member 0 (ip-10-244-33-92) synced with group.
102
120619 13:21:19 [Note] WSREP: Shifting JOINED -> SYNCED (TO: 105)
103
120619 13:21:20 [Note] WSREP: Synchronized with group, ready for connections
105
For debugging information about the |SST|, you can check the sst.err file and the error log too.
107
After the SST's is done, you should check if you have a 3 node cluster.
109
.. code-block:: mysql
111
mysql> show global status like 'wsrep_cluster_size';
112
+--------------------+-------+
113
| Variable_name | Value |
114
+--------------------+-------+
115
| wsrep_cluster_size | 3 |
116
+--------------------+-------+
117
1 row in set (0.00 sec)
119
When all nodes are started, you can set up HAProxy on the client. The point of this is that the application will be able to connect to localhost as |MySQL| server, so although we are using |PXC|, the application will see this as a single MySQL server running on localhost.
121
In order to achieve this, you'll need to configure HAProxy on the client node. There are 2 possible configurations here.
122
First is configuring round robin, which means you will connect and write to all cluster nodes. This can be done, but because of optimistic locking at commit time, rollbacks can happen if you have conflicting writes. In the second configuration, you will configure HAProxy in a way that it writes only to one node, so the application doesn't have to be prepared about unexpected rollbacks. The first configuration is a good choice in most cases, not handling rollbacks is not healthy in a well behaving application anyway.
124
HAProxy can be configured in the /etc/haproxy/haproxy.cfg and it should look like this. ::
128
log 127.0.0.1 local1 notice
130
chroot /usr/share/haproxy
150
default_backend pxc-back
155
default_backend stats-back
157
frontend pxc-onenode-front
160
default_backend pxc-onenode-back
166
server c1 10.116.39.76:3306 check port 9200 inter 12000 rise 3 fall 3
167
server c2 10.195.206.117:3306 check port 9200 inter 12000 rise 3 fall 3
168
server c3 10.202.23.92:3306 check port 9200 inter 12000 rise 3 fall 3
173
stats uri /haproxy/stats
174
stats auth pxcstats:secret
176
backend pxc-onenode-back
180
server c1 10.116.39.76:3306 check port 9200 inter 12000 rise 3 fall 3
181
server c2 10.195.206.117:3306 check port 9200 inter 12000 rise 3 fall 3 backup
182
server c3 10.202.23.92:3306 check port 9200 inter 12000 rise 3 fall 3 backup
184
In this configuration, three frontend-backend pairs are defined. The stats pair is for |HAProxy| statistics page, and the others are for |PXC|. |MySQL| will be listening on ports 3306 and 3307. If you connect to port 3306, you'll connect to `pxc-onenode`, and you'll be only using one node at a time (to avoid rollbacks because of optimistic locking). If that node goes off-line, you'll start using an other one.
185
However if you connect to port 3307, you'll be using all three nodes for reads and writes too. In this case the `leastconn` load balancing method is used instead of round robin, which means you always connect to the backend with the least connections established.
186
The statistics page is accessible on the client node with a browser pointed to `/haproxy/stats`, the stats auth parameter in the configuration has the credentials for that in plain text. You can also use this for monitoring purposes (the CSV version is good for trending and alerting).
188
Here |MySQL| is checked via HTTP checks. |MySQL| won't serve these requests. As part of |PXC| packages, we distribute the clustercheck utility which has to be set up. After that, HAProxy will be able to use check |MySQL| via HTTP. The clustercheck script is a simple shell script, which accepts HTTP requests, and checks MySQL on incoming request. If the |PXC| node is ok, it will emit a response with HTTP code 200 OK, otherwise, it emits 503. The script examines :option:`wsrep_local_state` variable.
190
To set it up, create the clustercheck user.
192
.. code-block:: mysql
194
mysql> grant process on *.* to 'clustercheckuser'@'localhost' identified by 'clustercheckpassword!';
195
Query OK, 0 rows affected (0.00 sec)
197
mysql> flush privileges;
198
Query OK, 0 rows affected (0.00 sec)
200
If you want to use a different username or password, you have to modify them in the script too.
206
Content-Type: Content-Type: text/plain
210
You can use `xinetd` to daemonize the script. If `xinetd` is not installed yet, you can install it with yum. ::
212
# yum -y install xinetd
214
The service itself should be configured in :file:`/etc/xinetd.d/mysqlchk`. ::
217
# description: mysqlchk
220
# this is a config for xinetd, place it in /etc/xinetd.d/
227
server = /usr/bin/clustercheck
228
log_on_failure += USERID
229
only_from = 0.0.0.0/0
230
# recommended to put the IPs that need
231
# to connect exclusively (security purposes)
232
per_source = UNLIMITED
235
Also, you should add the new service to :file:`/etc/services`. ::
237
mysqlchk 9200/tcp # mysqlchk
239
Clustercheck will now listen on port 9200 after xinetd restart, and |HAProxy| is ready to check |MySQL| via HTTP. ::
241
# service xinetd restart
243
If you did everything right so far, the statistics page of |HAProxy| should look like this.
245
.. image:: ../_static/pxc_haproxy_status_example.png
248
Testing the cluster with sysbench
249
=================================
251
You can test the cluster using the `sysbench <https://launchpad.net/sysbench/>`_ (this example uses one from the EPEL repository). First, you need to create a database and a user for it.
253
.. code-block:: mysql
255
mysql> create database sbtest;
256
Query OK, 1 row affected (0.01 sec)
258
mysql> grant all on sbtest.* to 'sbtest'@'%' identified by 'sbpass';
259
Query OK, 0 rows affected (0.00 sec)
261
mysql> flush privileges;
262
Query OK, 0 rows affected (0.00 sec)
264
Populate the table with data for the benchmark. ::
266
# sysbench --test=oltp --db-driver=mysql --mysql-engine-trx=yes --mysql-table-engine=innodb --mysql-host=127.0.0.1 --mysql-port=3307 --mysql-user=sbtest --mysql-password=sbpass --oltp-table-size=10000 prepare
268
You can now run the benchmark against the 3307 port. ::
270
# sysbench --test=oltp --db-driver=mysql --mysql-engine-trx=yes --mysql-table-engine=innodb --mysql-host=127.0.0.1 --mysql-port=3307 --mysql-user=sbtest --mysql-password=sbpass --oltp-table-size=10000 --num-threads=8 run
272
.. image:: ../_static/pxc_haproxy_lb_leastconn.png
274
This is the status of `pxc-back backend` while the |sysbench| above is running. If you look at Cur column under Session, you can see, that c1 has 2 threads connected, c2 and c3 has 3.
276
If you run the same benchmark, but against the 3306 backend, |HAProxy| stats will show us that the all the threads are going to hit the c1 server. ::
278
# sysbench --test=oltp --db-driver=mysql --mysql-engine-trx=yes --mysql-table-engine=innodb --mysql-host=127.0.0.1 --mysql-port=3306 --mysql-user=sbtest --mysql-password=sbpass --oltp-table-size=10000 --num-threads=8 run
280
.. image:: ../_static/pxc_haproxy_lb_active_backup.png
282
This is the status of `pxc-onenode-back` while |sysbench| above is running. Here only c1 has 8 connected threads, c2 and c3 are acting as backup nodes.
284
If you are using |HAProxy| for |MySQL| you can break the privilege system’s host part, because |MySQL| will think that the connections are always coming from the load balancer. You can work this around using T-Proxy patches and some `iptables` magic for the backwards connections. However in the setup described in this how-to this is not an issue, since each application server has it's own |HAProxy| instance, each application server connects to 127.0.0.1, so MySQL will see that connections are coming from the application servers. Just like in the normal case.
added
removed
doc-pxc/source/howtos/virt_sandbox.rst
