From fef61e2a8b9405eab789ab11fcb8f2019e7dffbb Mon Sep 17 00:00:00 2001 From: Patrick Birch <48594400+patrickbirch@users.noreply.github.com> Date: Tue, 11 Feb 2025 03:18:49 -0600 Subject: [PATCH] PSQLADM-Update remove PSQL1 versions of the docs --- docs/2.4.7.md | 2 +- docs/2.4.8.md | 4 +- docs/2.5.1.md | 4 +- docs/2.5.2.md | 4 +- docs/2.5.3.md | 4 +- docs/2.5.4.md | 4 +- docs/2.5.5-1.2.md | 2 +- docs/2.5.5.md | 4 +- docs/2.6.2.md | 4 +- docs/2.6.3.md | 2 +- docs/2.6.5.md | 4 +- docs/2.7.1.md | 2 +- docs/configure-proxysql1.md | 581 -------------------- docs/copyright-and-licensing-information.md | 2 +- docs/index.md | 49 +- docs/install-proxysql2-tarball.md | 12 +- docs/installing-v1.md | 30 - docs/proxysql-admin-tool-functions.md | 4 +- docs/proxysql-v1.md | 424 -------------- docs/psh-detailed-options.md | 164 +++--- docs/psh-known-limitations.md | 6 +- docs/psh-options.md | 2 +- docs/release-notes-1.4.12.md | 45 -- docs/release-notes-1.4.16.md | 23 - docs/release-notes-1.4.4.md | 35 -- docs/release-notes-1.4.5.md | 34 -- docs/release-notes-1.4.6.md | 42 -- docs/release-notes-1.4.7.md | 47 -- docs/release-notes-1.4.8.md | 43 -- docs/release-notes-index-v1.md | 279 ---------- docs/release-notes.md | 2 - docs/tarball-v1.md | 35 -- mkdocs-base.yml | 6 - 33 files changed, 148 insertions(+), 1757 deletions(-) delete mode 100644 docs/configure-proxysql1.md delete mode 100644 docs/installing-v1.md delete mode 100644 docs/proxysql-v1.md delete mode 100644 docs/release-notes-1.4.12.md delete mode 100644 docs/release-notes-1.4.16.md delete mode 100644 docs/release-notes-1.4.4.md delete mode 100644 docs/release-notes-1.4.5.md delete mode 100644 docs/release-notes-1.4.6.md delete mode 100644 docs/release-notes-1.4.7.md delete mode 100644 docs/release-notes-1.4.8.md delete mode 100644 docs/release-notes-index-v1.md delete mode 100644 docs/tarball-v1.md diff --git a/docs/2.4.7.md b/docs/2.4.7.md index c6c002b..5780725 100644 --- a/docs/2.4.7.md +++ b/docs/2.4.7.md @@ -9,7 +9,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1.x.x](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2.x.x and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. diff --git a/docs/2.4.8.md b/docs/2.4.8.md index 35fadcb..a4bb826 100644 --- a/docs/2.4.8.md +++ b/docs/2.4.8.md @@ -9,7 +9,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1.x.x](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2.x.x and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. @@ -29,4 +29,4 @@ ProxySQL Admin and pxc_scheduler_handler have not changed since the previous rel * [Contribute to the documentation](https://github.com/percona/proxysql-admin-tool-doc/blob/main/contributing.md) -* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) \ No newline at end of file +* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) diff --git a/docs/2.5.1.md b/docs/2.5.1.md index 6449ade..d57c8e0 100644 --- a/docs/2.5.1.md +++ b/docs/2.5.1.md @@ -9,7 +9,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1.x.x](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2.x.x and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. @@ -49,4 +49,4 @@ ProxySQL Admin and pxc_scheduler_handler have not changed since the previous rel * [Contribute to the documentation](https://github.com/percona/proxysql-admin-tool-doc/blob/main/contributing.md) -* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) \ No newline at end of file +* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) diff --git a/docs/2.5.2.md b/docs/2.5.2.md index 6e810ad..d65a5ee 100644 --- a/docs/2.5.2.md +++ b/docs/2.5.2.md @@ -8,7 +8,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1.x.x](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2.x.x and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. @@ -38,4 +38,4 @@ ProxySQL Admin and pxc_scheduler_handler have not changed since the previous rel * Download the product binaries, packages, and tarballs at [Download ProxySQL](https://www.percona.com/download-proxysql) -* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) \ No newline at end of file +* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) diff --git a/docs/2.5.3.md b/docs/2.5.3.md index 8ba3168..3e353d4 100644 --- a/docs/2.5.3.md +++ b/docs/2.5.3.md @@ -4,7 +4,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1.x.x](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2.x.x and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. @@ -34,4 +34,4 @@ ProxySQL Admin and pxc_scheduler_handler have not changed since the previous rel * Download the product binaries, packages, and tarballs at [Download ProxySQL](https://www.percona.com/download-proxysql) -* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) \ No newline at end of file +* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) diff --git a/docs/2.5.4.md b/docs/2.5.4.md index f558c3e..55d591e 100644 --- a/docs/2.5.4.md +++ b/docs/2.5.4.md @@ -4,7 +4,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1.x.x](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2.x.x and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. @@ -32,4 +32,4 @@ ProxySQL Admin and pxc_scheduler_handler have not changed since the previous rel * Download the product binaries, packages, and tarballs at [Download ProxySQL](https://www.percona.com/download-proxysql) -* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) \ No newline at end of file +* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) diff --git a/docs/2.5.5-1.2.md b/docs/2.5.5-1.2.md index c1346f7..cd681e6 100644 --- a/docs/2.5.5-1.2.md +++ b/docs/2.5.5-1.2.md @@ -4,7 +4,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2 and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. diff --git a/docs/2.5.5.md b/docs/2.5.5.md index 5163fbe..3d5d6c9 100644 --- a/docs/2.5.5.md +++ b/docs/2.5.5.md @@ -4,7 +4,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2 and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. @@ -35,4 +35,4 @@ ProxySQL Admin and pxc_scheduler_handler have not changed since the previous rel * Download the product binaries, packages, and tarballs at [Download ProxySQL](https://www.percona.com/download-proxysql) -* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) \ No newline at end of file +* For [training](https://www.percona.com/training), contact [Percona Training - Start learning now](https://learn.percona.com/contact-me) diff --git a/docs/2.6.2.md b/docs/2.6.2.md index a2a127b..796d26e 100644 --- a/docs/2.6.2.md +++ b/docs/2.6.2.md @@ -8,7 +8,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2 and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. @@ -55,4 +55,4 @@ For more information on these items and other changes, see the [ProxySQL 2.6.2 r [ProxySQL 2.5.5-1.2 release]: https://docs.percona.com/proxysql/2.5.5-1.2.html -[ProxySQL 2.6.2]: https://github.com/sysown/proxysql/releases/tag/v2.6.2 \ No newline at end of file +[ProxySQL 2.6.2]: https://github.com/sysown/proxysql/releases/tag/v2.6.2 diff --git a/docs/2.6.3.md b/docs/2.6.3.md index 0cd98be..ffaf3d3 100644 --- a/docs/2.6.3.md +++ b/docs/2.6.3.md @@ -8,7 +8,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2 and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. diff --git a/docs/2.6.5.md b/docs/2.6.5.md index 168faf5..4859597 100644 --- a/docs/2.6.5.md +++ b/docs/2.6.5.md @@ -8,7 +8,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2 and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has different features and capabilities than ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. @@ -40,4 +40,4 @@ In this release, we are skipping ProxySQL 2.6.4. We are releasing ProxySQL 2.6.5 [ProxySQL 2.6.3 release]: https://docs.percona.com/proxysql/2.6.3.html [ProxySQL 2.6.4]: https://github.com/sysown/proxysql/releases/tag/v2.6.4 -[ProxySQL 2.6.5]: https://github.com/sysown/proxysql/releases/tag/v2.6.5 \ No newline at end of file +[ProxySQL 2.6.5]: https://github.com/sysown/proxysql/releases/tag/v2.6.5 diff --git a/docs/2.7.1.md b/docs/2.7.1.md index d902601..3530633 100644 --- a/docs/2.7.1.md +++ b/docs/2.7.1.md @@ -8,7 +8,7 @@ You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL. -The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 1](proxysql-v1.md) requires custom `Bash` scripts to track the status of a Percona XtraDB Cluster. [ProxySQL Admin 2](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. +The [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) tool simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. [ProxySQL Admin 2.x.x](proxysql-admin-tool-functions.md) supports Percona XtraDB Cluster without custom scripts. The [ProxySQL 2 and pxc_scheduler_handler](psh-overview.md) tool can automatically perform a failover due to node failures, service degradation, or maintenance. The pxc_scheduler_handler tool has features and capabilities that are different from those of the ProxySQL admin. Do not use the options from one tool in the other tool. Mixing the options may cause unintended results. diff --git a/docs/configure-proxysql1.md b/docs/configure-proxysql1.md deleted file mode 100644 index e45773c..0000000 --- a/docs/configure-proxysql1.md +++ /dev/null @@ -1,581 +0,0 @@ -# Configure ProxySQL 1.x.x - -This tutorial describes how to configure *ProxySQL* with three *Percona XtraDB Cluster* nodes. - -| Node | Host name | IP address | -| ------ | --------- | ------------- | -| Node 1 | pxc1 | 192.168.70.61 | -| Node 2 | pxc2 | 192.168.70.62 | -| Node 3 | pxc3 | 192.168.70.63 | -| Node 4 | proxysql | 192.168.70.64 | - -*ProxySQL* can be configured either using *etc/proxysql-admin.cnf* or using the -admin interface. The admin interface can change the configuration dynamically and there is no need to restart the proxy. - -To connect to the ProxySQL admin interface, use the `mysql` client. You -can either connect to the admin interface from a *Percona XtraDB Cluster* node that already has the -`mysql` client installed (*Node 1*, *Node 2*, *Node 3*) or install the client on -*Node 4* and connect locally. For this tutorial, install *Percona XtraDB Cluster* on Node 4: - - -=== "On Debian-derived distributions" - - ```bash - [root@proxysql ~]# apt install percona-xtradb-cluster-client - ``` - -=== "On Red Hat-derived distributions" - - ```bash - [root@proxysql ~]# yum install percona-xtradb-cluster-client - ``` - -To connect to the admin interface, use the credentials, host name, and port -specified in the [ProxySQL global variables](https://github.com/sysown/proxysql/blob/master/doc/global_variables.md). - -Do not use the default credentials in production. - -The following example shows how to connect to the ProxySQL admin interface with the default credentials: - -```bash -root@proxysql:~# mysql -u admin -padmin -h 127.0.0.1 -P 6032 -``` - -??? example "Expected output" - - ```{.text .no-copy} - Welcome to the MySQL monitor. Commands end with ; or \g. - Your MySQL connection id is 8 - Server version: 5.1.30 (ProxySQL Admin Module) - - Copyright (c) 2009-2022 Percona LLC and/or its affiliates - Copyright (c) 2000, 2022, Oracle and/or its affiliates. - - Oracle is a registered trademark of Oracle Corporation and/or its - affiliates. Other names may be trademarks of their respective - owners. - - Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. - - mysql@proxysql> - ``` - -To see the *ProxySQL* databases and tables use the following commands: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SHOW DATABASES; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +-----+---------+-------------------------------+ - | seq | name | file | - +-----+---------+-------------------------------+ - | 0 | main | | - | 2 | disk | /var/lib/proxysql/proxysql.db | - | 3 | stats | | - | 4 | monitor | | - +-----+---------+-------------------------------+ - 4 rows in set (0.00 sec) - ``` - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SHOW TABLES; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +--------------------------------------+ - | tables | - +--------------------------------------+ - | global_variables | - | mysql_collations | - | mysql_query_rules | - | mysql_replication_hostgroups | - | mysql_servers | - | mysql_users | - | runtime_global_variables | - | runtime_mysql_query_rules | - | runtime_mysql_replication_hostgroups | - | runtime_mysql_servers | - | runtime_scheduler | - | scheduler | - +--------------------------------------+ - 12 rows in set (0.00 sec) - ``` - -ProxySQL has three areas where the configuration can reside: - -* MEMORY (your current working place) - -* RUNTIME (the production settings) - -* DISK (durable configuration saved in a [SQLite](https://sqlite.org/index.html) database) - -When you change a parameter, you change it in the MEMORY area. This method -allows you to test the changes before pushing the change to production -(RUNTIME) or to disk. - -## Add cluster nodes to ProxySQL - -To configure the backend *Percona XtraDB Cluster* nodes in *ProxySQL*, insert the corresponding records -into the `mysql_servers` table. - -ProxySQL uses the concept of hostgroups to group cluster nodes. This approach enables balancing the load in a cluster by routing different types of traffic to different groups. - -There are many ways you can configure hostgroups (for -example, master and slaves, read and write load, etc.) and a node can -be a member of multiple hostgroups. - -This example adds three *Percona XtraDB Cluster* nodes to the default hostgroup (`0`), -which receives both write and read traffic: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> INSERT INTO mysql_servers(hostgroup_id, hostname, port) VALUES (0,'192.168.70.61',3306); -mysql@proxysql> INSERT INTO mysql_servers(hostgroup_id, hostname, port) VALUES (0,'192.168.70.62',3306); -mysql@proxysql> INSERT INTO mysql_servers(hostgroup_id, hostname, port) VALUES (0,'192.168.70.63',3306); -``` - -To see the nodes: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SELECT * FROM mysql_servers; -``` - -??? example "Expected output" - - | hostgroup_id | hostname | port | status | weight | compression | max_connections | max_replication_lag | use_ssl | max_latency_ms | comment | - |---|---|---|---|---|---|---|---|---|---|---| - | 192.168.70.61 | 3306 | ONLINE | 1 | 0 | 1000 | 0 | 0 | | | | - | 192.168.70.62 | 3306 | ONLINE | 1 | 0 | 1000 | 0 | 0 | | | | - | 192.168.70.63 | 3306 | ONLINE | 1 | 0 | 1000 | 0 | 0 | | | | - -## Create a ProxySQL monitoring user - -To enable monitoring of *Percona XtraDB Cluster* nodes in *ProxySQL*, -create a user with the `USAGE` privilege on any node in the cluster -and configure the user in ProxySQL. - -The following example shows how to add a monitoring user on Node 2: - -```{.bash data-prompt="mysql@pxc2>"} -mysql@pxc2> CREATE USER 'proxysql'@'%' IDENTIFIED BY 'ProxySQLPa55'; -mysql@pxc2> GRANT USAGE ON *.* TO 'proxysql'@'%'; -``` - -The following example shows how to configure this user on the ProxySQL node: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> UPDATE global_variables SET variable_value='proxysql' - WHERE variable_name='mysql-monitor_username'; -mysql@proxysql> UPDATE global_variables SET variable_value='ProxySQLPa55' - WHERE variable_name='mysql-monitor_password'; -``` - -To load this configuration at runtime, issue a `LOAD` command. -Issue a `SAVE` command to save these changes to disk, this operation ensures that the changes persist after ProxySQL shuts down. - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> LOAD MYSQL VARIABLES TO RUNTIME; -mysql@proxysql> SAVE MYSQL VARIABLES TO DISK; -``` - -Check the monitoring logs to ensure that monitoring is enabled: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SELECT * FROM monitor.mysql_server_connect_log ORDER BY time_start_us DESC LIMIT 6; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +---------------+------+------------------+----------------------+---------------+ - | hostname | port | time_start_us | connect_success_time | connect_error | - +---------------+------+------------------+----------------------+---------------+ - | 192.168.70.61 | 3306 | 1469635762434625 | 1695 | NULL | - | 192.168.70.62 | 3306 | 1469635762434625 | 1779 | NULL | - | 192.168.70.63 | 3306 | 1469635762434625 | 1627 | NULL | - | 192.168.70.61 | 3306 | 1469635642434517 | 1557 | NULL | - | 192.168.70.62 | 3306 | 1469635642434517 | 2737 | NULL | - | 192.168.70.63 | 3306 | 1469635642434517 | 1447 | NULL | - +---------------+------+------------------+----------------------+---------------+ - 6 rows in set (0.00 sec) - ``` - -```{.bash data-prompt="mysql>"} -mysql> SELECT * FROM monitor.mysql_server_ping_log ORDER BY time_start_us DESC LIMIT 6; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +---------------+------+------------------+-------------------+------------+ - | hostname | port | time_start_us | ping_success_time | ping_error | - +---------------+------+------------------+-------------------+------------+ - | 192.168.70.61 | 3306 | 1469635762416190 | 948 | NULL | - | 192.168.70.62 | 3306 | 1469635762416190 | 803 | NULL | - | 192.168.70.63 | 3306 | 1469635762416190 | 711 | NULL | - | 192.168.70.61 | 3306 | 1469635702416062 | 783 | NULL | - | 192.168.70.62 | 3306 | 1469635702416062 | 631 | NULL | - | 192.168.70.63 | 3306 | 1469635702416062 | 542 | NULL | - +---------------+------+------------------+-------------------+------------+ - 6 rows in set (0.00 sec) - ``` - -The previous examples show that *ProxySQL* is able to connect -and ping the nodes you added. - -To enable monitoring of these nodes, load them at runtime: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> LOAD MYSQL SERVERS TO RUNTIME; -``` - -## Create a ProxySQL client user - -*ProxySQL* must have users that can access backend nodes -to manage connections. - -To add a user, insert credentials into `mysql_users` table: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> INSERT INTO mysql_users (username,password) VALUES ('sbuser','sbpass'); -``` - -??? example "Expected output" - - ```{.text .no-copy} - Query OK, 1 row affected (0.00 sec) - ``` - -!!! note - - *ProxySQL* currently does not encrypt passwords. - -Load the user into runtime space and save these changes to disk to ensure that the user account persists after ProxySQL shuts down: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> LOAD MYSQL USERS TO RUNTIME; -mysql@proxysql> SAVE MYSQL USERS TO DISK; -``` - -To confirm that the user has been set up correctly, you can try to log in: - -```mysql -root@proxysql:~# mysql -u sbuser -psbpass -h 127.0.0.1 -P 6033 -``` - -??? example "Expected output" - - ```{.text .no-copy} - - Welcome to the MySQL monitor. Commands end with ; or \g. - Your MySQL connection id is 1491 - Server version: 5.1.30 (ProxySQL) - - Copyright (c) 2009-2016 Percona LLC and/or its affiliates - Copyright (c) 2000, 2016, Oracle and/or its affiliates. All rights reserved. - - Oracle is a registered trademark of Oracle Corporation and/or its - affiliates. Other names may be trademarks of their respective - owners. - - Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. - ``` - -To provide read/write access to the cluster for ProxySQL, add this user on one of the *Percona XtraDB Cluster* nodes: - -```{.bash data-prompt="mysql@pxc3>"} -mysql@pxc3> CREATE USER 'sbuser'@'192.168.70.64' IDENTIFIED BY 'sbpass'; -``` - -??? example "Expected output" - - ```{.text .no-copy} - Query OK, 0 rows affected (0.01 sec) - ``` - -```{.bash data-prompt="mysql@pxc3>"} -mysql@pxc3> GRANT ALL ON *.* TO 'sbuser'@'192.168.70.64'; -``` - -??? example "Expected output" - - ```{.text .no-copy} - Query OK, 0 rows affected (0.00 sec) - ``` - -## Add Galera support in ProxySQL 1.x.x - -ProxySQL 2.x.x supports monitoring the status *Percona XtraDB Cluster* nodes. ProxySQL 1.x.x can't -detect a node which isn't in `Synced` state. To monitor the status of *Percona XtraDB Cluster* -nodes in ProxySQL 1.x.x, use the script proxysql_galera_checker. - -To use this script, load it into [ProxySQL scheduler](https://github.com/sysown/proxysql/blob/master/doc/scheduler.md). - -The following example shows how you can load the script for default -ProxySQL 1.x.x configuration: - -```{.bash data-prompt="mysql>"} -mysql> INSERT INTO scheduler (active,interval_ms,filename,arg1,comment) -VALUES (1,10000,'/usr/bin/proxysql_galera_checker','--config-file=/etc/proxysql-admin.cnf ---write-hg=10 --read-hg=11 --writer-count=1 --mode=singlewrite ---priority=192.168.100.20:3306,192.168.100.40:3306,192.168.100.10:3306,192.168.100.30:3306 ---log=/var/lib/proxysql/cluster_one_proxysql_galera_check.log','cluster_one'); -``` - -This scheduler script accepts the following options in the `arg1` argument: - -| Option | Name | Required | Description | -| -------------- | ------------------ | -------- | --------------------------------------------------------------------------------------------------- | -| `--config-file` | Configuration file | Yes | Specify `proxysql-admin` conifiguration file | -| `--write-hg` | HOSTGROUP WRITERS | No | Specify ProxySQL write hostgroup | -| `--read-hg` | HOSTGROUP READERS | No | Specify ProxySQL read hostgroup | -| `--writer-count` | NUMBER WRITERS | No | Specify the write node count. The options are: 0 for `loadbal` mode and `1` for `singlewrite` mode. | -| `--mode` | MODE | No | Specify ProxySQL read/write configuration mode | -| `--priority` | WRITER PRIORITY | No | Specify write notes priority | -| `--log` | LOG FILE | No | Specify `proxysql_galera_checker` log file | - -!!! note - - Specify the cluster name in comment column. - -To load the scheduler changes into the runtime space: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> LOAD SCHEDULER TO RUNTIME; -``` - -To make sure that the script has been loaded, -review the runtime_scheduler table: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SELECT * FROM scheduler\G -``` - -??? example "Expected output" - - ```{.text .no-copy} - *************************** 1. row *************************** - id: 1 - active: 1 - interval_ms: 10000 - filename: /bin/proxysql_galera_checker - arg1: --config-file=/etc/proxysql-admin.cnf --write-hg=10 --read-hg=11 - --writer-count=1 --mode=singlewrite - --priority=192.168.100.20:3306,192.168.100.40:3306,192.168.100.10:3306,192.168.100.30:3306 - --log=/var/lib/proxysql/cluster_one_proxysql_galera_check.log - arg2: NULL - arg3: NULL - arg4: NULL - arg5: NULL - comment: cluster_one - 1 row in set (0.00 sec) - ``` - -Review the status of available nodes: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SELECT hostgroup_id,hostname,port,status FROM mysql_servers; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +--------------+---------------+------+--------+ - | hostgroup_id | hostname | port | status | - +--------------+---------------+------+--------+ - | 0 | 192.168.70.61 | 3306 | ONLINE | - | 0 | 192.168.70.62 | 3306 | ONLINE | - | 0 | 192.168.70.63 | 3306 | ONLINE | - +--------------+---------------+------+--------+ - 3 rows in set (0.00 sec) - ``` - -Each node can have the following status: - -ONLINE - - Backend node is fully operational. - -SHUNNED - - backend node is temporarily taken out of use, because either too many - connection errors happened in a short time, or replication lag exceeded the - allowed threshold. - -OFFLINE_SOFT - - New incoming connections aren’t accepted, while existing connections are kept - until they become inactive. In other words, connections are kept in use until - the current transaction is completed. This allows to gracefully detach a - backend node. - -OFFLINE_HARD - - Existing connections are dropped, and new incoming connections aren’t - accepted. This is equivalent to deleting the node from a hostgroup, or - temporarily taking it out of the hostgroup for maintenance. - -## Test the cluster with sysbench - -Sysbench is designed to run CPU, memory and I/O test and has the option to run Online Transaction Processing (OLTP) workloads on a MySQL database. Install `Sysbench` from Percona software repositories: - -=== "On Debian-derived distributions" - - ```mysql - root@proxysql:~#> apt install sysbench - ``` - -=== "On Red Hat-derived distributions" - - ```bash - [root@proxysql ~]#> yum install sysbench - ``` - -`Sysbench` requires the ProxySQL client user credentials from [Create a ProxySQL client user](#create-a-proxysql-client-user). - -1. Create a database on one of the *Percona XtraDB Cluster* nodes. Use this database for testing. - - ```{.bash data-prompt="mysql@pxc1>"} - mysql@pxc1> CREATE DATABASE sbtest; - ``` - -2. Populate the table with data for the benchmark on the ProxySQL node: - - ```bash - root@proxysql:~#> sysbench --report-interval=5 --num-threads=4 \ - --num-requests=0 --max-time=20 \ - --test=/usr/share/doc/sysbench/tests/db/oltp.lua \ - --mysql-user='sbuser' --mysql-password='sbpass' \ - --oltp-table-size=10000 --mysql-host=127.0.0.1 --mysql-port=6033 \ - prepare - ``` - -3. Run the benchmark on the ProxySQL node: - - ```bash - root@proxysql:~#> sysbench --report-interval=5 --num-threads=4 \ - --num-requests=0 --max-time=20 \ - --test=/usr/share/doc/sysbench/tests/db/oltp.lua \ - --mysql-user='sbuser' --mysql-password='sbpass' \ - --oltp-table-size=10000 --mysql-host=127.0.0.1 --mysql-port=6033 \ - run - ``` - -ProxySQL stores collected data in the `stats` schema: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SHOW TABLES FROM stats; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +--------------------------------+ - | tables | - +--------------------------------+ - | stats_mysql_query_rules | - | stats_mysql_commands_counters | - | stats_mysql_processlist | - | stats_mysql_connection_pool | - | stats_mysql_query_digest | - | stats_mysql_query_digest_reset | - | stats_mysql_global | - +--------------------------------+ - ``` - -For example, to see the number of commands that run on the cluster: - -## Automatic fail-over - -*ProxySQL* automatically detects if a node isn't available or if the node isn't synced with the cluster. - -You can check the status of all available nodes by running: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SELECT hostgroup_id,hostname,port,status FROM mysql_servers; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +--------------+---------------+------+--------+ - | hostgroup_id | hostname | port | status | - +--------------+---------------+------+--------+ - | 0 | 192.168.70.61 | 3306 | ONLINE | - | 0 | 192.168.70.62 | 3306 | ONLINE | - | 0 | 192.168.70.63 | 3306 | ONLINE | - +--------------+---------------+------+--------+ - 3 rows in set (0.00 sec) - ``` - -To test problem detection and fail-over mechanism, shut down Node 3: - -```bash -root@pxc3:~# service mysql stop -``` - -*ProxySQL* detects that the node is down and updates the node's status to `OFFLINE_SOFT`: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SELECT hostgroup_id,hostname,port,status FROM mysql_servers; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +--------------+---------------+------+--------------+ - | hostgroup_id | hostname | port | status | - +--------------+---------------+------+--------------+ - | 0 | 192.168.70.61 | 3306 | ONLINE | - | 0 | 192.168.70.62 | 3306 | ONLINE | - | 0 | 192.168.70.63 | 3306 | OFFLINE_SOFT | - +--------------+---------------+------+--------------+ - 3 rows in set (0.00 sec) - ``` - -Start Node 3 again: - -```bash -root@pxc3:~#> service mysql start -``` - -The script detects the change and marks the node as `ONLINE`: - -```{.bash data-prompt="mysql@proxysql>"} -mysql@proxysql> SELECT hostgroup_id,hostname,port,status FROM mysql_servers; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +--------------+---------------+------+--------+ - | hostgroup_id | hostname | port | status | - +--------------+---------------+------+--------+ - | 0 | 192.168.70.61 | 3306 | ONLINE | - | 0 | 192.168.70.62 | 3306 | ONLINE | - | 0 | 192.168.70.63 | 3306 | ONLINE | - +--------------+---------------+------+--------+ - 3 rows in set (0.00 sec) - ``` - -## Assisted maintenance mode - -For maintenance, identify that node, update its status in ProxySQL to `OFFLINE_SOFT`, wait for ProxySQL to divert -traffic from this node, and then initiate the shutdown or perform maintenance -tasks. *Percona XtraDB Cluster* includes a special *maintenance mode* for nodes that enables you -to take a node down without adjusting *ProxySQL* manually. This mode is -controlled by the `pxc_maint_mode` variable, which is monitored by -*ProxySQL* and can be set to one of the following values: - -* `DISABLED`: This is the default state -that tells ProxySQL to route traffic to the node as usual. - -* `SHUTDOWN`: This state is set automatically -when you initiate node shutdown. - -* `MAINTENANCE`: You can manually change to this state -if you need to perform maintenance on a node without shutting it down. diff --git a/docs/copyright-and-licensing-information.md b/docs/copyright-and-licensing-information.md index 493b667..e2d2e51 100644 --- a/docs/copyright-and-licensing-information.md +++ b/docs/copyright-and-licensing-information.md @@ -2,4 +2,4 @@ ## Documentation licensing -Percona ProxySQL admin tools documentation is (C)2009-2024 Percona LLC and/or its affiliates and is distributed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). +Percona ProxySQL admin tools documentation is (C)2009-2025 Percona LLC and/or its affiliates and is distributed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). diff --git a/docs/index.md b/docs/index.md index 794cc11..8bdb251 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,32 +4,45 @@ This documentation is for the latest release: Percona ProxySQL admin tools {{release}} ([Release notes]({{release}}.md)). -[ProxySQL](https://www.proxysql.com/) is a tool that performs like a proxy between *Percona XtraDB Cluster* and your client application. *ProxySQL* manages a connection pool, which caches your connections and keeps the connections open for future requests. *ProxySQL* is designed to run continuously without being restarted. +[ProxySQL](https://www.proxysql.com/) acts as a proxy between Percona XtraDB Cluster +and your client application. It manages a connection pool, caching connections and +keeping them open for future requests. ProxySQL runs continuously without needing a +restart. -Without a connection pool, each SQL request opens a connections to the remote node. When the SQL request is complete, the connection is closed. A new one is opened on the next SQL request. +Without a connection pool, each SQL request opens a new connection to the remote +node and closes it after completion. ProxySQL keeps certain connections open and +reuses them or closes them if not reused within a specific time. You connect to the +proxy, and it forwards your requests to the cluster. -ProxySQL maintains the connection pool. The pool allows a certain number of connections to remain open. A connection is reused or closed if not reused within a specific time. You connect to the proxy and the tool forwards your requests to the cluster. +ProxySQL operates as a daemon monitored by a process that can restart it in case of +an unexpected exit, minimizing downtime. The daemon accepts traffic from MySQL +clients and forwards it to backend MySQL servers. -*ProxySQL* runs as a daemon watched by a monitoring process which can restart *ProxySQL* in case of an unexpected exit to minimize downtime. The daemon accepts incoming traffic from *MySQL* clients and forwards the traffic to backend *MySQL* servers. +Configuration options include runtime parameters, server grouping, and +traffic-related parameters, many of which can be set at runtime using SQL-like +queries. -The configuration options include runtime parameters, server grouping, and traffic-related parameters. Many of the settings can be done at runtime using queries that are similar to SQL statements. +The [ProxySQL 2 documentation](https://proxysql.com/documentation/) provides details +on installation, running ProxySQL, and using the ProxySQL admin tools. The maintained releases are listed on +[ProxySQL Installation](https://proxysql.com/documentation/installing-proxysql/). -The [ProxySQL documentation](https://proxysql.com/documentation/) provides information on installing and running ProxySQL and the ProxySQL admin tools. +You can [download ProxySQL 2.x.x](https://www.percona.com/download-proxysql). Note that +version 1 is no longer actively maintained. +ProxySQL 2.x.x downloads include: -ProxySQL is available from the Percona software repositories with the following: +- [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) simplifies + the configuration of Percona XtraDB Cluster nodes with ProxySQL. -* ProxySQL 1.x.x downloads include: +- [pxc_scheduler_handler](build-psh.md) automatically performs failovers due to + node failures, service degradation, or maintenance. Available from + [ProxySQL 2.3.2-1.2](./release-notes-2.3.2-1.md) and higher. - * [ProxySQL Admin 1.x.x](proxysql-v1.md) does not natively support *Percona XtraDB Cluster* and requires custom `Bash` scripts to track the status of a *Percona XtraDB Cluster*. - -* ProxySQL 2.x.x downloads include: +In a MySQL 8.4 or Percona Server for MySQL 8.4 environment, you may face these +issues: - * [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) simplifies the configuration of *Percona XtraDB Cluster* nodes with ProxySQL. +- ProxySQL contains counters that have not been updated to use the new terminology, + leading to unexpected results. - * [pxc_scheduler_handler](build-psh.md) can automatically perform a failover due to node failures, service degradation, or maintenance. This utility is available from [ProxySQL 2.3.2-1.2](./release-notes-2.3.2-1.md) and higher. - -In an MySQL 8.4 or Percona Server for MySQL 8.4 environment, you may have the following issues: - -* ProxySQL contains counters that have not been updated to use the new terminology. Unexpected results may occur -* The binlog reader errors out during initialization due to the use of the old terminology, such as SHOW MASTER STATUS command. +- The binlog reader errors out during initialization due to the use of old + terminology, such as the the `SHOW MASTER STATUS` command \ No newline at end of file diff --git a/docs/install-proxysql2-tarball.md b/docs/install-proxysql2-tarball.md index 38d3073..64981f3 100644 --- a/docs/install-proxysql2-tarball.md +++ b/docs/install-proxysql2-tarball.md @@ -69,16 +69,16 @@ Follow these steps: 7. Create a directory to store the _ProxySQL_ data. - ```{.bash data-prompt="$"} - $ mkdir /home/user/data - ``` + ```{.bash data-prompt="$"} + $ mkdir /home/user/data + ``` 8. In the configuration file, update the `datadir` value to point to the created data directory. - ```{.text .no-copy} - datadir="/home/user/data" - ``` + ```{.text .no-copy} + datadir="/home/user/data" + ``` 9. Set the other options, as needed. diff --git a/docs/installing-v1.md b/docs/installing-v1.md deleted file mode 100644 index 096bec2..0000000 --- a/docs/installing-v1.md +++ /dev/null @@ -1,30 +0,0 @@ -# Install ProxySQL 1.x.x - -If that is what you used to [install PXC](https://www.percona.com/doc/percona-xtradb-cluster/5.7/install/index.html) or -any other **Percona** software, run the corresponding command: - -On Debian or Ubuntu: - -```{.bash data-prompt="$"} -$ sudo apt install proxysql -``` - -On Red Hat Enterprise Linux or CentOS: - -```{.bash data-prompt="$"} -$ sudo yum install proxysql -``` - -To start *ProxySQL*, run the following command: - -```{.bash data-prompt="$"} -$ sudo service proxysql start -``` - -## Do not use the default credentials - -!!! warning - - Do not run ProxySQL with default credentials in production. - -Before starting the proxysql service, you can change the defaults in `/etc/proxysql.cnf` by changing the `admin_credentials` variable. For more information, see [ProxySQL global variables](https://github.com/sysown/proxysql/blob/master/doc/global_variables.md). diff --git a/docs/proxysql-admin-tool-functions.md b/docs/proxysql-admin-tool-functions.md index 6bf5670..698271f 100644 --- a/docs/proxysql-admin-tool-functions.md +++ b/docs/proxysql-admin-tool-functions.md @@ -165,8 +165,8 @@ syncing proxysql instances that manage multiple clusters. ## –-add-query-rule Create query rules for synced mysql user. This is applicable only for -singlewrite mode and works only with [--syncusers](#--syncusers) -and [–sync-multi-cluster-users](#sync-multi-cluster-users) options. +singlewrite mode and works only with `--syncusers` +and `–-sync-multi-cluster-users` options. ```bash Syncing user accounts from PXC to ProxySQL diff --git a/docs/proxysql-v1.md b/docs/proxysql-v1.md deleted file mode 100644 index b9c2b93..0000000 --- a/docs/proxysql-v1.md +++ /dev/null @@ -1,424 +0,0 @@ -# Use ProxySQL 1.x.x with ProxySQL Admin - -*ProxySQL* version 1.4.x does not natively support *Percona XtraDB Cluster* and proxysql-admin and requires custom bash scripts to keep track of *Percona XtraDB Cluster* status: -proxysql_galera_checker and proxysql_node_monitor. - -## Automatic configuration - -The `proxysql` package from *Percona* includes the *proxysql-admin* tool for configuring *Percona XtraDB Cluster* nodes with *ProxySQL*. - -!!! note - - The proxysql-admin script is specially developed by *Percona* to automate the *ProxySQL* configuration. Bug reports and feature proposals are welcome in the proxysql-admin [issue tracking system](https://jira.percona.com/projects/PSQLADM). - - The proxysql-admin tool can only be used for the *initial* *ProxySQL* configuration. - -To view usage information, run `proxysql-admin` without any options: - -```{.text .no-copy} -Usage: [ options ] -Options: ---config-file= Read login credentials from a configuration file - (command line options override any configuration file login credentials) ---proxysql-datadir= Specify the proxysql data directory location ---proxysql-username=user_name ProxySQL service username ---proxysql-password[=password] ProxySQL service password ---proxysql-port=port_num ProxySQL service port number ---proxysql-hostname=host_name ProxySQL service hostname ---cluster-username=user_name Percona XtraDB Cluster node username ---cluster-password[=password] Percona XtraDB Cluster node password ---cluster-port=port_num Percona XtraDB Cluster node port number ---cluster-hostname=host_name Percona XtraDB Cluster node hostname ---cluster-app-username=user_name Percona XtraDB Cluster node application username ---cluster-app-password[=password] Percona XtraDB Cluster node application password ---without-cluster-app-user Configure Percona XtraDB Cluster without application user ---monitor-username=user_name Username for monitoring Percona XtraDB Cluster nodes through ProxySQL ---monitor-password[=password] Password for monitoring Percona XtraDB Cluster nodes through ProxySQL ---use-existing-monitor-password Do not prompt for a new monitor password if one is provided. ---node-check-interval=3000 Interval for monitoring node checker script (in milliseconds) - (default: 3000) ---mode=[loadbal|singlewrite] ProxySQL read/write configuration mode - currently supporting: 'loadbal' and 'singlewrite' - (default: 'singlewrite') ---write-node=host_name:port Writer node to accept write statments. - This option is supported only when using --mode=singlewrite - Can accept comma-delimited list with the first listed being - the highest priority. ---include-slaves=host_name:port Add specified slave node(s) to ProxySQL, these nodes will go - into the reader hostgroup and will only be put into - the writer hostgroup if all cluster nodes are down (this - depends on the value of --use-slave-as-writer). - Slaves must be read only. Can accept a comma-delimited list. - If used, make sure 'read_only=1' is in the slave's my.cnf ---use-slave-as-writer= If this value is 'yes', then a slave may be used as a writer - if the entire cluster is down. If 'no', then a slave - will not be used as a writer. This option is required - if '--include-slaves' is used. ---writer-is-reader= Defines if the writer node also accepts writes. - Possible values are 'always', 'never', and 'ondemand'. - 'ondemand' means that the writer node only accepts reads - if there are no other readers. - (default: 'ondemand') ---max-connections= Value for max_connections in the mysql_servers table. - This value is the maximum number of connections that - ProxySQL will open to the backend servers. - (default: 1000) ---debug Enables additional debug logging. ---help Displays this help text. - -These options are the possible operations for proxysql-admin. -You must provide one of the options. ---adduser Adds the Percona XtraDB Cluster application user to the ProxySQL database ---disable, -d Remove any Percona XtraDB Cluster configurations from ProxySQL ---enable, -e Auto-configure Percona XtraDB Cluster nodes into ProxySQL ---quick-demo Setup a quick demo with no authentication ---syncusers Sync user accounts currently configured in MySQL to ProxySQL - May be used with --enable. - (deletes ProxySQL users not in MySQL) ---sync-multi-cluster-users Sync user accounts currently configured in MySQL to ProxySQL - May be used with --enable. - (doesn't delete ProxySQL users not in MySQL) ---version, -v Print version info -``` - -!!! note - - The *Percona XtraDB Cluster* nodes and *ProxySQL* must be available before using the proxysql-admin tool. For security purposes, change the default user settings in the *ProxySQL* configuration file. - -## Prepare a configuration file - -We recommend providing the connection and authentication information -in the *ProxySQL* configuration file (/etc/proxysql-admin.cnf), -instead of specifying this information on the command line. - -By default, the configuration file contains the following: - -```{.text .no-copy} -# proxysql admin interface credentials. -export PROXYSQL_DATADIR='/var/lib/proxysql' -export PROXYSQL_USERNAME='admin' -export PROXYSQL_PASSWORD='admin' -export PROXYSQL_HOSTNAME='localhost' -export PROXYSQL_PORT='6032' - -# PXC admin credentials for connecting to pxc-cluster-node. -export CLUSTER_USERNAME='admin' -export CLUSTER_PASSWORD='admin' -export CLUSTER_HOSTNAME='localhost' -export CLUSTER_PORT='3306' - -# proxysql monitoring user. proxysql admin script will create this user in pxc to monitor pxc-nodes. -export MONITOR_USERNAME='monitor' -export MONITOR_PASSWORD='monit0r' - -# Application user to connect to pxc-node through proxysql -export CLUSTER_APP_USERNAME='proxysql_user' -export CLUSTER_APP_PASSWORD='passw0rd' - -# *ProxySQL* read/write hostgroup -export WRITE_HOSTGROUP_ID='10' -export READ_HOSTGROUP_ID='11' - -# *ProxySQL* read/write configuration mode. -export MODE="singlewrite" - -# Writer-is-reader configuration -export WRITER_IS_READER="ondemand" - -# max_connections default (used only when INSERTing a new mysql_servers entry) -export MAX_CONNECTIONS="1000" -``` - -!!! note - - We recommend that you change the default *ProxySQL* credentials before running *ProxySQL* in production. Make sure that you provide *ProxySQL* location and credentials in the configuration file. See [Do not use the default credentials](#do-not-use-the-default-credentials). Provide superuser credentials for one of the *Percona XtraDB Cluster* nodes. The `proxysql-admin` script will detect other nodes in the cluster automatically. - -## Enabling ProxySQL - -Use the `--enable` option to automatically configure a *Percona XtraDB Cluster* node -into *ProxySQL*. The `proxysql-admin` tool will do the following: - -* Add a *Percona XtraDB Cluster* node into the *ProxySQL* database - -* Add the `proxysql_galera_checker` monitoring script into the [ProxySQL scheduler](https://github.com/sysown/proxysql/blob/master/doc/scheduler.md) table if it is not available. This script checks for desynced nodes and temporarily deactivates them. It also calls the `proxysql_node_monitor` script, which checks cluster node membership and re-configures *ProxySQL* if the membership changes. - -* Create two new *Percona XtraDB Cluster* users with the `USAGE` privilege on the node and add them to *ProxySQL* configuration if they are not already configured. *ProxySQL* uses one user for monitoring cluster nodes, and the other one is used for communicating with the cluster. Make sure to use superuser credentials from cluster to set up the default users. - -!!! warning - - Running more than one copy of `proxysql_galera_check` in the same runtime environment simultaneously is not supported and may lead to undefined behavior. To avoid this problem, Galera process identification prevents a duplicate script execution in most cases. However, in some rare cases, it may be possible to circumvent this check if you run more than one copy of `proxysql_galera_check`. - -The following example shows how to add a *Percona XtraDB Cluster* node -using the *ProxySQL* configuration file -with all necessary connection and authentication information: - -```{.bash data-prompt="$"} -$ proxysql-admin --config-file=/etc/proxysql-admin.cnf --enable -``` - -??? example "Expected output" - - ```{.text .no-copy} - This script will assist with configuring ProxySQL for use with - Percona XtraDB Cluster (currently, only PXC in combination with ProxySQL is supported) - - ProxySQL read/write configuration mode is singlewrite - - Configuring the ProxySQL monitoring user. ProxySQL monitor user name as per - command line/config-file is monitor - - User 'monitor'@'127.%' has been added with USAGE privileges - - Configuring the Percona XtraDB Cluster application user to connect through ProxySQL - Percona XtraDB Cluster application user name as per command line/config-file is proxysql_user - - Percona XtraDB Cluster application user 'proxysql_user'@'127.%' has been added with ALL privileges. This user is created for testing purposes. - Adding the Percona XtraDB Cluster server nodes to ProxySQL - - Write node info - - +-----------+--------------+-------+--------+ - | hostname | hostgroup_id | port | weight | - +-----------+--------------+-------+--------+ - | 127.0.0.1 | 10 | 26100 | 1000 | - +-----------+--------------+-------+--------+ - - ProxySQL configuration completed! - - ProxySQL has been successfully configured to use with Percona XtraDB Cluster - - You can use the following login credentials to connect your application through ProxySQL - - $ mysql --user=proxysql_user -p --host=localhost --port=6033 --protocol=tcp - ``` - -```{.bash data-prompt="mysql>"} -mysql> select hostgroup_id,hostname,port,status,comment from mysql_servers; -``` - -??? example "Expected output" - - ```{.text .no-copy} - +--------------+-----------+-------+--------+---------+ - | hostgroup_id | hostname | port | status | comment | - +--------------+-----------+-------+--------+---------+ - | 11 | 127.0.0.1 | 25400 | ONLINE | READ | - | 10 | 127.0.0.1 | 25000 | ONLINE | WRITE | - | 11 | 127.0.0.1 | 25100 | ONLINE | READ | - | 11 | 127.0.0.1 | 25200 | ONLINE | READ | - | 11 | 127.0.0.1 | 25300 | ONLINE | READ | - +--------------+-----------+-------+--------+---------+ - 5 rows in set (0.00 sec) - ``` - -## Disabling ProxySQL - -Use the `--disable` option to remove a *Percona XtraDB Cluster* node’s configuration -from *ProxySQL*. -The `proxysql-admin` tool will do the following: - -* Remove *Percona XtraDB Cluster* node from the *ProxySQL* database - -* Stop the *ProxySQL* monitoring daemon for this node - -* Remove the application user for this cluster - -* Remove any query rules set up for this cluster - -The following example shows how to disable *ProxySQL* and remove the *Percona XtraDB Cluster* node: - -```{.bash data-prompt="$"} -$ proxysql-admin --config-file=/etc/proxysql-admin.cnf --disable -*ProxySQL* configuration removed! -``` - -## Additional options - -The following extra options can be used: - -* `--adduser` - - Add *Percona XtraDB Cluster* application user to *ProxySQL* database. - - ```{.bash data-prompt="$"} - $ proxysql-admin --config-file=/etc/proxysql-admin.cnf --adduser - ``` - - ??? example "Expected output" - - ```{.text .no-copy} - Adding Percona XtraDB Cluster application user to *ProxySQL* database - Enter Percona XtraDB Cluster application user name: cluster_user - Enter Percona XtraDB Cluster application user password: cluster_passw0Rd - Added Percona XtraDB Cluster application user to *ProxySQL* database! - ``` - -* `--syncusers` - -Sync user accounts currently configured in *Percona XtraDB Cluster* to *ProxySQL* database -except for users with no password and the `admin` user. - -!!! warning - - This option also deletes users that are not in *Percona XtraDB Cluster* from *ProxySQL* database. - -* `--sync-multi-cluster-users` - -This option works in the same way as `--syncusers`, but it does not delete *ProxySQL* -users that are not present in the Percona XtraDB Cluster. It is to be used when -syncing proxysql instances that manage multiple clusters. - -* `--node-check-interval` - -This option configures the interval for monitoring via the -`proxysql_galera_checker` script (in milliseconds). - -```{.bash data-prompt="$"} -$ proxysql-admin --config-file=/etc/proxysql-admin.cnf \ ---node-check-interval=5000 --enable -``` - -* `--mode` - -Set the read/write mode for *Percona XtraDB Cluster* nodes in *ProxySQL* database, based on the hostgroup. - -Supported modes are `loadbal` and `singlewrite`. - -* `singlewrite` is the default mode, it will accept writes only on one single node (based on the info you provide in `--write-node`). The remaining nodes will accept only read statements. - - Servers can be separated by commas, for example: - - ```{.text .no-copy} - 10.0.0.51:3306,10.0.0.52:3306 - ``` - - In the previous example, `10.0.0.51:3306` will be in the writer hostgroup if it is ONLINE. If it is OFFLINE, then `10.0.0.52:3306` will go into the writer hostgroup. And if that node also goes down, then one of the remaining nodes will be randomly chosen for the writer hostgroup. The configuration file is deleted when `--disable` is used. - -* `singlewrite` mode setup: - - ```{.bash data-prompt="$"} - $ sudo grep "MODE" /etc/proxysql-admin.cnf - export MODE="singlewrite" - $ sudo proxysql-admin --config-file=/etc/proxysql-admin.cnf --write-node=127.0.0.1:25000 --enable - *ProxySQL* read/write configuration mode is singlewrite - [..] - *ProxySQL* configuration completed! - ``` - - To check the configuration you can run: - - ```{.bash data-prompt="mysql>"} - mysql> SELECT hostgroup_id,hostname,port,status,comment FROM mysql_servers; - +--------------+-----------+-------+--------+---------+ - | hostgroup_id | hostname | port | status | comment | - +--------------+-----------+-------+--------+---------+ - | 11 | 127.0.0.1 | 25400 | ONLINE | READ | - | 10 | 127.0.0.1 | 25000 | ONLINE | WRITE | - | 11 | 127.0.0.1 | 25100 | ONLINE | READ | - | 11 | 127.0.0.1 | 25200 | ONLINE | READ | - | 11 | 127.0.0.1 | 25300 | ONLINE | READ | - +--------------+-----------+-------+--------+---------+ - 5 rows in set (0.00 sec) - ``` - -* The `loadbal` mode uses a set of evenly weighted read/write nodes. - - `loadbal` mode setup: - - ```{.bash data-prompt="$"} - $ sudo proxysql-admin --config-file=/etc/proxysql-admin.cnf --mode=loadbal --enable - - This script will assist with configuring *ProxySQL* (currently only Percona XtraDB cluster in combination with *ProxySQL* is supported) - - *ProxySQL* read/write configuration mode is loadbal - [..] - *ProxySQL* has been successfully configured to use with Percona XtraDB Cluster - - You can use the following login credentials to connect your application through *ProxySQL* - - mysql --user=proxysql_user --password=*** --host=127.0.0.1 --port=6033 --protocol=tcp - ``` - - ```{.bash data-prompt="mysql>"} - mysql> SELECT hostgroup_id,hostname,port,status,comment FROM mysql_servers; - +--------------+-----------+-------+--------+-----------+ - | hostgroup_id | hostname | port | status | comment | - +--------------+-----------+-------+--------+-----------+ - | 10 | 127.0.0.1 | 25400 | ONLINE | READWRITE | - | 10 | 127.0.0.1 | 25000 | ONLINE | READWRITE | - | 10 | 127.0.0.1 | 25100 | ONLINE | READWRITE | - | 10 | 127.0.0.1 | 25200 | ONLINE | READWRITE | - | 10 | 127.0.0.1 | 25300 | ONLINE | READWRITE | - +--------------+-----------+-------+--------+-----------+ - 5 rows in set (0.01 sec) - ``` - -* `--quick-demo` - - This option is used to setup dummy *ProxySQL* configuration. - - ```{.bash data-prompt="$"} - $ sudo proxysql-admin --enable --quick-demo - ``` - -??? example "Expected output" - - ```{.text .no-copy} - You have selected the dry test run mode. WARNING: This will create a test user (with all privileges) in the Percona XtraDB Cluster & *ProxySQL* installations. - - You may want to delete this user after you complete your testing! - - Would you like to proceed with '--quick-demo' [y/n] ? y - - Setting up proxysql test configuration! - - Do you want to use the default *ProxySQL* credentials (admin:admin:6032:127.0.0.1) [y/n] ? y - Do you want to use the default Percona XtraDB Cluster credentials (root::3306:127.0.0.1) [y/n] ? n - - Enter the Percona XtraDB Cluster username (super user): root - Enter the Percona XtraDB Cluster user password: - Enter the Percona XtraDB Cluster port: 25100 - Enter the Percona XtraDB Cluster hostname: localhost - - - *ProxySQL* read/write configuration mode is singlewrite - - Configuring *ProxySQL* monitoring user.. - - User 'monitor'@'127.%' has been added with USAGE privilege - - Configuring the Percona XtraDB Cluster application user to connect through *ProxySQL* - - Percona XtraDB Cluster application user 'pxc_test_user'@'127.%' has been added with ALL privileges, this user is created for testing purposes - - Adding the Percona XtraDB Cluster server nodes to *ProxySQL* - - *ProxySQL* configuration completed! - - *ProxySQL* has been successfully configured to use with Percona XtraDB Cluster - - You can use the following login credentials to connect your application through *ProxySQL* - - mysql --user=pxc_test_user --host=127.0.0.1 --port=6033 --protocol=tcp - ``` - -* `--include-slaves=host_name:port` - -This option helps to include specified slave node(s) to *ProxySQL* database. -These nodes will go into the reader hostgroup and will only be put into the -writer hostgroup if all cluster nodes are down. Slaves must be read only. Can accept comma-delimited list. If this is used, make sure `read_only=1` is included into the slave’s `my.cnf` configuration file. - -!!! note - - With `loadbal` mode slave hosts only accept read/write requests when all cluster nodes are down. - -## proxysql_status script - -There is a simple script to dump *ProxySQL* configuration and statistics: - -```{.text .no-copy} -Usage: - -proxysql-status admin admin 127.0.0.1 6032 -``` - diff --git a/docs/psh-detailed-options.md b/docs/psh-detailed-options.md index 6193b01..04cd2cc 100644 --- a/docs/psh-detailed-options.md +++ b/docs/psh-detailed-options.md @@ -4,40 +4,40 @@ The pxc_scheduler_handler script lists the available options in the pxc_schedule | Option Name | |---------------------------------------------------------| -| [--add-query-rule](#-add-query-rule) | -| [--adduser](#-adduser) | -| [--auto-assign-weights](#-auto-assign-weights) | -| [--config-file](#-config-file) | -| [--debug](#-debug) | -| [--disable/-d](#-disable-d) | -| [--enable/-e](#-enable-e) | -| [--force](#-force) | -| [--help](#-help)| -| [--is-enabled](#-is-enabled) | -| [--LockRefreshTime](#-lockrefreshtime) | -| [--server](#-server) | -| [--status](#-status) | -| [--sync-multi-cluster-users](#-sync-multi-cluster-users) | -| [--syncusers](#-syncusers) | -| [--trace][trace] | -| [--update-cluster](#-update-cluster) | -| [--update-mysql-version](#-update-mysql-version) | -| [--update-read-weight](#-update-read-weight) | -| [--update-write-weight](#-update-write-weight) | -| [--use-stdin-for-credentials](#-use-stdin-for-credentials) | -| [--version](#-version) | -| [--write-node](#-write-node) | - -## -–add-query-rule +| [add-query-rule](#add-query-rule) | +| [adduser](#adduser) | +| [auto-assign-weights](#auto-assign-weights) | +| [config-file](#config-file) | +| [debug](#debug) | +| [disable/-d](#disable) | +| [enable/-e](#enable) | +| [force](#force) | +| [help](#help)| +| [is-enabled](#is-enabled) | +| [LockRefreshTime](#lockrefreshtime) | +| [server](#server) | +| [status](#status) | +| [sync-multi-cluster-users](#sync-multi-cluster-users) | +| [syncusers](#syncusers) | +| [trace](#trace) | +| [update-cluster](#update-cluster) | +| [update-mysql-version](#update-mysql-version) | +| [update-read-weight](#update-read-weight) | +| [update-write-weight](#update-write-weight) | +| [use-stdin-for-credentials](#use-stdin-for-credentials) | +| [version](#version) | +| [write-node](#write-node) | + +## add-query-rule This option creates query rules for a synced MySQL user and applies only to the `singlewrite` mode. -### --add-query-rule requires +### add-query-rule requires -Either the –syncusers or –sync-multi-cluster-users options. +Either the [`syncusers`](#syncusers) or [`sync-multi-cluster-users`](#sync-multi-cluster-users) options. -### --add-query-rule example +### add-query-rule example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --syncusers @@ -60,11 +60,11 @@ $ percona-scheduler-admin --config-file=config.toml --syncusers Synced PXC users to the ProxySQL database! ``` -## –-adduser +## adduser This option adds the cluster application user account to the ProxySQL database. -### –-adduser example +### adduser example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --adduser @@ -85,13 +85,13 @@ $ percona-scheduler-admin --config-file=config.toml --adduser Added PXC application user to the ProxySQL database! ``` -## –-auto-assign-weights +## auto-assign-weights ProxySQL uses weights for defining the failover procedure in `singlewrite` mode and handling load balancing `loadbal` mode. For the failover procedure, this option with the -[--update-cluster](#update-cluster) option assigns weights to the PXC nodes when the cluster is +[update-cluster](#update-cluster) option assigns weights to the PXC nodes when the cluster is in `singlewrite` mode. As a best practice, ensure that the writer node election operation returns the @@ -134,7 +134,7 @@ The following example is a default configuration when the Cluster membership updated in the ProxySQL database! ``` -### --auto-assign-weights example +### auto-assign-weights example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --update-cluster --auto-assign-weights @@ -163,19 +163,21 @@ $ percona-scheduler-admin --config-file=config.toml --update-cluster --auto-assi Cluster membership updated in the ProxySQL database! ``` -## --config-file +## config-file This option reads the login credentials from a configuration file. Command-line options override configuration file values. For more information, see [pxc_scheduler_handler configuration](./psh-configuration.md). -## --debug +## debug This option enables additional debug logging. -## –-disable / -d +## disable This option removes Percona XtraDB Cluster nodes from ProxySQL and stops the ProxySQL monitoring daemon. -### --disable example +You also use `-d`, which a short version of the option. + +### disable example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --disable @@ -189,7 +191,7 @@ $ percona-scheduler-admin --config-file=config.toml --disable Removing query rules from the ProxySQL database if any. ``` -## --disable_updates +## disable_updates This option can be used with any command to disable updating the pxc_scheduler_handler checksum for the `mysql_query_rules`, @@ -202,7 +204,7 @@ Specifying this option sets the following values to `false`: * admin-checksum_mysql_servers * admin_checksum_mysql_users -## –-enable / -e +## enable This option creates the entries for the Galera hostgroups and adds the Percona XtraDB Cluster nodes into ProxySQL’s `mysql_servers` table. @@ -216,7 +218,9 @@ privilege. The users have the following tasks: You must have [`super`](https://dev.mysql.com/doc/refman/8.0/en/privileges-provided.html#priv_super) user credentials from Percona XtraDB Cluster to set up the default users. -### --enable example +You also use `-e` which is the short version of the option. + +### enable example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --enable @@ -265,7 +269,7 @@ $ percona-scheduler-admin --config-file=config.toml --enable ProxySQL has been successfully configured to use with Percona XtraDB Cluster -### Verify -enable example +### Verify enable example You can verify the successful configuration with the following command: @@ -454,18 +458,18 @@ mysql> select * from scheduler\G 1 row in set (0.00 sec) ``` -## –-force +## force -This option must be combined with either [–enable / -e](#enable---e) or -[–update-cluster](#update-cluster). This option skips any `mysql_servers` table, +This option must be combined with either [enable or -e](#enable) or +[update-cluster](#update-cluster). This option skips any `mysql_servers` table, `mysql_users` table, and `mysql_galera_hostgroups` table configuration checks. Certain checks issue warnings, instead of errors, which allows the option to continue processing. -## --help +## help This option displays the help text. -## –-is-enabled +## is-enabled This option checks if `pxc_scheduler_handler` configured the hostgroups in ProxySQL. @@ -473,7 +477,7 @@ Returns a zero (0) if an entry corresponds to the writer hostgroup and is set to Returns a one (1) if an entry does not correspond to the writer hostgroup. -### --is-enabled example +### is-enabled example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --is-enabled @@ -485,7 +489,7 @@ $ percona-scheduler-admin --config-file=config.toml --is-enabled The current configuration has been enabled and is active ``` -### --is-enabled verification example +### is-enabled verification example Verify if `pxc_scheduler_handler` configured the hostgroups in ProxySQL. @@ -499,7 +503,7 @@ $ echo $? 0 ``` -### --is-enabled example with cluster disabled +### is-enabled example with cluster disabled Disabling the cluster configuration and then calling the option creates an error. @@ -530,40 +534,40 @@ $ percona-scheduler-admin --config-file=config.toml --is-enabled ERROR (line:2450) : The current configuration has not been enabled ``` -## --LockRefreshTime +## LockRefreshTime Implemented in [ProxySQL 2.5.5-1.2]. The time, measured in seconds, after which the scheduler refreshes the epoch inside the ProxySQL server table. This parameter reduces the frequency of ProxySQL updates. -## –-remove-all-servers +## remove-all-servers -When used with [--update-cluster](#update-cluster) this option removes -all servers belonging to the current cluster before running the [--update-cluster](#update-cluster) option. +When used with [update-cluster](#update-cluster) this option removes +all servers belonging to the current cluster before running the [update-cluster](#update-cluster) option. -### --remove-all-server example +### remove-all-server example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --remove-all-servers --update-cluster ``` -## –-server +## server Selects a server by the IP address and port. This option can be -combined with [--syncusers](#syncusers) or [–sync-multi-cluster-users](#sync-multi-cluster-users) to sync a single non-cluster server. The option does not require that the server belong to a *Percona XtraDB Cluster*. +combined with [syncusers](#syncusers) or [sync-multi-cluster-users](#sync-multi-cluster-users) to sync a single non-cluster server. The option does not require that the server belong to a Percona XtraDB Cluster. -### -server example +### server example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --server=192.168.56.32:3306 ``` -## –-status +## status This option displays information about all Galera hostgroups and their servers supported by this ProxySQL instance. -### --status example +### status example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --status @@ -589,7 +593,7 @@ $ percona-scheduler-admin --config-file=config.toml --status +---------------+-------+---------------+------+--------+--------+----------+---------+-----------+ ``` -## –-sync-multi-cluster-users +## sync-multi-cluster-users Use this option to sync proxysql instances that manage multiple clusters. @@ -599,9 +603,9 @@ This option does the following: * Keeps ProxySQL users that are not present in the Percona XtraDB Cluster -To sync a specific server combine this option with the [--server](#server) option. +To sync a specific server combine this option with the [server](#server) option. -## –-syncusers +## syncusers This option does the following: @@ -609,12 +613,12 @@ This option does the following: * Deletes ProxySQL user accounts that are not also in Percona XtraDB Cluster from the ProxySQL database. -To sync a specific server combine this option with the [--server](#server) option. +To sync a specific server combine this option with the [server](#server) option. Review the user accounts in the ProxySQL database as root from ProxySQL database. -### --syncusers example +### syncusers example ```sql proxysql admin#> SELECT DISTINCT username FROM mysql_users; @@ -689,11 +693,11 @@ proxysql-admin> SELECT DISTINCT username FROM mysql_users; 2 rows in set (0.00 sec) ``` -## --trace +## trace This option enables shell-level tracing for this shell script. -## –-update-cluster +## update-cluster This option checks the *Percona XtraDB Cluster* for new nodes. If nodes are found, they are added to ProxySQL. By default, offline nodes are not removed from the cluster. @@ -733,11 +737,11 @@ $ percona-scheduler-admin --config-file=config.toml --write-node=127.0.0.1:4130 Cluster membership updated in the ProxySQL database! ``` -## –-update-mysql-version +## update-mysql-version This option updates the mysql server version in the proxysql db based on the online writer node. -### --update-mysql-version example +### update-mysql-version example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --update-mysql-version @@ -749,7 +753,7 @@ $ percona-scheduler-admin --config-file=config.toml --update-mysql-version ProxySQL MySQL version changed to 8.0.27 ``` -## –-update-read-weight +## update-read-weight Combining –update-cluster with this option assigns the specified read weight to a node. @@ -758,7 +762,7 @@ The syntax for the arguments are: and . The format can be either Internet Protocol version 4 (IPv4) or Internet Protocol version 6 (IPv6). -### --update-read-weight example +### update-read-weight example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --update-cluster --update-read-weight=", " @@ -818,16 +822,16 @@ $ percona-scheduler-admin --config-file=config.toml --update-cluster --update-re Cluster membership updated in the ProxySQL database! ``` -## –-update-write-weight +## update-write-weight -Combining this option with [--update-cluster](#update-cluster) assigns the +Combining this option with [update-cluster](#update-cluster) assigns the specified write weight to a node. The syntax for the arguments are: and . The format can be either Internet Protocol version 4 (IPv4) or Internet Protocol version 6 (IPv6). -### --update-write-weight example +### update-write-weight example ```sql $ percona-scheduler-admin --config-file=config.toml --update-cluster --update-write-weight=", " @@ -887,24 +891,24 @@ $ percona-scheduler-admin --config-file=config.toml --update-cluster --update-wr Cluster membership updated in the ProxySQL database! ``` -## --use-stdin-for-credentials +## use-stdin-for-credentials This option uses `stdin` to send credentials to the MySQL client instead of process substitution. The default setting disables the option and uses process substitution. -## --version +## version This option prints the version information. -## –-write-node +## write-node This option chooses which Percona XtraDB Cluster node is the writer -node when the mode is `singlewrite`. You can combine this option with –enable / -e and –update-cluster. +node when the mode is `singlewrite`. You can combine this option with [enable / -e](#enable) and [update-cluster](#update-cluster). The option requires only a single IP address and port combination. -Assigning a node with [--write-node](#write-node) gives the writer node a weight of 1000000. The default weight is 1000. +Assigning a node with `write-node` gives the writer node a weight of 1000000. The default weight is 1000. -### --write-node example +### write-node example The argument syntax is a single IP address and port combination. @@ -912,6 +916,6 @@ The argument syntax is a single IP address and port combination. $ percona-scheduler-admin --config-file=config.toml --write-node=192.168.56.32:3306 ``` -[trace]: #-trace +[trace]: #trace [ProxySQL 2.5.5-1.2]: 2.5.5-1.2.md diff --git a/docs/psh-known-limitations.md b/docs/psh-known-limitations.md index f548ede..32794fc 100644 --- a/docs/psh-known-limitations.md +++ b/docs/psh-known-limitations.md @@ -6,11 +6,11 @@ This document lists the known issues in the pxc_scheduler_handler. The following options are mutually exclusive. An attempt to combine these options in a command creates in an error and no action is taken. -* [-–update-write-weight](./psh-detailed-options.md#-update-write-weight) and [-–auto-assign-weights](./psh-detailed-options.md#-auto-assign-weights) +* [-–update-write-weight](psh-detailed-options.md#update-write-weight) and [-–auto-assign-weights](psh-detailed-options.md#auto-assign-weights) -* [-–write-node](./psh-detailed-options.md#-write-node) and [-–auto-assign-weights](./psh-detailed-options.md#-auto-assign-weights) +* [-–write-node](psh-detailed-options.md#write-node) and [-–auto-assign-weights](psh-detailed-options.md#auto-assign-weights) -* [-–write-node](./psh-detailed-options.md#-write-node) and [-–update-write-weight](./psh-detailed-options.md#-update-write-weight) +* [-–write-node](psh-detailed-options.md#write-node) and [-–update-write-weight](psh-detailed-options.md#update-write-weight) ## Do not place the log file or lock file in the Home directory diff --git a/docs/psh-options.md b/docs/psh-options.md index 7ab64be..bd2c26b 100644 --- a/docs/psh-options.md +++ b/docs/psh-options.md @@ -19,7 +19,7 @@ ERROR : The --config-file option is required but is missing from the command. The options determine what the statement does. The pxc_scheduler_handler statement must include at least one option. A command without an option returns an error and nothing happens. -For most options, two hyphens (--) precede an option name. The [disable](./psh-detailed-options.md#-disable---d) and the [enable](./psh-detailed-options.md#–enable---e) option can be selected with one hyphen (-) and the appropriate abbreviation. +For most options, two hyphens (--) precede an option name. The [disable](psh-detailed-options.md#disable) and the [enable](psh-detailed-options.md#enable) option can be selected with one hyphen (-) and the appropriate abbreviation. For example, the following commands return the same result: diff --git a/docs/release-notes-1.4.12.md b/docs/release-notes-1.4.12.md deleted file mode 100644 index a211cf4..0000000 --- a/docs/release-notes-1.4.12.md +++ /dev/null @@ -1,45 +0,0 @@ -# ProxySQL 1.4.12 and proxysql-admin (2018-11-13) - -* **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -*ProxySQL* release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -*ProxySQL* is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created *ProxySQL* for DBAs as a means of solving -complex replication topology issues. - -The *ProxySQL* 1.4.12 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include **ProxySQL Admin** – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into *ProxySQL*. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). *ProxySQL* offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -## Improvements - -* [PSQLADM-68](https://jira.percona.com/browse/PSQLADM-68): Scripts are now compatible with *Percona XtraDB Cluster (PXC)* hosts using IPv6 - -* [PSQLADM-107](https://jira.percona.com/browse/PSQLADM-107): In include-slaves, a slave would always be moved into the write hostgroup even if the whole cluster went down. A new option –use-slave-as-writer specifies whether or not the slave is added to the write hostgroup. - -## Bugs Fixed - -* [PSQLADM-110](https://jira.percona.com/browse/PSQLADM-110): In some cases, pattern cluster hostname did not work with proxysql-admin. - -* [PSQLADM-104](https://jira.percona.com/browse/PSQLADM-104): proxysql-admin testsuite bug fixes. - -* [PSQLADM-113](https://jira.percona.com/browse/PSQLADM-113): `proxysql_galera_checker` assumed that parameters were given in the long format. - -* [PSQLADM-114](https://jira.percona.com/browse/PSQLADM-114): In some cases, *ProxySQL* could not be started - -* [PSQLADM-115](https://jira.percona.com/browse/PSQLADM-115): `proxysql_node_monitor` could fail with more than one command in the ProxySQL scheduler. - -* [PSQLADM-116](https://jira.percona.com/browse/PSQLADM-116): In some cases, the ProxySQL scheduler was reloading servers on every run - -* [PSQLADM-117](https://jira.percona.com/browse/PSQLADM-117): The `–syncusers` option did not work when enabling cluster - -* [PSQLADM-125](https://jira.percona.com/browse/PSQLADM-125): The check-is-galera-checker-running function was not preventing multiple instances of the script from running. - -Other bugs fixed: [PSQLADM-112](https://jira.percona.com/browse/PSQLADM-112), [PSQLADM-120](https://jira.percona.com/browse/PSQLADM-120) - -*ProxySQL* is available under Open Source license GPLv3. diff --git a/docs/release-notes-1.4.16.md b/docs/release-notes-1.4.16.md deleted file mode 100644 index 6c52f7b..0000000 --- a/docs/release-notes-1.4.16.md +++ /dev/null @@ -1,23 +0,0 @@ -# ProxySQL 1.4.16 and proxysql-admin (2020-02-11) - -* **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -*ProxySQL* release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -*ProxySQL* is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created *ProxySQL* for DBAs as a means of solving -complex replication topology issues. - -The *ProxySQL* 1.4.16 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include **ProxySQL Admin** – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into *ProxySQL*. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). *ProxySQL* offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -## Bugs Fixed - -* [PSQLADM-219](https://jira.percona.com/browse/PSQLADM-219): The [ProxySQL scheduler](https://github.com/sysown/proxysql/blob/master/doc/scheduler.md) was handling the `pxc_maint_mode` variable incorrectly. As a result, open connections were closed immediately. This bug has been fixed and now the ProxySQL scheduler only sets the node status to `OFFLINE_SOFT`. This prevents opening new connections and lets the already established connections finish their work. It is up to the user to decide when it is safe to start the node maintenance. - -*ProxySQL* is available under Open Source license GPLv3. diff --git a/docs/release-notes-1.4.4.md b/docs/release-notes-1.4.4.md deleted file mode 100644 index 24a7db8..0000000 --- a/docs/release-notes-1.4.4.md +++ /dev/null @@ -1,35 +0,0 @@ -# ProxySQL 1.4.4 and proxysql-admin (2018-01-18) - -* **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -*ProxySQL* 1.4.4, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s **proxysql-admin** tool. - -*ProxySQL* is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created *ProxySQL* for DBAs as a means of solving -complex replication topology issues. - -The *ProxySQL* 1.4.4 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into *ProxySQL*. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). *ProxySQL* offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -## This release fixes the following bugs in ProxySQL Admin - -* [PXC-892](https://jira.percona.com/browse/PXC-892): proxysql-admin was unable to recognize IP -address of localhost. - -* [PXC-893](https://jira.percona.com/browse/PXC-893): proxysql-admin couldn’t interpret passwords with -special characters correctly, such as ‘$’ - -* [PSQLADM-3](https://jira.percona.com/browse/PSQLADM-3): proxysql_node_monitor script had writer/reader hostgroup -conflict issue. - -* [PQA-155](https://jira.percona.com/browse/PQA-155): Runtime table was not updated in case of any changes in -Percona XtraDB Cluster membership. - -* [BLD-853](https://jira.percona.com/browse/BLD-853): *ProxySQL* logrotate script did not work properly, -producing empty /etc/proxysql.log after logrotate. - -*ProxySQL* is available under Open Source license GPLv3. diff --git a/docs/release-notes-1.4.5.md b/docs/release-notes-1.4.5.md deleted file mode 100644 index d343220..0000000 --- a/docs/release-notes-1.4.5.md +++ /dev/null @@ -1,34 +0,0 @@ -# ProxySQL 1.4.5 and proxysql-admin (2018-02-15) - -* **Installation**:[https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -*ProxySQL* 1.4.5, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -*ProxySQL* is a high-performance proxy, currently for MySQL, and database -servers in the *MySQL* ecosystem (like **Percona Server for MySQL** and *MariaDB*). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created *ProxySQL* for DBAs as a means of solving -complex replication topology issues. - -The *ProxySQL* 1.4.5 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into *ProxySQL*. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). *ProxySQL* offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -* [PSQLADM-6](https://jira.percona.com/browse/PSQLADM-6): If the cluster node goes offline, the proxysql_node_monitor -script now sets the node status as OFFLINE_HARD, and does not remove it from the *ProxySQL* database. Also, logging is consistent regardless of the cluster node online status. - -* [PSQLADM-30](https://jira.percona.com/browse/PSQLADM-30): Validation was added for the host priority file. - -* [PSQLADM-33](https://jira.percona.com/browse/PSQLADM-33): Added –proxysql-datadir option to run the proxysql-admin script with a custom *ProxySQL* data directory. - -* Also, BATS test suite was added for the proxysql-admin testing. - -## Bug fixes - -* [PSQLADM-5](https://jira.percona.com/browse/PSQLADM-5): *Percona XtraDB Cluster (PXC)* mode specified with proxysql-admin with use of `–mode` parameter was not persistent. - -* [PSQLADM-8](https://jira.percona.com/browse/PSQLADM-8): *ProxySQL* High CPU load took place when mysqld was hanging. - -*ProxySQL* is available under Open Source license GPLv3. diff --git a/docs/release-notes-1.4.6.md b/docs/release-notes-1.4.6.md deleted file mode 100644 index 48601ba..0000000 --- a/docs/release-notes-1.4.6.md +++ /dev/null @@ -1,42 +0,0 @@ -# ProxySQL 1.4.6 and proxysql-admin (2018-03-12) - -* **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -*ProxySQL* release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -*ProxySQL* is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created *ProxySQL* for DBAs as a means of solving -complex replication topology issues. - -The *ProxySQL* 1.4.6 source and binary packages available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into *ProxySQL*. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). *ProxySQL* offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -## Usability improvements - -* [PSQLADM-32](https://jira.percona.com/browse/PSQLADM-32): Now, proxysql-admin script can configure -multiple clusters in *ProxySQL*, when there are unique cluster names specified -by the wsrep_cluster_name option, and the /etc/proxysql-admin.cnf -configuration contains different *ProxySQL* READ/WRITE hostgroup and different -application user for each cluster. Currently multiple clusters support is not -compatible with host priority feature, which works only with a single cluster. - -* [PSQLADM-81](https://jira.percona.com/browse/PSQLADM-81): The new version substantially increases the number of test cases -in the ProxySQL Admin test-suite. - -## Bug fixes - -* [PSQLADM-35](https://jira.percona.com/browse/PSQLADM-35): proxysql_galera_checker monitoring script was -unable to discover new writer nodes. - -* [PSQLADM-36](https://jira.percona.com/browse/PSQLADM-36): upgrade to *ProxySQL* 1.4.6 from the previous version -was broken. - -* [PSQLADM-79](https://jira.percona.com/browse/PSQLADM-79): Fixed by properly quoting the MONITOR_USERNAME environment -variable in the admin script query. - -*ProxySQL* is available under Open Source license GPLv3. diff --git a/docs/release-notes-1.4.7.md b/docs/release-notes-1.4.7.md deleted file mode 100644 index b32999b..0000000 --- a/docs/release-notes-1.4.7.md +++ /dev/null @@ -1,47 +0,0 @@ -# ProxySQL 1.4.7 and proxysql-admin (2018-04-16) - -- **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -*ProxySQL* release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -*ProxySQL* is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created *ProxySQL* for DBAs as a means of solving -complex replication topology issues. - -The *ProxySQL* 1.4.7 source and binary packages available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into *ProxySQL*. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). *ProxySQL* offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -## Usability improvements - -- Added `proxysql_status` tool to dump *ProxySQL* configuration and statistics. - -## Bug fixes - -- [PSQLADM-2](https://jira.percona.com/browse/PSQLADM-2): `proxysql_galera_checker` script didn’t check if -another instance of itself is already running. While running more then one -copy of `proxysql_galera_checker` in the same runtime environment at -the same time is still not supported, the introduced fix is able to prevent -duplicate script execution in most cases. - -- [PSQLADM-40](https://jira.percona.com/browse/PSQLADM-40): ProxySQL scheduler generated a lot of -`proxysql_galera_checker` and `proxysql_node_monitor` processes in case of wrong ProxySQL credentials in `/etc/proxysql-admin.cnf` file. - -- [PSQLADM-41](https://jira.percona.com/browse/PSQLADM-41): Timeout error handling was improved with clear messages. - -- [PSQLADM-42](https://jira.percona.com/browse/PSQLADM-42): An inconsistency of the date format in *ProxySQL* and scripts was fixed. - -- [PSQLADM-43](https://jira.percona.com/browse/PSQLADM-43): `proxysql_galera_checker` didn’t take into account -the possibility of special characters presence in mysql-monitor_password. - -- [PSQLADM-44](https://jira.percona.com/browse/PSQLADM-44): `proxysql_galera_checker` generated unclear errors -in the `/etc/proxysql.log` file if wrong credentials where passed. - -- [PSQLADM-46](https://jira.percona.com/browse/PSQLADM-46): `proxysql_node_monitor` script incorrectly split -the hostname and the port number in URLs containing hyphen character. - -*ProxySQL* is available under Open Source license GPLv3. diff --git a/docs/release-notes-1.4.8.md b/docs/release-notes-1.4.8.md deleted file mode 100644 index 8e62b95..0000000 --- a/docs/release-notes-1.4.8.md +++ /dev/null @@ -1,43 +0,0 @@ -# ProxySQL 1.4.8 and proxysql-admin (2018-05-22) - -- **Installation** - - [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -*ProxySQL* release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -*ProxySQL* is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created *ProxySQL* for DBAs as a means of solving -complex replication topology issues. - -The *ProxySQL* 1.4.8 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into *ProxySQL*. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). *ProxySQL* offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -## Usability improvement - -- [PSQLADM-84](https://jira.percona.com/browse/PSQLADM-84): Now proxysql_status tool dumps host_priority -and /etc/proxysql-admin.cnf. Also output format was changed. - -## Other improvements and bug fixes - -- [PSQLADM-66](https://jira.percona.com/browse/PSQLADM-66): The `–syncusers` option now makes ProxySQL Admin to -update the user’s password in *ProxySQL* database if there is any password difference between *ProxySQL* user and MySQL user. - -- [PSQLADM-45](https://jira.percona.com/browse/PSQLADM-45): it was unclear from the help screen, that -`–config-file` option requires an argument. - -- [PSQLADM-48](https://jira.percona.com/browse/PSQLADM-48): `${PROXYSQL_DATADIR}/${CLUSTER_NAME}`_mode file was not -created at ProxySQL Admin upgrade (1.4.5 or before to 1.4.6 onwards). - -- [PSQLADM-52](https://jira.percona.com/browse/PSQLADM-52): The *proxysql_galera_checker* script was not -checking empty query rules. - -- [PSQLADM-54](https://jira.percona.com/browse/PSQLADM-54): `proxysql_node_monitor` did not change -OFFLINE_HARD status properly for the coming back online nodes. - -*ProxySQL* is available under Open Source license GPLv3. diff --git a/docs/release-notes-index-v1.md b/docs/release-notes-index-v1.md deleted file mode 100644 index b813809..0000000 --- a/docs/release-notes-index-v1.md +++ /dev/null @@ -1,279 +0,0 @@ -# - -## Release Notes for Version 1 - -### ProxySQL 1.4.16 and proxysql-admin (2020-02-11) - -- **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -_ProxySQL_ release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -_ProxySQL_ is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created _ProxySQL_ for DBAs as a means of solving -complex replication topology issues. - -The _ProxySQL_ 1.4.16 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include **ProxySQL Admin** – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into _ProxySQL_. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). _ProxySQL_ offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -#### Bugs Fixed - -- [PSQLADM-219](https://jira.percona.com/browse/PSQLADM-219): The [ProxySQL scheduler](https://github.com/sysown/proxysql/blob/master/doc/scheduler.md) was handling the `pxc_maint_mode` variable incorrectly. As a result, open connections were closed immediately. This bug has been fixed and now the ProxySQL scheduler only sets the node status to `OFFLINE_SOFT`. This prevents opening new connections and lets the already established connections finish their work. It is up to the user to decide when it is safe to start the node maintenance. - -_ProxySQL_ is available under Open Source license GPLv3. - -### ProxySQL 1.4.12 and proxysql-admin (2018-11-13) - -- **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -_ProxySQL_ release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -_ProxySQL_ is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created _ProxySQL_ for DBAs as a means of solving -complex replication topology issues. - -The _ProxySQL_ 1.4.12 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include **ProxySQL Admin** – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into _ProxySQL_. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). _ProxySQL_ offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -#### Improvements - -- [PSQLADM-68](https://jira.percona.com/browse/PSQLADM-68): Scripts are now compatible with _Percona XtraDB Cluster (PXC)_ hosts using IPv6 - -- [PSQLADM-107](https://jira.percona.com/browse/PSQLADM-107): In include-slaves, a slave would always be moved into the write hostgroup even if the whole cluster went down. A new option –use-slave-as-writer specifies whether or not the slave is added to the write hostgroup. - -#### Bugs Fixed - -- [PSQLADM-110](https://jira.percona.com/browse/PSQLADM-110): In some cases, pattern cluster hostname did not work with proxysql-admin. - -- [PSQLADM-104](https://jira.percona.com/browse/PSQLADM-104): proxysql-admin testsuite bug fixes. - -- [PSQLADM-113](https://jira.percona.com/browse/PSQLADM-113): `proxysql_galera_checker` assumed that parameters were given in the long format. - -- [PSQLADM-114](https://jira.percona.com/browse/PSQLADM-114): In some cases, _ProxySQL_ could not be started - -- [PSQLADM-115](https://jira.percona.com/browse/PSQLADM-115): `proxysql_node_monitor` could fail with more than one command in the ProxySQL scheduler. - -- [PSQLADM-116](https://jira.percona.com/browse/PSQLADM-116): In some cases, the ProxySQL scheduler was reloading servers on every run - -- [PSQLADM-117](https://jira.percona.com/browse/PSQLADM-117): The `–syncusers` option did not work when enabling cluster - -- [PSQLADM-125](https://jira.percona.com/browse/PSQLADM-125): The check-is-galera-checker-running function was not preventing multiple instances of the script from running. - -Other bugs fixed: [PSQLADM-112](https://jira.percona.com/browse/PSQLADM-112), [PSQLADM-120](https://jira.percona.com/browse/PSQLADM-120) - -_ProxySQL_ is available under Open Source license GPLv3. - -### ProxySQL 1.4.8 and proxysql-admin (2018-05-22) - -- **Installation** - - [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -_ProxySQL_ release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -_ProxySQL_ is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created _ProxySQL_ for DBAs as a means of solving -complex replication topology issues. - -The _ProxySQL_ 1.4.8 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into _ProxySQL_. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). _ProxySQL_ offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -#### Usability improvement - -- [PSQLADM-84](https://jira.percona.com/browse/PSQLADM-84): Now proxysql_status tool dumps host_priority - and /etc/proxysql-admin.cnf. Also output format was changed. - -#### Other improvements and bug fixes - -- [PSQLADM-66](https://jira.percona.com/browse/PSQLADM-66): The `–syncusers` option now makes ProxySQL Admin to - update the user’s password in _ProxySQL_ database if there is any password difference between _ProxySQL_ user and MySQL user. - -- [PSQLADM-45](https://jira.percona.com/browse/PSQLADM-45): it was unclear from the help screen, that - `–config-file` option requires an argument. - -- [PSQLADM-48](https://jira.percona.com/browse/PSQLADM-48): `${PROXYSQL_DATADIR}/${CLUSTER_NAME}`\_mode file was not - created at ProxySQL Admin upgrade (1.4.5 or before to 1.4.6 onwards). - -- [PSQLADM-52](https://jira.percona.com/browse/PSQLADM-52): The _proxysql_galera_checker_ script was not - checking empty query rules. - -- [PSQLADM-54](https://jira.percona.com/browse/PSQLADM-54): `proxysql_node_monitor` did not change - OFFLINE_HARD status properly for the coming back online nodes. - -_ProxySQL_ is available under Open Source license GPLv3. - -### ProxySQL 1.4.7 and proxysql-admin (2018-04-16) - -- **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -_ProxySQL_ release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -_ProxySQL_ is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created _ProxySQL_ for DBAs as a means of solving -complex replication topology issues. - -The _ProxySQL_ 1.4.7 source and binary packages available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into _ProxySQL_. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). _ProxySQL_ offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -#### Usability improvements - -- Added `proxysql_status` tool to dump _ProxySQL_ configuration and statistics. - -#### Bug fixes - -- [PSQLADM-2](https://jira.percona.com/browse/PSQLADM-2): `proxysql_galera_checker` script didn’t check if - another instance of itself is already running. While running more then one - copy of `proxysql_galera_checker` in the same runtime environment at - the same time is still not supported, the introduced fix is able to prevent - duplicate script execution in most cases. - -- [PSQLADM-40](https://jira.percona.com/browse/PSQLADM-40): ProxySQL scheduler generated a lot of - `proxysql_galera_checker` and `proxysql_node_monitor` processes in case of wrong ProxySQL credentials in `/etc/proxysql-admin.cnf` file. - -- [PSQLADM-41](https://jira.percona.com/browse/PSQLADM-41): Timeout error handling was improved with clear messages. - -- [PSQLADM-42](https://jira.percona.com/browse/PSQLADM-42): An inconsistency of the date format in _ProxySQL_ and scripts was fixed. - -- [PSQLADM-43](https://jira.percona.com/browse/PSQLADM-43): `proxysql_galera_checker` didn’t take into account - the possibility of special characters presence in mysql-monitor_password. - -- [PSQLADM-44](https://jira.percona.com/browse/PSQLADM-44): `proxysql_galera_checker` generated unclear errors - in the `/etc/proxysql.log` file if wrong credentials where passed. - -- [PSQLADM-46](https://jira.percona.com/browse/PSQLADM-46): `proxysql_node_monitor` script incorrectly split - the hostname and the port number in URLs containing hyphen character. - -_ProxySQL_ is available under Open Source license GPLv3. - -### ProxySQL 1.4.6 and proxysql-admin (2018-03-12) - -- **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -_ProxySQL_ release, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -_ProxySQL_ is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created _ProxySQL_ for DBAs as a means of solving -complex replication topology issues. - -The _ProxySQL_ 1.4.6 source and binary packages available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into _ProxySQL_. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). _ProxySQL_ offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -#### Usability improvements - -- [PSQLADM-32](https://jira.percona.com/browse/PSQLADM-32): Now, proxysql-admin script can configure - multiple clusters in _ProxySQL_, when there are unique cluster names specified - by the wsrep*cluster_name option, and the /etc/proxysql-admin.cnf - configuration contains different \_ProxySQL* READ/WRITE hostgroup and different - application user for each cluster. Currently multiple clusters support is not - compatible with host priority feature, which works only with a single cluster. - -- [PSQLADM-81](https://jira.percona.com/browse/PSQLADM-81): The new version substantially increases the number of test cases - in the ProxySQL Admin test-suite. - -#### Bug fixes - -- [PSQLADM-35](https://jira.percona.com/browse/PSQLADM-35): proxysql_galera_checker monitoring script was - unable to discover new writer nodes. - -- [PSQLADM-36](https://jira.percona.com/browse/PSQLADM-36): upgrade to _ProxySQL_ 1.4.6 from the previous version - was broken. - -- [PSQLADM-79](https://jira.percona.com/browse/PSQLADM-79): Fixed by properly quoting the MONITOR_USERNAME environment - variable in the admin script query. - -_ProxySQL_ is available under Open Source license GPLv3. - -### ProxySQL 1.4.5 and proxysql-admin (2018-02-15) - -- **Installation**:[https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -_ProxySQL_ 1.4.5, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s -**proxysql-admin** tool. - -_ProxySQL_ is a high-performance proxy, currently for MySQL, and database -servers in the _MySQL_ ecosystem (like **Percona Server for MySQL** and _MariaDB_). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created _ProxySQL_ for DBAs as a means of solving -complex replication topology issues. - -The _ProxySQL_ 1.4.5 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into _ProxySQL_. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). _ProxySQL_ offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -- [PSQLADM-6](https://jira.percona.com/browse/PSQLADM-6): If the cluster node goes offline, the proxysql*node_monitor - script now sets the node status as OFFLINE_HARD, and does not remove it from the \_ProxySQL* database. Also, logging is consistent regardless of the cluster node online status. - -- [PSQLADM-30](https://jira.percona.com/browse/PSQLADM-30): Validation was added for the host priority file. - -- [PSQLADM-33](https://jira.percona.com/browse/PSQLADM-33): Added –proxysql-datadir option to run the proxysql-admin script with a custom _ProxySQL_ data directory. - -- Also, BATS test suite was added for the proxysql-admin testing. - -#### Bug fixes - -- [PSQLADM-5](https://jira.percona.com/browse/PSQLADM-5): _Percona XtraDB Cluster (PXC)_ mode specified with proxysql-admin with use of `–mode` parameter was not persistent. - -- [PSQLADM-8](https://jira.percona.com/browse/PSQLADM-8): _ProxySQL_ High CPU load took place when mysqld was hanging. - -_ProxySQL_ is available under Open Source license GPLv3. - -### ProxySQL 1.4.4 and proxysql-admin (2018-01-18) - -- **Installation**: [https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1](https://www.percona.com/doc/percona-xtradb-cluster/LATEST/howtos/proxysql-v1.html#installing-proxysql-v1) - -_ProxySQL_ 1.4.4, released by [ProxySQL](https://www.proxysql.com/), is now available for download in -the [Percona repository](https://www.percona.com/software/percona-software-repositories-for-mysql) along with an updated version of **Percona**’s **proxysql-admin** tool. - -_ProxySQL_ is a high-performance proxy, currently for MySQL, and database -servers in the MySQL ecosystem (like **Percona Server for MySQL** and MariaDB). It acts as an -intermediary for client requests seeking resources from the -database. René Cannaò created _ProxySQL_ for DBAs as a means of solving -complex replication topology issues. - -The _ProxySQL_ 1.4.4 source and binary packages are available from the [Percona -download page for ProxySQL](https://percona.com/downloads/proxysql) include ProxySQL Admin – a tool developed by -**Percona** to configure **Percona XtraDB Cluster** nodes into _ProxySQL_. Docker images are available as well. You can [download the original ProxySQL from GitHub](https://github.com/sysown/proxysql/releases). _ProxySQL_ offers the [ProxySQL documentation](https://proxysql.com/documentation/). - -#### This release fixes the following bugs in ProxySQL Admin - -- [PXC-892](https://jira.percona.com/browse/PXC-892): proxysql-admin was unable to recognize IP - address of localhost. - -- [PXC-893](https://jira.percona.com/browse/PXC-893): proxysql-admin couldn’t interpret passwords with - special characters correctly, such as ‘$’ - -- [PSQLADM-3](https://jira.percona.com/browse/PSQLADM-3): proxysql_node_monitor script had writer/reader hostgroup - conflict issue. - -- [PQA-155](https://jira.percona.com/browse/PQA-155): Runtime table was not updated in case of any changes in - Percona XtraDB Cluster membership. - -- [BLD-853](https://jira.percona.com/browse/BLD-853): _ProxySQL_ logrotate script did not work properly, - producing empty /etc/proxysql.log after logrotate. - -_ProxySQL_ is available under Open Source license GPLv3. diff --git a/docs/release-notes.md b/docs/release-notes.md index eb0663c..3968e80 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -65,5 +65,3 @@ [ProxySQL 2.0.4 and ProxySQL-admin (2019-05-28)](release-notes-2.0.4.md) [ProxySQL 2.0.3 and ProxySQL-admin (2019-05-07)](release-notes-2.0.3.md) - -See the [ProxySQL 1.x.x release notes](release-notes-index-v1.md) diff --git a/docs/tarball-v1.md b/docs/tarball-v1.md deleted file mode 100644 index 319a17d..0000000 --- a/docs/tarball-v1.md +++ /dev/null @@ -1,35 +0,0 @@ -# Install ProxySQL 1.X from a binary tarball - -Installing *ProxySQL* from a tarball is an alternative method if the recommended method, using either the apt or the yum package manager, is not applicable in your environment. - -1. In [Download ProxySQL 1.x page](https://www.percona.com/downloads/proxysql/), select the *ProxySQL* version, and select **Linux - Generic** in the *Software* field. Download the appropriate package for your platform. - -2. Extract the files from the archive and change to the directory that contains the extracted files. - - ```{.bash data-prompt="$"} - # Extract the files (assuming you have changed to the download destination directory) - $ tar xzf proxysql-VERSION-Linux-PLATFORM-ARCHITECTURE*.tar.gz - # Change to the directory that contains the extracted files - $ cd proxysql-VERSION-Linux-PLATFORM-ARCHITECTURE - ``` - -3. Create a directory to store the *ProxySQL* data: - - ```{.bash data-prompt="$"} - $ mkdir /home/user/data - ``` - -4. Update the value of the `datadir` in the configuration file to point to the data directory you have created. - - ```text - datadir="/home/user/data" - ``` - -5. Set the other options, as needed. - -6. Start *ProxySQL* with the `-c` option to pass the configuration file you have updated: - - ```{.bash data-prompt="$"} - $ /home/user/path-to-extracted-dir/usr/bin/proxysql \ - -c /home/user/path-to-extracted-dir/etc/proxysql.cnf - ``` diff --git a/mkdocs-base.yml b/mkdocs-base.yml index a591269..7872407 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -201,12 +201,6 @@ nav: - psh-options.md - psh-detailed-options.md - psh-known-limitations.md - - ProxySQL 1.x.x and the proxysql-admin: - - proxysql-v1.md - - Release notes for ProxySQL 1.x.x: release-notes-index-v1.md - - installing-v1.md - - tarball-v1.md - - configure-proxysql1.md - Reference: - trademark-policy.md - copyright-and-licensing-information.md