The version 0.6.0 of Percona ClusterSync for MongoDB is the technical preview. We encourage you to test Percona ClusterSync for MongoDB and give your feedback. - This will help us improve the product in the future. - -{% endblock %} - {% block scripts %} {{ super() }} diff --git a/docs/installation.md b/docs/installation.md index cb7b292..bd49bff 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -17,7 +17,7 @@ We recommend installing PCSM via the package manager of your operating system fo === ":material-docker: Docker" - Run {{plm.full_name}} in a Docker container. This is useful when your MongoDB clusters run in Docker or when you want to isolate {{plm.short}} in a containerized environment. + Run {{pcsm.full_name}} in a Docker container. This is useful when your MongoDB clusters run in Docker or when you want to isolate {{pcsm.short}} in a containerized environment. [Run in Docker :material-arrow-right:](install/docker.md){.md-button} diff --git a/docs/intro.md b/docs/intro.md index ec92663..ec9a5b2 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -75,9 +75,10 @@ The workflow for {{pcsm.short}} depends on your MongoDB deployment topology. Sel ## Filtered replication -You can replicate the whole dataset or only a specific subset of data, which is a filtered replication. Filtered replication works for both replica sets and sharded clusters. You can use filtered replication for various use cases, such as: +You can replicate the whole data set or only a specific subset of data, which is a filtered replication. You can use filtered replication for various use cases, such as: + +* Spin up a new development environment with a specific subset of data instead of the whole data set. -* Spin up a new development environment with a specific subset of data instead of the whole dataset. * Optimize cloud storage costs for hybrid environments where your target MongoDB deployment runs in the cloud. Specify what namespaces—databases and collections—to include and/or exclude from the replication when you start it. See [Start the filtered replication](install/usage.md#start-the-filtered-replication) for details. diff --git a/docs/release-notes.md b/docs/release-notes.md index fc207eb..53f7656 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -2,9 +2,11 @@ !!! note "" - Starting with version 0.7.0, Percona Link for MongoDB has been rebranded as Percona ClusterSync. Any mentions of Percona Link for MongoDB in earlier release notes now refer to this product. + Starting with version 0.7.0, Percona Link for MongoDB has been rebranded as Percona ClusterSync for MongoDB. Any mentions of Percona Link for MongoDB in earlier release notes now refer to this product. + + +* [Percona ClusterSync for MongoDB 0.7.0 ({{date.v0_7_0}})](release-notes/0.7.0.md) - * [Percona Link for MongoDB 0.6.0 ({{date.v0_6_0}})](release-notes/0.6.0.md) * [Percona Link for MongoDB 0.5.0 ({{date.v0_5_0}})](release-notes/0.5.0.md) diff --git a/docs/release-notes/0.7.0.md b/docs/release-notes/0.7.0.md new file mode 100644 index 0000000..c1937a1 --- /dev/null +++ b/docs/release-notes/0.7.0.md @@ -0,0 +1,59 @@ +# {{ pcsm.full_name }} 0.7.0 ({{ date.v0_7_0 }}) + +We are excited to announce the general availability (GA) of {{ pcsm.full_name }} ({{pcsm.short}}) for data replication across replica sets. The GA status means {{ pcsm.short }} has passed the stability and reliability milestones required for enterprise use. You can confidently deploy it in production for data migration across replica sets with near-zero downtime. + +This release also introduces data replication in sharded clusters in a tech preview stage. While not yet GA, this feature is available for testing. We encourage you to try it in non‑production environments and share feedback to help shape future improvements. + +[Get started with {{pcsm.short}}](../installation.md){.md-button} + +## Release highlights + +This release provides the following new features and improvements: + +### Data replication in sharded clusters + +You can now replicate data between sharded MongoDB clusters or sync data from one sharded deployment to another. This makes it easier to migrate clusters with minimal downtime, set up disaster recovery across sharded environments, or keep data in sync for testing and development. + +{{pcsm.short}} connects to `mongos` in both the source and target sharded clusters. This means clusters can have different numbers of shards, and you don't need to disable the balancer. Note that {{pcsm.short}} replicates data only, not metadata. That means chunk distribution and the primary shard for a collection may look different between your source and target clusters. + +This feature is in the tech preview stage. We don't recommend using it in production yet, but we encourage you to try it in testing or staging environments and share your feedback. Your input will help us improve and shape the future of {{pcsm.full_name}}. + +Learn more about sharding support in our [documentation](../sharding.md) + +### New deployment options + +In addition to installing {{pcsm.full_name}} from repositories or building from source, you now have two new options: + +* **Run {{pcsm.short}} in Docker** – quickly spin up a containerized environment with consistent dependencies and easy portability. +* **Install from binary tarballs** – drop in pre-built binaries for fast setup, even in environments without package managers or container runtimes. + +These new deployment methods give you more flexibility to choose the approach that best fits your infrastructure, whether you're working in cloud-native setups, air‑gapped systems, or lightweight test environments. + +Refer to our [Quickstart guide](../installation.md) for detailed instructions on these new deployment options. + +### Fine-tune the timeout for MongoDB client operations + +In smaller and medium‑sized clusters, the default MongoDB client operations timeout of 5 minutes is usually enough to complete data replication. However, in larger clusters, replication could fail if operations like insert, delete, or update take longer than this default limit. + +You can now override the default timeout using the `PCSM_MONGODB_CLI_OPERATION_TIMEOUT` environment variable. This gives you control to extend the timeout when working with large datasets or complex replication tasks, ensuring replication continues smoothly without being interrupted by the 5‑minute limit. + +Learn more about this and other available environment variables in our [documentation](../install/parameters.md). + +## Changelog + +### New Feature + +* [PCSM-167](https://perconadev.atlassian.net/browse/PCSM-167) - Improved the status output to include the total number of events and display the time of the last replication operation in human-readable format +* [PCSM-194](https://perconadev.atlassian.net/browse/PCSM-194) - Added the support of the `shardCollection` change stream event to replicate sharded collections +* [PCSM-195](https://perconadev.atlassian.net/browse/PCSM-195) - Added the ability to clone sharded collections +* [PCSM-207](https://perconadev.atlassian.net/browse/PCSM-207) - Expose MongoDB client operation timeout via env variable (Thank you user @balthazar for contributing to this issue) + +### Improvement + +* [PCSM-238](https://perconadev.atlassian.net/browse/PCSM-238) - Finalization stage logs now include the namespace for each index + +### Bugs Fixed + +* [PCSM-185](https://perconadev.atlassian.net/browse/PCSM-185) - Fixed a bug in the `pcsm status` command where `initialSync.lagTime` was incorrectly reported as non-zero value after the initial sync phase was finished. + +* [PCSM-230](https://perconadev.atlassian.net/browse/PCSM-230) - Fixed the issue with incorrect handling of exclude and include filtered during the filtered sync. diff --git a/docs/system-requirements.md b/docs/system-requirements.md index 85c7e25..347bc4d 100644 --- a/docs/system-requirements.md +++ b/docs/system-requirements.md @@ -11,7 +11,7 @@ ## Docker requirements -When running {{plm.short}} in Docker: +When running {{pcsm.short}} in Docker: * Ensure the Docker container has sufficient resources allocated (at least 1GB RAM and 2 CPU cores) * The container must have network connectivity to all MongoDB cluster nodes (source and target) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index ecc5591..6daea0f 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -4,7 +4,7 @@ site_name: Percona ClusterSync for MongoDB site_description: documentation site_author: Percona LLC copyright: > - Percona LLC and/or its affiliates © 2025 + Percona LLC and/or its affiliates © 2026 — Cookie Preferences repo_name: percona/pcsm-docs repo_url: https://github.com/percona/pcsm-docs @@ -188,6 +188,7 @@ nav: - FAQ: faq.md - Release notes: - Release notes index: release-notes.md + - 0.7.0: release-notes/0.7.0.md - 0.6.0: release-notes/0.6.0.md - 0.5.0: release-notes/0.5.0.md - Reference: diff --git a/variables.yml b/variables.yml index 055a5a0..aa42c4f 100644 --- a/variables.yml +++ b/variables.yml @@ -1,10 +1,11 @@ # PBM Variables set for HTML output # See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path -year: '2025' -release: '0.6.0' +year: '2026' +release: '0.7.0' date: + v0_7_0: '2026-01-14' v0_6_0: '2025-09-04' v0_5_0: '2025-06-04'