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

Proposed by Hrvoje Matijakovic on 2014-09-23
Status: Merged
Approved by: Alexey Kopytov on 2014-09-25
Approved revision: 765
Merged at revision: 767
Proposed branch: lp:~hrvojem/percona-xtrabackup/bug1355652-2.1
Merge into: lp:percona-xtrabackup/2.1
Diff against target: 225 lines (+42/-38)
13 files modified
doc/source/conf.py (+2/-0)
doc/source/faq.rst (+1/-1)
doc/source/glossary.rst (+3/-0)
doc/source/howtos/setting_up_replication.rst (+1/-1)
doc/source/index.rst (+1/-0)
doc/source/innobackupex/creating_a_backup_ibk.rst (+1/-1)
doc/source/innobackupex/how_innobackupex_works.rst (+1/-1)
doc/source/innobackupex/innobackupex_option_reference.rst (+1/-1)
doc/source/innobackupex/innobackupex_script.rst (+0/-2)
doc/source/innobackupex/throttling_ibk.rst (+4/-0)
doc/source/installation/apt_repo.rst (+7/-7)
doc/source/installation/yum_repo.rst (+7/-24)
doc/source/known_issues.rst (+13/-0)
To merge this branch: bzr merge lp:~hrvojem/percona-xtrabackup/bug1355652-2.1
Reviewer Review Type Date Requested Status
Alexey Kopytov (community) 2014-09-23 Approve on 2014-09-25
Review via email: mp+235618@code.launchpad.net
To post a comment you must log in.
765. By Hrvoje Matijakovic on 2014-09-25

- Fixed bugs: WEB-966, DOC-93, DOC-104, Bug #1349543, and Bug #1355652
- Documented changes in yum repositories described in BLD-195

Alexey Kopytov (akopytov) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/source/conf.py'
2--- doc/source/conf.py 2014-05-18 08:23:31 +0000
3+++ doc/source/conf.py 2014-09-25 07:33:56 +0000
4@@ -96,6 +96,8 @@
5
6 .. |xbstream| replace:: :term:`xbstream`
7
8+.. |xbcrypt| replace:: :term:`xbcrypt`
9+
10 .. |XtraDB| replace:: :term:`XtraDB`
11
12 .. |InnoDB| replace:: :term:`InnoDB`
13
14=== modified file 'doc/source/faq.rst'
15--- doc/source/faq.rst 2013-11-15 12:42:15 +0000
16+++ doc/source/faq.rst 2014-09-25 07:33:56 +0000
17@@ -35,7 +35,7 @@
18
19 :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.
20
21-: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.
22+: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.
23
24 However, for some specific tasks, you must use :program:`xtrabackup` directly. See the :ref:`user-manual` for details on each one.
25
26
27=== modified file 'doc/source/glossary.rst'
28--- doc/source/glossary.rst 2013-11-14 12:17:21 +0000
29+++ doc/source/glossary.rst 2014-09-25 07:33:56 +0000
30@@ -69,6 +69,9 @@
31 datadir
32 The directory in which the database server stores its databases. Most Linux distribution use :file:`/var/lib/mysql` by default.
33
34+ xbcrypt
35+ 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|.
36+
37 xbstream
38 To support simultaneous compression and streaming, a new custom streaming format called xbstream was introduced to |Percona XtraBackup| in addition to the TAR format.
39
40
41=== modified file 'doc/source/howtos/setting_up_replication.rst'
42--- doc/source/howtos/setting_up_replication.rst 2013-08-30 09:55:04 +0000
43+++ doc/source/howtos/setting_up_replication.rst 2014-09-25 07:33:56 +0000
44@@ -56,7 +56,7 @@
45
46 .. code-block:: console
47
48- TheMaster$ innobackupex --user=yourDBuser --password=MaGiCdB1 /
49+ TheMaster$ innobackupex --user=yourDBuser --password=MaGiCdB1 \
50 --apply-log /path/to/backupdir/$TIMESTAMP/
51
52 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.
53
54=== modified file 'doc/source/index.rst'
55--- doc/source/index.rst 2013-11-15 12:42:15 +0000
56+++ doc/source/index.rst 2014-09-25 07:33:56 +0000
57@@ -67,6 +67,7 @@
58 :maxdepth: 1
59 :glob:
60
61+ known_issues
62 faq
63 release-notes
64 glossary
65
66=== modified file 'doc/source/innobackupex/creating_a_backup_ibk.rst'
67--- doc/source/innobackupex/creating_a_backup_ibk.rst 2013-04-29 11:08:57 +0000
68+++ doc/source/innobackupex/creating_a_backup_ibk.rst 2014-09-25 07:33:56 +0000
69@@ -2,7 +2,7 @@
70 Creating a Backup with |innobackupex|
71 =======================================
72
73-|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.
74+|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|.
75
76 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 ::
77
78
79=== modified file 'doc/source/innobackupex/how_innobackupex_works.rst'
80--- doc/source/innobackupex/how_innobackupex_works.rst 2013-08-30 09:55:04 +0000
81+++ doc/source/innobackupex/how_innobackupex_works.rst 2014-09-25 07:33:56 +0000
82@@ -4,7 +4,7 @@
83 How |innobackupex| Works
84 ==========================
85
86-: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.
87+: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.
88
89 The following describes the rationale behind :program:`innobackupex` actions.
90
91
92=== modified file 'doc/source/innobackupex/innobackupex_option_reference.rst'
93--- doc/source/innobackupex/innobackupex_option_reference.rst 2014-09-10 11:21:05 +0000
94+++ doc/source/innobackupex/innobackupex_option_reference.rst 2014-09-25 07:33:56 +0000
95@@ -234,7 +234,7 @@
96
97 .. option:: --throttle=IOS
98
99- 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.
100+ 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.
101
102 .. option:: --tmpdir=DIRECTORY
103
104
105=== modified file 'doc/source/innobackupex/innobackupex_script.rst'
106--- doc/source/innobackupex/innobackupex_script.rst 2013-11-15 12:42:15 +0000
107+++ doc/source/innobackupex/innobackupex_script.rst 2014-09-25 07:33:56 +0000
108@@ -4,8 +4,6 @@
109
110 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.
111
112-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.
113-
114 This manual section explains how to use |innobackupex| in detail.
115
116 Prerequisites
117
118=== modified file 'doc/source/innobackupex/throttling_ibk.rst'
119--- doc/source/innobackupex/throttling_ibk.rst 2013-04-29 09:29:00 +0000
120+++ doc/source/innobackupex/throttling_ibk.rst 2014-09-25 07:33:56 +0000
121@@ -8,4 +8,8 @@
122
123 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.
124
125+.. note::
126+
127+ :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.
128+
129 The :option:`--throttle` option is similar to the ``--sleep`` option in ``mysqlbackup`` and should be used instead of it, as ``--sleep`` will be ignored.
130
131=== modified file 'doc/source/installation/apt_repo.rst'
132--- doc/source/installation/apt_repo.rst 2013-11-21 10:08:38 +0000
133+++ doc/source/installation/apt_repo.rst 2014-09-25 07:33:56 +0000
134@@ -39,13 +39,13 @@
135 * 13.04 (raring)
136 * 13.10 (saucy)
137
138-Experimental Repository
139-=======================
140-
141-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: ::
142-
143- deb http://repo.percona.com/apt VERSION main experimental
144- deb-src http://repo.percona.com/apt VERSION main experimental
145+Percona `apt` Testing repository
146+=================================
147+
148+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: ::
149+
150+ deb http://repo.percona.com/apt VERSION main testing
151+ deb-src http://repo.percona.com/apt VERSION main testing
152
153 Ubuntu PPA of daily builds
154 ==========================
155
156=== modified file 'doc/source/installation/yum_repo.rst'
157--- doc/source/installation/yum_repo.rst 2012-02-02 20:12:11 +0000
158+++ doc/source/installation/yum_repo.rst 2014-09-25 07:33:56 +0000
159@@ -9,31 +9,16 @@
160 Automatic Installation
161 ======================
162
163-Execute the following command as a ``root`` user, replacing ``x86_64`` with ``i386`` if you are not running a 64-bit operating system: ::
164+Execute the following command as a ``root`` user: ::
165
166- $ rpm -Uhv http://www.percona.com/downloads/percona-release/percona-release-0.0-1.x86_64.rpm
167+ $ yum install http://www.percona.com/downloads/percona-release/redhat/0.1-3/percona-release-0.1-3.noarch.rpm
168
169 You should see some output such as the following: ::
170
171- Retrieving http://www.percona.com/downloads/percona-release/percona-release-0.0-1.x86_64.rpm
172+ Retrieving yum install http://www.percona.com/downloads/percona-release/redhat/0.1-3/percona-release-0.1-3.noarch.rpm
173 Preparing... ########################################### [100%]
174 1:percona-release ########################################### [100%]
175
176-The RPMs for the automatic installation are available at http://www.percona.com/downloads/percona-release/ and include source code.
177-
178-Manual Installation
179-===================
180-
181-To install the repository manually, place the following into a new file named :file:`/etc/yum.repos.d/Percona.repo`: ::
182-
183- [percona]
184- name = CentOS $releasever - Percona
185- baseurl=http://repo.percona.com/centos/$releasever/os/$basearch/
186- enabled = 1
187- gpgkey = file:///etc/pki/rpm-gpg/RPM-GPG-KEY-percona
188- gpgcheck = 1
189-
190-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`.
191
192 Testing The Repository
193 ======================
194@@ -69,9 +54,7 @@
195 * *CentOS* 6 and *RHEL* 6
196 * *Amazon Linux AMI* (works the same as *CentOS* 5)
197
198-Release Candidate Repository
199-============================
200-
201-To subscribe to the release candidate repository, install the release candidate (RC) *RPM*: ::
202-
203- rpm -Uhv http://www.percona.com/downloads/percona-release/percona-rc-0.0-2.x86_64.rpm
204+Percona `yum` Testing Repository
205+=================================
206+
207+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.
208
209=== added file 'doc/source/known_issues.rst'
210--- doc/source/known_issues.rst 1970-01-01 00:00:00 +0000
211+++ doc/source/known_issues.rst 2014-09-25 07:33:56 +0000
212@@ -0,0 +1,13 @@
213+.. _known_issues:
214+
215+==============================
216+ Known issues and limitations
217+==============================
218+
219+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.
220+
221+Known issues:
222+
223+ * 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.
224+
225+ * 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.

Subscribers

People subscribed via source and target branches