Skip to content

Commit b3f1eab

Browse files
authored
Merge pull request #548 from percona/ps-10095
PS-10095 [DOCS] - Add get help to Upgrade topics 8.4
2 parents 427e5c7 + 42abe2e commit b3f1eab

10 files changed

+84
-37
lines changed

docs/apt-repo.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ See [Configuring Percona repositories with `percona-release`](https://docs.perco
6868

6969
--8<--- "storage-engines.md"
7070

71-
Percona Server for MySQL contains user-defined functions from [Percona Toolkit](https://docs.percona.com/percona-toolkit/). These user-defined functions, `fnv_64`, `fnv1a_64`, `murmur_hash`, provide faster checksums. For more details on the user-defined functions, see [Percona Toolkit UDF functions](udf-percona-toolkit.md).
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).
7272

73-
After the installation completes, run the following command to create these functions:
73+
Once the installation completes, execute the following command to install these functions:
7474

75-
```mysql
76-
mysql -e "INSTALL COMPONENT 'file://component_percona_udf'"
75+
```{.bash data-prompt="mysql>"}
76+
mysql> -e "INSTALL COMPONENT 'file://component_percona_udf'"
7777
```
7878

7979
## Install the Percona Testing repository using APT

docs/downgrade.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,33 @@
44

55
Downgrading to a 5.7 or earlier series is not supported.
66

7-
The following table lists the downgrade paths:
8-
9-
| Path | Examples | Methods |
10-
|---|---|---|
11-
| Within a bugfix release series or an LTS release | 8.0.35 to 8.0.34 | in-place downgrade, logical downgrade, asynchronous replication, MySQL Clone plugin |
12-
| A bugfix or LTS release to the last bugfix or LTS release series | 8.4.x to 8.0.x | logical downgrade, asynchronous replication |
13-
| A bugfix or LTS release to an innovation release after the last LTS series | 8.4.x to 8.3.0 | logical downgrade, asynchronous replication |
14-
| An innovation release to another innovation release after the last LTS series | 8.3.0 to 8.2.0 | logical downgrade, asynchronous replication |
7+
Between versions within the same Long-Term Support (LTS) series, you can downgrade from 8.4.y LTS to 8.4.x LTS using the following methods:
8+
9+
* Performing an in-place upgrade
10+
11+
* Creating a logical dump and loading it
12+
13+
* Use MySQL Clone functionality
14+
15+
* Set up replication between the versions
16+
17+
Between one LTS or Bugfix series to the previous LTS or Bugfix series, such as moving from 8.4.x LTS to 8.0.y, you have two primary options:
18+
19+
* Create a logical dump of your data and load it into the older version
20+
21+
* Set up replication between the versions.
22+
23+
!!! important "Important"
24+
This downgrade path is only supported when no new server functionality has been applied to your data.
25+
26+
Between an LTS or Bugfix series to an earlier Innovation series (after the previous LTS release), such as from 8.4.x LTS to 8.3.0 Innovation, you have the following options:
27+
28+
* Create a logical dump of your data and load it into the older version
29+
30+
* Set up replication between the versions.
31+
32+
!!! important "Important"
33+
This downgrade path is only supported when no new server functionality has been applied to your data.
1534

1635
We don't support downgrades with any 8.0.x release below 8.0.34.
1736
A releases in the range above 8.0.34 can be downgraded to any release within that range, including 8.0.34.

docs/libcoredumper.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ reasons:
5959
!!! note
6060

6161
For example, operators and containers run as the process id of PID 1. If the process ID is used to identify the core file, each container crash generates a core dump that overwrites the previous core file.
62+
63+
!!! tip "Complex Core Dump Analysis?"
64+
65+
[Percona Support](https://www.percona.com/services/support) offers expert debugging and in-depth analysis of core dump diagnostics to help you resolve critical system issues.
6266

6367
### Disabling the libcoredumper
6468

docs/udf-percona-toolkit.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Percona Toolkit UDFs
22

3-
Three Percona Toolkit UDFs that provide faster checksums are provided:
3+
These Percona Toolkit user-defined functions (UDFs) offer faster checksum calculations compared to standard methods:
44

55
* `libfnv1a_udf`
66

@@ -14,27 +14,27 @@ Three Percona Toolkit UDFs that provide faster checksums are provided:
1414

1515
## Installation
1616

17-
These UDFs are part of the *Percona Server for MySQL* packages. To install one of the UDFs into the server, execute one of the following commands, depending on which UDF you want to install:
17+
Once the installation is complete, execute the following command to install these functions:
1818

19-
```sql
20-
mysql -e "CREATE FUNCTION fnv1a_64 RETURNS INTEGER SONAME 'libfnv1a_udf.so'"
21-
mysql -e "CREATE FUNCTION fnv_64 RETURNS INTEGER SONAME 'libfnv_udf.so'"
22-
mysql -e "CREATE FUNCTION murmur_hash RETURNS INTEGER SONAME 'libmurmur_udf.so'"
19+
```{.bash data-prompt="mysql>"}
20+
mysql> mysql -e "INSTALL COMPONENT 'file://component_percona_udf'"
2321
```
2422

25-
Executing each of these commands will install its respective UDF into the server.
26-
2723
## Troubleshooting
2824

29-
If you get the error:
30-
31-
??? example "Error message"
25+
If the `INSTALL COMPONENT` command fails, try these steps:
3226

33-
```text
34-
ERROR 1126 (HY000): Can't open shared library 'fnv_udf.so' (errno: 22 fnv_udf.so: cannot open shared object file: No such file or directory)
35-
```
27+
* Check the error message for clues about what went wrong.
3628

37-
Then you may need to copy the .so file to another location in your system. Try both `/lib` and `/usr/lib`. Look at your environment’s `$LD_LIBRARY_PATH` variable for clues. If none is set, and neither `/lib` nor `/usr/lib` works, you may need to set `LD_LIBRARY_PATH` to `/lib` or `/usr/lib`.
29+
* Verify the component path `'file://component_percona_udf'`
30+
is correct and accessible.
31+
32+
* Ensure you have the necessary permissions to install
33+
components in MySQL.
34+
35+
If you're still facing issues, consider reaching out to
36+
[Percona Support](https://www.percona.com/services/support)
37+
for further assistance.
3838

3939
## Other reading
4040

docs/upgrade-components.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Upgrading from plugins to components
22

3+
[Need help navigating plugin to component transitions? Percona Support can assist].(https://www.percona.com/services/support)
4+
35
The following plugins have changed:
46

57
| Plugin | 8.0 information | {{vers}} changes | Notes |

docs/upgrade-percona-repos.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Upgrade using the Percona repositories
22

3+
[Need expert guidance for your Percona Server upgrade? Percona Support is here to help.](https://www.percona.com/services/support)
4+
35
We recommend using the Percona repositories to upgrade your server.
46

57
Find the instructions on how to enable the repositories in the following documents:

docs/upgrade-pro.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ This document provides instructions on upgrading from Percona Server for MySQL t
66

77
## Preconditions
88

9-
Request the access to the pro repository from Percona Support. You will receive the client ID and the access token which you use when downloading the packages.
9+
To begin, please contact [Percona Support](https://www.percona.com/services/support) to request access to the pro repository. They'll provide you with the client ID and access token needed for downloading packages.
10+
11+
For additional assistance during your upgrade process, our [Percona Support team](https://www.percona.com/services/support) is available to help ensure a smooth transition.
1012

1113
[Check files in packages built for Percona Server for MySQL Pro :material-arrow-right:](pro-files.md){.md-button}
1214

docs/upgrade-standalone-packages.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
# Upgrade using standalone packages
22

33

4-
Make a full backup (or dump if possible) of your database. Move the database configuration file, `my.cnf`, to another direction to save it. Stop the server with `/etc/init.d/mysql stop`.
4+
Before beginning the upgrade process:
5+
6+
1. Create a full backup (or dump if possible) of your database
7+
8+
2. Move your database configuration file (`my.cnf`) to a safe location
9+
10+
3. Stop the server using `/etc/init.d/mysql stop`
11+
12+
For detailed upgrade procedures or if you encounter any issues during this process, our [Percona support team](https://www.percona.com/services/support) is available to assist you.
513

614
=== "Debian-derived distribution"
715

docs/upgrade-strategies.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# Upgrade strategies
22

3-
There are different strategies to consider when upgrading from 8.0 to {{vers}}.
3+
For critical production systems, consider engaging [Percona Support](https://www.percona.com/services/support) to assist with your upgrade process. Our experts can help ensure a smooth transition and minimize potential risks during this sensitive operation.
44

5-
## In-place upgrade
5+
## Downgrade options
6+
7+
Review the [Downgrade options](downgrade.md) to ensure that your downgrade path is supported.
68

7-
An upgrade to {{vers}} does not allow a rollback. The in-place upgrade strategy is not recommended, and it should be used only as a last resort.
9+
## In-place upgrade
810

9-
An in-place upgrade involves shutting down the 8.0 server, and replacing the server binaries, or packages, with new ones. At this point the new server version can be started on the existing data directory. Note that the server should be configured to perform a slow shutdown by setting `innodb_fast_shutdown=0` prior to shutdown.
11+
Use the in-place upgrade strategy only as a last resort. This approach involves shutting down the server and replacing the server binaries or packages with new ones. The new server version then starts using the existing data directory. Configure the server to perform a slow shutdown by setting `innodb_fast_shutdown=0` before shutting down.
1012

1113
The benefits are:
1214

13-
* Less additional infrastructure cost compared to a new environment, but nodes must be tested.
14-
* An upgrade can be completed over weeks with cool-down periods between reader node upgrades.
15-
* Requires a failover of production traffic, and for minimal downtime you must have good high-availability tools.
15+
* Lower infrastructure costs compared to creating a new environment, though nodes require testing.
16+
17+
* Ability to complete an upgrade over weeks with cool-down periods between reader node upgrades.
18+
19+
* Requires a failover of production traffic, and achieving minimal downtime demands robust high-availability tools.
1620

17-
If you use XA transactions with InnoDB, running XA RECOVER before upgrading checks for uncommitted XA transactions. If results are returned, either commit or rollback the XA transactions by issuing an XA COMMIT or XA ROLLBACK statement.
21+
If you use XA transactions with InnoDB, running `XA RECOVER` before upgrading checks for uncommitted XA transactions. If results are returned, either commit or rollback the XA transactions by issuing an `XA COMMIT` or `XA ROLLBACK` statement.
1822

1923
## New environment with cut over
2024

docs/upgrade.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
--8<--- "get-help-snip.md"
44

5+
[Need expert guidance for your upgrade? Percona Support is here to help.](https://www.percona.com/services/support).
6+
57
Upgrading your server to {{vers}} has the following benefits:
68

79
| Benefits | Description |
@@ -22,12 +24,16 @@ Not upgrading your database can have the following risks:
2224
| Compatibility risks | You can experience compatibility issues with hardware, operating systems, or applications since the older version is not supported on newer platforms. At some point, the database server is no longer supportable. |
2325
| Failure risk | A failure in either hardware, operating system, or application may force an upgrade at the wrong time. |
2426

27+
[Concerned about upgrade risks? Percona Support can help mitigate potential issues.](https://www.percona.com/services/support)
28+
2529
Create a test environment to verify the upgrade before you upgrade the production servers. The test environment is crucial to the success of the upgrade. There is no supported [downgrade procedure](./downgrade.md). You can try to replicate from an {{vers}} version to an 8.0 version or restore a backup.
2630

2731
Tools, such as the [`pt-upgrade` tool](https://docs.percona.com/percona-toolkit/pt-upgrade.html) in the [Percona Toolkit](https://docs.percona.com/percona-toolkit/), can help with the upgrade process.
2832

2933
We recommend upgrading to the latest version.
3034

35+
[Need personalized support during your upgrade? Contact Percona Support.](https://www.percona.com/services/support)
36+
3137
Review the documentation for other changes between 8.0 to {{vers}}.
3238

3339
Review [Upgrade Strategies](./upgrade-strategies.md) for an overview of the major strategies.

0 commit comments

Comments
 (0)