Skip to content

Commit d8f2e80

Browse files
DISTMYSQL-515-84 [DOCS] Split the Installation doc into PDPS and PDPXC (#205)
new file: docs/install-pdps.md new file: docs/install-pdpxc.md modified: docs/installing.md modified: docs/release-notes-ps-8.4.4.md
1 parent be1d8f3 commit d8f2e80

File tree

5 files changed

+339
-289
lines changed

5 files changed

+339
-289
lines changed

docs/install-pdps.md

+185
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
# Install Percona Server-based variant
2+
3+
We gather [Telemetry data on Percona Server for MySQL](https://docs.percona.com/percona-server/8.4/telemetry.html) in the Percona packages and Docker images.
4+
5+
## Prerequisites
6+
7+
To install Percona software, you need to configure the required repository. To simplify this process, use the `percona-release` repository management tool.
8+
9+
1. Install GnuPG and curl
10+
11+
```{.bash data-prompt="$"}
12+
$ sudo apt install gnupg2 curl
13+
```
14+
15+
2. [Install percona-release](https://www.percona.com/doc/percona-repo-config/installing.html). If you have it installed, [update percona-release](https://www.percona.com/doc/percona-repo-config/updating.html) to the latest version.
16+
17+
## Procedure
18+
19+
=== "On Debian and Ubuntu Linux"
20+
21+
!!! important
22+
23+
Run the following commands as the root user or via `sudo`.
24+
25+
### Enable Percona repository
26+
27+
To enable the desired repository, we recommend to use the `enable` subcommand of `percona-release`.
28+
29+
```{.bash data-prompt="$"}
30+
$ sudo percona-release enable {{majorpkg}}
31+
```
32+
33+
!!! tip
34+
35+
To enable the minor version repository, use the following command:
36+
37+
```
38+
$ sudo percona-release enable {{minorpkg}}
39+
```
40+
41+
### Install Percona Distribution for MySQL packages
42+
43+
1. Install *Percona Server for MySQL*:
44+
45+
```{.bash data-prompt="$"}
46+
$ sudo apt install percona-server-server
47+
```
48+
49+
2. Install the components. Use the commands below to install the required components:
50+
51+
Install Percona XtraBackup:
52+
53+
```{.bash data-prompt="$"}
54+
$ sudo apt install percona-xtrabackup-84
55+
```
56+
57+
Install Percona Toolkit:
58+
59+
```{.bash data-prompt="$"}
60+
$ sudo apt install percona-toolkit
61+
```
62+
63+
Install Orchestrator:
64+
65+
```{.bash data-prompt="$"}
66+
$ sudo apt install percona-orchestrator percona-orchestrator-cli percona-orchestrator-client
67+
```
68+
69+
Install MySQL Shell:
70+
71+
```{.bash data-prompt="$"}
72+
$ sudo apt install percona-mysql-shell
73+
```
74+
75+
Install ProxySQL:
76+
77+
```{.bash data-prompt="$"}
78+
$ sudo apt install proxysql2
79+
```
80+
81+
Install MySQL Router:
82+
83+
```{.bash data-prompt="$"}
84+
$ sudo apt install percona-mysql-router
85+
```
86+
87+
=== "On Red Hat Enterprise Linux and derivatives"
88+
89+
!!! admonition "Platform specific notes"
90+
91+
On CentOS 7, install the `epel-release` package. It includes the dependencies required to install Orchestrator. Use the following command:
92+
93+
```{.bash data-prompt="$"}
94+
$ sudo yum -y install epel-release
95+
```
96+
97+
Run the following commands as the root user or via `sudo`.
98+
99+
### Enable Percona repository
100+
101+
To enable the desired repository, we recommend to use the `enable` subcommand of `percona-release`.
102+
103+
```{.bash data-prompt="$"}
104+
$ sudo percona-release enable {{majorpkg}}
105+
```
106+
107+
!!! tip
108+
109+
To enable the minor version repository, use the following command:
110+
111+
```{.bash data-prompt="$"}
112+
$ sudo percona-release enable {{minorpkg}}
113+
```
114+
115+
### Install Percona Distribution for MySQL packages
116+
117+
1. Install *Percona Server for MySQL*:
118+
119+
```{.bash data-prompt="$"}
120+
$ sudo yum install percona-server-server
121+
```
122+
123+
2. Install the components. Use the commands below to install the required components:
124+
125+
Install Percona XtraBackup
126+
127+
```{.bash data-prompt="$"}
128+
$ sudo yum install percona-xtrabackup-84
129+
```
130+
131+
Install Orchestrator
132+
133+
```{.bash data-prompt="$"}
134+
$ sudo yum install percona-orchestrator percona-orchestrator-cli percona-orchestrator-client
135+
```
136+
137+
Install Percona Toolkit
138+
139+
```{.bash data-prompt="$"}
140+
$ sudo yum install percona-toolkit
141+
```
142+
143+
Install MySQL Shell:
144+
145+
```{.bash data-prompt="$"}
146+
$ sudo yum install percona-mysql-shell
147+
```
148+
149+
Install ProxySQL:
150+
151+
```{.bash data-prompt="$"}
152+
$ sudo yum install proxysql2
153+
```
154+
155+
Install MySQL Router:
156+
157+
```{.bash data-prompt="$"}
158+
$ sudo yum install percona-mysql-router
159+
```
160+
161+
### Run Percona Distribution for MySQL
162+
163+
Percona Distribution for MySQL is not started automatically on Red Hat Enterprise Linux and CentOS after the installation is complete.
164+
165+
Start it manually using the following command:
166+
167+
```{.bash data-prompt="$"}
168+
$ sudo systemctl start mysql
169+
```
170+
171+
Confirm that the service is running:
172+
173+
```{.bash data-prompt="$"}
174+
$ sudo systemctl status mysql
175+
```
176+
177+
Stop the service:
178+
179+
```{.bash data-prompt="$"}
180+
$ sudo systemctl stop mysql
181+
```
182+
183+
## Useful links
184+
185+
[Percona Software Download Instructions](download-instructions.md)

docs/install-pdpxc.md

+147
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
# Install Percona XtraDB Cluster-based variant
2+
3+
We gather [Telemetry data on Percona XtraDB Cluster](https://docs.percona.com/percona-xtradb-cluster/8.4/telemetry.html) in the Percona packages and Docker images.
4+
5+
## Prerequisites
6+
7+
To install Percona software, you need to configure the required repository. To simplify this process, use the `percona-release` repository management tool.
8+
9+
1. Install GnuPG and curl
10+
11+
```{.bash data-prompt="$"}
12+
$ sudo apt install gnupg2 curl
13+
```
14+
15+
2. [Install percona-release](https://www.percona.com/doc/percona-repo-config/installing.html). If you have it installed, [update percona-release](https://www.percona.com/doc/percona-repo-config/updating.html) to the latest version.
16+
17+
## Procedure
18+
19+
=== "On Debian and Ubuntu Linux"
20+
21+
!!! important
22+
23+
Run the following commands as the root user or via `sudo`.
24+
25+
### Enable Percona repository
26+
27+
To enable the desired repository, we recommend to use the `setup` subcommand of `percona-release`.
28+
29+
```{.bash data-prompt="$"}
30+
$ sudo percona-release setup {{majorpkgpxc}}
31+
```
32+
33+
!!! tip
34+
35+
To enable the minor version repository, use the following command:
36+
37+
```{.bash data-prompt="$"}
38+
$ sudo percona-release setup {{minorpkgpxc}}
39+
```
40+
41+
### Install Percona Distribution for MySQL packages
42+
43+
1. Install *Percona XtraDB Cluster*:
44+
45+
```{.bash data-prompt="$"}
46+
$ sudo apt install percona-xtradb-cluster
47+
```
48+
49+
50+
2. Install HAProxy:
51+
52+
```{.bash data-prompt="$"}
53+
$ sudo apt install percona-haproxy
54+
```
55+
56+
57+
3. Install the components. Use the commands below to install the required components:
58+
59+
Install Percona XtraBackup:
60+
61+
```{.bash data-prompt="$"}
62+
$ sudo apt install percona-xtrabackup-84
63+
```
64+
65+
Install Percona Toolkit:
66+
67+
```{.bash data-prompt="$"}
68+
$ sudo apt install percona-toolkit
69+
```
70+
71+
=== "On Red Hat Enterprise Linux and derivatives"
72+
73+
!!! important
74+
75+
Run the following commands as the root user or via `sudo`.
76+
77+
### Enable Percona repository
78+
79+
To enable the desired repository, we recommend to use the `setup` subcommand of `percona-release`.
80+
81+
```{.bash data-prompt="$"}
82+
$ sudo percona-release setup {{majorpkgpxc}}
83+
```
84+
85+
!!! tip
86+
87+
To enable the minor version repository, use the following command:
88+
89+
```{.bash data-prompt="$"}
90+
$ sudo percona-release setup {{minorpkgpxc}}
91+
```
92+
93+
### Install Percona Distribution for MySQL packages
94+
95+
1. Install *Percona XtraDB Cluster*:
96+
97+
```{.bash data-prompt="$"}
98+
$ sudo yum install percona-xtradb-cluster
99+
```
100+
101+
102+
2. Install HAProxy:
103+
104+
```{.bash data-prompt="$"}
105+
$ sudo yum install percona-haproxy
106+
```
107+
108+
109+
3. Install the components. Use the commands below to install the required components:
110+
111+
Install Percona XtraBackup:
112+
113+
```{.bash data-prompt="$"}
114+
$ sudo yum install percona-xtrabackup-84
115+
```
116+
117+
Install Percona Toolkit:
118+
119+
```{.bash data-prompt="$"}
120+
$ sudo yum install percona-toolkit
121+
```
122+
123+
### Run Percona Distribution for MySQL
124+
125+
Percona Distribution for MySQL is not started automatically on Red Hat Enterprise Linux and CentOS after the installation is complete.
126+
127+
Start it manually using the following command:
128+
129+
```{.bash data-prompt="$"}
130+
$ sudo systemctl start mysql
131+
```
132+
133+
Confirm that the service is running:
134+
135+
```{.bash data-prompt="$"}
136+
$ sudo systemctl status mysql
137+
```
138+
139+
Stop the service:
140+
141+
```{.bash data-prompt="$"}
142+
$ sudo systemctl stop mysql
143+
```
144+
145+
## Useful links
146+
147+
[Percona Software Download Instructions](download-instructions.md)

0 commit comments

Comments
 (0)