Merge lp:~hrvojem/percona-xtrabackup/bug1355652-2.1 into lp:percona-xtrabackup/2.1

[Hrvoje Matijakovic]

[Alexey Kopytov (akopytov)]

review: Approve

=== modified file 'doc/source/conf.py'
--- doc/source/conf.py	2014-05-18 08:23:31 +0000
+++ doc/source/conf.py	2014-09-25 07:33:56 +0000
@@ -96,6 +96,8 @@
 
 .. |xbstream|  replace:: :term:`xbstream`
 
+.. |xbcrypt|  replace:: :term:`xbcrypt`
+
 .. |XtraDB|  replace:: :term:`XtraDB`
 
 .. |InnoDB|  replace:: :term:`InnoDB`

=== modified file 'doc/source/faq.rst'
--- doc/source/faq.rst	2013-11-15 12:42:15 +0000
+++ doc/source/faq.rst	2014-09-25 07:33:56 +0000
@@ -35,7 +35,7 @@
 
 :program:`xtrabackup` is a C program written to take advantage of the InnoDB or XtraDB features in order to make it as fast, less resource-consuming and unobtrusive (locking the database server) as possible. That is only possible with those engines. In the case of MyISAM a "read lock" is needed.
 
-:program:`innobackupex` is a script written in Perl which wraps :program:`xtrabackup` and other backup tools (such as :program:`tar4ibd`) and provides you with the functionality of each tool taking care of the details.
+:program:`innobackupex` is a script written in Perl which wraps :program:`xtrabackup` and other backup tools and provides you with the functionality of each tool taking care of the details.
 
 However, for some specific tasks, you must use :program:`xtrabackup` directly. See the :ref:`user-manual` for details on each one.
 

=== modified file 'doc/source/glossary.rst'
--- doc/source/glossary.rst	2013-11-14 12:17:21 +0000
+++ doc/source/glossary.rst	2014-09-25 07:33:56 +0000
@@ -69,6 +69,9 @@
    datadir
     The directory in which the database server stores its databases. Most Linux distribution use :file:`/var/lib/mysql` by default.
 
+   xbcrypt
+     To support encryption and decryption of the backups, a new tool xbcrypt was introduced to |Percona XtraBackup|. This utility has been modeled after The xbstream binary to perform encryption and decryption outside of |Percona XtraBackup|.
+     
    xbstream
      To support simultaneous compression and streaming, a new custom streaming format called xbstream was introduced to |Percona XtraBackup| in addition to the TAR format. 
 

=== modified file 'doc/source/howtos/setting_up_replication.rst'
--- doc/source/howtos/setting_up_replication.rst	2013-08-30 09:55:04 +0000
+++ doc/source/howtos/setting_up_replication.rst	2014-09-25 07:33:56 +0000
@@ -56,7 +56,7 @@
 
 .. code-block:: console
 
-   TheMaster$ innobackupex --user=yourDBuser --password=MaGiCdB1 /
+   TheMaster$ innobackupex --user=yourDBuser --password=MaGiCdB1 \
               --apply-log /path/to/backupdir/$TIMESTAMP/
 
 You need to select path where your snapshot has been taken, for example /home/backups/2012-01-16_11-14-43. If everything is ok you should get the same OK message. Now the transaction logs are applied to the data files, and new ones are created: your data files are ready to be used by the MySQL server.

=== modified file 'doc/source/index.rst'
--- doc/source/index.rst	2013-11-15 12:42:15 +0000
+++ doc/source/index.rst	2014-09-25 07:33:56 +0000
@@ -67,6 +67,7 @@
    :maxdepth: 1
    :glob:
 
+   known_issues
    faq
    release-notes
    glossary

=== modified file 'doc/source/innobackupex/creating_a_backup_ibk.rst'
--- doc/source/innobackupex/creating_a_backup_ibk.rst	2013-04-29 11:08:57 +0000
+++ doc/source/innobackupex/creating_a_backup_ibk.rst	2014-09-25 07:33:56 +0000
@@ -2,7 +2,7 @@
  Creating a Backup with |innobackupex|
 =======================================
 
-|innobackupex| is the tool that glues |xtrabackup| and |tar4ibd|, which are specific tools, plus adding functionality to provide a single interface to backup all the data in your database server.
+|innobackupex| is the tool which provides functionality to backup a whole MySQL database instance using the |xtrabackup| in combination with tools like |xbstream| and |xbcrypt|.
 
 To create a full backup, invoke the script with the options needed to connect to the server and only one argument: the path to the directory where the backup will be stored ::
 

=== modified file 'doc/source/innobackupex/how_innobackupex_works.rst'
--- doc/source/innobackupex/how_innobackupex_works.rst	2013-08-30 09:55:04 +0000
+++ doc/source/innobackupex/how_innobackupex_works.rst	2014-09-25 07:33:56 +0000
@@ -4,7 +4,7 @@
  How |innobackupex| Works
 ==========================
 
-:program:`innobackupex` is a script written in Perl that wraps the :program:`xtrabackup` and :program:`tar4ibd` binaries and performs the tasks where the performance and efficiency of *C* program isn't needed. In this way, it provides a convinient and integrated approach to backing up in many common scenarios. 
+:program:`innobackupex` is a script written in Perl that wraps the :program:`xtrabackup` and performs the tasks where the performance and efficiency of *C* program isn't needed. In this way, it provides a convenient and integrated approach to backing up in many common scenarios. 
 
 The following describes the rationale behind :program:`innobackupex` actions.
 

=== modified file 'doc/source/innobackupex/innobackupex_option_reference.rst'
--- doc/source/innobackupex/innobackupex_option_reference.rst	2014-09-10 11:21:05 +0000
+++ doc/source/innobackupex/innobackupex_option_reference.rst	2014-09-25 07:33:56 +0000
@@ -234,7 +234,7 @@
 
 .. option:: --throttle=IOS
 
-   This option accepts an integer argument that specifies the number of I/O operations (i.e., pairs of read+write) per second. It is passed directly to xtrabackup's :option:`xtrabackup --throttle` option.
+   This option accepts an integer argument that specifies the number of I/O operations (i.e., pairs of read+write) per second. It is passed directly to xtrabackup's :option:`xtrabackup --throttle` option. **NOTE:** This option works only during the backup phase, ie. it will not work with :option:`innobackupex --apply-log` and :option:`innobackupex --copy-back` options.
 
 .. option:: --tmpdir=DIRECTORY
 

=== modified file 'doc/source/innobackupex/innobackupex_script.rst'
--- doc/source/innobackupex/innobackupex_script.rst	2013-11-15 12:42:15 +0000
+++ doc/source/innobackupex/innobackupex_script.rst	2014-09-25 07:33:56 +0000
@@ -4,8 +4,6 @@
 
 The |innobackupex| tool is a *Perl* script that acts as a wrapper for the :doc:`xtrabackup <../xtrabackup_bin/xtrabackup_binary>` *C* program. It is a patched version of the ``innobackup`` *Perl* script that *Oracle* distributes with the *InnoDB Hot Backup* tool. It enables more functionality by integrating |xtrabackup| and other functions such as file copying and streaming, and adds some convenience. It lets you perform point-in-time backups of |InnoDB| / |XtraDB| tables together with the schema definitions, |MyISAM| tables, and other portions of the server.
 
-We are currently not satisfied with the architecture, code quality and maintainability, or functionality of |innobackupex|, and we expect to replace it with something else in the future.
-
 This manual section explains how to use |innobackupex| in detail.
 
 Prerequisites

=== modified file 'doc/source/innobackupex/throttling_ibk.rst'
--- doc/source/innobackupex/throttling_ibk.rst	2013-04-29 09:29:00 +0000
+++ doc/source/innobackupex/throttling_ibk.rst	2014-09-25 07:33:56 +0000
@@ -8,4 +8,8 @@
 
 One way of checking the current I/O operations at a system is with :command:`iostat` command. See :ref:`throttling_backups_xbk` for details of how throttling works.
 
+.. note:: 
+
+   :option:`innobackupex --throttle` option works only during the backup phase, ie. it will not work with :option:`innobackupex --apply-log` and :option:`innobackupex --copy-back` options.
+
 The :option:`--throttle` option is similar to the ``--sleep`` option in ``mysqlbackup`` and should be used instead of it, as ``--sleep`` will be ignored.

=== modified file 'doc/source/installation/apt_repo.rst'
--- doc/source/installation/apt_repo.rst	2013-11-21 10:08:38 +0000
+++ doc/source/installation/apt_repo.rst	2014-09-25 07:33:56 +0000
@@ -39,13 +39,13 @@
  * 13.04 (raring)
  * 13.10 (saucy)
 
-Experimental Repository
-=======================
-
-Percona now offers experimental repository for beta releases. To enable it add this to :file:`/etc/apt/sources.list`, replacing ``VERSION`` with the name of your distribution: ::
-
-  deb http://repo.percona.com/apt VERSION main experimental
-  deb-src http://repo.percona.com/apt VERSION main experimental
+Percona `apt` Testing repository
+=================================
+
+Percona offers pre-release builds from the testing repository. To enable it add the following lines to your  :file:`/etc/apt/sources.list` , replacing ``VERSION`` with the name of your distribution: ::
+
+  deb http://repo.percona.com/apt VERSION main testing
+  deb-src http://repo.percona.com/apt VERSION main testing
 
 Ubuntu PPA of daily builds
 ==========================

=== modified file 'doc/source/installation/yum_repo.rst'
--- doc/source/installation/yum_repo.rst	2012-02-02 20:12:11 +0000
+++ doc/source/installation/yum_repo.rst	2014-09-25 07:33:56 +0000
@@ -9,31 +9,16 @@
 Automatic Installation
 ======================
 
-Execute the following command as a ``root`` user, replacing ``x86_64`` with ``i386`` if you are not running a 64-bit operating system: ::
+Execute the following command as a ``root`` user: ::
 
-  $ rpm -Uhv http://www.percona.com/downloads/percona-release/percona-release-0.0-1.x86_64.rpm
+  $ yum install http://www.percona.com/downloads/percona-release/redhat/0.1-3/percona-release-0.1-3.noarch.rpm 
 
 You should see some output such as the following: ::
 
-  Retrieving http://www.percona.com/downloads/percona-release/percona-release-0.0-1.x86_64.rpm
+  Retrieving yum install http://www.percona.com/downloads/percona-release/redhat/0.1-3/percona-release-0.1-3.noarch.rpm
   Preparing...                ########################################### [100%]
      1:percona-release        ########################################### [100%]
 
-The RPMs for the automatic installation are available at http://www.percona.com/downloads/percona-release/ and include source code.
-
-Manual Installation
-===================
-
-To install the repository manually, place the following into a new file named :file:`/etc/yum.repos.d/Percona.repo`: ::
-
-  [percona]
-  name = CentOS $releasever - Percona
-  baseurl=http://repo.percona.com/centos/$releasever/os/$basearch/
-  enabled = 1
-  gpgkey = file:///etc/pki/rpm-gpg/RPM-GPG-KEY-percona
-  gpgcheck = 1
-
-Also, copy the `Percona GPG key <http://www.percona.com/downloads/RPM-GPG-KEY-percona>`_  into a file named :file:`/etc/pki/rpm-gpg/RPM-GPG-KEY-percona`.
 
 Testing The Repository
 ======================
@@ -69,9 +54,7 @@
 * *CentOS* 6 and *RHEL* 6
 * *Amazon Linux AMI* (works the same as *CentOS* 5)
 
-Release Candidate Repository
-============================
-
-To subscribe to the release candidate repository, install the release candidate (RC) *RPM*: ::
-
-  rpm -Uhv http://www.percona.com/downloads/percona-release/percona-rc-0.0-2.x86_64.rpm
+Percona `yum` Testing Repository
+=================================
+
+Percona offers pre-release builds from the testing repository. To subscribe to the testing repository, you'll need to enable the testing repository in :file:`/etc/yum.repos.d/percona-release.repo`. **NOTE:** You'll need to install the Percona repository first if this hasn't been done already.

=== added file 'doc/source/known_issues.rst'
--- doc/source/known_issues.rst	1970-01-01 00:00:00 +0000
+++ doc/source/known_issues.rst	2014-09-25 07:33:56 +0000
@@ -0,0 +1,13 @@
+.. _known_issues:
+
+==============================
+ Known issues and limitations
+==============================
+
+There is a number of |Percona XtraBackup| related issues with compressed |InnoDB| tables. These issues result from either server-side bugs, or OS configuration and thus, cannot be fixed on the |Percona XtraBackup| side.
+
+Known issues:
+
+ * For |MySQL| or |Percona Server| versions 5.1 and 5.5 there are known and unfixed bugs with redo-logging of updates to compressed |InnoDB| tables. For example, internal Oracle bug #16267120 has been fixed only in |MySQL| 5.6.12, but not in 5.1 or 5.5. The bug is about compressed page images not being logged on page reorganization and thus, creating a possibility for recovery process to fail in case a different zlib version is being used when replaying a ``MLOG_ZIP_PAGE_REORGANIZE`` redo log record.
+
+ * For |MySQL| or |Percona Server| version 5.6 it is NOT recommended to set ``innodb_log_compressed_pages=OFF`` for servers that use compressed |InnoDB| tables which are backed up with |Percona XtraBackup|. This option makes |InnoDB| recovery (and thus, backup prepare) sensible to ``zlib`` versions. In case the host where a backup prepare is performed uses a different ``zlib`` version than the one that was used by the server during runtime, backup prepare may fail due to differences in compression algorithms.