From e9e122543608e62227dea4f32e4748d7966a237f Mon Sep 17 00:00:00 2001 From: Patrick Birch Date: Fri, 6 Oct 2023 06:56:48 -0500 Subject: [PATCH] PXB-3161 Add topic index (8.0) deleted: docs/binaries-overiew.md modified: docs/prepare-compressed-backup.md new file: docs/topic-index.md renamed: docs/varify-backup.md -> docs/verify-backup.md modified: mkdocs-base.yml --- docs/binaries-overiew.md | 13 --- docs/prepare-compressed-backup.md | 2 +- docs/topic-index.md | 114 ++++++++++++++++++++ docs/{varify-backup.md => verify-backup.md} | 0 mkdocs-base.yml | 4 +- 5 files changed, 118 insertions(+), 15 deletions(-) delete mode 100644 docs/binaries-overiew.md create mode 100644 docs/topic-index.md rename docs/{varify-backup.md => verify-backup.md} (100%) diff --git a/docs/binaries-overiew.md b/docs/binaries-overiew.md deleted file mode 100644 index 9e240c599..000000000 --- a/docs/binaries-overiew.md +++ /dev/null @@ -1,13 +0,0 @@ -# Percona XtraBackup binaries overview - -Percona XtraBackup is a set of the following binaries: - -* [xtrabackup](xtrabackup-binary-overview.md) - a compiled *C* binary that provides functionality to backup a whole *MySQL* database instance with *MyISAM*, *InnoDB*, and *XtraDB* tables. - -* [xbcrypt](xbcrypt-binary-overview.md) - a utility used for encrypting and decrypting backup files. - -* [xbstream](xbstream-binary-overview.md) - a utility that allows streaming and extracting files to / from the xbstream format. - -* [xbcloud](xbcloud-binary-overview.md) - a utility used for downloading and uploading full or part of *xbstream* archive from / to cloud. - -The recommended way to take the backup is by using the *xtrabackup* script. For more information on script options, see [xtrabackup](xtrabackup-binary-overview.md). diff --git a/docs/prepare-compressed-backup.md b/docs/prepare-compressed-backup.md index ea7bcf86c..0dffaa6eb 100644 --- a/docs/prepare-compressed-backup.md +++ b/docs/prepare-compressed-backup.md @@ -1,4 +1,4 @@ -# Prepare the backup +# Decompress and prepare a compressed backup Before you can prepare the backup you’ll need to uncompress all the files. *Percona XtraBackup* has implemented `--decompress` option diff --git a/docs/topic-index.md b/docs/topic-index.md new file mode 100644 index 000000000..ca8d01d9b --- /dev/null +++ b/docs/topic-index.md @@ -0,0 +1,114 @@ +# Topic index + +* [About Percona Xtrabackup](about-xtrabackup.md) +* [Accelerate the backup process](accelerate-backup-process.md) +* [Analyze table statistics](analyze-table-statistics.md) +* [Apt pinning the Percona XtraBackup 8.0 packages](apt-pinning.md) + + + +* [Binary tarball file names available](binary-tarball-names.md) + +* [Compile and install Percona XtraBackup 8.0 from source](compile-xtrabackup.md) +* [Configure xtrabackup](configure-xtrabackup.md) +* [Connection and privileges needed](privileges.md) +* [Copyright and licensing information](copyright-and-licensing-information.md) +* [Create a compressed backup](create-compressed-backup.md) +* [Create a full backup](create-full-backup.md) + +* [Create an incremental backup](create-incremental-backup.md) +* [Create an individual partitions backup](create-individual-partition-backup.md) +* [Create a partial backup](create-partial-backup.md) +* [Decompress and prepare a compressed backup](prepare-compressed-backup.md) +* [Dictionary cache](dictionary-cache.md) + +* [Encrypt backups](encrypt-backups.md) +* [Encrypted InnoDB tablespace backups](encrypted-innodb-tablespace-backups.md) +* [Error message: Found tables with row versions due to INSTANT ADD/DROP columns](error-message-instant.md) +* [Exponential backup](xbcloud-exbackoff.md) +* [FIFO data sink](xbcloud-binary-fifo-datasink.md) +* [Files in the DEB package built for Percona XtraBackup 8.0](apt-files.md) +* [Files in the RPM package built for Percona XtraBackup 8.0](yum-files.md) +* [FLUSH TABLES WITH READ LOCK option](flush-tables-with-read-lock.md) +* [Frequently asked questions](faq.md) + +* [Glossary](glossary.md) + +* [Home](index.md) +* [How Percona XtraBackup works](how-xtrabackup-works.md) +* [How to create a new (or repair a broken) GTID-based replica](create-gtid-replica.md) +* [How to set up a replica for replication in 6 simple steps with Percona XtraBackup](set-up-replication.md) +* [Improved log statements](log-enhancements.md) +* [Install Percona XtraBackup 8.0 from a binary tarball](binary-tarball.md) +* [Install Percona XtraBackup 8.0 overview](installation.md) +* [Install Percona XtraBackup 8.0 using downloaded DEB packages](apt-download-deb.md) +* [Install Percona XtraBackup 8.0 using downloaded RPM packages](yum-download-rpm.md) +* [Index of files created by Percona XtraBackup](xtrabackup-files.md) + +* [lock-ddl-per-table option improvements](lock-options.md) +* [LRU dump backup](lru-dump-backup.md) +* [Make backups in replication environments](make-backup-in-replication-env.md) + +* [Permissions needed](permissions.md) +* [Point-in-time recovery](point-in-time-recovery.md) + +* [Prepare a full backup](prepare-full-backup.md) +* [Prepare an incremental backup](prepare-incremental-backup.md) +* [Prepare an individual partitions backup](prepare-individual-partitions-backup.md) +* [Prepare a partial backup](prepare-partial-backup.md) + +* [Percona Toolkit version checking](toolkit-version-check.md) +* [Percona XtraBackup binaries overview](binaries-overview.md) +* [Quickstart Guide for Percona XtraBackup](quickstart-overview.md) +* [Release notes index](release-notes.md) +* [Restore a backup](restore-a-backup.md) +* [Restore a partial backup](restore-partial-backup.md) +* [Restore individual tables](restore-individual-tables.md) +* [Restore the partition from a backup](restore-individual-partitions.md) + + +* [Run Percona XtraBackup 8.0 in a Docker container](docker.md) +* [Server version and backup version comparison](server-backup-version-comparison.md) + +* [Smart memory estimation](smart-memory-estimation.md) +* [Store backup history on the server](store-backup-history.md) + +* [Take a streaming backup](take-streaming-backup.md) +* [Take an incremental backup using page tracking](page-tracking.md) +* [Throttling backups](throttling-backups.md) + +* [Trademark policy](trademark-policy.md) +* [The xtrabackup option reference](xtrabackup-option-reference.md) +* [The xtrabackup binary overview](xtrabackup-binary-overview.md) +* [The xbcloud binary overview](xbcloud-binary-overview.md) +* [Understand version numbers](xtrabackup-version-numbers.md) +* [Uninstall Percona XtraBackup 8.0 on Debian and Ubuntu](apt-uninstall-xtrabackup.md) +* [Uninstall Percona XtraBackup 8.0 on Red Hat Enterprise Linux and CentOS](yum-uninstall-xtrabackup.md) +* [Update curl utility](update-curl-utility.md) +* [Use an APT repository to install Percona XtraBackup 8.0](apt-repo.md) + +* [Use the xbcloud binary with Amazon S3](xbcloud-s3.md) +* [Use the xbcloud binary with Google Cloud Storage](xbcloud-gcs.md) +* [Use the xbcloud binary with an IAM instance profile](xbcloud-iam-profile.md) +* [Use the xbcloud binary with Microsoft Azure Cloud Storage](xbcloud-azure.md) +* [Use the xbcloud binary with MinIO](xbcloud-minio.md) +* [Use the xbcloud binary with Swift](xbcloud-swift.md) +* [Use a YUM repository to install Percona XtraBackup](yum-repo.md) +* [The xbcrypt binary overview](xbcrypt-binary-overview.md) +* [The xbstream binary overview](xbstream-binary-overview.md) +* [Verify backups with replication and pt-checksum](verify-backup.md) +* [Work with AppArmor](work-with-apparmor.md) +* [Work with binary logs](working-with-binary-logs.md) +* [Work with SELinux](work-with-selinux.md) + + + +* [xtrabackup exit codes](xtrabackup-exit-codes.md) + +* [xtrabackup implementation details](xtrabackup-implementation-details.md) + + + + + + diff --git a/docs/varify-backup.md b/docs/verify-backup.md similarity index 100% rename from docs/varify-backup.md rename to docs/verify-backup.md diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 4f937a4d3..65d698bd8 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -271,14 +271,16 @@ nav: - set-up-replication.md - create-gtid-replica.md - make-backup-in-replication-env.md - - varify-backup.md + - verify-backup.md - Troubleshoot: - error-message-instant.md - xtrabackup-exit-codes.md - Reference: + - topic-index.md - xtrabackup-files.md - faq.md - glossary.md + - toolkit-version-check.md - trademark-policy.md - copyright-and-licensing-information.md