Skip to content

Commit a32c1bd

Browse files
patrickbirchpatrickbirch
committed
PS-10109 [DOCS] - Review and update apt-repo 8.4
 modified: docs/apt-pinning.md modified: docs/apt-repo.md
1 parent 212f6eb commit a32c1bd

File tree

4 files changed

+185
-45
lines changed

4 files changed

+185
-45
lines changed

‎docs/apt-download-deb.md

Lines changed: 120 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,127 @@
1-
# Install Percona Server for MySQL {{vers}} using downloaded DEB packages
21

3-
Download the packages from [Percona Product Downloads](https://www.percona.com/downloads). If needed, [Instructions for the Percona Product Download](download-instructions.md) are available.
2+
## Download and install Percona Server for MySQL from a `.tar` file
43

5-
The following example downloads Percona Server for MySQL {{release}} release packages for Ubuntu 22.04:
4+
Percona provides `.tar` files for different system architectures (such as AMD64 or ARM64) and [glibc](https://www.gnu.org/software/libc/) versions.
5+
6+
To avoid compatibility errors, download a file that matches your system’s architecture and glibc version.
7+
8+
## Why use a `.tar` file instead of APT or DNF?
9+
10+
You might choose a `.tar` file over your system’s package manager in the following situations:
11+
12+
13+
| Scenario | Description |
14+
|----------------------------------------------|-----------------------------------------------------------------------------|
15+
| You need a version not available in your OS | `.tar` files often include newer or custom Percona builds. |
16+
| You’re using an unsupported Linux distro | For example, Alpine, Arch, or Amazon Linux. |
17+
| You want full control over installation | Choose install path, skip auto startup, and configure manually. |
18+
| You don’t want to modify system package DB | Useful in environments with limited or no root access. |
19+
| You’re using containers or minimal images | Ideal for Docker or stripped-down environments without APT or DNF. |
20+
21+
22+
> ⚠️ Manual dependency management required
23+
> Using `.tar` files means you must manage all software dependencies yourself. This approach is best for experienced users, test environments, or containerized deployments. It’s not always recommended for production use.
24+
25+
## Download the `.tar` file
26+
27+
Use the [Percona Downloads page](https://www.percona.com/downloads/) to get the appropriate `.tar` file for your system.
28+
29+
Need help using the page? See [Instructions for the Percona Product Download](#).
30+
31+
## Recommended downloads
32+
33+
The table below lists the available tarballs for AMD64 systems. Each entry includes the glibc version and the file size.
34+
35+
| Package Type | Glibc Version | File Name | Size |
36+
|--------------|----------------|-----------|------|
37+
| Full Bundle | glibc 2.28 | `Percona-Server-8.4.5-5-Linux.x86_64.glibc2.28.tar.gz` | 1.48 GB |
38+
| Minimal | glibc 2.28 | `Percona-Server-8.4.5-5-Linux.x86_64.glibc2.28-minimal.tar.gz` | 145.7 MB |
39+
| Full Bundle | glibc 2.31 | `Percona-Server-8.4.5-5-Linux.x86_64.glibc2.31.tar.gz` | 1.49 GB |
40+
| Minimal | glibc 2.31 | `Percona-Server-8.4.5-5-Linux.x86_64.glibc2.31-minimal.tar.gz` | 151.4 MB |
41+
| Full Bundle | glibc 2.34 | `Percona-Server-8.4.5-5-Linux.x86_64.glibc2.34.tar.gz` | 1.28 GB |
42+
| Minimal | glibc 2.34 | `Percona-Server-8.4.5-5-Linux.x86_64.glibc2.34-minimal.tar.gz` | 141.2 MB |
43+
| Full Bundle | glibc 2.35 | `Percona-Server-8.4.5-5-Linux.x86_64.glibc2.35.tar.gz` | 1.47 GB |
44+
| Minimal | glibc 2.35 | `Percona-Server-8.4.5-5-Linux.x86_64.glibc2.35-minimal.tar.gz` | 151.2 MB |
45+
46+
## Choosing between Full and Minimal packages
47+
48+
Percona provides two `.tar` package types:
49+
50+
### 🏗️ Full Bundle
51+
52+
Includes server binaries, client tools, test utilities, and plugins.
53+
54+
Best for:
55+
56+
* First-time installations
57+
* Development environments
58+
* Users who want everything included
59+
60+
Size: ~1.4–1.5 GB
61+
62+
### 🧪 Minimal Package
63+
64+
A slim version with only core server binaries.
65+
66+
Best for:
67+
68+
* Lightweight containers or virtual machines
69+
* Production systems with tight resource limits
70+
* Advanced users who prefer installing only what they need
71+
72+
Size: ~140–150 MB
73+
74+
> 🔍 Quick Tip
75+
> If you’re unsure which package to use, start with the Full Bundle. It’s easier to explore and troubleshoot. You can switch to the Minimal version later for leaner deployments.
76+
77+
## Check your system architecture and glibc version
78+
79+
Make sure the file you download is compatible with your system.
80+
81+
### Check your architecture
82+
83+
Run this command to identify your system’s CPU type:
84+
85+
```
86+
$ uname -m
87+
```
88+
89+
This command shows what type of processor your system uses:
90+
91+
* `x86_64` means your system uses AMD64 architecture (Intel or AMD).
92+
93+
* `aarch64` means your system uses ARM64 architecture (Apple Silicon or ARM-based servers).
94+
95+
??? example "Expected output"
96+
97+
```{.text .no-copy}
98+
x86_64
99+
```
100+
101+
#### Check your glibc version
102+
103+
Run this command to see which version of the GNU C Library (glibc) your system is using:
104+
105+
```
106+
$ getconf GNU_LIBC_VERSION
107+
```
108+
109+
The glibc version must match or exceed the version required by the Percona tarball.
110+
111+
112+
??? example "Expected output"
113+
114+
```{.text .no-copy}
115+
glibc 2.35
116+
```
117+
118+
119+
> 🧠 **Tip:** If the architecture or glibc version doesn't match, the binary may not run, and you could see errors like `wrong ELF class` or `version 'GLIBC_x.x' not found`.
120+
121+
The following example downloads Percona Server for MySQL {{release}} packages for Ubuntu 22.04 on a AMD64 server:
6122

7123
```{.bash data-prompt="$"}
8-
$ wget https://downloads.percona.com/downloads/Percona-Server-8.4/Percona-Server-8.4.0-1/binary/debian/jammy/x86_64/Percona-Server-8.4.0-1-r238b3c02-jammy-x86_64-bundle.tar
124+
$ wget https://downloads.percona.com/downloads/Percona-Server-{{version}}/Percona-Server-{{release}}/binary/debian/jammy/x86_64/percona-server-server_{{release}}-1.jammy_amd64.deb
9125
```
10126

11127
Unpack the download to get the packages:

‎docs/apt-pinning.md

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,44 @@
11
# Apt pinning the Percona Server for MySQL {{vers}} packages
22

3-
Pinning allows you to stay on a release and get packages from a different version. In some cases, you can pin selected packages and avoid accidentally upgrading all the packages.
3+
Apt pinning helps you control which version of a package is installed from different repositories. This is useful when you want to stay on a specific release such as Percona Server for MySQL 8.4 and avoid automatic upgrades from other sources.
44

5-
The pinning takes place in the `preference` file. To pin a package, set the `Pin-Priority` to higher numbers.
6-
7-
Make a new file `/etc/apt/preferences.d/00percona.pref`. For example, add the following to the `preference` file:
5+
To pin the Percona Server for MySQL 8.4 packages, follow these steps:
6+
{.power-number}
87

9-
```text
10-
Package:
11-
Pin: release o=Percona Development Team
12-
Pin-Priority: 1001
13-
```
8+
1. Create a preferences file in `/etc/apt/preferences.d/` named `00percona.pref`:
149

15-
For more information about the pinning, you can check the official [debian wiki](https://wiki.debian.org/AptConfiguration?action=show&redirect=AptPreferences).
10+
```{.bash data-prompt="$"}
11+
$ sudo nano /etc/apt/preferences.d/00percona.pref
12+
```
13+
14+
2. Add the pinning configuration content to the file:
15+
16+
```ini
17+
Package: percona-server-server
18+
Pin: release o=Percona Development Team,a=stable
19+
Pin-Priority: 1001
20+
```
21+
22+
* The `Package` field specifies the exact name of the package.
23+
* The `Pin` field identifies the origin of the package, which is the Percona repository.
24+
* The `Pin-Priority` field sets the priority level. A value above 1000 ensures this version is preferred over others.
25+
26+
Save and close the file.
27+
28+
3. Update package lists to refresh your package sources:
29+
30+
```{.bash data-prompt="$"}
31+
$ sudo apt update
32+
```
33+
34+
4. Install Percona Server for MySQL 8.4 using the following command:
35+
36+
```{.bash data-prompt="$"}
37+
$ sudo apt install percona-server-server
38+
```
39+
40+
Your system prioritizes the version from the Percona repository according to your pinning settings.
41+
42+
## Learn more
43+
44+
For additional details, visit the [debian wiki](https://wiki.debian.org/AptConfiguration?action=show&redirect=AptPreferences).

‎docs/apt-repo.md

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,59 @@
1-
# Use an APT repository to install Percona Server for MySQL {{vers}}
1+
# Install Percona Server for MySQL {{vers}} Using APT on Debian/Ubuntu
22

3-
Ready-to-use packages are available from the Percona Server for MySQL software
4-
repositories and the [Percona downloads] page.
3+
Percona provides ready-to-use packages for Percona Server for MySQL 8.4 through its APT repositories, offering seamless updates and dependency resolution for Debian-based systems.
54

6-
Specific information on the supported platforms, products, and versions is described in [Percona Software and Platform Lifecycle](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mysql).
5+
If you need help with installation or configuration, [Percona Support](https://www.percona.com/services/support) is available to assist you.
6+
7+
Specific information on the supported platforms, products, and versions are available in [Percona Software and Platform Lifecycle](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mysql).
8+
9+
Percona packages and Docker images collect anonymous telemetry data to improve product quality. For details on what is collected and how to opt out, see [Telemetry in Percona Server for MySQL].
710

8-
We gather [Telemetry data] in the Percona packages and Docker images.
911

10-
--8<--- "get-help-snip.md"
1112

1213
## ARM support
1314

14-
The DEB builds for Ubuntu 20.04, Ubuntu 22.04, Ubuntu 24.04, DEBIAN 11, and DEBIAN 12 contain ARM packages with the `aarch64.rpm` extension. This means that Percona Server for MySQL is available for users on ARM-based systems.
15+
Percona Server for MySQL 8.4 includes native support for the ARM64 (aarch64) architecture in its DEB packages. These packages are available for Ubuntu starting with version 20.04 and for Debian starting with version 11.
16+
1517

1618
## Install Percona Server for MySQL using APT
1719

1820
To install Percona Server for MySQL using APT, do the following steps:
1921
{.power-number}
2022

21-
1. Update the package repositories:
23+
1. Update the package index and install `curl`:
2224

2325
```{.bash data-prompt="$"}
24-
$ sudo apt update
26+
$ sudo apt update && sudo apt install curl
2527
```
2628

27-
2. Install the `curl` download utility if needed:
28-
29-
```{.bash data-prompt="$"}
30-
$ sudo apt install curl
31-
```
32-
33-
3. Download the `percona-release` repository package:
29+
2. Download the `percona-release` repository package:
3430

3531
```{.bash data-prompt="$"}
3632
$ curl -O https://repo.percona.com/apt/percona-release_latest.generic_all.deb
3733
```
3834

39-
4. Install the downloaded package with `apt` as root or with sudo:
35+
3. Install the package with `apt` as root or with sudo:
4036

4137
```{.bash data-prompt="$"}
4238
$ sudo apt install gnupg2 lsb-release ./percona-release_latest.generic_all.deb
4339
```
4440

45-
46-
5. Refresh the local cache to update the package information:
41+
4. Refresh the package index:
4742

4843
```{.bash data-prompt="$"}
4944
$ sudo apt update
5045
```
5146

52-
6. Use `percona-release` to set up the repository for the Percona Server for MySQL {{vers}} version:
47+
5. Enable the Percona Server for MySQL {{vers}} repository:
5348

5449
```{.bash data-prompt="$"}
5550
$ sudo percona-release enable-only {{pkg}} release
5651
$ sudo percona-release enable tools release
5752
```
5853

59-
7. You can check the repository setup for the Percona original release list in `/etc/apt/sources.list.d/percona-original-release.list`.
54+
6. [Optional] You can check the repository setup for the Percona original release list in ```cat /etc/apt/sources.list.d/percona-original-release.list```.
6055

61-
8. Install the server package with the `percona-release` command:
56+
8. Install the server:
6257

6358
```{.bash data-prompt="$"}
6459
$ sudo apt install percona-server-server
@@ -68,7 +63,7 @@ See [Configuring Percona repositories with `percona-release`](https://docs.perco
6863

6964
--8<--- "storage-engines.md"
7065

71-
Percona Server for MySQL includes user-defined functions (UDFs) from [Percona Toolkit](https://docs.percona.com/percona-toolkit/). These UDFs, `fnv_64`, `fnv1a_64`, `murmur_hash`, offer faster checksum calculations compared to standard methods. For detailed information about these user-defined functions, see [Percona Toolkit UDF functions](udf-percona-toolkit.md).
66+
Percona Server for MySQL includes user-defined functions (UDFs) from [Percona Toolkit](https://docs.percona.com/percona-toolkit/) for faster checksum calculations. Learn more in [Percona Toolkit UDF functions](udf-percona-toolkit.md).
7267

7368
Once the installation completes, execute the following command to install these functions:
7469

@@ -89,4 +84,4 @@ These builds should not be run in production. This build may not contain all of
8984

9085
[Percona downloads]: https://www.percona.com/downloads/Percona-Server-{{vers}}/
9186

92-
[Telemetry data]: telemetry.md
87+
[Telemetry in Percona Server for MySQL]: telemetry.md

‎mkdocs-base.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -247,21 +247,21 @@ nav:
247247
- Install Percona Server for MySQL from repositories: installation.md
248248
- Before you start:
249249
- download-instructions.md
250-
- Use APT:
251-
- Use APT repositories: apt-repo.md
250+
- APT:
251+
- Install using APT repositories: apt-repo.md
252252
- Files in DEB package: apt-files.md
253253
- build-apt-packages.md
254-
- Downloaded DEB packages: apt-download-deb.md
254+
- Download .tar file: apt-download-deb.md
255255
- Apt pinning: apt-pinning.md
256256
- Run Percona Server for MySQL: apt-run.md
257257
- Uninstall: apt-uninstall-server.md
258-
- Use YUM:
259-
- Use RPM repositories: yum-repo.md
258+
- YUM:
259+
- Install using RPM repositories: yum-repo.md
260260
- Files in RPM package: yum-files.md
261-
- Downloaded RPM packages: yum-download-rpm.md
261+
- Download RPM packages: yum-download-rpm.md
262262
- Run Percona Server for MySQL: yum-run.md
263263
- Uninstall: yum-uninstall.md
264-
- Use binary tarballs:
264+
- Binary tarballs:
265265
- Install with binary tarballs: binary-tarball-install.md
266266
- Binary tarballs available: binary-tarball-names.md
267267
- Compile from source:

0 commit comments

Comments
 (0)