Added instructions to disable glibc for tarballs and enable THP for u…

…pgrade
percona · Aug 12, 2024 · c9f3bec · c9f3bec
1 parent 1f9ecd2
commit c9f3bec
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 4 deletions.
diff --git a/.cache/plugin/git-committers/page-authors.json b/.cache/plugin/git-committers/page-authors.json
diff --git a/docs/install/apt.md b/docs/install/apt.md
@@ -91,6 +91,10 @@ Percona provides the [`percona-release`](https://docs.percona.com/percona-softwa
 By default, {{psmdb.full_name}} stores data files in `/var/lib/mongodb/`
 and configuration parameters in `/etc/mongod.conf`.
 
+## Enable Transparent Hugepages (THP)
+
+Enable Transparent Hugepages (THP) before starting Percona Server for MongoDB 8.0. THP is required to use the new TCMalloc version with MongoDB. For how to enable THP, see [Enable Transparent Hugepages (THP)](https://www.mongodb.com/docs/upcoming/administration/tcmalloc-performance/#enable-transparent-hugepages--thp-) section of documentation.
+
 ## Run {{psmdb.full_name}}
 
 **Start the service**

diff --git a/docs/install/tarball.md b/docs/install/tarball.md
@@ -71,8 +71,14 @@ Follow these steps to install Percona Server for MongoDB from a tarball:
     $ mkdir -p /data/db
     ```
 
+5. The new TCMalloc requires [Restartable Sequences (rseq) :octicons-external-16:](https://github.com/google/tcmalloc/blob/master/docs/design.md#restartable-sequences-and-per-cpu-tcmalloc) to implement [per-CPU caches](https://www.mongodb.com/docs/upcoming/reference/glossary/#std-term-per-CPU-cache). To ensure that TCMalloc can use rseq, prevent glibc from registering an rseq structure. To do this, set the following environment variable:
 
-5. Make sure that you have read and write permissions for the data
+    ```{.bash data-prompt="$"}
+    GLIBC_TUNABLES=glibc.pthread.rseq=0
+    $ export GLIBC_TUNABLES
+    ```
+
+6. Make sure that you have read and write permissions for the data
 directory and run `mongod`.
 
 ## Next steps

diff --git a/docs/install/upgrade-from-70.md b/docs/install/upgrade-from-70.md
@@ -1,12 +1,17 @@
 # Upgrading from Percona Server for MongoDB 7.0 to 8.0
 
-To upgrade Percona Server for MongoDB to version 8.0, you must be running version
+## Considerations
+
+1. To upgrade Percona Server for MongoDB to version 8.0, you must be running version
 7.0. Upgrades from earlier versions are not supported.
 
-Before upgrading your production Percona Server for MongoDB deployments, test all your applications
+2. Before upgrading your production Percona Server for MongoDB deployments, test all your applications
 in a testing environment to make sure they are compatible with the new version.
 For more information, see [Compatibility Changes in MongoDB 8.0](https://www.mongodb.com/docs/v8.0/release-notes/8.0-compatibility/)
 
+3. Enable Transparent Hugepages (THP) before starting Percona Server forMongoDB 8.0. THP is required to use the new TCMalloc version with MongoDB. For how to enable THP, see [Enable Transparent Hugepages (THP)](https://www.mongodb.com/docs/upcoming/administration/tcmalloc-performance/#enable-transparent-hugepages--thp-) section of documentation.
+
+4. If you are using data-at-rest-encryption with KMIP server, check the [upgrade considerations](../kmip.md#upgrade-considerations)
 We recommend to upgrade Percona Server for MongoDB from official Percona repositories using [`percona-release` repository management tool](https://docs.percona.com/percona-software-repositories/index.html) and
 the corresponding package manager for your system. 
 

diff --git a/docs/install/yum.md b/docs/install/yum.md
@@ -82,6 +82,10 @@ Percona provides the [`percona-release`](https://docs.percona.com/percona-softwa
 By default, {{psmdb.full_name}} stores data files in `/var/lib/mongodb/`
 and configuration parameters in `/etc/mongod.conf`.
 
+## Enable Transparent Hugepages (THP)
+
+Enable Transparent Hugepages (THP) before starting Percona Server for MongoDB 8.0. THP is required to use the new TCMalloc version with MongoDB. For how to enable THP, see [Enable Transparent Hugepages (THP)](https://www.mongodb.com/docs/upcoming/administration/tcmalloc-performance/#enable-transparent-hugepages--thp-) section of documentation.
+
 ## Run {{psmdb.full_name}}
 
 !!! note