Skip to content

Commit

Permalink
PBM-1255 Added icons for external links and icons for tabs
Browse files Browse the repository at this point in the history
  • Loading branch information
@nastena1606
nastena1606 committed Mar 18, 2024
1 parent d4816c5 commit 497d06c
Show file tree
Hide file tree
Showing 26 changed files with 353 additions and 343 deletions.
22 changes: 11 additions & 11 deletions docs/details/storage-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ Percona Backup for MongoDB supports the following storage types:
Percona Backup for MongoDB should work with other S3-compatible storages, but was only tested with the following ones:


* [Amazon Simple Storage Service](https://docs.aws.amazon.com/s3/index.html)
* [Amazon Simple Storage Service :octicons-link-external-16:](https://docs.aws.amazon.com/s3/index.html)


* [Google Cloud Storage](https://cloud.google.com/storage)
* [Google Cloud Storage :octicons-link-external-16:](https://cloud.google.com/storage)


* [MinIO](https://min.io/)
* [MinIO :octicons-link-external-16:](https://min.io/)

#### Server-side encryption

Expand Down Expand Up @@ -73,8 +73,8 @@ serverSideEncryption:

AWS Documentation:

* [Protecting Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html)
* [Protecting data using server-side encryption with customer-provided encryption keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html)
* [Protecting Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service (SSE-KMS) :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html)
* [Protecting data using server-side encryption with customer-provided encryption keys (SSE-C) :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html)

#### Debug logging

Expand All @@ -88,7 +88,7 @@ To enable S3 debug logging, set the `storage.s3.DebugLogLevel` option in Percona

!!! admonition "Version added: [1.7.0](../release-notes/1.7.0.md)"

Percona Backup for MongoDB supports [Amazon S3 storage classes](https://aws.amazon.com/s3/storage-classes/). Knowing your data access patterns, you can set the S3 storage class in Percona Backup for MongoDB configuration. When Percona Backup for MongoDB uploads data to S3, the data is distributed to the corresponding storage class. The support of S3 bucket storage types allows you to effectively manage S3 storage space and costs.
Percona Backup for MongoDB supports [Amazon S3 storage classes :octicons-link-external-16:](https://aws.amazon.com/s3/storage-classes/). Knowing your data access patterns, you can set the S3 storage class in Percona Backup for MongoDB configuration. When Percona Backup for MongoDB uploads data to S3, the data is distributed to the corresponding storage class. The support of S3 bucket storage types allows you to effectively manage S3 storage space and costs.

To set the storage class, specify the `storage.s3.storageClass` option in Percona Backup for MongoDB configuration file

Expand Down Expand Up @@ -150,7 +150,7 @@ This cannot be used except if you have a single-node replica set. (See the warni

!!! admonition "Version added: [1.5.0](../release-notes/1.5.0.md)"

You can use [Microsoft Azure Blob Storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction) as the remote backup storage for Percona Backup for MongoDB.
You can use [Microsoft Azure Blob Storage :octicons-link-external-16:](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction) as the remote backup storage for Percona Backup for MongoDB.

This gives users a vendor choice. Companies with Microsoft-based infrastructure can set up Percona Backup for MongoDB with less administrative efforts.

Expand Down Expand Up @@ -190,9 +190,9 @@ Please refer to the documentation of your selected storage for the data access m

!!! admonition "See also"

* AWS documentation: [Controlling access to a bucket with user policies](https://docs.aws.amazon.com/AmazonS3/latest/userguide/walkthrough1.html)
* Google Cloud Storage documentation: [Overview of access control](https://cloud.google.com/storage/docs/access-control)
* Microsoft Azure documentation: [Assign an Azure role for access to blob data](https://docs.microsoft.com/en-us/azure/storage/blobs/assign-azure-role-data-access?tabs=portal)
* MinIO documentation: [Policy Management](https://docs.min.io/minio/baremetal/security/minio-identity-management/policy-based-access-control.html)
* AWS documentation: [Controlling access to a bucket with user policies :octicons-link-external-16:](https://docs.aws.amazon.com/AmazonS3/latest/userguide/walkthrough1.html)
* Google Cloud Storage documentation: [Overview of access control :octicons-link-external-16:](https://cloud.google.com/storage/docs/access-control)
* Microsoft Azure documentation: [Assign an Azure role for access to blob data :octicons-link-external-16:](https://docs.microsoft.com/en-us/azure/storage/blobs/assign-azure-role-data-access?tabs=portal)
* MinIO documentation: [Policy Management :octicons-link-external-16:](https://docs.min.io/minio/baremetal/security/minio-identity-management/policy-based-access-control.html)

*[AWS KMS]: Amazon Web Services Key Management Service
6 changes: 3 additions & 3 deletions docs/details/versions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Percona Backup for MongoDB is compatible with the following MongoDB versions:

| 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](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](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](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](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](https://docs.mongodb.com/manual/replication/) enabled| Logical backups - version 3.6 and higher|
| [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|

2 changes: 1 addition & 1 deletion docs/features/comparison.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Percona Backup for MongoDB is a fully supported community backup solution that c

* [Enterprise features without extra costs](comparison.md)
* [Works for both sharded clusters and non-sharded replica sets](../details/deployments.md)
* [Simple command-line management utility](../reference/pbm-commands.md). For backup management via a user interface, consider [using PBM through Percona Monitoring and Management](https://docs.percona.com/percona-monitoring-and-management/get-started/backup/index.html)
* [Simple command-line management utility](../reference/pbm-commands.md). For backup management via a user interface, consider [using PBM through Percona Monitoring and Managemen :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/get-started/backup/index.html)
* Simple, [integrated-with-MongoDB authentication](../install/initial-setup.md#external-authentication-support-in-percona-backup-for-mongodb)
* Distributed transaction consistency with MongoDB 4.2+
* Compatibility with different storage types: [S3-compatible storage](../details/storage-configuration.md#s3-compatible-storage), [Microsoft Azure Blob storage](../details/storage-configuration.md#microsoft-azure-blob-storage), `filesystem` storage type for [locally-mounted remote filesystem backup servers](../details/storage-configuration.md#remote-filesystem-server-storage)
6 changes: 3 additions & 3 deletions docs/features/incremental-backup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@

We recommend to make a new incremental base backup and start the incremental backup chain from it after the upgrade to Percona Backup for MongoDB 2.1.0

* Incremental backup implementation is based on the [`$backupCursor`](https://docs.percona.com/percona-server-for-mongodb/6.0/backup-cursor.html) aggregation stage that is available only in Percona Server for MongoDB. Therefore, you must be running Percona Server for MongoDB in your deployment to use incremental physical backups.
* Incremental backups are supported for Percona Server for MongoDB starting with the following versions: [4.2.24-24](https://docs.percona.com/percona-server-for-mongodb/4.2/release_notes/4.2.24-24.html), [4.4.18](https://docs.percona.com/percona-server-for-mongodb/4.4/release_notes/4.4.18-18.html), [5.0.14-12](https://docs.percona.com/percona-server-for-mongodb/5.0/release_notes/5.0.14-12.html), [6.0.3-2](https://docs.percona.com/percona-server-for-mongodb/6.0/release_notes/6.0.3-2.html) and higher.
* Due to [WiredTger restrictions in Log-Structured Merge (LSM) trees](https://source.wiredtiger.com/develop/backup.html#backup_incremental-block) behavior when the `$backupCursor` is opened, incremental backups are not available if the LSM tree is configured in the database.
* Incremental backup implementation is based on the [`$backupCursor` :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/latest/backup-cursor.html) aggregation stage that is available only in Percona Server for MongoDB. Therefore, you must be running Percona Server for MongoDB in your deployment to use incremental physical backups.
* Incremental backups are supported for Percona Server for MongoDB starting with the following versions: [4.2.24-24 :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/4.2/release_notes/4.2.24-24.html), [4.4.18 :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/4.4/release_notes/4.4.18-18.html), [5.0.14-12 :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/5.0/release_notes/5.0.14-12.html), [6.0.3-2 :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/6.0/release_notes/6.0.3-2.html) and higher.
* Due to [WiredTger restrictions in Log-Structured Merge (LSM) trees :octicons-link-external-16:](https://source.wiredtiger.com/develop/backup.html#backup_incremental-block) behavior when the `$backupCursor` is opened, incremental backups are not available if the LSM tree is configured in the database.

Owners of large datasets may need to back up data frequently. Making full physical backups every time is costly in terms of storage space. Incremental physical backups come in handy in this scenario, enabling you to optimize backup strategy and reduce storage costs.

Expand Down
14 changes: 7 additions & 7 deletions docs/features/physical.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
## Availability and system requirements

* Percona Server for MongoDB starting from versions 4.2.15-16, 4.4.6-8, 5.0 and higher.
* WiredTiger is used as the storage engine in Percona Server for MongoDB, since physical backups heavily rely on the WiredTiger [`$backupCursor`](https://docs.percona.com/percona-server-for-mongodb/6.0/backup-cursor.html) functionality.
* WiredTiger is used as the storage engine in Percona Server for MongoDB, since physical backups heavily rely on the WiredTiger [`$backupCursor` :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/6.0/backup-cursor.html) functionality.

!!! admonition "See also"

Percona Blog

* [Physical Backup Support in Percona Backup for MongoDB](https://www.percona.com/blog/physical-backup-support-in-percona-backup-for-mongodb/)
* [$backupCursorExtend in Percona Server for MongoDB](https://www.percona.com/blog/2021/06/07/experimental-feature-backupcursorextend-in-percona-server-for-mongodb/)
* [Physical Backup Support in Percona Backup for MongoDB :octicons-link-external-16:](https://www.percona.com/blog/physical-backup-support-in-percona-backup-for-mongodb/)
* [$backupCursorExtend in Percona Server for MongoDB :octicons-link-external-16:](https://www.percona.com/blog/2021/06/07/experimental-feature-backupcursorextend-in-percona-server-for-mongodb/)

Physical backup is copying of physical files from the Percona Server for MongoDB `dbPath` data directory to the remote backup storage. These files include data files, journal, index files, etc. Starting with version 2.0.0, Percona Backup for MongoDB also copies the WiredTiger storage options to the backup’s metadata.

Expand Down Expand Up @@ -41,7 +41,7 @@ You may run both MongoDB Community / Enterprise Edition nodes and Percona Server

You can make a physical, incremental or a snapshot-based backup in such a mixed deployment using PBM. This saves you from having to reconfigure your deployment for a backup, and keeps both your migration and backup strategies intact.

Physical, incremental and snapshot-based backups are only possible from PSMDB nodes since their implementation is based on the [`$backupCursorExtend`](https://docs.percona.com/percona-server-for-mongodb/latest/backup-cursor.html) functionality. When it’s time to make a backup, PBM searches the PSMDB node and makes a backup from it. The PSMDB node must not be an arbiter nor a delayed node.
Physical, incremental and snapshot-based backups are only possible from PSMDB nodes since their implementation is based on the [`$backupCursorExtend` :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/latest/backup-cursor.html) functionality. When it’s time to make a backup, PBM searches the PSMDB node and makes a backup from it. The PSMDB node must not be an arbiter nor a delayed node.

If more than 2 nodes are suitable for a backup, PBM selects the one with a higher [priority](../usage/start-backup.md#adjust-node-priority-for-backups). Note that if you override a priority for at least one node, PBM assigns priority `1.0` for the remaining nodes and uses the new priority list .

Expand All @@ -64,16 +64,16 @@ During a backup, Percona Backup for MongoDB stores the encryption settings in th

Make sure that you know what master encryption key was used and store it, as this key is required for the restore.

Starting with [Percona Server for MongoDB version 4.4.19-19](https://docs.percona.com/percona-server-for-mongodb/4.4/release_notes/4.4.19-19.html), [5.0.15-13](https://docs.percona.com/percona-server-for-mongodb/5.0/release_notes/5.0.15-13.html), [6.0.5-4](https://docs.percona.com/percona-server-for-mongodb/6.0/release_notes/6.0.5-4.html) and higher, the master key rotation for data-at-rest encrypted with HashiCorp Vault has been improved to use the same secret key path on every server in your entire deployment. For the restore with earlier versions of Percona Server for MongoDB and PBM 2.0.5 and earlier, see the [Restore for Percona Server for MongoDB **before** 4.4.19-19, 5.0.15-13, 6.0.5-4 using HashiCorpVault](#restore-for-percona-server-for-mongodb-before-4419-19-5015-13-605-4-using-hashicorpvault) section.
Starting with [Percona Server for MongoDB version 4.4.19-19 :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/4.4/release_notes/4.4.19-19.html), [5.0.15-13 :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/5.0/release_notes/5.0.15-13.html), [6.0.5-4 :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/6.0/release_notes/6.0.5-4.html) and higher, the master key rotation for data-at-rest encrypted with HashiCorp Vault has been improved to use the same secret key path on every server in your entire deployment. For the restore with earlier versions of Percona Server for MongoDB and PBM 2.0.5 and earlier, see the [Restore for Percona Server for MongoDB **before** 4.4.19-19, 5.0.15-13, 6.0.5-4 using HashiCorpVault](#restore-for-percona-server-for-mongodb-before-4419-19-5015-13-605-4-using-hashicorpvault) section.

To restore the encrypted data from the backup, configure data-at-rest encryption settings on all nodes of your destination cluster or replica set to match the settings of the target cluster where you made the backup

During the restore, Percona Backup for MongoDB restores the data all nodes using the same master key. To meet the security policy requirements in your organization, we recommend to rotate the master encryption keys afterwards.

To learn more about master key rotation, refer to the following documentation:

* [Master key rotation in HashiCorp Vault server](https://docs.percona.com/percona-server-for-mongodb/6.0/vault.html#key-rotation)
* [KMIP master key rotation](https://www.mongodb.com/docs/manual/tutorial/rotate-encryption-key/#kmip-master-key-rotation)
* [Master key rotation in HashiCorp Vault server :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/6.0/vault.html#key-rotation)
* [KMIP master key rotation :octicons-link-external-16:](https://www.mongodb.com/docs/manual/tutorial/rotate-encryption-key/#kmip-master-key-rotation)

### Restore for Percona Server for MongoDB **before** 4.4.19-19, 5.0.15-13, 6.0.5-4 using HashiCorpVault

Expand Down
Loading

0 comments on commit 497d06c

Please sign in to comment.