Merge lp:~hrvojem/percona-xtrabackup/rn-2.3.0-alpha1-2.3 into lp:percona-xtrabackup/2.3

[Hrvoje Matijakovic]

[Alexey Kopytov (akopytov)]

review: Approve

=== modified file 'storage/innobase/xtrabackup/doc/source/conf.py'
--- storage/innobase/xtrabackup/doc/source/conf.py	2014-09-30 09:43:35 +0000
+++ storage/innobase/xtrabackup/doc/source/conf.py	2014-11-06 09:00:04 +0000
@@ -51,9 +51,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.2.5'
+version = '2.3.0'
 # The full version, including alpha/beta/rc tags.
-release = '2.2.5'
+release = '2.3.0-alpha1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -126,6 +126,8 @@
 
 .. |tar|  replace:: :program:`tar`
 
+.. |xbcloud| replace:: *xbcloud*
+
 '''
 
 extlinks = {'bug': ('https://bugs.launchpad.net/percona-xtrabackup/+bug/%s',
@@ -152,10 +154,10 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = 'Percona XtraBackup 2.2 Documentation'
+html_title = 'Percona XtraBackup 2.3 Documentation'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-html_short_title = 'Percona XtraBackup 2.2 Documentation'
+html_short_title = 'Percona XtraBackup 2.3 Documentation'
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -227,7 +229,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'PerconaXtraBackup-2.2.tex', u'Percona XtraBackup 2.2 Documentation',
+  ('index', 'PerconaXtraBackup-2.3.tex', u'Percona XtraBackup 2.3 Documentation',
    u'Percona LLC and/or its affiliates', 'manual'),
 ]
 
@@ -260,7 +262,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('xtrabackup_bin/xtrabackup_binary', 'xtrabackup', u'Percona XtraBackup 2.2 Documentation',
+    ('xtrabackup_bin/xtrabackup_binary', 'xtrabackup', u'Percona XtraBackup 2.3 Documentation',
      [u'Percona LLC and/or its affiliates'], 1),
     ('innobackupex/innobackupex_script', 'innobackupex', u'innobackupex Documentation',
      [u'Percona LLC and/or its affiliates'], 1),

=== modified file 'storage/innobase/xtrabackup/doc/source/index.rst'
--- storage/innobase/xtrabackup/doc/source/index.rst	2014-09-30 09:43:35 +0000
+++ storage/innobase/xtrabackup/doc/source/index.rst	2014-11-06 09:00:04 +0000
@@ -15,6 +15,9 @@
 
 |Percona XtraBackup| is a combination of the |xtrabackup| *C* program, and the |innobackupex| *Perl* script. The |xtrabackup| program copies and manipulates |InnoDB| and |XtraDB| data files, and the *Perl* script enables enhanced functionality, such as interacting with a running |MySQL| server and backing up |MyISAM| tables. 
 
+.. warning:: 
+
+   This release is considered **ALPHA** quality and not inteded for production.
 
 Introduction
 ============

=== modified file 'storage/innobase/xtrabackup/doc/source/installation/apt_repo.rst'
--- storage/innobase/xtrabackup/doc/source/installation/apt_repo.rst	2014-09-25 16:10:20 +0000
+++ storage/innobase/xtrabackup/doc/source/installation/apt_repo.rst	2014-11-06 09:00:04 +0000
@@ -37,10 +37,10 @@
 
  * 10.04LTS (lucid)
  * 12.04LTS (precise) 
- * 13.10 (saucy)
  * 14.04LTS (trusty)
+ * 14.10 (utopic)
 
-.. _debian_experimental: 
+.. _debian_testing: 
 
 Percona `apt` Testing repository
 =================================

=== modified file 'storage/innobase/xtrabackup/doc/source/manual.rst'
--- storage/innobase/xtrabackup/doc/source/manual.rst	2013-08-30 09:55:04 +0000
+++ storage/innobase/xtrabackup/doc/source/manual.rst	2014-11-06 09:00:04 +0000
@@ -12,6 +12,7 @@
    xtrabackup_bin/xtrabackup_binary
    xbstream/xbstream
    xbcrypt/xbcrypt
+   xbcloud/xbcloud
    how_xtrabackup_works
 
 |Percona XtraBackup| is a set of following tools:
@@ -28,4 +29,7 @@
 :doc:`xbstream <xbstream/xbstream>`
    utility that allows streaming and extracting files to/from the :term:`xbstream` format.
 
+:doc:`xbcloud <xbcloud/xbcloud>`
+   utility used for downloading and uploading full or part of |xbstream| archive from/to cloud.
+
 It is possible to use the |xtrabackup| binary alone, however, the recommend way is using it through the |innobackupex| wrapper script and let it execute |xtrabackup| for you. It might be helpful to first learn :doc:`how to use innobackupex <innobackupex/innobackupex_script>`, and then learn  :doc:`how to use xtrabackup <xtrabackup_bin/xtrabackup_binary>` for having a better low-level understanding or control of the tool if needed.

=== modified file 'storage/innobase/xtrabackup/doc/source/release-notes.rst'
--- storage/innobase/xtrabackup/doc/source/release-notes.rst	2014-03-26 07:39:36 +0000
+++ storage/innobase/xtrabackup/doc/source/release-notes.rst	2014-11-06 09:00:04 +0000
@@ -48,3 +48,12 @@
    :glob:
 
    release-notes/2.2/*
+
+Percona |XtraBackup| 2.3 
+=========================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   release-notes/2.3/*

=== modified file 'storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.1-alpha1.rst'
--- storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.1-alpha1.rst	2014-03-28 11:46:09 +0000
+++ storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.1-alpha1.rst	2014-11-06 09:00:04 +0000
@@ -2,7 +2,7 @@
  |Percona XtraBackup| 2.2.1-alpha1
 =======================================
 
-Percona is glad to announce the release of |Percona XtraBackup| 2.2.1-alpha1 on March 28th 2014. Downloads are available from our download site `here <http://www.percona.com/downloads/XtraBackup/2.2.1/>`_. This **ALPHA** release, will be available in :ref:`Debian experimental <debian_experimental>` and :ref:`CentOS testing <yum_testing>` repositories. 
+Percona is glad to announce the release of |Percona XtraBackup| 2.2.1-alpha1 on March 28th 2014. Downloads are available from our download site `here <http://www.percona.com/downloads/XtraBackup/2.2.1/>`_. This **ALPHA** release, will be available in :ref:`Debian experimental <debian_testing>` and :ref:`CentOS testing <yum_testing>` repositories. 
 
 This is an **ALPHA** quality release and it is not intended for production. If you want a high quality, Generally Available release, the current Stable version should be used (currently 2.1.8 in the 2.1 series at the time of writing).
 

=== modified file 'storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.2-beta1.rst'
--- storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.2-beta1.rst	2014-05-06 17:08:06 +0000
+++ storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.2-beta1.rst	2014-11-06 09:00:04 +0000
@@ -2,7 +2,7 @@
  |Percona XtraBackup| 2.2.2-beta1
 =======================================
 
-Percona is glad to announce the release of |Percona XtraBackup| 2.2.2-beta1 on May 8th 2014. Downloads are available from our download site `here <http://www.percona.com/downloads/XtraBackup/2.2.2/>`_. This **BETA** release will be available in :ref:`Debian experimental <debian_experimental>` and :ref:`CentOS testing <yum_testing>` repositories. 
+Percona is glad to announce the release of |Percona XtraBackup| 2.2.2-beta1 on May 8th 2014. Downloads are available from our download site `here <http://www.percona.com/downloads/XtraBackup/2.2.2/>`_. This **BETA** release will be available in :ref:`Debian experimental <debian_testing>` and :ref:`CentOS testing <yum_testing>` repositories. 
 
 This is a **BETA** quality release and it is not intended for production. If you want a high quality, Generally Available release, the current Stable version should be used (currently 2.1.9 in the 2.1 series at the time of writing).
 

=== added directory 'storage/innobase/xtrabackup/doc/source/release-notes/2.3'
=== added file 'storage/innobase/xtrabackup/doc/source/release-notes/2.3/2.3.0-alpha1.rst'
--- storage/innobase/xtrabackup/doc/source/release-notes/2.3/2.3.0-alpha1.rst	1970-01-01 00:00:00 +0000
+++ storage/innobase/xtrabackup/doc/source/release-notes/2.3/2.3.0-alpha1.rst	2014-11-06 09:00:04 +0000
@@ -0,0 +1,16 @@
+===================================
+ |Percona XtraBackup| 2.3.0-alpha1
+===================================
+
+Percona is glad to announce the release of |Percona XtraBackup| 2.3.0-alpha1 on October 30th 2014. Downloads are available from our download site `here <http://www.percona.com/downloads/TESTING/XtraBackup/xtrabackup-2.3.0alpha1/>`_. This **ALPHA** release, will be available in :ref:`Debian testing <debian_testing>` and :ref:`CentOS testing <yum_testing>` repositories. 
+
+This is an **ALPHA** quality release and it is not intended for production. If you want a high quality, Generally Available release, the current Stable version should be used (currently 2.2.5 in the 2.2 series at the time of writing).
+
+New features
+------------
+
+ |Percona XtraBackup| has implemented new tool, :ref:`xbcloud_binary`, which can be used to upload/download full or part of |xbstream| archive from/to cloud. 
+ 
+.. note:: 
+
+   In order to sucessfully install Percona Xtrabackup 2.3.0-alpha1 on *CentOS*, ``libev.so.4`` package will need to be installed first. ``libev.so.4`` package can be installed from the `EPEL <https://fedoraproject.org/wiki/EPEL>`_ repositories.

=== added directory 'storage/innobase/xtrabackup/doc/source/xbcloud'
=== added file 'storage/innobase/xtrabackup/doc/source/xbcloud/xbcloud.rst'
--- storage/innobase/xtrabackup/doc/source/xbcloud/xbcloud.rst	1970-01-01 00:00:00 +0000
+++ storage/innobase/xtrabackup/doc/source/xbcloud/xbcloud.rst	2014-11-06 09:00:04 +0000
@@ -0,0 +1,87 @@
+.. _xbcloud_binary:
+
+======================
+ The xbcloud Binary
+======================
+
+.. note::
+
+   This feature implementation is considered **ALPHA** quality.
+
+|xbcloud| is a new tool which is part of the |Percona XtraBackup| 2.3.0-alpha1 release. The purpose of |xbcloud| is to download and upload full or part of |xbstream| archive from/to cloud. Archive uploading will employ multipart upload for Amazon and Large Objects on Swift. Along with |xbstream| archive index file will be uploaded which contains list of files and their parts and offsets of those parts in the |xbstream| archive. This index is needed for downloading only part of archive (one or several tables from backups) on demand.
+
+Usage
+-----
+
+Backup: ::
+
+ innobackupex --stream=xbstream /tmp | xbcloud [options] put <name>
+
+Following example shows how to make a full backup and upload it to Swift: :: 
+
+ innobackupex --stream=xbstream --extra-lsndir=/tmp /tmp | \
+ xbcloud put --storage=Swift \
+ --swift-container=test \
+ --swift-user=test:tester \
+ --swift-url=http://192.168.8.80:8080/ \
+ --swift-key=testing \
+ --parallel=10 \
+ full_backup
+
+Restore: :: 
+
+ xbcloud [options] get <name> [<list-of-files>] | xbstream -x
+
+Following example shows how to fetch and restore the backup from Swift: :: 
+
+  xbcloud get --storage=Swift \
+  --swift-container=test \
+  --swift-user=test:tester \
+  --swift-url=http://192.168.8.80:8080/ \
+  --swift-key=testing \
+  full_backup | xbstream -xv -C /tmp/downloaded_full
+
+  innobackupex --apply-log /tmp/downloaded_full
+  innobackupex --copy-back /tmp/downloaded_full
+
+Limitations
+-----------
+
+Restoring individual tables from full cloud backup isn't possible without downloading the entire backup.
+
+Command-line options
+--------------------
+
+|xbcloud| has following command line options:
+
+.. option:: --storage
+
+   Cloud storage option. Only support for Swift is currently implemented. Default is Swift
+
+.. option:: --swift-url 
+
+   URL of Swift cluster
+
+.. option:: --swift-user
+
+   Swift username (X-Auth-User, specific to Swift)
+
+.. option:: --swift-key 
+
+   Swift key/password (X-Auth-Key, specific to Swift)
+
+.. option:: --swift-container 
+
+   Container to backup into (specific to Swift)
+
+.. option:: --parallel=N 
+
+   Maximum number of concurrent upload/download threads. Default is 1.
+
+.. option:: --cacert 
+
+   Path to the file with CA certificates
+
+.. option:: --insecure 
+
+   Do not verify servers certificate