PBM-1339 Extended PBM compatibility table (#186)

PBM-1339 Extended PBM compatibility table * Added links to it modified: docs/details/versions.md modified: docs/index.md modified: docs/install/repos.md modified: docs/install/source.md modified: docs/install/tarball.md modified: docs/installation.md modified: mkdocs-base.yml --------- Co-authored-by: Santo <[email protected]>
percona · Jun 24, 2024 · 363bad6 · 363bad6
1 parent 459c713
commit 363bad6
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 12 deletions.
diff --git a/docs/details/versions.md b/docs/details/versions.md
@@ -1,10 +1,27 @@
 # Supported MongoDB versions
 
-Percona Backup for MongoDB is compatible with the following MongoDB versions:
+Percona Backup for MongoDB is compatible with:
+
+* MongoDB Community / Enterprise Edition  with [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/) enabled for logical backups.
+* Percona Server for MongoDB with [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/) for logical backups. For physical backups, also configure WiredTiger as the storage engine.
+
+The following table provides information about the supported MongoDB versions for each PBM release. 
+
+!!! note ""
+
+    End-of-life MongoDB versions may work with PBM, but they are not tested for compatibility. Consider using an previous PBM version in this case.
+
+
+| PBM version | MongoDB Community / Enterprise | Percona Server for MongoDB|Compatibility with previous PBM versions|
+| ----------- |------------------------------- | ------------------------- |----------------------------------------|
+| [2.5.0](../release-notes/2.5.0.md) | <ul><li>Logical backups: version 5.0.x and higher</li></ul> | <ul><li>Logical backups: version 5.0.x and higher</li><li>Physical backups: version 5.0.x, 6.0.x, 7.0.x</li><li>Incremental backups: version 5.0.14-12, 6.0.3-2 and higher, 7.0.x</li></ul> | Yes |
+| [2.4.0](../release-notes/2.4.0.md) | <ul><li>Logical backups: version 5.0.x and higher</li></ul> | <ul><li>Logical backups: version 5.0.x and higher</li><li>Physical backups: version 5.0.x, 6.0.x, 7.0.x</li><li>Incremental backups: version 5.0.14-12, 6.0.3-2 and higher, 7.0.x</li></ul>| Yes |
+| [2.3.0](../release-notes/2.3.0.md) | <ul><li>Logical backups: version 4.4 and higher</li></ul> | <ul><li>Logical backups: version 4.4 and higher</li><li>Physical backups - version 4.4.6-8 and higher, 5.0.x, 6.0.x</li><li>Incremental backups: versions 4.4.18, 5.0.14-12, 6.0.3-2 and higher</li></ul>| Yes |
+| [2.2.0](../release-notes/2.2.0.md) | <ul><li>Logical backups: version 4.4 and higher</li></ul> | <ul><li>Logical backups: version 4.4 and higher</li><li>Physical backups - version 4.4.6-8 and higher, 5.0.x, 6.0.x</li><li>Incremental backups: versions 4.4.18, 5.0.14-12, 6.0.3-2 and higher</li></ul>| Yes |
+| [2.1.0](../release-notes/2.1.0.md) | <ul><li>Logical backups: version 4.4 and higher</li></ul> | <ul><li>Logical backups: version 4.4 and higher</li><li>Physical backups - version 4.4.6-8, 5.0.x, 6.0.x</li><li>Incremental backups: version 4.2.24-24, 4.4.18, 5.0.14-12, 6.0.3-2 and higher</li></ul>| No. A fresh backup is required|
+| [1.7.0](../release-notes/1.7.0.md) | <ul><li>Logical backups: version 4.2 and higher</li></ul> | <ul><li>Logical backups: version 4.2 and higher</li><li>Physical backups (tech preview): version 4.2.15-16, 4.4.6-8, 5.0 and higher</li></ul> | Yes
+| [1.6.1](../release-notes/1.6.1.md) | <ul><li>Logical backups: version 3.6 and higher with [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/) enabled</li></ul> | <ul><li>Logical backups: version 3.6 and higher</li></ul>|Yes
+
+
 
-| PBM version | MongoDB Community / Enterprise | Percona Server for MongoDB|
-| ----------- |------------------------------- | ------------------------- |
-| [2.3.0](../release-notes/2.3.0.md)              | Logical backups - version 4.4 and higher with [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/) enabled| - Logical backups - version 4.4 and higher <br> - Physical backups -  version 4.4.6-8, 5.0 and higher with [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/) enabled and WiredTiger configured as the storage engine.|
-| [1.7.0](../release-notes/1.7.0.md)              | Logical backups - version 4.2 and higher with [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/) enabled| - Logical backups - version 4.2 and higher <br> - Physical backups (tech preview) -  version 4.2.15-16, 4.4.6-8, 5.0 and higher with [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/) enabled and WiredTiger configured as the storage engine.
-| [1.6.1](../release-notes/1.6.1.md)              | Logical backups - version 3.6 and higher with [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/) enabled| Logical backups - version 3.6 and higher|
 
diff --git a/docs/index.md b/docs/index.md
@@ -1,8 +1,13 @@
 # Percona Backup for MongoDB documentation
 
-Percona Backup for MongoDB (PBM) is an open source and distributed solution for consistent backups and restore of [MongoDB sharded clusters and replica sets](details/deployments.md). Read more [how PBM works](intro.md).
+Percona Backup for MongoDB (PBM) is an open source and distributed solution for consistent backups and restores of [MongoDB sharded clusters and replica sets](details/deployments.md) to a specific point in time. Check [supported MongoDB versions](details/versions.md).
 
-Make backups on a running server and restore your database to a specific point in time using the PBM command line interface. Alternatively, manage backups from a web interface [with PBM and Percona Monitoring and Management :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/get-started/backup/index.html). 
+Here's how you can make backups on a running server and/or restore your database to a specific point in time:
+
+* using the [PBM command line interface](reference/pbm-commands.md). 
+* from a web interface [with PBM and Percona Monitoring and Management :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/get-started/backup/index.html). 
+
+Read [how PBM works](intro.md).
 
 !!! note ""
 

diff --git a/docs/install/repos.md b/docs/install/repos.md
@@ -6,7 +6,7 @@ To install the software from Percona repositories means to subscribe to them. Pe
 
 ## Before you start
 
-Check the [system requirements](../system-requirements.md).
+Check the [system requirements](../system-requirements.md) and [supported MongoDB versions](../details/versions.md).
 
 ## Procedure
 

diff --git a/docs/install/source.md b/docs/install/source.md
@@ -1,5 +1,11 @@
 # Build from source code
 
+--8<-- "pbm-install-nodes.md"
+
+## Before you start
+
+Check the [system requirements](../system-requirements.md) and [supported MongoDB versions](../details/versions.md).
+
 ## Prerequisites 
 
 To build Percona Backup for MongoDB from source, you need the following:

diff --git a/docs/install/tarball.md b/docs/install/tarball.md
@@ -7,7 +7,11 @@ You can download Percona Backup for MongoDB from [Percona website :octicons-link
 
 --8<-- "pbm-install-nodes.md"
 
-## Install from binary tarball
+## Before you start
+
+Check the [system requirements](../system-requirements.md) and [supported MongoDB versions](../details/versions.md).
+
+## Install from binary tarballs
 
 Find the link to the binary tarballs under the **Generic Linux** menu item on [Percona website :octicons-link-external-16:](https://www.percona.com/downloads/percona-backup-mongodb/).
 {.power-number}

diff --git a/docs/installation.md b/docs/installation.md
@@ -2,7 +2,7 @@
 
 Percona Backup for MongoDB (PBM) is an open source and distributed solution for consistent backups and restore of [MongoDB sharded clusters and replica sets](details/deployments.md). [Learn how PBM works](intro.md).
 
-Find the list of supported platforms for Percona Backup for MongoDB on the [Percona Software and Platform Lifecycle :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mongodb) page.
+Find the list of supported platforms for Percona Backup for MongoDB on the [Percona Software and Platform Lifecycle :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mongodb) page. Also, check [supported MongoDB versions](details/versions.md).
 
 ## Tutorials
 

diff --git a/mkdocs-base.yml b/mkdocs-base.yml
@@ -208,7 +208,7 @@ nav:
       - release-notes/2.4.1.md
       - release-notes/2.4.0.md
       - 2023 (versions 2.0.4 to 2.3.1):
-        - release-notes/2.3.1.md
+        - Percona Backup for MongoDB 2.3.1 (2023-12-04): release-notes/2.3.1.md
         - release-notes/2.3.0.md
         - release-notes/2.2.1.md
         - release-notes/2.2.0.md