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
2 changes: 1 addition & 1 deletion docs/binaries-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ xbstream -x -C /restore/directory < backup.xbstream
xtrabackup --backup --stream=xbstream | xbstream -c -C /backup/directory
```

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

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

Expand Down
14 changes: 7 additions & 7 deletions docs/quickstart-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ The benefits of using a Docker volume are the following:

* You can quickly backup and restore your data using the `docker cp` command or mount the volume to another container.

```{.bash data-prompt="$"}
$ docker volume create backupvol
```shell
docker volume create backupvol
```

??? example "Expected output"
Expand Down Expand Up @@ -42,7 +42,7 @@ In our example, the command has the following options:
|`--password` | Prompts the user to enter the password for the root user. For convenience you can add the password for the root user to this option, for example, `--password=secret`. Then the password will be passed automaticaly when running the command. Note that if you specify the password with `--password=secret`, the password is visible in `docker ps`, `docker ps -a` (docker history) and regular ps command. |
| `8.4` | Use this tag to specify a specific version. Avoid using the `latest` tag. <br> In our example, we use the `8.4` tag. In Docker, a tag is a label assigned to an image and is used to maintain different versions of an image.|

If you do not add a tag, Docker uses `latest` as the default tag and downloads the newest image from [percona/percona-xtrabackup on the Docker Hub](https://hub.docker.com/r/percona/percona-xtrabackup). This image can be in a different series or version from what you expect since the latest image changes over time. If you are using Percona XtraBackup version prior to 8.4, use tags to ensure that you use [compatible versions](server-backup-version-comparison.md) of Percona Server for MySQL and Percona XtraBackup.
If you do not add a tag, Docker uses `latest` as the default tag and downloads the newest image from [percona/percona-xtrabackup on the Docker Hub :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-xtrabackup). This image can be in a different series or version from what you expect since the latest image changes over time. If you are using Percona XtraBackup version prior to 8.4, use tags to ensure that you use [compatible versions](server-backup-version-comparison.md) of Percona Server for MySQL and Percona XtraBackup.

The CPU architecture or platform for Percona Server for MySQL and Percona XtraBackup should be the same. If you want to use a different platform, you can add the following command:

Expand All @@ -58,8 +58,8 @@ You can run the Docker ARM64 version of Percona XtraBackup. Use the `8.4-aarch64
We recommend using the `–-user root` option in the Docker command.
Run a Docker container example

```{.bash data-prompt="$"}
$ docker run --name pxb --volumes-from psmysql -v backupvol:/backup_84 -it --user root percona/percona-xtrabackup:8.4 /bin/bash -c "xtrabackup --backup --datadir=/var/lib/mysql/ --target-dir=/backup_84 --user=root --password; xtrabackup --prepare --target-dir=/backup_84"
```shell
docker run --name pxb --volumes-from psmysql -v backupvol:/backup_84 -it --user root percona/percona-xtrabackup:8.4 /bin/bash -c "xtrabackup --backup --datadir=/var/lib/mysql/ --target-dir=/backup_84 --user=root --password; xtrabackup --prepare --target-dir=/backup_84"
```

You are prompted to enter the password. In our example, the password is `secret`.
Expand Down Expand Up @@ -99,8 +99,8 @@ You can check the Xtrabackup logs with the `docker container logs <container-nam

For example:

```{.bash data-prompt="$"}
$ docker container logs pxb
```shell
docker container logs pxb
```

## Next steps
Expand Down
32 changes: 16 additions & 16 deletions docs/quickstart-exit.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ The steps are as follows:

1. To exit the MySQL command client shell in `psmysql2` container, we use `exit`. You can also use the `\q` or `quit` commands. The execution of the statement also closes the connection.

```{.bash data-prompt="mysql>"}
mysql> exit
```sql
exit
```

??? example "Expected output"
Expand All @@ -27,8 +27,8 @@ The steps are as follows:

* Remove `psmysql2`, `psmysql` and `pxb` Docker containers:

```{.bash data-prompt="$"}
$ docker container rm psmysql2 -f
```shell
docker container rm psmysql2 -f
```

??? example "Expected output"
Expand All @@ -37,8 +37,8 @@ The steps are as follows:
psmysql2
```

```{.bash data-prompt="$"}
$ docker container rm psmysql -f
```shell
docker container rm psmysql -f
```

??? example "Expected output"
Expand All @@ -47,8 +47,8 @@ The steps are as follows:
psmysql
```

```{.bash data-prompt="$"}
$ docker container rm pxb -f
```shell
docker container rm pxb -f
```

??? example "Expected output"
Expand All @@ -59,8 +59,8 @@ The steps are as follows:

* Remove `percona/percona-server:8.0.34` and `percona/percona-xtrabackup:8.0.34` Docker images

```{.bash data-prompt="$"}
$ docker image rmi percona/percona-server:8.0.34
```shell
docker image rmi percona/percona-server:8.0.34
```

??? example "Expected output"
Expand All @@ -69,8 +69,8 @@ The steps are as follows:
Untagged: percona/percona-server:8.0.34
```

```{.bash data-prompt="$"}
$ docker image rmi percona/percona-xtrabackup:8.0.34
```shell
docker image rmi percona/percona-xtrabackup:8.0.34
```

??? example "Expected output"
Expand All @@ -91,8 +91,8 @@ The steps are as follows:

Remove `backupvol` and `myvol2` Docker volumes:

```{.bash data-prompt="$"}
$ docker volume rm backupvol
```shell
docker volume rm backupvol
```

??? example "Expected output"
Expand All @@ -101,8 +101,8 @@ The steps are as follows:
backupvol
```

```{.bash data-prompt="$"}
$ docker volume rm myvol2
```shell
docker volume rm myvol2
```

??? example "Expected output"
Expand Down
10 changes: 5 additions & 5 deletions docs/quickstart-next-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,31 @@

After you take your first backup with Percona Xtrabackup, it's high time to expand your knowledge and skills in using Percona Xtrabackup.

Review the [Percona Xtrabackup documentation](https://docs.percona.com/percona-xtrabackup/8.0/) for more information.
Review the [Percona Xtrabackup documentation :octicons-link-external-16:](https://docs.percona.com/percona-xtrabackup/{{vers}}/) for more information.

## Learn more about other Percona products

### For superior and optimized performance

Percona Server for MySQL (PS) is a freely available, fully compatible, enhanced, and open source drop-in replacement for any MySQL database. It provides superior and optimized performance, greater scalability and availability, enhanced backups, increased visibility, and instrumentation. Percona Server for MySQL is trusted by thousands of enterprises to provide better performance and concurrency for their most demanding workloads.

Install [Percona Server for MySQL](https://docs.percona.com/percona-server/8.0/installation.html).
Install [Percona Server for MySQL :octicons-link-external-16:](https://docs.percona.com/percona-server/{{vers}}/installation.html).

### For high availability

Percona XtraDB Cluster (PXC) is a 100% open source, enterprise-grade, highly available clustering solution for MySQL multi-master setups based on Galera. PXC helps enterprises minimize unexpected downtime and data loss, reduce costs, and improve performance and scalability of your database environments supporting your critical business applications in the most demanding public, private, and hybrid cloud environments.

Install [Percona XtraDB Cluster](https://docs.percona.com/percona-xtradb-cluster/8.0/install-index.html).
Install [Percona XtraDB Cluster :octicons-link-external-16:](https://docs.percona.com/percona-xtradb-cluster/{{vers}}/install-index.html).

### For Monitoring and Management

Percona Monitoring and Management (PMM) monitors and provides actionable performance data for MySQL variants, including Percona Server for MySQL, Percona XtraDB Cluster, Oracle MySQL Community Edition, Oracle MySQL Enterprise Edition, and MariaDB. PMM captures metrics and data for the InnoDB, XtraDB, and MyRocks storage engines, and has specialized dashboards for specific engine details.

[Install PMM and connect your MySQL instances to it](https://docs.percona.com/percona-monitoring-and-management/3/quickstart/quickstart.html#connect-database).
[Install PMM and connect your MySQL instances to it :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/3/quickstart/quickstart.html#connect-database).

### Advanced command-line tools

Percona Toolkit is a collection of advanced command-line tools used by the Percona support staff to perform a variety of MySQL, MongoDB, and system tasks that are complex or difficult to perform manually. These tools are ideal alternatives to “one-off” scripts because they are professionally developed, formally tested, and documented. Each tool is self-contained, so installation is quick and easy and does not require installing libraries.

[Percona Toolkit documentation](https://docs.percona.com/percona-toolkit/)
[Percona Toolkit documentation :octicons-link-external-16:](https://docs.percona.com/percona-toolkit/)

10 changes: 5 additions & 5 deletions docs/quickstart-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,20 @@ This guide will help you get started quickly, but there's a lot more to learn ab

## Prerequisites

* [Install Docker](https://docs.docker.com/engine/install/) on your system.
* [Install Docker :octicons-link-external-16:](https://docs.docker.com/engine/install/) on your system.

To take a backup of Percona Server for MySQL, run Percona Server for MySQL in a Docker container and create a database, and a table.

* [Start Percona Server in a Docker container](https://docs.percona.com/percona-server/8.4/quickstart-docker.html)
* [Create a database and table in Percona Server](https://docs.percona.com/percona-server/8.4/quickstart-docker.html#create-a-database)
* [Start Percona Server in a Docker container :octicons-link-external-16:](https://docs.percona.com/percona-server/{{vers}}/quickstart-docker.html)
* [Create a database and table in Percona Server :octicons-link-external-16:](https://docs.percona.com/percona-server/{{vers}}/quickstart-docker.html#create-a-database)

### Limitations

Percona XtraBackup 8.4 does not support making backups of databases created in versions before the 8.4 series of MySQL, Percona Server for MySQL, or Percona XtraDB Cluster.
Percona XtraBackup {{vers}} does not support making backups of databases created in versions before the {{vers}} series of MySQL, Percona Server for MySQL, or Percona XtraDB Cluster.

### Support servers and storage engines

Percona XtraBackup 8.4 supports backing up data from various MySQL-compatible servers and storage engines.
Percona XtraBackup {{vers}} supports backing up data from various MySQL-compatible servers and storage engines.

Supported Servers:

Expand Down
44 changes: 22 additions & 22 deletions docs/quickstart-restore-back.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ The following steps describe how to restore your backup to another Percona Serve

1. Create another Docker volume

```{.bash data-prompt="$"}
$ docker volume create myvol2
```shell
docker volume create myvol2
```

??? example "Expected output"
Expand All @@ -33,8 +33,8 @@ The following steps describe how to restore your backup to another Percona Serve

* Run a Docker container example

```{.bash data-prompt="$"}
$ docker run -d -p 3307:3306 --name psmysql2 -e MYSQL_ROOT_PASSWORD=secret -v myvol2:/var/lib/mysql percona/percona-server:8.4
```shell
docker run -d -p 3307:3306 --name psmysql2 -e MYSQL_ROOT_PASSWORD=secret -v myvol2:/var/lib/mysql percona/percona-server:8.4
```

??? example "Expected output"
Expand All @@ -46,8 +46,8 @@ The following steps describe how to restore your backup to another Percona Serve

3. Stop `psmysql2` container

```{.bash data-prompt="$"}
$ docker stop psmysql2
```shell
docker stop psmysql2
```

??? example "Expected output"
Expand All @@ -60,16 +60,16 @@ The following steps describe how to restore your backup to another Percona Serve

The `--rm` option automatically removes the temporary container created from percona/percona-xtrabackup:8.0.34 image after the container exits.

```{.bash data-prompt="$"}
$ docker run --volumes-from psmysql2 -v backupvol:/backup_84 -it --rm --user root percona/percona-xtrabackup:8.4 /bin/bash -c "rm -rf /var/lib/mysql/*"
```shell
docker run --volumes-from psmysql2 -v backupvol:/backup_84 -it --rm --user root percona/percona-xtrabackup:8.4 /bin/bash -c "rm -rf /var/lib/mysql/*"
```

If the command executes successfully, the expected output is empty.

5. Restore backup of `psmysql` from `backupvol` to a new `psmysql2` instance.

```{.bash data-prompt="$"}
$ docker run --platform linux/amd64 --volumes-from psmysql2 -v backupvol:/backup_84 -it --rm --user root percona/percona-xtrabackup:8.4 /bin/bash -c "xtrabackup --copy-back --datadir=/var/lib/mysql/ --target-dir=/backup_84"
```shell
docker run --platform linux/amd64 --volumes-from psmysql2 -v backupvol:/backup_84 -it --rm --user root percona/percona-xtrabackup:8.4 /bin/bash -c "xtrabackup --copy-back --datadir=/var/lib/mysql/ --target-dir=/backup_84"
```

??? example "Expected output"
Expand Down Expand Up @@ -98,16 +98,16 @@ This section describes the backup validation steps assuming that you backed up `

To avoid permission issues when running `psmysql2` container, you need to change the owner because the files were restored by `root` user and `psmysql2` will use `mysql` user.

```{.bash data-prompt="$"}
$ docker run --volumes-from psmysql2 -v backupvol:/backup_84 -it --rm --user root percona/percona-xtrabackup:8.4 /bin/bash -c "chown -R mysql:mysql /var/lib/mysql/"
```shell
docker run --volumes-from psmysql2 -v backupvol:/backup_84 -it --rm --user root percona/percona-xtrabackup:8.4 /bin/bash -c "chown -R mysql:mysql /var/lib/mysql/"
```

If the command executes successfully, the expected output is empty.

2. Start the `psmysql2` container

```{.bash data-prompt="$"}
$ docker start psmysql2
```shell
docker start psmysql2
```

??? example "Expected output"
Expand All @@ -130,8 +130,8 @@ This section describes the backup validation steps assuming that you backed up `

* Connect to the database instance example

```{.bash data-prompt="$"}
$ docker exec -it psmysql2 mysql -uroot -p
```shell
docker exec -it psmysql2 mysql -uroot -p
```

You are prompted to enter the password, which is `secret`.
Expand Down Expand Up @@ -161,8 +161,8 @@ This section describes the backup validation steps assuming that you backed up `

4. Check the list of databases to make sure, the backed up, `mydb` database is in the list.

```{.bash data-prompt="mysql>"}
mysql> show databases;
```sql
show databases;
```

??? example "Expected output"
Expand Down Expand Up @@ -191,8 +191,8 @@ This section describes the backup validation steps assuming that you backed up `

5. Use the `mydb` database.

```{.bash data-prompt="mysql>"}
mysql> use mydb;
```sql
use mydb;
```

??? example "Expected output"
Expand All @@ -203,8 +203,8 @@ This section describes the backup validation steps assuming that you backed up `

6. Check that your table contains data

```{.bash data-prompt="mysql>"}
mysql> SELECT * FROM employees;
```sql
SELECT * FROM employees;
```

??? example "Expected output"
Expand Down
Loading
Loading