diff --git a/docs/build-psh.md b/docs/build-psh.md index d540d40..5f108fa 100644 --- a/docs/build-psh.md +++ b/docs/build-psh.md @@ -1,10 +1,5 @@ # Build the pxc_scheduler_handler tool -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 pxc_scheduler_handler tool has two main files: the `pxc_scheduler_handler` binary and the `percona_scheduler_admin` script. The `pxc_scheduler_handler` does the following tasks: @@ -39,12 +34,12 @@ $ build_scheduler.sh The `pxc_scheduler_handler` binary is located in the base directory. -We do not recommend running multiple instances of the same binary. If you start a new instance when an instance of -`pxc_scheduler_handler` is already running, the binary runs, but the second instance does the following: +Do not run multiple instances of this binary. If you start a new instance when an instance of +`pxc_scheduler_handler` is already running, both instances execute, but the second instance: -* Consumes network and system resources +* Consumes additional network and system resources -* Returns the same results since multiple versions use the same configuration file +* Returns identical results because both use the same configuration file ## Create an account diff --git a/docs/index.md b/docs/index.md index 9dff936..1c8177c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,11 +12,15 @@ The ProxySQL service runs as a daemon and is monitored by a watchdog process cap Configuration is handled using SQL-like statements, including runtime options, server grouping, and query routing rules. Most settings can be changed dynamically without restarting the proxy. -The [ProxySQL 2 documentation](https://proxysql.com/documentation/) includes detailed guidance on installation, operation, and the use of supporting tools. The maintained releases are listed on +!!! note + + [ProxySQL 3.0.1 contains a PostgreSQL module in beta.](https://github.com/sysown/proxysql/releases) The Percona build of ProxySQL is only tested with Percona Server for MySQL. + +The [ProxySQL documentation](https://proxysql.com/documentation/) includes detailed guidance on installation, operation, and the use of supporting tools. The maintained releases are listed on [ProxySQL Installation](https://proxysql.com/documentation/installing-proxysql/). -[You can download Percona's build of ProxySQL 2.x.x](https://www.percona.com/download-proxysql). Note that -Version 1 is no longer actively maintained. The ProxySQL 2. x. x downloads may include: +[You can download Percona build of ProxySQL](https://www.percona.com/download-proxysql). Note that +Version 1 is no longer actively maintained. The ProxySQL downloads may include: - [ProxySQL Admin (proxysql-admin)](proxysql-admin-tool-v2-config.md) simplifies the configuration of Percona XtraDB Cluster nodes with ProxySQL. diff --git a/docs/install-proxysql2-tarball.md b/docs/install-proxysql2-tarball.md index c26a487..4e2cc9b 100644 --- a/docs/install-proxysql2-tarball.md +++ b/docs/install-proxysql2-tarball.md @@ -1,55 +1,65 @@ -# Install Percona's build of ProxySQL 2.x.x binary tarball +# Install Percona build of ProxySQL binary tarball -If installing [_ProxySQL 2_ with a package manager](install-v2.md) is not an option in your environment, you can install from a binary tarball. The difference between versions is the available tar files or the command to extract the file. +If installing [Percona build of ProxySQL with a package manager](install-v2.md) is not an option in your environment, you can install from a binary tarball. The difference between versions is the available tar files or the command to extract the file. + +## Version changes + +### CentOS 6 Starting with [_ProxySQL 2.3.2-1.2_](release-notes-2.3.2-1.md), Percona no longer provides a tarball for CentOS 6. For more information, see [Spring Cleaning: Discontinuing RHEL 6/CentOS 6 (glibc2.12) and 32-bit Binary Builds of Percona Software](https://www.percona.com/blog/spring-cleaning-discontinuing-rhel-6-centos-6-glibc-2-12-and-32-bit-binary-builds-of-percona-software/) +### OpenSSL 1.1.1 + The password-based file encryption requires OpenSSL 1.1.1, but Ubuntu 16.04 does not support this OpenSSL version. A special statically linked OpenSSL 1.1.1 binary is packaged with the executable. This packaged binary avoids conflicts with the system OpenSSL and any shared libraries. Each new release rebuilds the binary. -Follow these steps: +## Format + +The tar file binary have the following format: -1. In [Download ProxySQL](https://www.percona.com/downloads/proxysql/), select the `ProxySQL 2` product. +proxysql-<version>-<operating_system>-<architecture>-<glibc_version>.tar.gz -2. In the _Select Product Version_ field, select the `ProxySQL 2` version. +The following is an example of a tar file binary for ProxySQL 3.0.1 -3. In the _Select Platform_ field, select **Linux - Generic**. + proxysql-3.0.1-Linux-x86_64.glibc2.31.tar.gz + +## Download the file -4. Select the tar file. +[Follow the instructions in `Download locations for Percona’s build of ProxySQL and ProxySQL admin tools`](where-to-download-proxysql.md) - ??? note "tar files for ProxySQL 2.4.4 and higher" +Be sure to select the appropriate file for your operating system based on the `glibc version` used. Verify that you're installing the correct ProxySQL version for your environment, such as `proxysql2` or `proxysql3`. - | Name | Description | - | ------------------------------------------------- | ------------------------------------- | - | proxysql-2--Linux-x86_64.glibc2.23.xenial.tar.gz | For Ubuntu 16.04 `xenial` only | - |proxysql-2--Linux-x86_64.glibc2.17.tar.gz | For every supported operating system | - |proxysql-2--Linux-x86_64.glibc2.27.tar.gz | For every supported operating system but `xenial`. For CentOS 7, install OpenSSL 1.1.1, if needed. | +??? note "tar files for ProxySQL 2.4.4 and higher" - ??? note "tar files from ProxySQL 2.3.2-1.2 to ProxySQL 2.4.3" + | Name | Description | + | ------------------------------------------------- | ------------------------------------- | + | proxysql-2--Linux-x86_64.glibc2.23.xenial.tar.gz | For Ubuntu 16.04 `xenial` only | + |proxysql-2--Linux-x86_64.glibc2.17.tar.gz | For every supported operating system | + |proxysql-2--Linux-x86_64.glibc2.27.tar.gz | For every supported operating system but `xenial`. For CentOS 7, install OpenSSL 1.1.1, if needed. | - | Name | Description | - | ------------------------------------------------- | ------------------------------------- | - | proxysql-2--Linux-x86_64.glibc2.23.xenial.tar.gz | For Ubuntu 16.04 `xenial` only | +??? note "tar files from ProxySQL 2.3.2-1.2 to ProxySQL 2.4.3" - ??? note "tar files from ProxySQL 2.0.15 to ProxySQL 2.3.2" + | Name | Description | + | ------------------------------------------------- | ------------------------------------- | + | proxysql-2--Linux-x86_64.glibc2.23.xenial.tar.gz | For Ubuntu 16.04 `xenial` only | - | Name | Description | - | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------- | - | proxysql-2.0.XX-Linux-x86_64.glibc2.12.tar.gz | For every supported operating system but `xenial`. For CentOS 7, install OpenSSL 1.1.1, if needed. | - | proxysql-2.x.xx-Linux-x86_64.glibc2.17.tar.gz | For every supported operating system | - | proxysql-2.0.XX-Linux-x86_64.glibc2.23.xenial.tar.gz | For Ubuntu 16.04 `xenial` only. +??? note "tar files from ProxySQL 2.0.15 to ProxySQL 2.3.2" - See ProxySQL 2.0.15 and proxysql-admin + | Name | Description | + | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------- | + | proxysql-2.0.XX-Linux-x86_64.glibc2.12.tar.gz | For every supported operating system but `xenial`. For CentOS 7, install OpenSSL 1.1.1, if needed. | + | proxysql-2.x.xx-Linux-x86_64.glibc2.17.tar.gz | For every supported operating system | + | proxysql-2.0.XX-Linux-x86_64.glibc2.23.xenial.tar.gz | For Ubuntu 16.04 `xenial` only. -5. Navigate to the downloaded tar file. +## Install the file -6. Extract the files with the following commands: +1. Navigate to the downloaded tar file. + +2. Extract the files with the following commands: ??? "Extract ProxySQL 2.0.14 or higher" ```{.bash data-prompt="$"} - $ # Extract the files to the download destination directory - $ tar xzf proxysql-2.X.X-.tar.gz - $ # Change to the directory that contains the extracted files + $ tar xzf proxysql--Linux--.tar.gz $ cd proxysql--Linux- ``` @@ -62,24 +72,20 @@ Follow these steps: $ cd proxysql--Linux- ``` -7. Create a directory to store the _ProxySQL_ data. +3. Create a directory to store the _ProxySQL_ data. ```{.bash data-prompt="$"} $ mkdir /home/user/data ``` -8. In the configuration file, update the `datadir` value to point +4. In the configuration file, update the `datadir` value to point to the created data directory. ```{.text .no-copy} datadir="/home/user/data" ``` -9. Set the other options, as needed. - -!!! admonition "See also" - - [ProxySQL 2.x and proxysql-admin utility](proxysql-admin-tool-v2-config.md) +5. Set the other options, as needed. ## MySQL 8.4 and Percona Server for MySQL 8.4 considerations diff --git a/docs/install-v2.md b/docs/install-v2.md index 66397c1..d2454b7 100644 --- a/docs/install-v2.md +++ b/docs/install-v2.md @@ -1,15 +1,24 @@ -# Install Percona's build of ProxySQL 2.x.x and the admin utilities +# Install Percona build of ProxySQL and the admin tools -Select the same package installer used to install [Percona XtraDB Cluster](https://www.percona.com/doc/percona-xtradb-cluster/8.0/install/index.html) or other Percona software. +Select the same package installer used to install [Percona XtraDB Cluster](https://www.percona.com/doc/percona-xtradb-cluster/8.0/install/index.html) or other Percona software to ensure compatibility. + +Verify that you're installing the correct ProxySQL version for your environment, such as `proxysql2` or `proxysql3`. === "On a Debian-derived distribution" - If you used APT to install Percona software, run the following command as sudo or as root: + If you installed Percona software using APT, run the following command as sudo or as root. Make sure to use the correct package name for the version you installed, such as `proxysql2` or `proxysql3`. ```{.bash data-prompt="$"} $ sudo apt install proxysql2 ``` + + or + + ```{.bash data-prompt="$"} + $ sudo apt install proxysql3 + ``` + ??? example "Expected output" ```{.text .no-copy} @@ -27,12 +36,18 @@ Select the same package installer used to install [Percona XtraDB Cluster](https === "On a Red Hat-derived distribution" - If you used YUM to install Percona software, run the following command: + If you installed Percona software using YUM, run the following command. Make sure to use the correct package name for the version you installed, such as `proxysql2` or `proxysql3`. ```{.bash data-prompt="$"} $ sudo yum install proxysql2 ``` + or + + ```{.bash data-prompt="$"} + $ sudo yum install proxysql3 + ``` + ??? example "Expected output" ```{.text .no-copy} @@ -63,7 +78,7 @@ Select the same package installer used to install [Percona XtraDB Cluster](https ## Verify the pxc_scheduler_handler installation -If you have installed [ProxySQL 2.3.2-2.1](release-notes-2.3.2-1.md) or later, verify the pxc_scheduler_handler installation with the following command: +If you have installed [ProxySQL 2.3.2-2.1](release-notes-2.3.2-1.md) or later, verify the [pxc_scheduler_handler](psh-overview.md) installation with the following command: ```{.bash data-prompt="$"} $ percona-scheduler-admin --debug @@ -79,7 +94,11 @@ Running this command without the [pxc_scheduler_handler configuration file](psh- ## Run Docker -To run ProxySQL2 in Docker, download the latest image at [percona/proxysql2](https://hub.docker.com/r/percona/proxysql2). +To run the Percona build of ProxySQL in Docker, do the following: + +* ProxySQL2 in Docker, download the latest image at [percona/proxysql2](https://hub.docker.com/r/percona/proxysql2). + +* ProxySQL3 in Docker, download the latest image at [percona/proxysql3](https://hub.docker.com/r/percona/proxysql3). ## MySQL 8.4 and Percona Server for MySQL 8.4 considerations diff --git a/docs/proxysql-admin-tool-changes.md b/docs/proxysql-admin-tool-changes.md index 41df434..66ab175 100644 --- a/docs/proxysql-admin-tool-changes.md +++ b/docs/proxysql-admin-tool-changes.md @@ -1,43 +1,68 @@ -# ProxySQL Admin tool changes +# Percona build of ProxySQL Admin tool changes ## Added features -* New option `--use-ssl` to use SSL for connections between ProxySQL and the backend database servers +### `--use-ssl` -* New option `--max-transactions-behind` to determine the maximum number of writesets - that can be queued before the node is SHUNNED to avoid stale reads. The default value is 100 +Enables SSL connections between ProxySQL and the backend database servers -* New operation `--update-cluster` to update the cluster membership by adding - server nodes as found. (Note that nodes are added but not removed). The - `--writer-hg` option may be used to specify which Galera hostgroup to - update. The `--remove-all-servers` option instructs to remove all servers - from the mysql_servers table before updating the cluster. +### `--max-transactions-behind` -* Hostgroups can be specified on the command-line: `--writer-hg`, - `--reader-hg`, `--backup-writer-hg`, and `--offline-hg`. Previously, - these host groups were only read from the configuration file. +Specifies the maximum number of writesets that can be queued before the node is SHUNNED to avoid stale reads. The default value is `100`. -* The `--enable` and `--update-cluster` options used simultaneously have - special meaning. If the cluster has not been enabled, then `--enable` is - run. If the cluster has already been enabled, then `--update-cluster` is run. +### `--update-cluster` -* New command `--is-enabled` to see if a cluster has been enabled. This - command checks for the existence of a row in the mysql_Galera_hostgroups - table. The `--writer-hg` option may be used to specify the writer hostgroup - used to search the mysql_galera_hostgroups table. +Updates the cluster membership by adding newly discoveredserver nodes. Note: This operation adds nodes but does not remove them. Use [`--writer-hg`] option may be used to specify which Galera hostgroup to update. The `--remove-all-servers` option instructs to remove all servers from the mysql_servers table before updating the cluster. -* New command `--status` to display Galera hostgroup information. This command - lists all rows in the current `mysql_galera_hostgroups` table as well as all servers that belong to these hostgroups. With the `--writer-hg` option, only the information for the Galera hostgroup with that writer hostgroup is displayed. +### Hostgroup options on the command-line -* New option `--login-file` reads login credentials from an encrypted file. - If the `--login-password` or `login-password-file` options are not - specified, the user is prompted for the password. +Hostgroups can now be set with command-line options: -* New option `--login-password` is the key used to decrypt the encrypted - login-file. You cannot use the option with the `--login-password-file`. +* `--writer-hg` -* New option `--login-password-file` reads the key from a file using the - specified path. You cannot use the option with `login-password`. + +* `--reader-hg` + +* `--backup-writer-hg` + +* `--offline-hg`. + +These options were previously only available through the configuration file. + +### Combined use of `--enable` and `--update-cluster` + +When used together: + +* If the cluster is not yet enabled, then `--enable` is + executed. + +* If the cluster is already enabled, then `--update-cluster` is executed. + +### `--is-enabled` + +Checks whether a cluster has been enabled by querying the `mysql_galera_hostgroups` table. Optionally, use the `--writer-hg` option to specify the writer hostgroup for the lookup. + + +### `--status` + +Displays the current Galera hostgroup configuration. This option lists all rows in the current `mysql_galera_hostgroups` table, along with the servers assigned to each hostgroup. + +Use the `--writer-hg` option to limit the result to a specific hostgroup. + +### `--login-file` + +Reads login credentials from an encrypted file. +If neither `--login-password` nor `--login-password-file` is specified, the user is prompted to enter the decryption password interactively. + +### `--login-password` + +Specifies the decryption key used to unlock the credentials stored in the `--login-file`. +This option is mutually exclusive with `--login-password-file`. + +### `--login-password-file` + +Reads the decryption key from a file located at the specified path. +This option is mutually exclusive with `--login-password`. ## Changed features @@ -69,24 +94,32 @@ Galera cluster associated with that hostgroup overriding the value specified in the configuration file. -## Removed features +## Removed Features + +### Asynchronous slave reader support + +The `--include-slaves` option is no longer supported. Asynchronous slave reader support has been removed. + +### Node priority lists + +ProxySQL v2 no longer supports specifying a list of nodes in priority order. Only a single node is supported. + +### Automatic cluster membership updates + +Cluster membership is no longer updated automatically. The `galera_proxysql_checker` and `galera_node_monitor` scripts are no longer run in the scheduler. -* Asynchronous slave reader support has been removed: the `--include-slaves` - option is not supported. +### `pxc_maint_mode` check -* A list of nodes in the priority order is not supported in *ProxySQL* v2. Only - a single node is supported at this time. +The check for the `pxc_maint_mode` variable has been removed and is no longer supported. -* Since the galera_proxysql_checker and galera_node_monitor scripts are no - longer run in the scheduler, automatic cluster membership updates are not - supported. +### Desynced node fallback -* Checking the pxc_maint_mode variable is no longer supported +Falling back to desynced nodes when no synced nodes are available is no longer supported. -* Using desynced nodes if no other nodes are available is no longer supported. +### Server status tracking in `mysql_servers` -* The server status is no longer maintained in the mysql_servers table. +The `mysql_servers` table no longer maintains server status information. ## Limitations -* With `--writers-as-readers=backup` read-only nodes are not allowed. This is a limitation of ProxySQL 2.x. Note that backup is the default value of `--writers-as-readers` when `--mode=singlewrite` +* With `--writers-as-readers=backup` read-only nodes are not allowed. This is a limitation of ProxySQL. Note that backup is the default value of `--writers-as-readers` when `--mode=singlewrite` diff --git a/docs/proxysql-admin-tool-v2-config.md b/docs/proxysql-admin-tool-v2-config.md index e134a88..d524f23 100644 --- a/docs/proxysql-admin-tool-v2-config.md +++ b/docs/proxysql-admin-tool-v2-config.md @@ -1,6 +1,6 @@ -# ProxySQL 2.x and proxysql-admin utility +# ProxySQL and proxysql-admin utility -The `proxysql2.x` package from Percona includes the `proxysql-admin` tool for configuring Percona XtraDB Cluster nodes with ProxySQL. +The Percona build of ProxySQL from Percona includes the `proxysql-admin` tool for configuring Percona XtraDB Cluster nodes with ProxySQL. Before using the `proxysql-admin` tool, ensure that ProxySQL and Percona XtraDB Cluster nodes you want to add are running. For security purposes, change the default user settings in the Proxysql configuration file. diff --git a/docs/psh-detailed-options.md b/docs/psh-detailed-options.md index 40678f5..420e78a 100644 --- a/docs/psh-detailed-options.md +++ b/docs/psh-detailed-options.md @@ -1,6 +1,8 @@ # pxc-scheduler-handler options -The pxc_scheduler_handler script lists the available options in the pxc_scheduler_handler configuration file. The following options are described in more detail: +The `pxc_scheduler_handler` script displays the available configuration options defined in its configuration file. + +The following options are described in more detail: | Option Name | |---------------------------------------------------------| @@ -33,11 +35,11 @@ The pxc_scheduler_handler script lists the available options in the pxc_schedule This option creates query rules for a synced MySQL user and applies only to the `singlewrite` mode. -### add-query-rule requires +### Requirements -Either the [`syncusers`](#syncusers) or [`sync-multi-cluster-users`](#sync-multi-cluster-users) options. +Use with either the [`syncusers`](#syncusers) or [`sync-multi-cluster-users`](#sync-multi-cluster-users) option. -### add-query-rule example +### Example ```{.bash data-prompt="$"} $ percona-scheduler-admin --config-file=config.toml --syncusers @@ -87,25 +89,36 @@ $ percona-scheduler-admin --config-file=config.toml --adduser ## auto-assign-weights -ProxySQL uses weights for defining the failover procedure in `singlewrite` mode -and handling load balancing `loadbal` mode. +ProxySQL uses weight values to manage failover behavior in `singlewrite` mode +and to distribute load in `loadbal` mode. + +In `singlewrite` mode, this option with the +[update-cluster](#update-cluster) command automatically assigns weight values to the PXC nodes to determine the failover priority. + +As a best practice, ensure that the writer node election is deterministic by assigning progressively lower weight values to fallback nodes. + +For example, + +* Node 1:`1000` + +* Node 2: `999` + +* Node 3: `998` + +This setup establishes a clear election priority for the failover. + +In `loadbal` mode, use weight values to reduce the read traffic on the writer node and balance it evenly across the reader nodes. . -For the failover procedure, this option with the -[update-cluster](#update-cluster) option assigns weights to the PXC nodes when the cluster is -in `singlewrite` mode. +For example, -As a best practice, ensure that the writer node election operation returns the -same result each time. For example, assign the value of `1000` to node one, -`999` to node two, and `998` to the node three. This method sets a clear -priority for the election. +* Writer: `900` -For load balancing you want to reduce the reads on the writer node and, also, -split the reads across all the reader nodes equally. +* Reader 1: `1000` -For example, in a three-node cluster, assign a `900` to the writer node and -`1000` and `1000` to the reader nodes. +* Reader 2: `1000` -This option does these operations automatically without any manual intervention. +ProxySQL automatically applies these weight values without requiring manual +configuration. Review [do not combine certain options](./psh-known-limitations.md#do-not-combine-certain-options). @@ -605,7 +618,7 @@ This option does the following: To sync a specific server combine this option with the [server](#server) option. -Please note that When *caching_sha2_password* is used as an auth-plugin for a user, it is expected that *authentication_string* may differ across PXC DB nodes (because of salting). Consequently, after a failover or manual switch of the writer node, *syncusers* will detect these variations and trigger a DELETE and then CREATE operation for such users. This will not cause downtime nor affect connected clients, as the entire set of changes is committed in a single operation. +When using caching_sha2_password as the authentication plugin, the authentication_string may differ across PXC nodes. This difference is because the plugin uses salting. This process adds random data to the password before hashing to ensure that even identical passwords result in unique hashes for improved security. Consequently, after a failover or manual switch of the writer node, the *syncusers* option detects these variations, triggers a DELETE, and then CREATE operation for these users. The changes are committed in a single operation and do not cause downtime or affect connected clients. ## syncusers diff --git a/docs/psh-overview.md b/docs/psh-overview.md index d18ae60..cae6d85 100644 --- a/docs/psh-overview.md +++ b/docs/psh-overview.md @@ -1,4 +1,4 @@ -# ProxySQL 2.x.x and pxc_scheduler_handler tool +# ProxySQL and pxc_scheduler_handler tool [*ProxySQL* 2.3.2-1.2](release-notes-2.3.2-1.md) adds the pxc_scheduler_handler tool. This tool has a segment-aware failover mechanism and can automatically perform a failover due to node failures, service degradation, or maintenance requirements. The external scheduler has the following qualities: diff --git a/docs/start-or-stop-proxysql2.md b/docs/start-or-stop-proxysql2.md index 4915b5b..1f70f78 100644 --- a/docs/start-or-stop-proxysql2.md +++ b/docs/start-or-stop-proxysql2.md @@ -1,8 +1,10 @@ -# Start and stop ProxySQL +# Start and stop Percona build of ProxySQL -There are several methods to start or stop ProxySQL 2. You can invoke the commands with either `systemctl` or `service`. Currently, both are supported. +There are several methods to start or stop ProxySQL. You can invoke the commands with either `systemctl` or `service`. Currently, both are supported. -## Start ProxySQL 2.x.x with a service manager +Make sure to use the correct package name for the version you installed, such as `proxysql2` or `proxysql3`. + +## Start ProxySQL with a service manager === "service" @@ -27,14 +29,14 @@ $ /home/user//usr/bin/proxysql \ [ProxySQL Documentation: Getting Started](https://proxysql.com/documentation/getting-started/). -## Stop ProxySQL 2.x.x +## Stop ProxySQL -To stop ProxySQL 2.x, run any of the following commands: +To stop ProxySQL, run any of the following commands: -=== "service and proxysql" +=== "service and proxysql3" ```{.bash data-prompt="$"} - $ sudo service proxysql stop + $ sudo service proxysql3 stop ``` === "service and proxysql2" @@ -43,10 +45,10 @@ To stop ProxySQL 2.x, run any of the following commands: $ sudo service proxysql2 stop ``` -=== "systemctl and proxysql" +=== "systemctl and proxysql3" ```{.bash data-prompt="$"} - $ sudo systemctl stop proxysql + $ sudo systemctl stop proxysql3 ``` === "systemctl and proxysql2" diff --git a/docs/uninstall-proxysql2.md b/docs/uninstall-proxysql2.md index 54ddf08..f86301b 100644 --- a/docs/uninstall-proxysql2.md +++ b/docs/uninstall-proxysql2.md @@ -1,6 +1,6 @@ -# Uninstall ProxySQL 2.x.x +# Uninstall Percona build of ProxySQL -You can uninstall *ProxySQL 2.x.x* using the command line. +You can uninstall ProxySQL using the command line. Make sure to use the correct package name for the version you installed, such as `proxysql2` or `proxysql3`. === "List package contents using APT" @@ -9,6 +9,12 @@ You can uninstall *ProxySQL 2.x.x* using the command line. ```{.bash data-prompt="$"} $ apt search proxysql2 ``` + + or + + ```{.bash data-prompt="$"} + $ apt search proxysql3 + ``` ??? example "Expected output" @@ -29,6 +35,12 @@ You can uninstall *ProxySQL 2.x.x* using the command line. $ sudo yum info proxysql2 ``` + or + + ```{.bash data-prompt="$"} + $ sudo yum info proxysql3 + ``` + ??? example "Expected output" ```{.text .no-copy} @@ -47,7 +59,7 @@ You can uninstall *ProxySQL 2.x.x* using the command line. Description : A high-performance MySQL proxy ``` -To uninstall ProxySQL 2, the following instructions are based on the package manager. +To uninstall ProxySQL, the following instructions are based on the package manager. === "Uninstall in a Debian-based distribution" @@ -55,17 +67,29 @@ To uninstall ProxySQL 2, the following instructions are based on the package man The `apt remove` removes the packages. Any configuration files, data, and dependencies remain in the system. If you reinstall *ProxySQL 2.x.x*, the software uses the same configuration files, data, and dependencies. The reinstallation may ask to override the existing files. - You can uninstall `ProxySQL 2.x.x` with the following command: + You can uninstall `ProxySQL` with the following command: ```{.bash data-prompt="$"} $ sudo apt remove proxysql2 ``` + + or + + ```{.bash data-prompt="$"} + $ sudo apt remove proxysql3 + ``` The `apt purge` removes the packages and any configuration files and data. You can also use `apt purge` to remove packages for an uninstalled application. ```{.bash data-prompt="$"} $ sudo apt purge proxysql2 ``` + + or + + ```{.bash data-prompt="$"} + $ sudo apt purge proxysql3 + ``` The `apt autoremove` removes the packages, configuration files, data, and any unused libraries or dependent packages that were installed when the application was installed. @@ -82,9 +106,21 @@ To uninstall ProxySQL 2, the following instructions are based on the package man ```{.bash data-prompt="$"} $ sudo yum remove proxysql2 ``` + + or + + ```{.bash data-prompt="$"} + $ sudo yum remove proxysql3 + ``` To uninstall *ProxySQL 2.x.x* along with unused dependencies, use the following command: ```{.bash data-prompt="$"} $ sudo yum autoremove proxysql2 ``` + + or + + ```{.bash data-prompt="$"} + $ sudo yum autoremove proxysql3 + ``` diff --git a/docs/upgrade-proxysql2.md b/docs/upgrade-proxysql2.md index cab83b6..5eacbe9 100644 --- a/docs/upgrade-proxysql2.md +++ b/docs/upgrade-proxysql2.md @@ -1,22 +1,15 @@ -# Upgrade ProxySQL +# Upgrade Percona build of ProxySQL - - -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. - -You can upgrade ProxySQL from version 1 to the latest version 2 or you can upgrade minor versions with ProxySQL 2. +You can upgrade to the latest version or you can upgrade minor versions. === "Upgrade between major versions" - Remove any *ProxySQL 1.x.x* packages before installing *ProxySQL 2.x.x* to upgrade ProxySQL. + Remove packages from an earlier version before installing the latest version. === "Upgrade between minor ProxySQL 2 versions" - Installing a later version automatically upgrades an earlier version *ProxySQL 2.x.x*. + Installing a later version automatically upgrades an earlier versionL. !!! admonition "See also" - [Install ProxySQL 2.x.x and the admin utilities](install-v2.md) + [Install Percona build ofProxySQL and admin utilities](install-v2.md) diff --git a/docs/where-to-download-proxysql.md b/docs/where-to-download-proxysql.md index f470152..4c88f4f 100644 --- a/docs/where-to-download-proxysql.md +++ b/docs/where-to-download-proxysql.md @@ -1,26 +1,22 @@ -# Download locations for ProxySQL 2.x.x and ProxySQL admin utilities +# Download locations for Percona build of ProxySQL and ProxySQL admin tools -In an MySQL 8.4 or Percona Server for MySQL 8.4 environment, you may have the following issues: +On the **Download ProxySQL** page, make the following selections: -* 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. +* *Select Product* - Choose either ProxySQL 2 or ProxySQL 3 -The binaries, packages, and tarballs are available at [Percona Download ProxySQL](https://www.percona.com/download-proxysql). +* *Select Product Version* - Select either ProxySQL2 or ProxySQL3 -On the **Download ProxySQL** page, select the following: +* *Select Platform* - Choose your Linux distribution -* *Product* - ProxySQL 2 -* *Product Version* - the version of ProxySQL2 -* *Platform* - the Linux distribution - -The available software platforms are based on the selected version. -You can either download all packages together in a single tar file or download the packages separately. Select **Linux - Generic** to download [binary tarballs](install-proxysql2-tarball.md). +The available software platforms are determined by the selected version. +You can download all required packages as a single tar archive or obtain them individually. +To download tarball binaries, choose Select Platform – Linux – Generic. For details, see the [tarball installation guide.](install-proxysql2-tarball.md). !!! note - You must download ProxySQL 2.4.2 or later to install the Percona Scheduler Admin tool. + To install the [pxc_scheduler_handler tool](psh-overview.md), you must use ProxySQL version 2.4.2 or later. ## Find the source code -The source code is located at [Percona/proxysql-admin-tool](https://github.com/percona/proxysql-admin-tool). The documentation source code is located at [Percona/proxysql-admin-tool-doc](https://github.com/percona/proxysql-admin-tool-doc). +The source code for the tool is available in the [Percona/proxysql-admin-tool repository](https://github.com/percona/proxysql-admin-tool). The source for its documentation is maintained separately in the [Percona/proxysql-admin-tool-doc repository](https://github.com/percona/proxysql-admin-tool-doc). diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 1cd525c..21bc1f3 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -174,22 +174,23 @@ nav: - install-v2.md - install-proxysql2-tarball.md - build-psh.md + - uninstall-proxysql2.md - Deploy: - start-or-stop-proxysql2.md - upgrade-proxysql2.md - uninstall-proxysql2.md - proxysql-admin: - - Manage: - - proxysql-admin-tool-changes.md - - proxysql-admin-tool-v2-config.md - - proxysql-admin-tool-functions.md + + - proxysql-admin-tool-changes.md + - proxysql-admin-tool-v2-config.md + - proxysql-admin-tool-functions.md - pxc_scheduler_handler: - - Manage: - - psh-overview.md - - psh-configuration.md - - psh-options.md - - psh-detailed-options.md - - psh-known-limitations.md + + - psh-overview.md + - psh-configuration.md + - psh-options.md + - psh-detailed-options.md + - psh-known-limitations.md - Reference: - trademark-policy.md - copyright-and-licensing-information.md diff --git a/variables.yml b/variables.yml index ace39ab..7be367b 100644 --- a/variables.yml +++ b/variables.yml @@ -1,6 +1,6 @@ # variables for HTML output -release: "2.7.3" -version: "2.x.x" -release_date: "April , 2025" -title_date: "2025-04-" +release: "3.0.1" +version: "3.x" +release_date: "June 12, 2025" +title_date: "2025-06-"