Skip to content

Commit bac5f01

Browse files
DISTMYSQL-571 Add the plugin and update links to open in a new tab. Remove code copy (8.4) (#253)
modified: docs/architecture-components.md modified: docs/components.md modified: docs/copyright.md modified: docs/deploy-pdps-group-replication.md modified: docs/deployment-variants.md modified: docs/download-instructions.md modified: docs/get-help.md modified: docs/index.md modified: docs/install-pdps.md modified: docs/install-pdpxc.md modified: docs/installing.md modified: docs/minor-upgrade.md modified: docs/monitoring.md modified: docs/pdps-group-replication.md modified: docs/ps-or-pdps.md modified: docs/replication-manager-for-pxc.md modified: docs/replication-manager-troubleshooting.md modified: docs/trademark-policy.md modified: docs/uninstalling.md modified: mkdocs-base.yml
1 parent e38ddda commit bac5f01

20 files changed

+214
-216
lines changed

docs/architecture-components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Architecture and components
22

33
The following is the architecture layout for
4-
*Percona Server for MySQL* based deployment variant of Percona Distribution for MySQL with [Group Replication](https://dev.mysql.com/doc/refman/{{vers}}/en/group-replication.html).
4+
*Percona Server for MySQL* based deployment variant of Percona Distribution for MySQL with [Group Replication :octicons-link-external-16:](https://dev.mysql.com/doc/refman/{{vers}}/en/group-replication.html).
55

66
## Architecture layout
77

docs/components.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22

33
Percona Distribution for MySQL consists of the following **components**:
44

5-
* [Percona Server for MySQL](https://docs.percona.com/percona-server/{{vers}}/) is a drop-in replacement for MySQL Community Edition with the enterprise-grade features embedded by Percona.
5+
* [Percona Server for MySQL :octicons-link-external-16:](https://docs.percona.com/percona-server/{{vers}}/) is a drop-in replacement for MySQL Community Edition with the enterprise-grade features embedded by Percona.
66

7-
* [Percona XtraDB Cluster](https://docs.percona.com/percona-xtradb-cluster/{{vers}}/index.html) is the high-available clustering solution for MySQL. It is based on [Percona Server for MySQL](https://docs.percona.com/percona-server/{{vers}}/index.html) and uses [Percona XtraBackup](https://docs.percona.com/percona-xtrabackup/{{vers}}/index.html) for node provisioning.
7+
* [Percona XtraDB Cluster :octicons-link-external-16:](https://docs.percona.com/percona-xtradb-cluster/{{vers}}/index.html) is the high-available clustering solution for MySQL. It is based on [Percona Server for MySQL :octicons-link-external-16:](https://docs.percona.com/percona-server/{{vers}}/index.html) and uses [Percona XtraBackup :octicons-link-external-16:](https://docs.percona.com/percona-xtrabackup/{{vers}}/index.html) for node provisioning.
88

9-
* [Percona XtraBackup](https://docs.percona.com/percona-xtrabackup/{{vers}}/) is an open-source hot backup utility for MySQL-based servers that doesn’t lock your database during the backup.
9+
* [Percona XtraBackup :octicons-link-external-16:](https://docs.percona.com/percona-xtrabackup/{{vers}}/) is an open-source hot backup utility for MySQL-based servers that doesn’t lock your database during the backup.
1010

11-
* [Orchestrator](https://github.com/openark/orchestrator) is the replication topology manager for Percona Server for MySQL.
11+
* [Orchestrator :octicons-link-external-16:(https://github.com/openark/orchestrator) is the replication topology manager for Percona Server for MySQL.
1212

13-
* [HAProxy](http://www.haproxy.org/) is the default high-availability and load-balancing solution for Percona XtraDB Cluster.
13+
* [HAProxy :octicons-link-external-16:](http://www.haproxy.org/) is the default high-availability and load-balancing solution for Percona XtraDB Cluster.
1414

15-
* [ProxySQL](https://proxysql.com/) is a high performance, high-availability, protocol-aware proxy for MySQL.
15+
* [ProxySQL :octicons-link-external-16:](https://proxysql.com/) is a high performance, high-availability, protocol-aware proxy for MySQL.
1616

17-
* [Percona Toolkit](https://www.percona.com/doc/percona-toolkit/3.0/index.html) is the set of scripts to simplify and optimize database operation.
17+
* [Percona Toolkit :octicons-link-external-16:](https://docs.percona.com/percona-toolkit/index.html) is the set of scripts to simplify and optimize database operation.
1818

19-
* [MySQL Shell](https://dev.mysql.com/doc/mysql-shell/{{vers}}/en/) is an advanced client and code editor for MySQL Server.
19+
* [MySQL Shell :octicons-link-external-16:](https://dev.mysql.com/doc/mysql-shell/{{vers}}/en/) is an advanced client and code editor for MySQL Server.
2020

2121

22-
* [MySQL Router](https://dev.mysql.com/doc/mysql-router/{{vers}}/en/) is lightweight middleware that provides transparent routing between your application and back-end MySQL servers.
22+
* [MySQL Router :octicons-link-external-16:](https://dev.mysql.com/doc/mysql-router/{{vers}}/en/) is lightweight middleware that provides transparent routing between your application and back-end MySQL servers.
2323

2424
!!! important
2525

docs/copyright.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
## Documentation licensing
44

5-
Percona Distribution for MySQL documentation is (C)2009-2026 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/).
5+
Percona Distribution for MySQL documentation is (C)2009-2026 Percona LLC and/or its affiliates and is distributed under the [Creative Commons Attribution 4.0 International License :octicons-link-external-16:](https://creativecommons.org/licenses/by/4.0/).
66

docs/deploy-pdps-group-replication.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ We will use the following elements:
4646

4747
2. Make sure that all the nodes use the same time-zone and time
4848

49-
```{.bash data-prompt="$"}
50-
$ date
49+
```shell
50+
date
5151
Tue Aug 18 08:22:12 EDT 2020
5252
```
5353

@@ -64,8 +64,8 @@ We will use the following elements:
6464

6565
5. After instances are up and running, check *Percona Server for MySQL* version on each node:
6666

67-
```{.bash data-prompt="mysql>"}
68-
mysql>\s
67+
```sql
68+
\s
6969
--------------
7070
/opt/mysql_templates/PS-8P/bin/mysql Ver {{psvers}} for Linux on x86_64 (Percona Server (GPL), Release 11, Revision 159f0eb)
7171
```
@@ -88,8 +88,8 @@ We will use the following elements:
8888

8989
2. Make sure to have a good and unique SERVER_ID value:
9090

91-
```{.bash data-prompt="mysql>"}
92-
mysql> show global variables like 'server_id';
91+
```sql
92+
show global variables like 'server_id';
9393
+---------------+-------+
9494
| Variable_name | Value |
9595
+---------------+-------+
@@ -105,8 +105,8 @@ We will use the following elements:
105105

106106
1. Stop all the nodes
107107

108-
```{.bash data-prompt="$"}
109-
$ service mysql stop
108+
```shell
109+
service mysql stop
110110
```
111111

112112

@@ -161,8 +161,8 @@ We will use the following elements:
161161

162162
3. Restart all nodes:
163163

164-
```{.bash data-prompt="$"}
165-
$ service mysql start
164+
```shell
165+
service mysql start
166166
```
167167

168168

@@ -225,19 +225,19 @@ We will use the following elements:
225225
At this stage, you should be able to start the first (Primary) cluster node.
226226

227227

228-
4. Start the Primary node (Gr1) and enable Group Replication:
228+
4. Start the Primary node (Gr1), `(dba@node1)[none]>`, and enable Group Replication:
229229

230-
```{.bash data-prompt="(dba@node1)[none]>"}
231-
(dba@node1)[none]> SET GLOBAL group_replication_bootstrap_group=ON;
232-
(dba@node1)[none]> START GROUP_REPLICATION;
233-
(dba@node1)[none]> SET GLOBAL group_replication_bootstrap_group=OFF;
230+
```shell
231+
SET GLOBAL group_replication_bootstrap_group=ON;
232+
START GROUP_REPLICATION;
233+
SET GLOBAL group_replication_bootstrap_group=OFF;
234234
```
235235

236236
5. Check if the node registered correctly:
237237

238238

239-
```{.bash data-prompt="(dba@node1)[none]>"}
240-
(dba@node1) [none]>select * from performance_schema.replication_group_members\G
239+
```shell
240+
select * from performance_schema.replication_group_members\G
241241
CHANNEL_NAME: group_replication_applier
242242
MEMBER_ID: 90a353b8-e6dc-11ea-98fa-08002734ed50
243243
MEMBER_HOST: gr1
@@ -250,16 +250,16 @@ We will use the following elements:
250250
251251
6. Once the Primary node is running, connect to the secondary node (Gr2 node) and enable Group Replication:
252252
253-
```{.bash data-prompt="(dba@node2) [none]>"}
254-
(dba@node2) [none]>START GROUP_REPLICATION;
253+
```shell
254+
START GROUP_REPLICATION;
255255
Query OK, 0 rows affected (4.60 sec)
256256
```
257257
258258
7. Check if the secondary node registered correctly:
259259
260260
261-
```{.bash data-prompt="(dba@node2) [performance_schema]>"}
262-
(dba@node2) [performance_schema]>select * from replication_group_members\G
261+
```shell
262+
select * from replication_group_members\G
263263
*************************** 1. row ***************************
264264
CHANNEL_NAME: group_replication_applier
265265
MEMBER_ID: 58ffd118-e6dc-11ea-8af8-08002734ed50
@@ -299,8 +299,8 @@ We will use the following elements:
299299
300300
* On the secondary node:
301301
302-
```{.bash data-prompt="(dba@node2) [performance_schema]>"}
303-
(dba@node2) [performance_schema]>use \test
302+
```shell
303+
use \test
304304
Database changed
305305
(dba@node2) [test]>select * from test1;
306306
+----+
@@ -324,7 +324,7 @@ We will use the following elements:
324324
### Step 1. Installation
325325
326326
327-
1. [Install ProxySQL](https://www.percona.com/doc/proxysql/proxysql-v2.html#installing-proxysql-v2). [In our example](#preconditions), we install ProxySQL on Proxy1 192.168.4.191 and Proxy2 192.168.4.192 nodes.
327+
1. [Install ProxySQL :octicons-link-external-16:](https://www.percona.com/doc/proxysql/proxysql-v2.html#installing-proxysql-v2). [In our example](#preconditions), we install ProxySQL on Proxy1 192.168.4.191 and Proxy2 192.168.4.192 nodes.
328328
329329
330330
2. Create the monitoring user on MySQL Group Replication nodes:
@@ -404,7 +404,7 @@ We will use the following elements:
404404
405405
### Step 3. Create a view in SYS schema
406406
407-
Once all the configuration is ready, we need to have a special view in the SYS schema in Percona server nodes. Find the view working for the server version 8 and above [here](https://github.com/Percona-Lab/group_replication_tools/blob/master/GR_sys_view_forProxysql_v1.sql).
407+
Once all the configuration is ready, we need to have a special view in the SYS schema in Percona server nodes. Find the view working for the server version 8 and above in [group_replication_tools :octicons-link-external-16:](https://github.com/Percona-Lab/group_replication_tools/blob/master/GR_sys_view_forProxysql_v1.sql).
408408
409409
Run that sql on the **Primary** node of the Group Replication cluster.
410410
@@ -444,7 +444,7 @@ If instead, you have no issue or strict requirements about some stale read, you
444444
445445
!!! admonition "See also"
446446
447-
ProxySQL Documentation: [mysql_group_replication_hostgroups](https://proxysql.com/documentation/main-runtime/#mysql_group_replication_hostgroups)
447+
ProxySQL Documentation: [mysql_group_replication_hostgroups :octicons-link-external-16:](https://proxysql.com/documentation/main-runtime/#mysql_group_replication_hostgroups)
448448
449449
### Step 5. Enable high availability for ProxySQL
450450
@@ -455,15 +455,15 @@ If instead, you have no issue or strict requirements about some stale read, you
455455
456456
=== "on Debian/Ubuntu"
457457
458-
```{.bash data-prompt="$"}
459-
$ sudo apt install -y keepalived
458+
```shell
459+
sudo apt install -y keepalived
460460
```
461461
462462
463463
=== "On RHEL/derivatives"
464464
465-
```{.bash data-prompt="$"}
466-
$ sudo yum install -y keepalived
465+
```shell
466+
sudo yum install -y keepalived
467467
```
468468
469469
@@ -520,14 +520,14 @@ The implementation of a DR (Disaster Recovery) site will follow the same directi
520520
521521
* A DR site should be located in a different geographic location than the main site (several hundred kilometers/miles away).
522522
523-
* The connection link between the main site and the DR site can only be established using *asynchronous replication* (standard MySQL [replication setup](https://dev.mysql.com/doc/refman/{{vers}}/en/replication-gtids.html) ).
523+
* The connection link between the main site and the DR site can only be established using *asynchronous replication* (standard MySQL [replication setup :octicons-link-external-16:](https://dev.mysql.com/doc/refman/{{vers}}/en/replication-gtids.html) ).
524524
525525
## Monitoring
526526
527527
### Using Percona Management and Monitoring (PMM)
528528
529529
530-
1. Use [this quickstart](https://www.percona.com/software/pmm/quickstart) to install Percona Monitoring and Management (PMM).
530+
1. Use [this quickstart :octicons-link-external-16:](https://www.percona.com/software/pmm/quickstart) to install Percona Monitoring and Management (PMM).
531531
532532
2. Specify the `replication_set` flag when registering the *Percona Server for MySQL* node or the MySQL node in PMM:
533533
@@ -644,4 +644,4 @@ ORDER BY lag_in_sec, lag_in_sec desc\G
644644
645645
!!! admonition "Based on the material from Percona Database Performance Blog"
646646
647-
This document is based on the blog post [Percona Distribution for MySQL: High Availability with Group Replication Solution](https://www.percona.com/blog/2021/04/14/percona-distribution-for-mysql-high-availability-with-group-replication-solution/) by *Marco Tusa*
647+
This document is based on the blog post [Percona Distribution for MySQL: High Availability with Group Replication Solution :octicons-link-external-16:](https://www.percona.com/blog/2021/04/14/percona-distribution-for-mysql-high-availability-with-group-replication-solution/) by *Marco Tusa*

docs/deployment-variants.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Percona Distribution for MySQL provides two deployment variants: one is Percona
2020

2121
## What deployment variant to choose?
2222

23-
The **Percona Server-based deployment variant** with [asynchronous replication](https://dev.mysql.com/doc/refman/{{vers}}/en/replication.html) utilizes the primary / secondary replication model. It enables you to create geographically distributed infrastructures with the support for disaster recovery. However, this deployment variant does not guarantee data consistency on all nodes at the given moment and provides high availability of up to 4 nines.
23+
The **Percona Server-based deployment variant** with [asynchronous replication :octicons-link-external-16:](https://dev.mysql.com/doc/refman/{{vers}}/en/replication.html) utilizes the primary / secondary replication model. It enables you to create geographically distributed infrastructures with the support for disaster recovery. However, this deployment variant does not guarantee data consistency on all nodes at the given moment and provides high availability of up to 4 nines.
2424

25-
The **Percona Server-based deployment variant** with [Group Replication](https://dev.mysql.com/doc/refman/{{vers}}/en/group-replication.html) enables you to create fault-tolerant systems with redundancy by replicating the system state to a set of servers. *Percona Server for MySQL*-based deployment with Group Replication offers a high grade of high availability (4-5 nines) and almost instant fail over when associated with a proxy.
25+
The **Percona Server-based deployment variant** with [Group Replication :octicons-link-external-16:](https://dev.mysql.com/doc/refman/{{vers}}/en/group-replication.html) enables you to create fault-tolerant systems with redundancy by replicating the system state to a set of servers. *Percona Server for MySQL*-based deployment with Group Replication offers a high grade of high availability (4-5 nines) and almost instant fail over when associated with a proxy.
2626

2727
The **Percona XtraDB Cluster-based deployment variant** guarantees data consistency on all nodes and zero data loss. The Percona XtraDB Cluster-based deployment provides a high grade of high availability (4-5 nines) and almost instant failover.
2828

docs/download-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Do the following steps to select the software, the software version, and download the packages:
44

5-
1. Go to [Percona Software Downloads](https://www.percona.com/downloads).
5+
1. Go to [Percona Software Downloads :octicons-link-external-16:](https://www.percona.com/downloads).
66
2. Locate Percona Distribution for MySQL.
77
3. Select the required product in `Select Product`, for example, Percona Server for MySQL.
88
4. Select your distribution version in the `Select Product Version` dropdown, for example, `percona-distribution-mysql-ps-8.4.4`.

docs/get-help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Our documentation guides are packed with information, but they can’t cover eve
66

77
Be a part of a space where you can tap into a wealth of knowledge from other database enthusiasts and experts who work with Percona’s software every day. While our service is entirely free, keep in mind that response times can vary depending on the complexity of the question. You are engaging with people who genuinely love solving database challenges.
88

9-
We recommend visiting our [Community Forum](https://forums.percona.com/t/welcome-to-perconas-community-forum/7){:target="_blank"}. It’s an excellent place for discussions, technical insights, and support around Percona database software. If you’re new and feeling a bit unsure, our [FAQ](https://forums.percona.com/faq){:target="_blank"} and [Guide for New Users](https://forums.percona.com/t/faq-guide-for-new-users/8562){:target="_blank"} ease you in.
9+
We recommend visiting our [Community Forum :octicons-link-external-16:](https://forums.percona.com/t/welcome-to-perconas-community-forum/7). It’s an excellent place for discussions, technical insights, and support around Percona database software. If you’re new and feeling a bit unsure, our [FAQ :octicons-link-external-16:](https://forums.percona.com/faq) and [Guide for New Users :octicons-link-external-16:](https://forums.percona.com/t/faq-guide-for-new-users/8562) ease you in.
1010

11-
If you have thoughts, feedback, or ideas, the community team would like to hear from you at [Any ideas on how to make the forum better?](https://forums.percona.com/t/any-ideas-on-how-to-make-the-forum-better/11522){:target="blank"}. We’re always excited to connect and improve everyone's experience.
11+
If you have thoughts, feedback, or ideas, the community team would like to hear from you at [Any ideas on how to make the forum better? :octicons-link-external-16:](https://forums.percona.com/t/any-ideas-on-how-to-make-the-forum-better/11522). We’re always excited to connect and improve everyone's experience.
1212

1313
## Percona experts
1414

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Percona Distribution for MySQL {{vers}} Documentation
22

3-
Percona Distribution for MySQL is a single solution with the best and most critical enterprise components from the MySQL open source community, designed and tested to work together. With [Percona Server for MySQL](https://www.percona.com/software/mysql-database/percona-server) or [Percona XtraDB Cluster](https://www.percona.com/software/mysql-database/percona-xtradb-cluster) as the base server, the distribution brings you the enterprise-grade [features](#features) for free. The set of carefully selected [components](components.md) helps you operate your MySQL database to meet your application and business needs.
3+
Percona Distribution for MySQL is a single solution with the best and most critical enterprise components from the MySQL open source community, designed and tested to work together. With [Percona Server for MySQL :octicons-link-external-16:](https://www.percona.com/software/mysql-database/percona-server) or [Percona XtraDB Cluster :octicons-link-external-16:](https://www.percona.com/software/mysql-database/percona-xtradb-cluster) as the base server, the distribution brings you the enterprise-grade [features](#features) for free. The set of carefully selected [components](components.md) helps you operate your MySQL database to meet your application and business needs.
44

55
## Features
66

@@ -10,7 +10,7 @@ Percona Distribution for MySQL is a single solution with the best and most criti
1010

1111
- **Reduced costs** - save on purchasing software licensing by using the distribution - the open-source enterprise-grade solution.
1212

13-
- **Easy-to-integrate with PMM** - benefit from all the features of [PMM](https://docs.percona.com/percona-monitoring-and-management/3/) for monitoring and managing the health of your database.
13+
- **Easy-to-integrate with PMM** - benefit from all the features of [PMM :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/3/) for monitoring and managing the health of your database.
1414

1515
Percona Distribution for MySQL comes in two [deployment variants](deployment-variants.md): one is based on Percona Server for MySQL and another one - on Percona XtraDB Cluster. They differ in the set of components and how you can use them.
1616

0 commit comments

Comments
 (0)