DISTMYSQL-474 [DOC] Return info about PXC to 8.4 PDMySQL docs and upd…

…ate the configs (#181) modified: docs/components.md modified: docs/deployment-variants.md modified: docs/index.md modified: docs/installing.md modified: docs/minor-upgrade.md modified: docs/pdps-group-replication.md new file: docs/replication-manager-for-pxc.md new file: docs/replication-manager-troubleshooting.md new file: docs/single-replica-manager.md modified: docs/uninstalling.md modified: mkdocs-base.yml modified: variables.yml
percona · Nov 14, 2024 · 662d3b6 · 662d3b6
1 parent c1f508e
commit 662d3b6
Show file tree

Hide file tree

Showing 11 changed files with 759 additions and 183 deletions.
diff --git a/docs/components.md b/docs/components.md
@@ -4,14 +4,17 @@ Percona Distribution for MySQL consists of the following **components**:
 
 * [Percona Server for MySQL](https://docs.percona.com/percona-server/{{vers}}/) is a drop-in replacement for MySQL Community Edition with the enterprise-grade features embedded by Percona.
 
-* [Percona XtraBackup](https://docs.percona.com/percona-xtrabackup/{{vers}}/) is an open-source hot backup utility for MySQL-based servers that doesn’t lock your database during the backup.
+* [Percona XtraDB Cluster](https://docs.percona.com/percona-xtradb-cluster/{{vers}}/index.html) is the high-available clustering solution for MySQL. It is based on [Percona Server for MySQL](https://docs.percona.com/percona-server/{{vers}}/index.html) and uses [Percona XtraBackup](https://docs.percona.com/percona-xtrabackup/{{vers}}/index.html) for node provisioning.
 
+* [Percona XtraBackup](https://docs.percona.com/percona-xtrabackup/{{vers}}/) is an open-source hot backup utility for MySQL-based servers that doesn’t lock your database during the backup.
 
-* [Orchestrator](https://github.com/openark/orchestrator) is the replication topology manager for *Percona Server for MySQL*.
+* [Orchestrator](https://github.com/openark/orchestrator) is the replication topology manager for Percona Server for MySQL.
 
+* [HAProxy](http://www.haproxy.org/) is the default high-availability and load-balancing solution for Percona XtraDB Cluster.
 
 * [ProxySQL](https://proxysql.com/) is a high performance, high-availability, protocol-aware proxy for MySQL.
 
+* [Percona Toolkit](https://www.percona.com/doc/percona-toolkit/3.0/index.html) is the set of scripts to simplify and optimize database operation.
 
 * [MySQL Shell](https://dev.mysql.com/doc/mysql-shell/{{vers}}/en/) is an advanced client and code editor for MySQL Server.
 

diff --git a/docs/deployment-variants.md b/docs/deployment-variants.md
@@ -1,6 +1,6 @@
 # Deployment variants
 
-Percona Distribution for MySQL provides two deployment variants: one is *Percona Server for MySQL*-based with asynchronous replication and another one is *Percona Server for MySQL*-based with group replication. The table below lists what components are available with Percona Server for MySQL:
+Percona Distribution for MySQL provides two deployment variants: one is Percona Server for MySQL-based and another one is Percona XtraDB Cluster-based. Each deployment is available via its own repository and includes the base server (Percona Server for MySQL or Percona XtraDB Cluster) and [components](components.md). The table below lists what components are available with each server:
 
 | Components   | Percona Server for MySQL   |
 | ------------ | ---------------------------|
@@ -24,3 +24,6 @@ The **Percona Server-based deployment variant** with [asynchronous replication](
 
 The **Percona Server-based deployment variant** with [Group Replication](https://dev.mysql.com/doc/refman/{{vers}}/en/group-replication.html) enables you to create fault-tolerant systems with redundancy by replicating the system state to a set of servers. *Percona Server for MySQL*-based deployment with Group Replication  offers a high grade of high availability (4-5 nines) and almost instant fail over when associated with a proxy.
 
+The **Percona XtraDB Cluster-based deployment variant** guarantees data consistency on all nodes and zero data loss. The Percona XtraDB Cluster-based deployment provides a high grade of high availability (4-5 nines) and almost instant failover.
+
+
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
 # Percona Distribution for MySQL {{vers}} Documentation
 
-Percona Distribution for MySQL is a single solution with the best and most critical enterprise components from the MySQL open source community, designed and tested to work together. With [Percona Server for MySQL](https://www.percona.com/software/mysql-database/percona-server) as the base server, the distribution brings you the enterprise-grade [features](#features) for free. The set of carefully selected [components](components.md) helps you operate your MySQL database to meet your application and business needs.
+Percona Distribution for MySQL is a single solution with the best and most critical enterprise components from the MySQL open source community, designed and tested to work together. With [Percona Server for MySQL](https://www.percona.com/software/mysql-database/percona-server) or [Percona XtraDB Cluster](https://www.percona.com/software/mysql-database/percona-xtradb-cluster) as the base server, the distribution brings you the enterprise-grade [features](#features) for free. The set of carefully selected [components](components.md) helps you operate your MySQL database to meet your application and business needs.
 
 ## Features
 
@@ -10,7 +10,9 @@ Percona Distribution for MySQL is a single solution with the best and most criti
 
 - **Reduced costs** - save on purchasing software licensing by using the distribution - the open-source enterprise-grade solution.
 
-- **Easy-to-integrate with PMM** - benefit from all the features of [PMM](https://docs.percona.com/percona-monitoring-and-management/index.html) for monitoring and managing the health of your database. 
+- **Easy-to-integrate with PMM** - benefit from all the features of [PMM](https://docs.percona.com/percona-monitoring-and-management/index.html) for monitoring and managing the health of your database.
+
+Percona Distribution for MySQL comes in two [deployment variants](deployment-variants.md): one is based on Percona Server for MySQL and another one - on Percona XtraDB Cluster. They differ in the set of components and how you can use them. 
 
 !!! important
 

diff --git a/docs/installing.md b/docs/installing.md
@@ -37,148 +37,256 @@ To install Percona software, you need to configure the required repository. To s
 
 ## Procedure
 
-=== "On Debian and Ubuntu Linux"
+=== "Install Percona Server-based variant"
 
-    !!! important
+    === "On Debian and Ubuntu Linux"
 
-        Run the following commands as the root user or via `sudo`.
+        !!! important
 
-    ### Enable Percona repository
+            Run the following commands as the root user or via `sudo`.
 
-    To enable the desired repository, we recommend to use the `enable` subcommand of `percona-release`.
+        ### Enable Percona repository
 
-    ```{.bash data-prompt="$"}
-    $ sudo percona-release enable {{majorpkg}}
-    ```
+        To enable the desired repository, we recommend to use the `enable` subcommand of `percona-release`.
 
-    !!! tip
+        ```{.bash data-prompt="$"}
+        $ sudo percona-release enable {{majorpkg}}
+        ```
 
-        To enable the minor version repository, use the following command:
+        !!! tip
 
-        ```
-        $ sudo percona-release enable {{minorpkg}}
-        ```
+            To enable the minor version repository, use the following command:
 
-    ### Install Percona Distribution for MySQL packages
+            ```
+            $ sudo percona-release enable {{minorpkg}}
+            ```
 
-    1. Install *Percona Server for MySQL*:
+        ### Install Percona Distribution for MySQL packages
 
-        ```{.bash data-prompt="$"}
-        $ sudo apt install percona-server-server
-        ```
+        1. Install *Percona Server for MySQL*:
 
-    2. Install the components. Use the commands below to install the required components:
+            ```{.bash data-prompt="$"}
+            $ sudo apt install percona-server-server
+            ```
 
-        Install Percona XtraBackup:
+        2. Install the components. Use the commands below to install the required components:
 
-        ```{.bash data-prompt="$"}
-        $ sudo apt install percona-xtrabackup-84
-        ```
+            Install Percona XtraBackup:
 
-        Install Percona Toolkit:
+            ```{.bash data-prompt="$"}
+            $ sudo apt install percona-xtrabackup-84
+            ```
 
-        ```{.bash data-prompt="$"}
-        $ sudo apt install percona-toolkit
-        ```
+            Install Percona Toolkit:
 
-        Install Orchestrator:
+            ```{.bash data-prompt="$"}
+            $ sudo apt install percona-toolkit
+            ```
 
-        ```{.bash data-prompt="$"}
-        $ sudo apt install percona-orchestrator percona-orchestrator-cli percona-orchestrator-client
-        ```
+            Install Orchestrator:
 
-        Install MySQL Shell:
+            ```{.bash data-prompt="$"}
+            $ sudo apt install percona-orchestrator percona-orchestrator-cli percona-orchestrator-client
+            ```
 
-        ```{.bash data-prompt="$"}
-        $ sudo apt install percona-mysql-shell
-        ```
+            Install MySQL Shell:
 
-        Install ProxySQL:
+            ```{.bash data-prompt="$"}
+            $ sudo apt install percona-mysql-shell
+            ```
 
-        ```{.bash data-prompt="$"}
-        $ sudo apt install proxysql2
-        ```
+            Install ProxySQL:
 
-        Install MySQL Router:
+            ```{.bash data-prompt="$"}
+            $ sudo apt install proxysql2
+            ```
 
-        ```{.bash data-prompt="$"}
-        $ sudo apt install percona-mysql-router
-        ```
+            Install MySQL Router:
 
-=== "On Red Hat Enterprise Linux and derivatives"
+            ```{.bash data-prompt="$"}
+            $ sudo apt install percona-mysql-router
+            ```
+
+    === "On Red Hat Enterprise Linux and derivatives"
 
-    !!! admonition "Platform specific notes"
+        !!! admonition "Platform specific notes"
+
+            On CentOS 7, install the `epel-release` package. It includes the dependencies required to install Orchestrator. Use the following command:
+
+            ```{.bash data-prompt="$"}
+            $ sudo yum -y install epel-release
+            ```
+
+        Run the following commands as the root user or via `sudo`.
+
+        ### Enable Percona repository
 
-        On CentOS 7, install the `epel-release` package. It includes the dependencies required to install Orchestrator. Use the following command:
+        To enable the desired repository, we recommend to use the `enable` subcommand of `percona-release`.
 
         ```{.bash data-prompt="$"}
-        $ sudo yum -y install epel-release
+        $ sudo percona-release enable {{majorpkg}}
         ```
 
-    Run the following commands as the root user or via `sudo`.
+        !!! tip
 
-    ### Enable Percona repository
+            To enable the minor version repository, use the following command:
 
-    To enable the desired repository, we recommend to use the `enable` subcommand of `percona-release`.
+            ```{.bash data-prompt="$"}
+            $ sudo percona-release enable {{minorpkg}}
+            ```
 
-    ```{.bash data-prompt="$"}
-    $ sudo percona-release enable {{majorpkg}}
-    ```
+        ### Install Percona Distribution for MySQL packages
 
-    !!! tip
+        1. Install *Percona Server for MySQL*:
+
+            ```{.bash data-prompt="$"}
+            $ sudo yum install percona-server-server
+            ```
 
-        To enable the minor version repository, use the following command:
+        2. Install the components. Use the commands below to install the required components:
 
-        ```{.bash data-prompt="$"}
-        $ sudo percona-release enable {{minorpkg}}
-        ```
+            Install Percona XtraBackup
 
-    ### Install Percona Distribution for MySQL packages
+            ```{.bash data-prompt="$"}
+            $ sudo yum install percona-xtrabackup-84
+            ```
 
-    1. Install *Percona Server for MySQL*:
+            Install Orchestrator
 
-        ```{.bash data-prompt="$"}
-        $ sudo yum install percona-server-server
-        ```
+            ```{.bash data-prompt="$"}
+            $ sudo yum install percona-orchestrator percona-orchestrator-cli percona-orchestrator-client
+            ```
 
+            Install Percona Toolkit
 
-    2. Install the components. Use the commands below to install the required components:
+            ```{.bash data-prompt="$"}
+            $ sudo yum install percona-toolkit
+            ```
 
-        Install Percona XtraBackup
+            Install MySQL Shell:
 
-        ```{.bash data-prompt="$"}
-        $ sudo yum install percona-xtrabackup-84
-        ```
+            ```{.bash data-prompt="$"}
+            $ sudo yum install percona-mysql-shell
+            ```
 
-        Install Orchestrator
+            Install ProxySQL:
 
-        ```{.bash data-prompt="$"}
-        $ sudo yum install percona-orchestrator percona-orchestrator-cli percona-orchestrator-client
-        ```
+            ```{.bash data-prompt="$"}
+            $ sudo yum install proxysql2
+            ```
 
-        Install Percona Toolkit
+            Install MySQL Router:
 
-        ```{.bash data-prompt="$"}
-        $ sudo yum install percona-toolkit
-        ```
+            ```{.bash data-prompt="$"}
+            $ sudo yum install percona-mysql-router
+            ```
 
-        Install MySQL Shell:
+=== "Install Percona XtraDB Cluster-based variant"
 
-        ```{.bash data-prompt="$"}
-        $ sudo yum install percona-mysql-shell
-        ```
+    === "On Debian and Ubuntu Linux"
 
-        Install ProxySQL:
+        !!! important
 
-        ```{.bash data-prompt="$"}
-        $ sudo yum install proxysql2
-        ```
+            Run the following commands as the root user or via `sudo`.
 
-        Install MySQL Router:
+        ### Enable Percona repository
 
-        ```{.bash data-prompt="$"}
-        $ sudo yum install percona-mysql-router
-        ```
+        To enable the desired repository, we recommend to use the `setup` subcommand of `percona-release`.
+
+          ```{.bash data-prompt="$"}
+          $ sudo percona-release setup {{majorpkgpxc}}
+          ```
+
+        !!! tip
+
+            To enable the minor version repository, use the following command:
+
+            ```{.bash data-prompt="$"}
+            $ sudo percona-release setup {{minorpkgpxc}}
+            ```
+
+        ### Install Percona Distribution for MySQL packages
+
+         1. Install *Percona XtraDB Cluster*:
+
+             ```{.bash data-prompt="$"}
+             $ sudo apt install percona-xtradb-cluster
+             ```
+
+
+         2. Install HAProxy:
+
+             ```{.bash data-prompt="$"}
+             $ sudo apt install percona-haproxy
+             ```
+
+
+         3. Install the components. Use the commands below to install the required components:
+
+            Install Percona XtraBackup:
+
+             ```{.bash data-prompt="$"}
+             $ sudo apt install percona-xtrabackup-84
+             ```
+
+            Install Percona Toolkit:
+
+             ```{.bash data-prompt="$"}
+             $ sudo apt install percona-toolkit
+             ```
+
+    === "On Red Hat Enterprise Linux and derivatives"
+
+        !!! important
+
+            Run the following commands as the root user or via `sudo`.
+
+        ### Enable Percona repository
+
+        To enable the desired repository, we recommend to use the `setup` subcommand of `percona-release`.
+
+          ```{.bash data-prompt="$"}
+          $ sudo percona-release setup {{majorpkgpxc}}
+          ```
+
+        !!! tip
+
+            To enable the minor version repository, use the following command:
+
+            ```{.bash data-prompt="$"}
+            $ sudo percona-release setup {{minorpkgpxc}}
+            ```
+
+        ### Install Percona Distribution for MySQL packages
+
+
+         1. Install *Percona XtraDB Cluster*:
+
+             ```{.bash data-prompt="$"}
+             $ sudo yum install percona-xtradb-cluster
+             ```
+
+
+         2. Install HAProxy:
+
+             ```{.bash data-prompt="$"}
+             $ sudo yum install percona-haproxy
+             ```
+
+
+         3. Install the components. Use the commands below to install the required components:
+
+            Install Percona XtraBackup:
+
+             ```{.bash data-prompt="$"}
+             $ sudo yum install percona-xtrabackup-84
+             ```
+
+            Install Percona Toolkit:
+
+             ```{.bash data-prompt="$"}
+             $ sudo yum install percona-toolkit
+             ```
 
 ### Run Percona Distribution for MySQL