Merge pull request #320 from percona/pxb-3365

PXB-3365 [DOCS] - Update installation documents 8.4
percona · Dec 11, 2024 · f561f0d · f561f0d
2 parents 47645dc + 691a5f8
commit f561f0d
Show file tree

Hide file tree

Showing 2 changed files with 193 additions and 25 deletions.
diff --git a/docs/apt-repo.md b/docs/apt-repo.md
@@ -1,4 +1,4 @@
-# Install with an APT repository
+# Install with the Percona-release Tool on Debian-based Systems
 
 Ready-to-use packages are available from the Percona XtraBackup software
 repositories and the [download page].
@@ -8,39 +8,163 @@ described in [Percona Release Lifecycle Overview].
 
 ## Install Percona XtraBackup through percona-release
 
-Percona XtraBackup, like many other Percona products, is installed with the *percona-release* package configuration tool.
+Install Percona XtraBackup, like many other Percona products, with the `percona-release` package configuration tool.
 {.power-number}
 
-1. Download a `DEB` package for *percona-release* the repository packages from Percona web:
+1. Use the apt package manager to dowload `percona-release`:
 
     ```{.bash data-prompt="$"}
-    $ wget https://repo.percona.com/apt/percona-release_latest.$(lsb_release -sc)_all.deb
+    $ sudo apt update
+    ```
+
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        Get:1 http://security.ubuntu.com/ubuntu jammy-security InRelease [129 kB]
+        Get:2 http://archive.ubuntu.com/ubuntu jammy InRelease [270 kB]
+        Get:3 http://archive.ubuntu.com/ubuntu jammy-updates InRelease [128 kB]
+        Get:4 http://security.ubuntu.com/ubuntu jammy-security/main amd64 Packages [2458 kB]
+        ...
+        Building dependency tree... Done
+        Reading state information... Done
+        All packages are up to date.
+        ```
+
+2. Install the `curl` download utility if it's not installed:
+
+    ```{.bash data-prompt="$"}
+    $ sudo apt install curl
     ```
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        Reading package lists... Done
+        Building dependency tree... Done
+        Reading state information... Done
+        The following additional packages will be installed:
+        ...
+        Updating certificates in /etc/ssl/certs...
+        0 added, 0 removed; done.########################################################...] 
+        Running hooks in /etc/ca-certificates/update.d...
+        done.
+        ```
 
-2. Install the downloaded package with **dpkg**. To do that, run the following commands as root or with **sudo**: `dpkg -i percona-release_latest.$(lsb_release -sc)_all.deb`
-
-    Once you install this package the Percona repositories should be added. You
-    can check the repository setup in the `/etc/apt/sources.list.d/percona-release.list` file.
+3. Download the `percona-release` the repository package:
+
+    ```{.bash data-prompt="$"}
+    $ curl -O https://repo.percona.com/apt/percona-release_latest.generic_all.deb
+    ```
 
-3. Enable the repository: `percona-release enable-only tools release`
+    ??? example "Expected output"
 
-    If *Percona XtraBackup* is intended to be used in combination with
-    the upstream MySQL Server, you only need to enable the `tools`
-    repository: `percona-release enable-only tools`.
+        ```{.text .no-copy}
+        % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                        Dload  Upload   Total   Spent    Left  Speed
+        100 16510  100 16510    0     0  29915      0 --:--:-- --:--:-- --:--:-- 30127
+        ```
 
-4. Refresh the local cache to update the package information:
+4. Install the downloaded package and its dependencies using `apt`:
+
+    ```{.bash data-prompt="$"}
+    sudo apt install gnupg2 lsb-release ./percona-release_latest.generic_all.deb
+    ```
+
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        Reading package lists... Done
+        Building dependency tree... Done
+        Reading state information... Done
+        ...
+        For example, to enable the Percona Distribution for MySQL 8.0 repository use:
+
+          percona-release setup pdps8.0
+
+        Note: To avoid conflicts with older product versions, the percona-release setup command may disable our original repository for some products.
+
+        For more information, please visit:
+        https://docs.percona.com/percona-software-repositories/percona-release.html
+
+        Processing triggers for libc-bin (2.35-0ubuntu3.8) ...
+        ```
+
+5. Refresh the local cache to update the package information:
 
     ```{.bash data-prompt="$"}
     $ sudo apt update
     ```
 
-5. Install the `percona-xtrabackup-{{pkg}}` package:
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        Get:1 http://security.ubuntu.com/ubuntu jammy-security InRelease [129 kB]
+        Get:2 http://archive.ubuntu.com/ubuntu jammy InRelease [270 kB]
+        Get:3 http://archive.ubuntu.com/ubuntu jammy-updates InRelease [128 kB]
+        Get:4 http://security.ubuntu.com/ubuntu jammy-security/main amd64 Packages [2458 kB]
+        ...
+        Building dependency tree... Done
+        Reading state information... Done
+        All packages are up to date.
+        ```
+
+6. Enable the specific percona-release product.
+
+    ```{.bash data-prompt="$"}
+    $ sudo percona-release enable pxb-84-lts
+    ```
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        * Enabling the Percona Packaging Repository repository
+        Hit:1 http://repo.percona.com/pmm2-client/apt jammy InRelease
+        Hit:2 http://archive.ubuntu.com/ubuntu jammy InRelease                     
+        Hit:3 http://repo.percona.com/prel/apt jammy InRelease                     
+        Hit:4 http://security.ubuntu.com/ubuntu jammy-security InRelease
+        Hit:5 http://archive.ubuntu.com/ubuntu jammy-updates InRelease
+        Get:6 http://repo.percona.com/pxb-84-lts/apt jammy InRelease [12.8 kB]
+        Hit:7 http://archive.ubuntu.com/ubuntu jammy-backports InRelease
+        Hit:8 http://repo.percona.com/telemetry/apt jammy InRelease
+        Get:9 http://repo.percona.com/pxb-84-lts/apt jammy/main Sources [855 B]
+        Get:10 http://repo.percona.com/pxb-84-lts/apt jammy/main amd64 Packages [3547 B]
+        Fetched 17.2 kB in 4s (3958 B/s)   
+        Reading package lists... Done
+        ```
+
+7. Install Percona XtraBackup.
 
     ```{.bash data-prompt="$"}
-    $ sudo apt install percona-xtrabackup-{{pkg}}
+    $ sudo apt install percona-xtrabackup-84
     ```
 
-6. To decompress backups made using `LZ4` or `ZSTD` compression algorithm, install the corresponding package:
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        Reading package lists... Done
+        Building dependency tree... Done
+        Reading state information... Done
+        The following additional packages will be installed:
+        libaio1 libcurl4-openssl-dev libdbd-mysql-perl libdbi-perl libev4 libgdbm-compat4
+        libgdbm6 libmysqlclient21 libperl5.34 libpopt0 mysql-common netbase perl
+        perl-modules-5.34 rsync zstd
+        ...
+        Setting up libdbd-mysql-perl:amd64 (4.050-5ubuntu0.22.04.1) ...##############.......] 
+        Setting up percona-xtrabackup-84 (8.4.0-1-1.jammy) ...#########################.....] 
+        Processing triggers for libc-bin (2.35-0ubuntu3.8) ...###########################...] 
+        ```
+
+8. Verify the installation.
+
+    ```{.bash data-prompt="$"}
+    $ xtrabackup --version
+    ```
+
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        xtrabackup version 8.4.0-1 based on MySQL server 8.4.0 Linux (x86_64) (revision id: da6e1abd)
+        ```
+
+9. To decompress backups made using `LZ4` or `ZSTD` compression algorithm, install the corresponding package:
 
     === "Install the `lz4` package"
 

diff --git a/docs/yum-repo.md b/docs/yum-repo.md
@@ -20,30 +20,74 @@ To install Percona XtraBackup from Percona `yum` repository, do the following st
     noarch.rpm
     ```
 
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        Oracle Linux 9 BaseOS Latest (x86_64)           8.4 MB/s |  43 MB     00:05    
+        Oracle Linux 9 Application Stream Packages (x86 8.6 MB/s |  47 MB     00:05    
+        Last metadata expiration check: 0:00:06 ago on Wed Dec 11 14:12:54 2024.
+        percona-release-latest.noarch.rpm                62 kB/s |  27 kB     00:00    
+        Dependencies resolved.
+        ...
+        For more information, please visit:
+        https://docs.percona.com/percona-software-repositories/percona-release.html
+
+
+        Verifying        : percona-release-1.0-29.noarch                          1/1 
+
+        Installed:
+        percona-release-1.0-29.noarch                                                 
+
+        Complete!
+        ```
+
 2. Enable the repository: 
 
     ```{.bash data-prompt="$"}
-    $ sudo percona-release enable-only tools release
+    $ sudo percona-release enable pxb-84-lts
     ```
 
-    If *Percona XtraBackup* is intended to be used in combination with
-    the upstream MySQL Server, you only need to enable the `tools repository: 
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        * Enabling the Percona Packaging Repository repository
+        <*> All done!
+        ```
+
+3. Install Percona XtraBackup.
 
     ```{.bash data-prompt="$"}
-    $ sudo percona-release enable-only tools
+    $ sudo yum install percona-xtrabackup-84
     ```
 
-3. Install *Percona XtraBackup* by running:
+    ??? example "Expected output"
+
+        ```{.text .no-copy}
+        PMM2 Client release/x86_64 YUM repository        17 kB/s | 7.1 kB     00:00    
+        Percona Release release/noarch YUM repository   5.3 kB/s | 2.0 kB     00:00    
+        Percona Packaging Repository release/x86_64 YUM  95 kB/s |  52 kB     00:00    
+        Percona Telemetry release/x86_64 YUM repository 4.3 kB/s | 1.7 kB     00:00    
+        Dependencies resolved.
+        ...
+        perl-subs-1.03-481.el9.noarch                                                 
+        perl-vars-1.05-481.el9.noarch                                                 
+        rsync-3.2.3-20.el9.x86_64                                                     
+        zstd-1.5.1-2.el9.x86_64 
+        ```
+        
+4. Verify the installation.
 
     ```{.bash data-prompt="$"}
-    $ sudo yum install percona-xtrabackup-{{pkg}}
+    $ xtrabackup --version
     ```
 
-    !!! warning
+    ??? example "Expected output"
 
-        Make sure that you have the `libev` package installed before installing *Percona XtraBackup* on CentOS 6. For this operating system, the `libev` package is available from the [EPEL](https://fedoraproject.org/wiki/EPEL) repositories.
+        ```{.text .no-copy}
+        xtrabackup version 8.4.0-1 based on MySQL server 8.4.0 Linux (x86_64) (revision id: da6e1abd)
+        ```
 
-4. To decompress backups made using `LZ4` or `ZSTD` compression algorithm, install the corresponding package:
+5. To decompress backups made using `LZ4` or `ZSTD` compression algorithm, install the corresponding package:
 
     === "Install the `lz4` package"