Merge lp:~hrvojem/percona-xtradb-cluster/bug1253055-5.5 into lp:percona-xtradb-cluster/5.5

[Hrvoje Matijakovic]

=== modified file 'doc-pxc/source/faq.rst'
--- doc-pxc/source/faq.rst	2014-05-08 16:52:49 +0000
+++ doc-pxc/source/faq.rst	2014-05-14 11:32:28 +0000
@@ -22,13 +22,51 @@
 
 .. code-block:: mysql
 
-    SELECT * FROM someinnodbtable WHERE id=1;
+    SELECT 1 FROM dual;
 
 3 different results are possible:
    * You get the row with id=1 (node is healthy)
    * Unknown error (node is online but Galera is not connected/synced with the cluster)
    * Connection error (node is not online)
 
+You can also check the node health with the ``clustercheck`` script. You need to set up ``clustercheck`` user:
+
+.. code-block:: mysql
+
+   GRANT USAGE ON *.* TO 'clustercheck'@'localhost' IDENTIFIED BY PASSWORD '*2470C0C06DEE42FD1618BB99005ADCA2EC9D1E19';
+
+You can then check the node health by running the ``clustercheck`` script: 
+
+.. code-block:: bash
+
+   /usr/bin/clustercheck clustercheck password 0
+
+If the node is running correctly you should get the following status: :: 
+
+  HTTP/1.1 200 OK
+  Content-Type: text/plain
+  Connection: close
+  Content-Length: 40
+
+  Percona XtraDB Cluster Node is synced.
+
+In case node isn't sync or if it is off-line status will look like: :: 
+
+  HTTP/1.1 503 Service Unavailable
+  Content-Type: text/plain
+  Connection: close
+  Content-Length: 44
+
+  Percona XtraDB Cluster Node is not synced. 
+
+.. note::
+
+   clustercheck syntax: 
+
+   <user> <pass> <available_when_donor=0|1> <log_file> <available_when_readonly=0|1> <defaults_extra_file>"
+   Recommended: server_args = user pass 1 /var/log/log-file 0 /etc/my.cnf.local"
+   Compatibility: server_args = user pass 1 /var/log/log-file 1 /etc/my.cnf.local"
+
 Q: How does XtraDB Cluster handle big transaction?
 ==================================================
 A: XtraDB Cluster populates write set in memory before replication and this sets one limit for how large transactions make sense. There are wsrep variables for max row count and max size of of write set to make sure that server is not running out of memory.

=== modified file 'doc-pxc/source/howtos/ubuntu_howto.rst'
--- doc-pxc/source/howtos/ubuntu_howto.rst	2014-02-06 09:57:33 +0000
+++ doc-pxc/source/howtos/ubuntu_howto.rst	2014-05-14 11:32:28 +0000
@@ -31,11 +31,7 @@
 Installation
 ------------
 
-Percona repository should be set up as described in the :ref:`apt-repo` guide. Following command will install |Percona XtraDB Cluster| packages: :: 
-
-  $ apt-get install percona-xtradb-cluster-server-5.5 percona-xtradb-cluster-client-5.5 percona-xtradb-cluster-galera-2.x
-
-When these two commands have been executed successfully on all three nodes |Percona XtraDB Cluster| is installed.
+Installation information can be found in the :ref:`installation` guide.
 
 .. note:: 
 
@@ -83,11 +79,10 @@
   # Authentication for SST method
   wsrep_sst_auth="sstuser:s3cretPass"
 
-.. note:: For the first member of the cluster variable :variable:`wsrep_cluster_address` should contain empty ``gcomm://`` when the cluster is being bootstrapped. But as soon as we have bootstrapped the cluster and have at least one more node joined that line can be removed from the :file:`my.cnf` configuration file and the one where :variable:`wsrep_cluster_address` contains all three node addresses. In case the node gets restarted and without making this change it will make bootstrap new cluster instead of joining the existing one.
 
 After this, first node can be started with the following command: ::
 
-  [root@pxc1 ~]# /etc/init.d/mysql start
+  [root@pxc1 ~]# /etc/init.d/mysql bootstrap-pxc
  
 This command will start the first node and bootstrap the cluster (more information about bootstrapping cluster can be found in :ref:`bootstrap` manual).
 

=== modified file 'doc-pxc/source/index.rst'
--- doc-pxc/source/index.rst	2013-12-30 17:01:54 +0000
+++ doc-pxc/source/index.rst	2014-05-14 11:32:28 +0000
@@ -98,6 +98,7 @@
    release-notes/release-notes_index
    wsrep-status-index
    wsrep-system-index
+   wsrep-provider-index
    wsrep-files-index
    faq
    glossary

=== modified file 'doc-pxc/source/intro.rst'
--- doc-pxc/source/intro.rst	2013-02-01 13:41:34 +0000
+++ doc-pxc/source/intro.rst	2014-05-14 11:32:28 +0000
@@ -44,7 +44,7 @@
 
 Percona XtraDB Cluster has: Consistency and Availability.
 
-That is MySQL replication does not guarantee Consistency of your data, while Percona XtraDB Cluster provides data Consistency. (And yes, Percona XtraDB Cluster looses Partitioning tolerance property).
+That is |MySQL| replication does not guarantee Consistency of your data, while |Percona XtraDB Cluster| provides data Consistency (but it loses Partitioning tolerance property).
 
 Components
 ==========

=== added file 'doc-pxc/source/wsrep-provider-index.rst'
--- doc-pxc/source/wsrep-provider-index.rst	1970-01-01 00:00:00 +0000
+++ doc-pxc/source/wsrep-provider-index.rst	2014-05-14 11:32:28 +0000
@@ -0,0 +1,574 @@
+.. _wsrep_provider_index:
+
+============================================
+ Index of :variable:`wsrep_provider` options
+============================================
+
+Following variables can be set and checked in the :variable:`wsrep_provider_options` variable. Value of the variable can be changed in the |MySQL| configuration file, :file:`my.cnf`, or by setting the variable value in the |MySQL| client.
+
+To change the value of the in the :file:`my.cnf` following syntax should be used: :: 
+
+  wsrep_provider_options="variable1=value1;[variable2=value2]"
+
+For example to increase the size of the Galera buffer storage from the default value to 512MB, :file:`my.cnf` option should look like: ::
+
+  wsrep_provider_options="gcache.size=512M"
+
+Dynamic variables can be changed from the |MySQL| client by using the ``SET GLOBAL`` syntax. To change the value of the :variable:`pc.ignore_sb` following command should be used:: 
+
+  mysql> SET GLOBAL wsrep_provider_options="pc.ignore_sb=true";
+
+
+Index
+=====
+
+.. variable:: base_host
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: value of the :variable:`wsrep_node_address`
+
+This variable sets the value of the node's base IP. This is an IP address on which Galera listens for connections from other nodes. Setting this value incorrectly would stop the node from communicating with other nodes.
+
+.. variable:: base_port
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 4567
+
+This variable sets the port on which the Galera listens for connections from other nodes. Setting this value incorrectly would stop the node from communicating with other nodes.
+
+.. variable:: cert.log_conflicts
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: no
+
+.. variable:: evs.causal_keepalive_period
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: value of :variable:`evs.keepalive_period`
+
+This variable is used for development purposes and shouldn't be used by regular users.
+
+.. variable:: evs.debug_log_mask
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: Yes
+   :default: 0x1
+
+This variable is used for EVS (Extended Virtual Synchrony) debugging it can be used only when :variable:`wsrep_debug` is set to ``ON``.
+
+.. variable:: evs.inactive_check_period
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT0.5S
+
+This variable defines how often to check for peer inactivity.
+
+.. variable:: evs.inactive_timeout
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT15S
+
+This variable defines the inactivity limit, once this limit is reached the node will be pronounced dead.
+
+.. variable:: evs.info_log_mask
+
+   :cli: No
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 0
+
+This variable is used for controlling the extra EVS info logging.
+
+.. variable:: evs.install_timeout
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: Yes
+   :default: PT15S
+
+This variable defines the timeout on waiting for install message acknowledgments.
+
+.. variable:: evs.join_retrans_period
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT1S
+
+This variable defines how often to retransmit EVS join messages when forming cluster membership.
+
+.. variable:: evs.keepalive_period 
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT1S 
+
+This variable defines how often will keepalive beacons will be emmited (in the absence of any other traffic).
+
+.. variable:: evs.max_install_timeouts
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 1
+
+This variable defines how many membership install rounds to try before giving up (total rounds will be :variable:`evs.max_install_timeouts` + 2).
+
+.. variable:: evs.send_window
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 4
+
+This variable defines the maximum number of data packets in replication at a time. For WAN setups may be set considerably higher, e.g. 512. This variable must be no less than :variable:`evs.user_send_window`.
+
+.. variable:: evs.stats_report_period
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT1M 
+
+This variable defines the control period of EVS statistics reporting.
+
+.. variable:: evs.suspect_timeout
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT5S
+
+This variable defines the inactivity period after which the node is “suspected” to be dead. If all remaining nodes agree on that, the node will be dropped out of cluster even before :variable:`evs.inactive_timeout` is reached.
+
+.. variable:: evs.use_aggregate
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: true
+
+When this variable is enabled smaller packets will be aggregated into one.
+
+.. variable:: evs.user_send_window
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: Yes
+   :default: 2
+
+This variable defines the maximum number of data packets in replication at a time. For WAN setups may be set considerably higher, e.g. 512.
+
+.. variable:: evs.version
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 0
+
+This status variable is used to check which EVS (Extended Virtual Synchrony) protocol version is used.
+
+.. variable:: evs.view_forget_timeout
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: P1D
+
+This variable defines the timeout after which past views will be dropped from history.
+
+.. variable:: gcache.dir
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: :term:`datadir`
+
+This variable can be used to define the location of the :file:`galera.cache` file.
+
+.. variable:: gcache.keep_pages_size
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Local, Global
+   :dyn: No
+   :default: 0
+
+This variable is used to specify total size of the page storage pages to keep for caching purposes. If only page storage is enabled, one page is always present.
+
+.. variable:: gcache.mem_size
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 0
+
+
+.. variable:: gcache.name
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: /var/lib/mysql/galera.cache
+
+This variable can be used to specify the name of the Galera cache file.
+
+.. variable:: gcache.page_size
+
+   :cli: No
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 128M
+
+This variable can be used to specify the size of the page files in the page storage.
+
+.. variable:: gcache.size
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 128M
+
+Size of the transaction cache for Galera replication. This defines the size of the :file:`galera.cache` file which is used as source for |IST|. If this value is bigger there are better chances that the re-joining node will get IST instead of |SST|.
+
+.. variable:: gcs.fc_debug
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 0
+
+This variable specifies after how many writesets the debug statistics about SST flow control will be posted.
+
+.. variable:: gcs.fc_factor
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 1.0
+
+This variable is used for replication flow control. Replication will be paused till the value of this variable goes below the value of :variable:`gcs.fc_factor` * :variable:`gcs.fc_limit`.
+
+.. variable:: gcs.fc_limit
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 16
+
+This variable is used for replication flow control. When slave queue exceeds this limit replication will be paused.
+
+.. variable:: gcs.fc_master_slave
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: no
+
+This variable is used to specify if there is only one master node in the cluster.
+
+.. variable:: gcs.max_packet_size
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 64500
+
+This variable is used to specify the writeset size after which they will be fragmented.
+
+.. variable:: gcs.max_throttle
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 0.25
+
+This variable specifies how much the replication can be throttled during the state transfer in order to avoid running out of memory. Value can be set to ``0.0`` if stopping replication is acceptable in order to finish state transfer.
+
+.. variable:: gcs.recv_q_hard_limit
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 9223372036854775807
+
+This variable specifies the maximum allowed size of the receive queue. This should normally be half of (RAM + swap). If this limit is exceeded, Galera will abort the server.
+
+.. variable:: gcs.recv_q_soft_limit
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 0.25
+
+This variable specifies the fraction of the :variable:`gcs.recv_q_hard_limit` after which replication rate will be throttled.
+
+.. variable:: gcs.sync_donor
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: no
+
+This variable controls if the rest of the cluster should be in sync with the donor node. When this variable is set to ``Yes`` whole cluster will be blocked if the donor node is blocked with SST.
+
+.. variable:: gmcast.listen_addr
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: tcp://0.0.0.0:4567
+
+This variable defines the address on which node listens to connections from other nodes in the cluster.
+
+.. variable:: gmcast.mcast_addr
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: None
+
+This variable should be set up if UDP multicast should be used for replication.
+
+.. variable:: gmcast.mcast_ttl
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 1
+
+This variable can be used to define TTL for multicast packets.
+
+.. variable:: gmcast.peer_timeout
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT3S
+
+This variable specifies the connection timeout to initiate message relaying.
+
+.. variable:: gmcast.time_wait
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT5S
+
+This variable specifies the time to wait until allowing peer declared outside of stable view to reconnect.
+
+.. variable:: gmcast.version
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 0
+
+This status variable is used to check which gmcast protocol version is being used. 
+
+.. variable:: ist.recv_addr
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: value of :variable:`wsrep_node_address`
+
+This variable specifies the address on which nodes listens for Incremental State Transfer (|IST|).
+
+.. variable:: pc.announce_timeout 
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT3S 
+
+.. variable:: pc.checksum
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: false
+
+This variable controls will the replicated messages will be checksummed or not.
+
+.. variable::  pc.ignore_quorum
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: Yes
+   :default: false
+
+When this variable is set to ``TRUE`` node will completely ignore the quorum calculations. This should be used with extreme caution even in master-slave setups, because slaves won't automatically reconnect to master in this case.
+
+.. variable::  pc.ignore_sb
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: Yes
+   :default: false
+
+When this variable us set ti ``TRUE`` node will process updates even in the case of split brain. This should be used with extreme caution in multi-master setup, but should simplify things in master-slave cluster (especially if only 2 nodes are used).
+
+.. variable::  pc.linger 
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: PT20S
+
+This variable specifies the period which PC protocol waits for EVS termination.
+
+.. variable::  pc.npvo 
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: false
+
+When this variable is set to ``TRUE`` more recent primary component overrides older ones in case of conflicting prims.
+
+.. variable::  pc.version
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 0
+
+This status variable is used to check which ``PC`` protocol version is being used.
+
+.. variable:: pc.wait_prim 
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: true
+
+When this variable is set to ``true`` node will wait for :variable:`pc.wait_prim_timeout` value for the primary component. This option can be used to bring up a non-primary component and make it primary with :variable:`pc.bootstrap` option.
+
+.. variable:: pc.wait_prim_timeout 
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: P30S
+
+This variable is used to define how much time node should wait for the primary component.
+
+.. variable::  pc.weight 
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: Yes
+   :default: 1
+
+This variable specifies the node weight that's going to be used for Weighted Quorum calculations.
+
+.. variable::  protonet.backend
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: asio
+
+This variable is used to define which transport backend should be used. Currently only ``ASIO`` is supported.
+
+.. variable::  protonet.version
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 0
+
+This status variable is used to show which transport backend protocol version is used.
+
+.. variable::  repl.causal_read_timeout
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: Yes
+   :default: PT30S
+
+This variable specifies the causal read timeout.
+
+.. variable::  repl.commit_order
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: No
+   :default: 3
+
+This variable is used to specify Out-Of-Order committing (which is used to improve parallel applying performance). Allowed values are:
+
+ * ``0`` – BYPASS: all commit order monitoring is turned off (useful for measuring performance penalty)
+ * ``1`` – OOOC: allow out of order committing for all transactions
+ * ``2`` – LOCAL_OOOC: allow out of order committing only for local transactions
+ * ``3`` – NO_OOOC: no out of order committing is allowed (strict total order committing)
+

=== modified file 'doc-pxc/source/wsrep-system-index.rst'
--- doc-pxc/source/wsrep-system-index.rst	2014-05-08 07:51:46 +0000
+++ doc-pxc/source/wsrep-system-index.rst	2014-05-14 11:32:28 +0000
@@ -143,6 +143,16 @@
   * MIXED
   * NONE - This option resets the forced state of the binlog format
 
+.. variable:: wsrep_load_data_splitting
+
+   :cli: Yes
+   :conf: Yes
+   :scope: Global
+   :dyn: Yes
+   :default: ON 
+
+This variable controls whether ``LOAD DATA`` transaction splitting is wanted or not.
+
 .. variable:: wsrep_log_conflicts
 
    :cli: Yes