Merge pull request #359 from percona/pxb-3443

PXB-3443 [DOCS] - release docs for PXB 8.0.35-32 PRO

Author: patrickbirch

docs/compile-xtrabackup.md

@@ -93,35 +93,46 @@ directory:
     $ cd build
     ```
 
-3. Run cmake or cmake3. In either case, the options you need to use are the
-same.
+3. If you use a regular build, run cmake or cmake3. In either case, the options you need to use are the same.
 
 !!! note
 
-    You can build *Percona XtraBackup* with man pages but this requires
-    `python-sphinx` package which isn’t available from that main repositories
-    for every distribution. If you installed the `python-sphinx` package you
-    need to remove the `-DWITH_MAN_PAGES=OFF` from previous command.
+    You can build Percona XtraBackup with man pages but this requires
+    `python-sphinx` package which isn’t available from the main repositories
+    for every distribution. If you installed the `python-sphinx` package, remove `-DWITH_MAN_PAGES=OFF` from this command.
 
 ```{.bash data-prompt="$"}
 $ cmake -DWITH_BOOST=PATH-TO-BOOST-LIBRARY -DDOWNLOAD_BOOST=ON \
 -DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF -B ..
 ```
 
-### Parameter Information
-
-| **Parameter** | **Description** |
+| Parameter | Description |
 |---------------|-----------------|
 | `-DWITH_BOOST` | For the `-DWITH_BOOST` parameter, specify the name of a directory to download the boost library to. This directory is created automatically in your current directory. |
+| `-DBUILD_CONFIG` |  This flag allows you to define a build configuration, such as "debug" or "release", which can be used to control which parts of the source code are compiled. |
 | `-DWITH_MAN_PAGES` | To build **Percona XtraBackup** man pages, use `ON` or remove this parameter from the command line (it is `ON` by default). To install the man pages, install the python3-sphinx package first. |
-| `-B` (--build)| **Percona XtraBackup** is configured to forbid generating the build    pipeline for make in the same directory where you store your sources. The `-B` parameter refers to the directory that contains the source code. In this example, we use the relative path to the parent directory (..). |
+| `-B` (--build) | **Percona XtraBackup** is configured to forbid generating the build    pipeline for make in the same directory where you store your sources. The `-B` parameter refers to the directory that contains the source code. In this example, we use the relative path to the parent directory (..). |
 
 !!! important
 
     CMake Error at CMakeLists.txt:367 (MESSAGE): Please do not build in-source. Out-of source builds are highly recommended: you can have multiple builds for the same source, and there is an easy way to do cleanup, simply remove the build directory (note that ‘make clean’ or ‘make distclean’ does `not` work)
 
     You `can` force in-source build by invoking cmake with `-DFORCE_INSOURCE_BUILD=1`.
 
+<!--     
+If you use [Pro builds](./pxb-pro.md), run the following command:
+
+```{.bash data-prompt="$"}
+$ cmake -DPROBUILD=1 -DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF ..
+```
+
+| Parameter | Description |
+|---------------|-----------------|
+| `-DPROBUILD=1` | This option enables a Pro build. |
+| `-DBUILD_CONFIG` | This option builds a release/optimized version of the xtrabackup binary. |
+| `-DWITH_MAN_PAGES` | To build Percona XtraBackup man pages, use `ON` or remove this parameter from the command line (it is `ON` by default). To install the man pages, install the python3-sphinx package first. |
+-->
+
 ## 4. Compile the source code
 
 To compile the source code in your `build` directory, use the `make` command.

docs/index.md

@@ -10,6 +10,12 @@ Percona XtraBackup is an open source hot backup utility for MySQL-based servers,
 Whether it is a 24x7 highly loaded server or a low-transaction-volume
 Percona XtraBackup is designed to make backups seamless without disrupting the performance of the server in a production environment. Percona XtraBackup (PXB) is a 100% open source backup solution with [commercial support](https://www.percona.com/mysql-support/) available for organizations who want to benefit from comprehensive, responsive, and cost-flexible database support for MySQL.
 
+## Percona XtraBackup Pro
+
+--8<--- "pro-build-announcement.md"
+
+For more information, see [Percona XtraBackup Pro](pxb-pro.md).
+
 ## Supported versions
 
 Percona XtraBackup {{release}} can take backups of MySQL-compatible databases in older server versions, if specific conditions are met, and the following later versions:

docs/install-pro.md

@@ -0,0 +1,49 @@
+# 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}
+
+## Install Amazon Linux 2023
+
+!!! note 
+    
+    Percona XtraBackup 8.0.35-32 Pro build is available for the following platforms:
+    
+    * Amazon Linux 2023 (AL2023) - We support both AMD64 and ARM64 versions of Amazon Linux 2023.
+    
+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. Install the Percona dnf repository by running the following command as the `root` user or with **sudo**: 
+
+    ```{.bash data-prompt="$"}
+    $ sudo dnf install \
+    https://repo.percona.com/dnf/percona-release-latest.\
+    noarch.rpm
+    ```
+
+3. Enable the repository: 
+
+    ```{.bash data-prompt="$"}
+    $ sudo percona-release enable pxb-80-pro --user_name=<Your PRO repository user name> --repo_token=<Your PRO repository token>
+    ```
+
+3. Install Percona XtraBackup:
+
+    ```{.bash data-prompt="$"}
+    $ sudo dnf install percona-xtrabackup-pro-80
+    ```
+
+4. To decompress backups made using `LZ4` or `ZSTD` compression algorithm, install the corresponding package:
+
+=== "Install the `lz4` package"
+
+    ```{.bash data-prompt="$"}
+    $ sudo dnf install lz4
+    ```
+
+=== "Install the `zstd` package"
+
+    ```{.bash data-prompt="$"}
+    $ sudo dnf install zstd
+    ```

docs/pro-files.md

@@ -0,0 +1,27 @@
+# Files in packages built for Percona XtraBackup Pro
+
+--8<--- "pro-build-announcement.md"
+
+## Files in the RPM package
+
+The files are either aarch64.rpm or x86_64.rpm. 
+
+| Package                                     | Contains                                                         |
+|---------------------------------------------|------------------------------------------------------------------|
+|percona-xtrabackup-pro-{{pkg}}-{{amzn}}.aarch64.rpm               | The latest Percona XtraBackup GA binaries and associated files.  |
+|percona-xtrabackup-pro-{{pkg}}-debuginfo-{{amzn}}.aarch64.rpm     | The debug symbols for binaries.                                  |
+|percona-xtrabackup-pro-{{pkg}}-debugsource-{{amzn}}.aarch64.rpm   | The debug source for binaries.                                   |
+|percona-xtrabackup-test-pro-{{pkg}}-{{amzn}}.aarch64.rpm          | The test suite for Percona XtraBackup.                           |
+|percona-xtrabackup-pro-{{pkg}}-{{amzn}}.x86_64.rpm               | The latest Percona XtraBackup GA binaries and associated files.  |
+|percona-xtrabackup-pro-{{pkg}}-debuginfo-{{amzn}}.x86_64.rpm      | The debug symbols for binaries.                                  |
+|percona-xtrabackup-pro-{{pkg}}-debugsource-{{amzn}}.x86_64.rpm    | The debug source for binaries.                                   |
+|percona-xtrabackup-test-pro-{{pkg}}-{{amzn}}.x86_64.rpm          | The test suite for Percona XtraBackup.                           |
+
+## Files in the DEB package
+
+| Package                                     | Contains                                                         |
+|---------------------------------------------|------------------------------------------------------------------|
+|percona-xtrabackup-pro-{{pkg}}               | The latest Percona XtraBackup GA binaries and associated files.  |
+|percona-xtrabackup-pro-dbg-{{pkg}}           | The debug symbols for binaries.                                  |
+|percona-xtrabackup-test-pro-{{pkg}}          | The test suite for Percona XtraBackup.                           |
+

docs/pxb-pro.md

@@ -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  | 
+| ----------------------------------- | ------------- | -------------|
+|  Available on [Amazon Linux 2023](install-pro.md#installamazonlinux2023) | 8.0.35-32 | Amazon Linux 2023 is a purpose-built Linux distribution optimized for AWS. It's designed for performance, security, and seamless integration with the broader AWS ecosystem. We support both AMD64 and ARM64 versions of Amazon Linux 2023. |
+
+## 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).

mkdocs-base.yml

@@ -124,7 +124,7 @@ plugins:
   with-pdf: # https://github.com/orzih/mkdocs-with-pdf
           output_path: '_pdf/PerconaXtrabackup-8.0.pdf'
           cover_title: 'Percona XtraBackup Documentation'
-          cover_subtitle: 8.0.35-32 (2025-01-09)
+          cover_subtitle: 8.0.35-32 (2025-02-28)
           author: 'Percona Technical Documentation Team'
           cover_logo: docs/_static/Percona_Logo_Color.png
           debug_html: false
@@ -145,9 +145,11 @@ extra:
 
 nav:
   - Home: index.md
+  - pxb-pro.md
   - get-help.md
   - Release notes: 
       - Release notes index: release-notes.md
+    #  - release-notes/8.0/8.0.35-32.0.upd.md
       - release-notes/8.0/8.0.35-32.0.md
       - release-notes/8.0/8.0.35-31.0.upd.md
       - release-notes/8.0/8.0.35-31.0.md
@@ -271,6 +273,9 @@ nav:
         - Download RPM packages: yum-download-rpm.md
         - work-with-selinux.md
         - Uninstall: yum-uninstall-xtrabackup.md
+      - PRO:
+        - install-pro.md
+        - pro-files.md
       - Use binary tarballs:
         - Install with binary tarballs: binary-tarball.md
         - Binary tarballs available: binary-tarball-names.md

snippets/pro-build-announcement.md

@@ -0,0 +1,3 @@
+Percona XtraBackup Pro includes the 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}

variables.yml

@@ -3,6 +3,7 @@
 release: '8.0.35-32'
 update: '8.0.35-32'
 version: '8.0'
-release-date: '2025-01-09'
-title_date: '2025-01-09'
-
+pkg: 'pxb-80'
+release-date: '2025-02-28' # if a version is updated, change this date
+title_date: '2025-02-28' # if a version is updated, change this date
+amzn: '8.0.35-32.0.amzn2023.x86_64'