Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions docs/about-xtrabackup.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Percona XtraBackup has the following benefits:

Percona XtraBackup makes hot backups for Percona Server for MySQL and MySQL-compatible servers. XtraBackup takes streaming, compressed, and incremental server backups, and supports encryption.

Percona’s enterprise-grade commercial [MySQL Support] contracts include support for Percona XtraBackup. We recommend support for critical production deployments.
Percona’s enterprise-grade commercial [MySQL Support :octicons-link-external-16:](http://www.percona.com/mysql-support/) contracts include support for Percona XtraBackup. We recommend support for critical production deployments.

## Supported storage engines

Expand All @@ -25,7 +25,3 @@ MyISAM, and MyRocks tables on MySQL {{vers}} servers as well as Percona Server f
{{vers}}.

Percona XtraBackup supports the MyRocks storage engine. Percona XtraBackup copies all MyRocks files each time it takes a backup. An incremental backup on the MyRocks storage engine does not determine if an earlier full or incremental backup contains the same files.

[MySQL Support]: http://www.percona.com/mysql-support/


4 changes: 1 addition & 3 deletions docs/accelerate-backup-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,8 @@ the `FLUSH TABLES WITH READ LOCK`. Note that Percona XtraBackup will use
[Backup locks] where available as a lightweight alternative to `FLUSH TABLES WITH READ
LOCK`.

Percona XtraBackup uses these locks automatically to copy non-InnoDB data to avoid blocking Data manipulation language (DML) queries that modify InnoDB tables.
Percona XtraBackup uses these locks automatically to copy non-InnoDB data to avoid blocking Data manipulation language (DML) queries that modify InnoDB tables. Find more information in [Backup locks :octicons-link-external-16:](https://docs.percona.com/percona-server/8.4/backup-locks.html)

!!! note

This option cannot be used together with the `--stream` option.

[Backup locks]: https://docs.percona.com/percona-server/innovation-release/backup-locks.html
10 changes: 5 additions & 5 deletions docs/apt-download-deb.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Install using downloaded DEB packages

Download `DEB` packages of the desired series for your architecture from the [Percona Software Downloads](https://www.percona.com/downloads). If needed, [Percona Software Download instructions](download-instructions.md) are available.
Download `DEB` packages of the desired series for your architecture from the [Percona Software Downloads :octicons-link-external-16:](https://www.percona.com/downloads). If needed, [Percona Software Download instructions](download-instructions.md) are available.

This method requires you to resolve all dependencies and install any missing packages. Always back up your data before making significant system changes.

Expand All @@ -9,13 +9,13 @@ The following example downloads Percona XtraBackup {{release}} release package f

1. Use `wget` to download the `DEB` package:

```bash
```shell
wget https://downloads.percona.com/downloads/Percona-XtraBackup-{{vers}}/Percona-XtraBackup-{{release}}/binary/debian/jammy/x86_64/percona-xtrabackup-84_{{release}}-1.jammy_amd64.deb
```

2. Install Percona XtraBackup by using `dpkg`:

```bash
```shell
sudo dpkg -i percona-xtrabackup-84_{{release}}-1.jammy_amd64.deb
```

Expand All @@ -32,7 +32,7 @@ The following example downloads Percona XtraBackup {{release}} release package f

If there are missing dependencies, `dpkg` shows error messages. Install any missing packages with the following command:

```bash
```shell
sudo apt-get install -f
```
Retry the Percona XtraBackup installation.
Expand All @@ -41,7 +41,7 @@ Retry the Percona XtraBackup installation.

After installation, verify it by checking the version:

```bash
```shell
xtrabackup --version
```

Expand Down
4 changes: 1 addition & 3 deletions docs/apt-pinning.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,4 @@ Pin: release o=Percona Development Team
Pin-Priority: 1001
```

For more information about the pinning, check the official [debian wiki].

[debian wiki]: http://wiki.debian.org/AptPreferences
For more information about the pinning, check the official [debian wiki :octicons-link-external-16:](http://wiki.debian.org/AptPreferences).
47 changes: 21 additions & 26 deletions docs/apt-repo.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
# Install with the Percona-release Tool on Debian-based Systems

--8<--- "pro-build-announcement.md"

Ready-to-use packages are available from the Percona XtraBackup software
repositories and the [download page].
repositories and the [Percona Software Downloads :octicons-link-external-16:](https://www.percona.com/downloads).

Specific information on the supported platforms, products, and versions is
described in [Percona Release Lifecycle Overview].

## Install Percona XtraBackup through percona-release

Install Percona XtraBackup, like many other Percona products, with the `percona-release` package configuration tool.
Install Percona XtraBackup, like many other Percona products, with the `percona-release` package configuration tool. Run the following commands as root or use the sudo command.
{.power-number}

1. Use the apt package manager to dowload `percona-release`:

```{.bash data-prompt="$"}
$ sudo apt update
```shell
sudo apt update
```

??? example "Expected output"
Expand All @@ -34,8 +32,8 @@ Install Percona XtraBackup, like many other Percona products, with the `percona-

2. Install the `curl` download utility if it's not installed:

```{.bash data-prompt="$"}
$ sudo apt install curl
```shell
sudo apt install curl
```
??? example "Expected output"

Expand All @@ -53,8 +51,8 @@ Install Percona XtraBackup, like many other Percona products, with the `percona-

3. Download the `percona-release` the repository package:

```{.bash data-prompt="$"}
$ curl -O https://repo.percona.com/apt/percona-release_latest.generic_all.deb
```shell
curl -O https://repo.percona.com/apt/percona-release_latest.generic_all.deb
```

??? example "Expected output"
Expand All @@ -67,7 +65,7 @@ Install Percona XtraBackup, like many other Percona products, with the `percona-

4. Install the downloaded package and its dependencies using `apt`:

```{.bash data-prompt="$"}
```shell
sudo apt install gnupg2 lsb-release ./percona-release_latest.generic_all.deb
```

Expand All @@ -92,8 +90,8 @@ Install Percona XtraBackup, like many other Percona products, with the `percona-

5. Refresh the local cache to update the package information:

```{.bash data-prompt="$"}
$ sudo apt update
```shell
sudo apt update
```

??? example "Expected output"
Expand All @@ -111,8 +109,8 @@ Install Percona XtraBackup, like many other Percona products, with the `percona-

6. Enable the specific percona-release product.

```{.bash data-prompt="$"}
$ sudo percona-release enable pxb-84-lts
```shell
sudo percona-release enable pxb-84-lts
```
??? example "Expected output"

Expand All @@ -134,8 +132,8 @@ Install Percona XtraBackup, like many other Percona products, with the `percona-

7. Install Percona XtraBackup.

```{.bash data-prompt="$"}
$ sudo apt install percona-xtrabackup-84
```shell
sudo apt install percona-xtrabackup-84
```

??? example "Expected output"
Expand All @@ -156,8 +154,8 @@ Install Percona XtraBackup, like many other Percona products, with the `percona-

8. Verify the installation.

```{.bash data-prompt="$"}
$ xtrabackup --version
```shell
xtrabackup --version
```

??? example "Expected output"
Expand All @@ -170,14 +168,14 @@ Install Percona XtraBackup, like many other Percona products, with the `percona-

=== "Install the `lz4` package"

```{.bash data-prompt="$"}
$ sudo apt install lz4
```shell
sudo apt install lz4
```

=== "Install the `zstd` package"

```{.bash data-prompt="$"}
$ sudo apt install zstd
```shell
sudo apt install zstd
```

!!! note
Expand All @@ -190,6 +188,3 @@ Install Percona XtraBackup, like many other Percona products, with the `percona-
To install Percona XtraBackup using downloaded deb packages, see [Install Percona XtraBackup {{vers}}](apt-download-deb.md).

To uninstall Percona XtraBackup, see [Uninstall Percona XtraBackup {{vers}}](apt-uninstall-xtrabackup.md)

[download page]: https://www.percona.com/downloads
[Percona Release Lifecycle Overview]: https://www.percona.com/services/policies/percona-software-platform-lifecycle#mysql
6 changes: 3 additions & 3 deletions docs/apt-uninstall-xtrabackup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Uninstall Percona XtraBackup {{vers}} on Debian and Ubuntu

To completely uninstall Percona XtraBackup, remove all the installed packages:
To completely uninstall Percona XtraBackup, remove all the installed packages. Run the following command as root or use the sudo command.

```{.bash data-prompt="$"}
$ sudo apt remove percona-xtrabackup-{{pkg}}
```shell
sudo apt remove percona-xtrabackup-{{pkg}}
```
58 changes: 35 additions & 23 deletions docs/binaries-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,17 @@ Common Use Cases:

Basic Syntax:

```{.bash data-prompt="$"}
Run the following commands as root or use the sudo command.

```shell
# Create a full backup
$ xtrabackup --backup --target-dir=/backup/full
xtrabackup --backup --target-dir=/backup/full

# Create an incremental backup
$ xtrabackup --backup --target-dir=/backup/inc1 --incremental-basedir=/backup/full
xtrabackup --backup --target-dir=/backup/inc1 --incremental-basedir=/backup/full

# Prepare a backup for restore
$ xtrabackup --prepare --target-dir=/backup/full
xtrabackup --prepare --target-dir=/backup/full
```

Documentation: [xtrabackup Overview](xtrabackup-binary-overview.md)
Expand Down Expand Up @@ -82,12 +84,14 @@ Common Use Cases:

Basic Syntax:

```{.bash data-prompt="$"}
Run the following commands as root or use the sudo command.

```shell
# Upload backup to S3
$ xbcloud put s3://my-bucket/backup/ --storage=s3 --s3-bucket=my-bucket
xbcloud put s3://my-bucket/backup/ --storage=s3 --s3-bucket=my-bucket

# Download backup from S3
$ xbcloud get s3://my-bucket/backup/ --storage=s3 --s3-bucket=my-bucket
xbcloud get s3://my-bucket/backup/ --storage=s3 --s3-bucket=my-bucket
```

Documentation: [xbcloud Overview](xbcloud-binary-overview.md)
Expand Down Expand Up @@ -121,12 +125,14 @@ Common Use Cases:

Basic Syntax:

```{.bash data-prompt="$"}
Run the following commands as root or use the sudo command.

```shell
# Encrypt a backup file
$ xbcrypt --encrypt --encrypt-key-file=/path/to/keyfile --input=/backup/backup.xbstream
xbcrypt --encrypt --encrypt-key-file=/path/to/keyfile --input=/backup/backup.xbstream

# Decrypt a backup file
$ xbcrypt --decrypt --encrypt-key-file=/path/to/keyfile --input=/backup/backup.xbstream.encrypted
xbcrypt --decrypt --encrypt-key-file=/path/to/keyfile --input=/backup/backup.xbstream.encrypted
```

Documentation: [xbcrypt Overview](xbcrypt-binary-overview.md)
Expand Down Expand Up @@ -159,15 +165,17 @@ Common Use Cases:

Basic Syntax:

```{.bash data-prompt="$"}
Run the following commands as root or use the sudo command.

```shell
# Extract a streamed backup
$ xbstream -x -C /restore/directory < backup.xbstream
xbstream -x -C /restore/directory < backup.xbstream

# Create a streamed backup
$ xtrabackup --backup --stream=xbstream | xbstream -c -C /backup/directory
xtrabackup --backup --stream=xbstream | xbstream -c -C /backup/directory
```

Documentation: [xbstream Overview](https://docs.percona.com/percona-xtrabackup/8.4/xbstream.html)
Documentation: [xbstream Overview :octicons-link-external-16:](https://docs.percona.com/percona-xtrabackup/8.4/xbstream.html)

Command Line Options: [xbstream Options](xbstream-options.md)

Expand Down Expand Up @@ -207,30 +215,34 @@ Command Line Options: [xbstream Options](xbstream-options.md)

### Complete backup and upload workflow

```{.bash data-prompt="$"}
Run the following commands as root or use the sudo command.

```shell
# Create encrypted backup
$ xtrabackup --backup --target-dir=/tmp/backup --encrypt=AES256 --encrypt-key-file=/etc/mysql/backup.key
xtrabackup --backup --target-dir=/tmp/backup --encrypt=AES256 --encrypt-key-file=/etc/mysql/backup.key

# Stream and compress backup
$ xtrabackup --backup --stream=xbstream --encrypt=AES256 --encrypt-key-file=/etc/mysql/backup.key | \
xtrabackup --backup --stream=xbstream --encrypt=AES256 --encrypt-key-file=/etc/mysql/backup.key | \
xbstream -c -C /tmp/backup

# Upload to cloud storage
$ xbcloud put s3://my-backup-bucket/$(date +%Y%m%d)/ --storage=s3 --s3-bucket=my-backup-bucket
xbcloud put s3://my-backup-bucket/$(date +%Y%m%d)/ --storage=s3 --s3-bucket=my-backup-bucket
```

### Restore from cloud storage

```{.bash data-prompt="$"}
Run the following commands as root or use the sudo command.

```shell
# Download backup from cloud
$ xbcloud get s3://my-backup-bucket/20241201/ --storage=s3 --s3-bucket=my-backup-bucket
xbcloud get s3://my-backup-bucket/20241201/ --storage=s3 --s3-bucket=my-backup-bucket

# Decrypt backup
$ xbcrypt --decrypt --encrypt-key-file=/etc/mysql/backup.key --input=/tmp/backup/backup.xbstream.encrypted
xbcrypt --decrypt --encrypt-key-file=/etc/mysql/backup.key --input=/tmp/backup/backup.xbstream.encrypted

# Prepare and restore
$ xtrabackup --prepare --target-dir=/tmp/backup
$ xtrabackup --copy-back --target-dir=/tmp/backup
xtrabackup --prepare --target-dir=/tmp/backup
xtrabackup --copy-back --target-dir=/tmp/backup
```

## Next steps
Expand Down
8 changes: 3 additions & 5 deletions docs/binary-tarball-names.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

For recent versions of Percona XtraBackup, the tar files are organized by the `glibc2` version. You can find this version on your operating system with the following command:

```{.bash data-prompt="$"}
$ ldd --version
```shell
ldd --version
```

??? example "Expected output"
Expand Down Expand Up @@ -32,7 +32,7 @@ The following lists the platform and the associated full binary file name used b
| Red Hat Enterprise 8 | Percona-XtraBackup-{{release}}-Linux.x86_64.glibc2.28.tar.gz | glibc2.28 |


Download the binary tarballs from [Percona Software Downloads].
Download the binary tarballs from [Percona Software Downloads :octicons-link-external-16:](https://www.percona.com/downloads).

The following table lists the tarball types in `Linux - Generic`. Select the *Percona XtraBackup* {{vers}} version, the software or the operating system, and the tarball type for your installation. Binary tarballs support all distributions.

Expand All @@ -58,5 +58,3 @@ After you have downloaded the binary tarballs, extract the tarball in the file l
Select a different software, such as Ubuntu 20.04 (Focal Fossa), for a
tarball for that operating system. You can download the packages together or separately.

[Percona Software Downloads]: https://www.percona.com/downloads

13 changes: 5 additions & 8 deletions docs/binary-tarball.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# Install from a binary tarball

--8<--- "pro-build-announcement.md"

Binary tarballs are compressed `tar` archives that contain precompiled executable files, libraries, and other dependencies. You can extract the binary tarballs to any path.

Download the binary tarballs from the `Linux - Generic` section on [Percona Product Downloads].
Download the binary tarballs from the `Linux - Generic` section on [Percona Software Downloads :octicons-link-external-16:](https://www.percona.com/downloads).

The following example downloads the tarball. Run the following command as root or use the sudo command.

The following example downloads the tarball:

```{.bash data-prompt="$"}
$ wget https://downloads.percona.com/downloads/Percona-XtraBackup-8.4/Percona-XtraBackup-8.4.0-1/binary/tarball/percona-xtrabackup-8.4.0-1-Linux-x86_64.glibc2.28.tar.gz
```shell
wget https://downloads.percona.com/downloads/Percona-XtraBackup-8.4/Percona-XtraBackup-8.4.0-1/binary/tarball/percona-xtrabackup-8.4.0-1-Linux-x86_64.glibc2.28.tar.gz
```

The output displays the following information:
Expand All @@ -30,5 +29,3 @@ The output displays the following information:
2024-10-09 04:46:10 (4.48 MB/s) - ‘percona-xtrabackup-8.4.0-1-Linux-x86_64.glibc2.28.tar.gz’ saved
[439358509/439358509]
```

[Percona Product Downloads]: https://www.percona.com/downloads/
Loading
Loading