diff --git a/docs/.linkspector.yml b/docs/.linkspector.yml index e2f78ad7..5e923221 100644 --- a/docs/.linkspector.yml +++ b/docs/.linkspector.yml @@ -11,7 +11,6 @@ ignorePatterns: - pattern: "#mysql_alerts$" - pattern: "#postgresql_alerts$" - pattern: "#proxysql_alerts$" - - pattern: "^https://www\\.zmanda\\.com/zrm-community/?$" replacementPatterns: - pattern: "\\{\\{vers\\}\\}" diff --git a/docs/accelerate-backup-process.md b/docs/accelerate-backup-process.md index 8a92585d..e261cd87 100644 --- a/docs/accelerate-backup-process.md +++ b/docs/accelerate-backup-process.md @@ -34,7 +34,7 @@ xtrabackup --backup --parallel=4 --target-dir=/path/to/backup By using the xbstream in streaming backups, you can additionally speed up the compression process with the `--compress-threads` option. This option -specifies the number of threads created by xtrabackup for for parallel data +specifies the number of threads created by xtrabackup for parallel data compression. The default value for this option is 1. To use this feature, simply add the option to a local backup, for example: @@ -57,7 +57,7 @@ TABLES WITH READ LOCK` and once during to minimize the time the read lock is being held. During the second `rsync` call, it will only synchronize the changes to non-transactional data (if any) since the first call performed before 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 +[backup locks :octicons-link-external-16:](https://docs.percona.com/percona-server/8.4/backup-locks.html) 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. Find more information in [Backup locks :octicons-link-external-16:](https://docs.percona.com/percona-server/8.4/backup-locks.html) diff --git a/docs/apt-repo.md b/docs/apt-repo.md index 6796b034..22e7f9c0 100644 --- a/docs/apt-repo.md +++ b/docs/apt-repo.md @@ -4,14 +4,14 @@ Ready-to-use packages are available from the Percona XtraBackup software 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]. +described in [Percona Release Lifecycle Overview :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-support-lifecycle). ## Install Percona XtraBackup through percona-release 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`: +1. Use the apt package manager to download `percona-release`: ```shell sudo apt update diff --git a/docs/compile-xtrabackup.md b/docs/compile-xtrabackup.md index 72a2a004..45c13634 100644 --- a/docs/compile-xtrabackup.md +++ b/docs/compile-xtrabackup.md @@ -53,7 +53,7 @@ in your distribution as a separate package `cmake3`. For more information, see [ Percona Xtrabackup requires GCC version 5.3 or higher. If the version of GCC installed on your system is lower then you may need to - install and enable [the Developer Toolset] on + install and enable [the Developer Toolset :octicons-link-external-16:](https://developers.redhat.com/products/developertoolset/overview) on `RPM`-based distributions to make sure that you use the latest GCC compiler and development tools. Then, install `cmake` and other dependencies: @@ -193,10 +193,10 @@ Update your PATH environment variable if you would like to use the command on the command line directly. ```shell -$# Setting $PATH on the command line +# Setting $PATH on the command line PATH=$PATH:/usr/local/xtrabackup/bin/xtrabackup -$# Run xtrabackup directly +# Run xtrabackup directly xtrabackup ``` diff --git a/docs/create-incremental-backup.md b/docs/create-incremental-backup.md index ba3f3a91..cfd77650 100644 --- a/docs/create-incremental-backup.md +++ b/docs/create-incremental-backup.md @@ -31,7 +31,7 @@ xtrabackup --backup --target-dir=/data/backups/base ``` If you look at the `xtrabackup_checkpoints` file, you should see similar -content depending on your LSN nuber: +content depending on your LSN number: ??? example "Expected output" diff --git a/docs/docker.md b/docs/docker.md index ad1e7158..c6510507 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -44,7 +44,7 @@ To set up a database server on a host machine or in Docker container, follow the documentation of the supported product that you intend to use with Percona XtraBackup. -!!! admontion "See also" +!!! admonition "See also" [Docker volumes as container persistent data storage :octicons-link-external-16:](https://docs.docker.com/storage/volumes/) diff --git a/docs/encrypt-backups.md b/docs/encrypt-backups.md index 074c23fa..c5957faa 100644 --- a/docs/encrypt-backups.md +++ b/docs/encrypt-backups.md @@ -29,7 +29,7 @@ xtrabackup --backup --encrypt=AES256 --encrypt-key="{randomly-generated-alphanum ### encrypt-key-file option The recommended method uses the command line: `echo -n “{randomly-generated-alphanumeric-string}” > /data/backups/keyfile` to create the file. -Remember that using the-- encrypt-key-file option, your text editor can automatically insert a CRLF (end of line) character in the `KEYFILE`. This inserted character invalidates the key because the size is wrong. +Remember that when you use the `--encrypt-key-file` option, your text editor can automatically insert a CRLF (end of line) character in the `KEYFILE`. This inserted character invalidates the key because the size is wrong. An example of using the `--encrypt-key-file` option: diff --git a/docs/faq.md b/docs/faq.md index 6ef92ab2..b528f714 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -10,13 +10,11 @@ created in versions prior to {{vers}} of MySQL, Percona Server for MySQL or Percona XtraDB Cluster. -## Are you aware of any web-based backup management tools (commercial or not) built around Percona XtraBackup*? +## Are you aware of any web-based backup management tools (commercial or not) built around Percona XtraBackup? -[ZRM Community :octicons-link-external-16:](https://www.zmanda.com/zrm-community/) is a community tool that uses Percona XtraBackup for Non-Blocking Backups: +[Percona Monitoring and Management (PMM) :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/3/backup/index.html) includes backup management for MySQL. PMM uses Percona XtraBackup to create on-demand and scheduled physical backups and to restore them from the PMM web interface. -“ZRM provides support for non-blocking backups of MySQL using Percona -XtraBackup. ZRM with \Percona XtraBackup provides resource utilization -management by providing throttling based on the number of IO operations per second. Percona XtraBackup based backups also allow for table level recovery even though the backup was done at the database level (needs the recovery database server to be Percona Server for MySQL with XtraDB).”\* +For the required XtraBackup version and setup, see [MySQL backup prerequisites :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/3/backup/mysql-backup/mysql_prerequisites.html). ## xtrabackup binary fails with a floating point exception diff --git a/docs/glossary.md b/docs/glossary.md index 653522a5..6c524003 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -22,7 +22,7 @@ A finalized version of the product which is made available to the general public ## .ibd -On a multiple tablespace setup ([innodb\_file\_per\_table] enabled), MySQL will store each newly created table on a file with a `.ibd` extension. +On a multiple tablespace setup ([`innodb_file_per_table`](#innodb_file_per_table) enabled), MySQL will store each newly created table on a file with a `.ibd` extension. ## .MRG @@ -104,39 +104,49 @@ engine for MySQL {{vers}}. The size in bytes of the memory buffer to cache data and indexes of InnoDB’s tables. This aims to reduce disk access to provide better performance. -> \[mysqld\]
-> innodb\_buffer\_pool\_size=8MB +```ini +[mysqld] +innodb_buffer_pool_size=8MB +``` ## innodb\_data\_home\_dir The directory (relative to `datadir`) where the database server stores the files in a shared tablespace setup. This option does not affect the location of `innodb\_file\_per\_table`. For example: -> \[mysqld\]
-> innodb\_data\_home\_dir = ./ +```ini +[mysqld] +innodb_data_home_dir = ./ +``` ## innodb\_data\_file\_path Specifies the names, sizes and location of shared tablespace files: -> \[mysqld\]
-> innodb\_data\_file\_path=ibdata1:50M;ibdata2:50M:autoextend +```ini +[mysqld] +innodb_data_file_path=ibdata1:50M;ibdata2:50M:autoextend +``` ## innodb\_file\_per\_table By default, InnoDB creates tables and indexes in a [file-per-tablespace :octicons-link-external-16:](https://dev.mysql.com/doc/refman/{{vers}}/en/innodb-file-per-table-tablespaces.html). If the `innodb_file_per_table` variable is disabled, you can enable the variable in your configuration file: -> \[mysqld\]
-> innodb\_file\_per\_table
-> or
-> start the server with `--innodb_file_per_table`. +```ini +[mysqld] +innodb_file_per_table +``` + +Alternatively, start the server with `--innodb_file_per_table`. ## innodb\_log\_group\_home\_dir Specifies the location of the InnoDB log files: -> \[mysqld\]
-> innodb\_log\_group\_home=/var/lib/mysql +```ini +[mysqld] +innodb_log_group_home=/var/lib/mysql +``` ## logical backup diff --git a/docs/index.md b/docs/index.md index 465f1634..2f2da616 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,7 +12,7 @@ Percona XtraBackup is designed to make backups seamless without disrupting the p ## Percona XtraBackup features -Taking your backup with Percona XtraBackup is easy. Follow our documentation guides, and you’ll be set up in quickly. +Taking your backup with Percona XtraBackup is easy. Follow our documentation guides, and you’ll be set up quickly.
diff --git a/docs/lru-dump-backup.md b/docs/lru-dump-backup.md index e0214fda..0e6fc71f 100644 --- a/docs/lru-dump-backup.md +++ b/docs/lru-dump-backup.md @@ -7,7 +7,7 @@ reducing the warm up time. It restores the buffer pool state from `ib_buffer_pool` and backs it up automatically. -![image](_static/lru_dump.png) +![Diagram: page IDs from the InnoDB buffer pool LRU list, ordered from most to least recently used, are written to the ib_lru_dump file](_static/lru_dump.png) If the buffer restore option is enabled in `my.cnf`, buffer pool will be in the warm state after backup is restored. diff --git a/docs/page-tracking.md b/docs/page-tracking.md index 385561c7..91a0d5fe 100644 --- a/docs/page-tracking.md +++ b/docs/page-tracking.md @@ -16,13 +16,13 @@ To start using the page tracking functionality, do the following: 1. Install the `mysqlbackup` component and enable it on the server: - ```shell + ```sql INSTALL COMPONENT "file://component_mysqlbackup"; ``` 2. Check whether the `mysqlbackup` component is installed successfully: - ```shell + ```sql SELECT COUNT(1) FROM mysql.component WHERE component_urn='file://component_mysqlbackup'; ``` @@ -75,7 +75,7 @@ See also [`--page-tracking-merge-gap`](xtrabackup-option-reference.md#page-track After the mysqlbackup component is loaded and active on the server, you can start page tracking manually with the following option: -```shell +```sql SELECT mysqlbackup_page_track_set(true); ``` @@ -84,7 +84,7 @@ SELECT mysqlbackup_page_track_set(true); Check the LSN value starting from which changed pages are tracked with the following option: -```shell +```sql SELECT mysqlbackup_page_track_get_start_lsn(); ``` @@ -92,7 +92,7 @@ SELECT mysqlbackup_page_track_get_start_lsn(); To stop page tracking, use the following command: -```shell +```sql SELECT mysqlbackup_page_track_set(false); ``` @@ -107,7 +107,7 @@ grow until you stop the page tracking explicitly. If you purge the page tracking data, you should create a full backup afterward. To purge the page tracking data, do the following steps: -```shell +```sql SELECT mysqlbackup_page_track_set(false); SELECT mysqlbackup_page_track_purge_up_to(9223372036854775807); /* Specify the LSN up to which you want to purge page tracking data. / @@ -120,12 +120,12 @@ SELECT mysqlbackup_page_track_set(true); If the index is built in place using an exclusive algorithm and then is added to a table after the last LSN checkpoint, you may generate a bad incremental backup using page tracking. For more details -see [PS-8032 :octicons-link-external-16:](https://jira.percona.com/browse/PS-8032). +see [PS-8032 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PS-8032). ## Uninstall the mysqlbackup component To uninstall the mysqlbackup component, use the following statement: -```shell +```sql UNINSTALL COMPONENT "file://component_mysqlbackup" ``` diff --git a/docs/quickstart-exit.md b/docs/quickstart-exit.md index 26fc0d72..0bb141c6 100644 --- a/docs/quickstart-exit.md +++ b/docs/quickstart-exit.md @@ -109,12 +109,11 @@ Remove the Docker images to free disk space. Skip this step to retain images for ## Step 4: Remove Docker volumes -Remove the volumes that stored database and backup data. - !!! warning "Permanent data loss" Removing volumes permanently deletes all stored data. Verify the data is no longer needed before proceeding. +Remove the volumes that stored database and backup data. {.power-number} 1. Remove the backup volume: diff --git a/docs/release-notes/8.4.0-1.md b/docs/release-notes/8.4.0-1.md index 31f75b38..dec1b402 100644 --- a/docs/release-notes/8.4.0-1.md +++ b/docs/release-notes/8.4.0-1.md @@ -24,13 +24,13 @@ Use the Percona XtraBackup Innovation series, the latest version is 8.3.0-1, to * The terms MASTER and SLAVE have been replaced with SOURCE and REPLICA to align with MySQL 8.4.0. Find the full list of removed (MASTER/SLAVE) terminology in the [MySQL Deprecation and Removal Notes](https://dev.mysql.com/doc/relnotes/mysql/8.4/en/news-8-4-0.html). -* Percona XtraBackup 8.4.0-1 removes support for the [Keyring file plugin]. Use the [Keyring file component] instead. +* Percona XtraBackup 8.4.0-1 removes support for the keyring file plugin. Use the [Keyring file component] instead. * The `--stats` mode of operation for the xtrabackup binary has been removed. ## Additional resources -Install [Percona XtraBackup 8.4.0-1](..//installation.md) +Install [Percona XtraBackup 8.4.0-1](../installation.md) The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup) @@ -38,7 +38,6 @@ Download product binaries, packages, and tarballs at [Percona Product Downloads] [Percona XtraBackup 8.0 series]: https://docs.percona.com/percona-xtrabackup/8.0/ [Percona Server for MySQL 8.0.x]: https://docs.percona.com/percona-server/8.0/ -[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md +[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md [keyring_vault]: https://docs.percona.com/percona-server/8.4/use-keyring-vault-component.html -[Keyring file component]: https://docs.percona.com/percona-server/8.4/use-keyring-file.html?h=#use-the-keyring-file-component -[Keyring file plugin]: https://docs.percona.com/percona-server/8.4/use-keyring-file.html?h=#use-the-keyring-file-plugin \ No newline at end of file +[Keyring file component]: https://docs.percona.com/percona-server/8.4/use-keyring-file.html \ No newline at end of file diff --git a/docs/release-notes/8.4.0-2.md b/docs/release-notes/8.4.0-2.md index 458d3ef5..62d33e98 100644 --- a/docs/release-notes/8.4.0-2.md +++ b/docs/release-notes/8.4.0-2.md @@ -68,7 +68,7 @@ The `--lock-ddl=REDUCED` option features are as follows: * The number of open file handles in your operating system should be configured to match the number of files in the server data directory. -* Taking a backup using [page tracking](..//page-tracking.md) is not supported with `--lock-ddl=REDUCED` option. +* Taking a backup using [page tracking](../page-tracking.md) is not supported with `--lock-ddl=REDUCED` option. ## Pro features @@ -83,10 +83,10 @@ for reporting this issue.) ## Additional resources -Install [Percona XtraBackup 8.4.0-2](..//installation.md) +Install [Percona XtraBackup 8.4.0-2](../installation.md) The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup) Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads) -[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md +[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md diff --git a/docs/release-notes/8.4.0-3.md b/docs/release-notes/8.4.0-3.md index b857e3cd..cd5028fa 100644 --- a/docs/release-notes/8.4.0-3.md +++ b/docs/release-notes/8.4.0-3.md @@ -25,10 +25,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t ## Additional resources -Install [Percona XtraBackup 8.4.0-3](..//installation.md) +Install [Percona XtraBackup 8.4.0-3](../installation.md) The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup) Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads) -[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md +[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md diff --git a/docs/release-notes/8.4.0-4.md b/docs/release-notes/8.4.0-4.md index 2eb73df3..9e4073d1 100644 --- a/docs/release-notes/8.4.0-4.md +++ b/docs/release-notes/8.4.0-4.md @@ -20,10 +20,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t ## Additional resources -Install [Percona XtraBackup 8.4.0-4](..//installation.md) +Install [Percona XtraBackup 8.4.0-4](../installation.md) The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup) Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads) -[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md +[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md diff --git a/docs/release-notes/8.4.0-5.md b/docs/release-notes/8.4.0-5.md index e5b74b9f..92f77955 100644 --- a/docs/release-notes/8.4.0-5.md +++ b/docs/release-notes/8.4.0-5.md @@ -27,10 +27,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t ## Additional resources -Install [Percona XtraBackup 8.4.0-5](..//installation.md) +Install [Percona XtraBackup 8.4.0-5](../installation.md) The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup) Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads) -[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md +[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md diff --git a/docs/release-notes/8.4.0-6.md b/docs/release-notes/8.4.0-6.md index 76922552..3a48313b 100644 --- a/docs/release-notes/8.4.0-6.md +++ b/docs/release-notes/8.4.0-6.md @@ -50,10 +50,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t ## Additional resources -Install [Percona XtraBackup 8.4.0-6](..//installation.md) +Install [Percona XtraBackup 8.4.0-6](../installation.md) The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup) Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads/) -[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md +[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md diff --git a/docs/release-notes/8.4.0-7.md b/docs/release-notes/8.4.0-7.md index 0e8f1357..5be33f28 100644 --- a/docs/release-notes/8.4.0-7.md +++ b/docs/release-notes/8.4.0-7.md @@ -24,10 +24,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t ## Additional resources -Install [Percona XtraBackup 8.4.0-7](..//installation.md) +Install [Percona XtraBackup 8.4.0-7](../installation.md) The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup) Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads/) -[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md +[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md diff --git a/docs/server-backup-version-comparison.md b/docs/server-backup-version-comparison.md index 2bc07617..85ce46b1 100644 --- a/docs/server-backup-version-comparison.md +++ b/docs/server-backup-version-comparison.md @@ -29,8 +29,8 @@ The parameter checks for the following scenarios: Explicitly adding the `--no-server-version-check` parameter, like the example, overrides the parameter and the backup proceeds. -```{.bash data-prompt="$"} -$ xtrabackup --backup --no-server-version-check --target-dir=$mysql/backup1 +```shell +xtrabackup --backup --no-server-version-check --target-dir=$mysql/backup1 ``` Overriding the `--no-server-version-check` parameter allows taking backups using a Percona XtraBackup version that is equal to a version of your source server up to the last release in the LTS series. This means if you use Percona XtraBackup {{vers}}.x, you can back up the source server from {{vers}}.x to 8.4.xx. diff --git a/docs/set-up-replication.md b/docs/set-up-replication.md index 7925efe4..71fbfea3 100644 --- a/docs/set-up-replication.md +++ b/docs/set-up-replication.md @@ -293,8 +293,8 @@ rsync -avprP -e ssh /path/to/backupdir NewReplica:/path/to/mysql/datadir For example, to set up a new user, `user2`, you add another grant on the Source: -```{.bash data-prompt=">"} -> GRANT REPLICATION REPLICA ON *.* TO 'user2'@'$newreplicaip' +```sql +GRANT REPLICATION REPLICA ON *.* TO 'user2'@'$newreplicaip' IDENTIFIED BY '$replicapass'; ``` @@ -329,8 +329,8 @@ CHANGE REPLICATION SOURCE TO Start the replica: -```{.bash data-prompt=">"} -> START REPLICA; +```sql +START REPLICA; ``` If both IO and SQL threads are running when you check the `NewReplica`, diff --git a/docs/toolkit-version-check.md b/docs/toolkit-version-check.md index 0ce2fdd9..e785f795 100644 --- a/docs/toolkit-version-check.md +++ b/docs/toolkit-version-check.md @@ -73,7 +73,7 @@ Although the *version checking* feature does not collect any personal informatio you might prefer to disable this feature, either one time or permanently. To disable it one time, use `--no-version-check` option when invoking the tool from a Percona product which supports it. Here is a simple example which shows -running [pt-diskstats :octicons-link-external-16:](https://www.percona.com/doc/percona-toolkit/LATEST/pt-diskstats.html) tool +running [pt-diskstats :octicons-link-external-16:](https://docs.percona.com/percona-toolkit/pt-diskstats.html) tool from the *Percona Toolkit* with *version checking* turned off: ```text @@ -83,7 +83,7 @@ pt-diskstats --no-version-check Disabling *version checking* permanently can be done by placing `no-version-check` option into the configuration file of a Percona product (see correspondent documentation for exact file name and syntax). For example, -in case of *Percona Toolkit* [this can be done :octicons-link-external-16:](https://www.percona.com/doc/percona-toolkit/LATEST/configuration_files.html) +in case of *Percona Toolkit* [this can be done :octicons-link-external-16:](https://docs.percona.com/percona-toolkit/configuration_files.html) in a global configuration file `/etc/percona-toolkit/percona-toolkit.conf`: ```shell diff --git a/docs/verify-backup.md b/docs/verify-backup.md index 2bc60d7f..01b89b91 100644 --- a/docs/verify-backup.md +++ b/docs/verify-backup.md @@ -1,7 +1,7 @@ # Verify backups with replication and pt-checksum One way to verify if the backup is consistent is by setting up the -replication and running [pt-table-checksum :octicons-link-external-16:](http://www.percona.com/doc/percona-toolkit/pt-table-checksum.html). This can be used to verify any type of backups, but before setting up +replication and running [pt-table-checksum :octicons-link-external-16:](https://docs.percona.com/percona-toolkit/pt-table-checksum.html). This can be used to verify any type of backups, but before setting up replication, backup should be prepared and be able to run (this means that incremental backups should be merged to full backups, encrypted backups decrypted etc.). @@ -25,7 +25,7 @@ which produces different results on replicas that are inconsistent with the source. After you confirmed that replication has been set up successfully, you -can [install :octicons-link-external-16:](http://www.percona.com/doc/percona-toolkit/installation.html) +can [install :octicons-link-external-16:](https://docs.percona.com/percona-toolkit/installation.html) or download *pt-table-checksum*. This example shows downloading the latest version of *pt-table-checksum*: diff --git a/docs/xbcloud-azure.md b/docs/xbcloud-azure.md index 8c0942a9..6345311b 100644 --- a/docs/xbcloud-azure.md +++ b/docs/xbcloud-azure.md @@ -14,7 +14,7 @@ The following are the options, environment variables, and descriptions for uploa | --azure-endpoint=name | AZURE_ENDPOINT | The endpoint allows clients to securely access data | | --azure-tier-class=name | AZURE_STORAGE_CLASS | Cloud tier can decrease the local storage required while maintaining the performance. When enabled, this feature has the following categories:

Hot - Frequently accessed or modified data

Cool - Infrequently accessed or modified data

Archive - Rarely accessed or modified data | -Test your Azure applications with the [Azurite open-source emulator :octicons-link-external-16:](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=visual-studio). For testing purposes, the xbcloud binary adds the `--azure-development-storage` option that uses the default `access_key` and `storage account` of azurite and `testcontainer` for the container. You can overwrite these options, if needed. +Test your Azure applications with the [Azurite open-source emulator :octicons-link-external-16:](https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite). For testing purposes, the xbcloud binary adds the `--azure-development-storage` option that uses the default `access_key` and `storage account` of azurite and `testcontainer` for the container. You can overwrite these options, if needed. ## Usage diff --git a/docs/xbcloud-binary-fifo-datasink.md b/docs/xbcloud-binary-fifo-datasink.md index 484a21f5..09064538 100644 --- a/docs/xbcloud-binary-fifo-datasink.md +++ b/docs/xbcloud-binary-fifo-datasink.md @@ -39,7 +39,7 @@ When you stream backups to Amazon S3 compatible storage using LAN with a streami XtraBackup spawns multiple copy threads and each copy thread reads a data chunk from a specific file. Then multiple FIFO files are created to store the data from XtraBackup. Each XtraBackup copy thread writes the data chunks to a specific FIFO file. Xbcloud reads from the FIFO streams and uploads data to an object storage using an async request. The xbcloud event handler executes the callback depending on the response from the object storage (success or failure). -![image](_static/fifo-datasink.png) +![Diagram: parallel XtraBackup copy threads write data chunks to FIFO files; xbcloud read threads and event handlers upload them to object storage with asynchronous PUT operations](_static/fifo-datasink.png) ## Performance improvement diff --git a/docs/xbcloud-exbackoff.md b/docs/xbcloud-exbackoff.md index 294cfd56..b8f92fe2 100644 --- a/docs/xbcloud-exbackoff.md +++ b/docs/xbcloud-exbackoff.md @@ -78,7 +78,7 @@ Each cloud provider may return a different CURL error or an HTTP error, depending on the issue. Add new errors by setting the following variables `--curl-retriable-errors` or `--http-retriable-errors` on the command line or in `my.cnf` or in a custom configuration file under -the [xbcloud] section. You can add multiple errors using a comma-separated list of codes. +the `[xbcloud]` section. You can add multiple errors using a comma-separated list of codes. The error handling is enhanced when using the `--verbose` output. This output specifies which error caused xbcloud to fail and what parameter a diff --git a/docs/xbcloud-iam-profile.md b/docs/xbcloud-iam-profile.md index a5772211..a7dae09c 100644 --- a/docs/xbcloud-iam-profile.md +++ b/docs/xbcloud-iam-profile.md @@ -16,7 +16,7 @@ An IAM instance profile does not need the `--s3-secret-key` nor the `--s3-access An example of the command: ```text -$ xtrabackup ... | xbcloud put --storage=s3 --s3-bucket=bucket-name backup-name +xtrabackup ... | xbcloud put --storage=s3 --s3-bucket=bucket-name backup-name ``` The xbcloud binary outputs a connect message when successful. diff --git a/docs/xbcloud-options.md b/docs/xbcloud-options.md index 93ac03ce..99527b57 100644 --- a/docs/xbcloud-options.md +++ b/docs/xbcloud-options.md @@ -295,7 +295,7 @@ Turns on the cURL tracing. ## Swift authentication options -The Swift specification describes several [authentication options :octicons-link-external-16:](http://docs.openstack.org/developer/swift/overview_auth.html). The *xbcloud* tool can +The Swift specification describes several [authentication options :octicons-link-external-16:](https://docs.openstack.org/swift/latest/overview_auth.html). The *xbcloud* tool can authenticate against keystone with API version 2 and 3. ## swift-auth-version diff --git a/docs/xbcloud-s3.md b/docs/xbcloud-s3.md index d1c6d2fe..6663fe0b 100644 --- a/docs/xbcloud-s3.md +++ b/docs/xbcloud-s3.md @@ -8,7 +8,7 @@ xbcloud put --storage=s3 \ --s3-endpoint='s3.amazonaws.com' \ --s3-access-key='YOUR-ACCESSKEYID' \ --s3-secret-key='YOUR-SECRETACCESSKEY' \ ---s3-bucket='mysql_backups' +--s3-bucket='mysql_backups' \ --parallel=10 \ $(date -I)-full_backup ``` @@ -17,13 +17,13 @@ The following options are available when using Amazon S3: | Option | Details | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| –s3-access-key | Use to supply the AWS access key ID | -| –s3-secret-key | Use to supply the AWS secret access key | -| –s3-bucket | Use supply the AWS bucket name | -| –s3-region | Use to specify the AWS region. The default value is **us-east-1** | -| –s3-api-version = | Select the signing algorithm. The default value is AUTO. In this case, xbcloud will probe. | -| –s3-bucket-lookup = | Specify whether to use bucket.endpoint.com or endpoint.com/bucket*style requests. The default value is AUTO. In this case, xbcloud will probe. | | -| –s3-storage-class= | Specify the [S3 storage class :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html). The default storage class depends on the provider. The name options are the following:
  • STANDARD
  • STANDARD_IA
  • GLACIER
**NOTE** If you use the GLACIER storage class, the object must be [restored to S3 :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/userguide/restoring-objects.html) before restoring the backup. Also supports using custom S3 implementations such as MinIO or CephRadosGW. | +| `--s3-access-key` | Use to supply the AWS access key ID | +| `--s3-secret-key` | Use to supply the AWS secret access key | +| `--s3-bucket` | Use to supply the AWS bucket name | +| `--s3-region` | Use to specify the AWS region. The default value is **us-east-1** | +| `--s3-api-version=` | Select the signing algorithm. The default value is AUTO. In this case, xbcloud will probe. | +| `--s3-bucket-lookup=` | Specify whether to use bucket.endpoint.com or endpoint.com/bucket*style requests. The default value is AUTO. In this case, xbcloud will probe. | +| `--s3-storage-class=` | Specify the [S3 storage class :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html). The default storage class depends on the provider. The name options are the following:
  • STANDARD
  • STANDARD_IA
  • GLACIER
**NOTE** If you use the GLACIER storage class, the object must be [restored to S3 :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/userguide/restoring-objects.html) before restoring the backup. Also supports using custom S3 implementations such as MinIO or CephRadosGW. | ## Permissions setup diff --git a/docs/xbcloud-swift.md b/docs/xbcloud-swift.md index 810fc83a..ceb20c5a 100644 --- a/docs/xbcloud-swift.md +++ b/docs/xbcloud-swift.md @@ -5,7 +5,7 @@ The following example shows how to make a full backup and upload it to Swift. ```shell -$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \ +xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \ xbcloud put --storage=swift \ --swift-container=test \ --swift-user=test:tester \ @@ -119,7 +119,7 @@ Do not verify server's certificate ### Swift authentication options -The Swift specification describes several [authentication options :octicons-link-external-16:](http://docs.openstack.org/developer/swift/overview_auth.html). The *xbcloud* tool can +The Swift specification describes several [authentication options :octicons-link-external-16:](https://docs.openstack.org/swift/latest/overview_auth.html). The *xbcloud* tool can authenticate against keystone with API version 2 and 3. ### --swift-auth-version() diff --git a/docs/xbcrypt-options.md b/docs/xbcrypt-options.md index 2bb33fb5..41147818 100644 --- a/docs/xbcrypt-options.md +++ b/docs/xbcrypt-options.md @@ -3,7 +3,7 @@ Usage: ```shell -xbcrypt[OPTIONS] +xbcrypt [OPTIONS] ``` The `xbcrypt` binary has the following command line options: diff --git a/docs/xtrabackup-option-reference.md b/docs/xtrabackup-option-reference.md index dc06d116..0c7e47ae 100644 --- a/docs/xtrabackup-option-reference.md +++ b/docs/xtrabackup-option-reference.md @@ -15,7 +15,7 @@ You invoke xtrabackup in one of the following modes: When you intend to run xtrabackup in any of these modes, use the following syntax: ```shell -xtrabackup [--defaults-file=#] --backup|--prepare|--copy-back| [OPTIONS] +xtrabackup [--defaults-file=#] --backup|--prepare|--copy-back [OPTIONS] ``` For example, the `--prepare` mode is applied as follows: @@ -105,10 +105,10 @@ If a privilege is not needed for the current operation but is missing and may be ??? example "Example output" - ```{.text .no-copy} - xtrabackup: Error: missing required privilege LOCK TABLES on *.* - xtrabackup: Warning: missing required privilege REPLICATION CLIENT on *.* - ``` + ```{.text .no-copy} + xtrabackup: Error: missing required privilege LOCK TABLES on *.* + xtrabackup: Warning: missing required privilege REPLICATION CLIENT on *.* + ``` ### check-tables @@ -390,11 +390,11 @@ The option lets you enable or disable the [Smart memory estimation](smart-memory An example of how to enable the Smart memory estimation feature: ```shell -$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/ +xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/ ``` ```shell -$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/ +xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/ ``` ### export @@ -571,7 +571,7 @@ This option is ignored for MySQL option compatibility. ### innodb-miscellaneous -Usage: `--innodb-miscellaneous +Usage: `--innodb-miscellaneous` xtrabackup boots up its embedded InnoDB with the same configuration as your current server using the InnoDB options read from that server's `my.cnf` file. You do not need to specify these options explicitly. These options behave the same in either InnoDB or XtraDB. @@ -699,7 +699,7 @@ Use this option with caution since the operation removes backup files. Usage: `--no-backup-locks` -Explicity disables the [`--backup-locks`](#backup-locks) option which is enabled by default. +Explicitly disables the [`--backup-locks`](#backup-locks) option which is enabled by default. ### no-defaults @@ -769,7 +769,7 @@ Usage: `--open-files-limit=#` The maximum number of file descriptors to reserve with [setrlimit :octicons-link-external-16:]( https://man7.org/linux/man-pages/man2/setrlimit.2.html)git. -### `--page-tracking-merge-gap` +### page-tracking-merge-gap Controls how Percona XtraBackup combines reads of changed pages during incremental backups with page tracking. @@ -1163,11 +1163,11 @@ This option works only if `--estimate-memory` option is enabled. If the `--estim An example of how to enable the Smart memory estimation feature: ```shell -$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/ +xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/ ``` ```shell -$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/ +xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/ ``` ### use-memory