-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PXB-3410 [DOC] Add information on PRO builds to PXB 8.4 docs
new file: docs/install-pro.md new file: docs/pro-files.md new file: docs/pxb-pro.md modified: mkdocs-base.yml new file: snippets/pro-build-announcement.md
- Loading branch information
1 parent
973b6a8
commit f5330e8
Showing
7 changed files
with
165 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
# Install Percona XtraBackup Pro | ||
|
||
--8<--- "pro-build-announcement.md" | ||
|
||
This document provides guidelines how to install Pro packages of Percona XtraBackup from Percona repositories. [Check files in packages built for Percona XtraBackup Pro :material-arrow-right:](pro-files.md){.md-button} | ||
|
||
## Procedure | ||
|
||
1. Request the access to the pro repository from Percona Support. You will receive the client ID and the access token which you use when downloading the packages. | ||
|
||
2. Before configuring the repository and installing Percona XtraBackup packages, enable Pro builds with following command | ||
|
||
```{.bash .data-prompt="$"} | ||
$ cmake -DPROBUILD=ON | ||
``` | ||
|
||
3. Configure the repository and install Percona XtraBackup packages | ||
|
||
=== "On Debian and Ubuntu" | ||
|
||
1. Download a `DEB` package for *percona-release* the repository packages from Percona web: | ||
|
||
```{.bash data-prompt="$"} | ||
$ wget https://repo.percona.com/apt/percona-release_latest.$(lsb_release -sc)_all.deb | ||
``` | ||
|
||
2. Install the downloaded package with **dpkg**. To do that, run the following commands as root or with **sudo**: `dpkg -i percona-release_latest.$(lsb_release -sc)_all.deb` | ||
|
||
Once you install this package the Percona repositories should be added. You | ||
can check the repository setup in the `/etc/apt/sources.list.d/percona-release.list` file. | ||
|
||
3. Enable the repository: `percona-release enable-only tools release` | ||
|
||
If Percona XtraBackup is intended to be used in combination with the upstream MySQL Server, you only need to enable the `tools` repository: `percona-release enable-only tools`. | ||
|
||
4. Refresh the local cache to update the package information: | ||
|
||
```{.bash data-prompt="$"} | ||
$ sudo apt update | ||
``` | ||
|
||
5. Install the `percona-xtrabackup-pro` package: | ||
|
||
```{.bash data-prompt="$"} | ||
$ sudo apt install percona-xtrabackup-pro | ||
``` | ||
|
||
6. To decompress backups made using `LZ4` or `ZSTD` compression algorithm, install the corresponding package: | ||
|
||
=== "Install the `lz4` package" | ||
|
||
```{.bash data-prompt="$"} | ||
$ sudo apt install lz4 | ||
``` | ||
|
||
=== "Install the `zstd` package" | ||
|
||
```{.bash data-prompt="$"} | ||
$ sudo apt install zstd | ||
``` | ||
|
||
=== "On RHEL and derivatives" | ||
|
||
1. Install the Percona yum repository by running the following command as the `root` user or with **sudo**: | ||
|
||
```{.bash data-prompt="$"} | ||
$ sudo yum install \ | ||
https://repo.percona.com/yum/percona-release-latest.\ | ||
noarch.rpm | ||
``` | ||
|
||
2. Enable the repository: | ||
|
||
```{.bash data-prompt="$"} | ||
$ sudo percona-release enable-only tools release | ||
``` | ||
|
||
If *Percona XtraBackup* is intended to be used in combination with | ||
the upstream MySQL Server, you only need to enable the `tools repository: | ||
```{.bash data-prompt="$"} | ||
$ sudo percona-release enable-only tools | ||
``` | ||
|
||
3. Install *Percona XtraBackup* by running: | ||
|
||
```{.bash data-prompt="$"} | ||
$ sudo yum install percona-xtrabackup-pro | ||
``` | ||
|
||
!!! warning | ||
|
||
Make sure that you have the `libev` package installed before installing *Percona XtraBackup* on CentOS 6. For this operating system, the `libev` package is available from the [EPEL](https://fedoraproject.org/wiki/EPEL) repositories. | ||
|
||
4. To decompress backups made using `LZ4` or `ZSTD` compression algorithm, install the corresponding package: | ||
|
||
=== "Install the `lz4` package" | ||
|
||
```{.bash data-prompt="$"} | ||
$ sudo yum install lz4 | ||
``` | ||
|
||
=== "Install the `zstd` package" | ||
|
||
```{.bash data-prompt="$"} | ||
$ sudo yum install zstd | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Files in packages built for Percona XtraBackup Pro | ||
|
||
--8<--- "pro-build-announcement.md" | ||
|
||
## Files in the DEB package | ||
|
||
| Package | Contains | | ||
|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
| percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|
||
## Files in the RPM package | ||
|
||
| Package | Contains | | ||
|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
|percona-xtrabackup- | | | ||
| percona-xtrabackup- | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Percona XtraBackup Pro | ||
|
||
--8<--- "pro-build-announcement.md" | ||
|
||
## Capabilities | ||
|
||
Find the list of capabilities available in Percona XtraBackup Pro: | ||
|
||
| Name | Version | Description | | ||
| ----------------------------------- | ------------- | -------------| | ||
| [Reduced backup lock time](reduction-in-locks.md)| 8.4.0-2 | Reduces the time the server remains locked by `xtrabackup` during full and incremental backups. Allows `Data Definition Language` (DDL) operations on the server while the backup is in progress.| | ||
|
||
## What's in it for you? | ||
|
||
* Save on deploying and maintaining build infrastructure as we do the build and testing for you | ||
* Longer support for older versions of operating systems. | ||
|
||
[Install Percona XtraBackup Pro](install-pro.md){.md-button} | ||
|
||
Community users can receive all these capabilities by [building Percona XtraBackup from the same source code](compile-xtrabackup.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,3 +14,4 @@ mkdocs-htmlproofer-plugin | |
mkdocs-meta-descriptions-plugin | ||
mike | ||
mkdocs-glightbox | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Percona XtraBackup Pro includes the [capabilities](pxb-pro.md#capabilities) that are typically requested by large enterprises. Percona XtraBackup Pro contains packages created and tested by Percona. These packages are supported only for Percona Customers with a subscription. | ||
|
||
[Become a Percona Customer](https://www.percona.com/about/contact){.md-button} |