Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions _resource/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@
{# Import the theme's layout. #}
{% extends "base.html" %}

{% block announce %}
<p> The version 0.6.0 of Percona ClusterSync for MongoDB is the technical preview. We encourage you to test Percona ClusterSync for MongoDB and <a href= "https://forums.percona.com/c/mongodb/percona-link-for-mongodb-plm/87">give your feedback</a>.
This will help us improve the product in the future.

{% endblock %}

{% block scripts %}
<script src="https://cmp.osano.com/Azqe5vTyLOSbN3OuT/49ad85b5-0418-4794-ab81-7599dddd534c/osano.js"></script>
{{ super() }}
Expand Down
4 changes: 2 additions & 2 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ Afterwards, you will only need to switch your clients to connect to Percona Serv

## Filtered replication

You can replicate the whole dataset or only a specific subset of data, which is a filtered replication. 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 dataset.
* Spin up a new development environment with a specific subset of data instead of the whole data set.
* 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.
Expand Down
6 changes: 4 additions & 2 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Check notice on line 8 in docs/release-notes.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes.md#L8

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/release-notes.md", "range": {"start": {"line": 8, "column": 42}}}, "severity": "INFO"}


* [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)
58 changes: 58 additions & 0 deletions docs/release-notes/0.7.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# {{ pcsm.full_name }} 0.7.0 ({{ date.v0_7_0 }})

Check warning on line 1 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L1

[Google.Headings] '{{ pcsm.full_name }} 0.7.0 ({{ date.v0_7_0 }})' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] '{{ pcsm.full_name }} 0.7.0 ({{ date.v0_7_0 }})' should use sentence-style capitalization.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}

Check notice on line 1 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L1

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 1, "column": 30}}}, "severity": "INFO"}

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.

Check warning on line 3 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L3

[Google.We] Try to avoid using first-person plural like 'We'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}

Check notice on line 3 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L3

[Google.Contractions] Use 'we're' instead of 'We are'.
Raw output
{"message": "[Google.Contractions] Use 'we're' instead of 'We are'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 3, "column": 1}}}, "severity": "INFO"}

Check notice on line 3 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L3

[Google.Passive] In general, use active voice instead of passive voice ('are excited').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are excited').", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 3, "column": 4}}}, "severity": "INFO"}

Check notice on line 3 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L3

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 3, "column": 53}}}, "severity": "INFO"}

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.

Check warning on line 5 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L5

[Google.We] Try to avoid using first-person plural like 'We'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 5, "column": 149}}}, "severity": "WARNING"}

[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.

Check warning on line 17 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L17

[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.
Raw output
{"message": "[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 17, "column": 165}}}, "severity": "WARNING"}

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}}.

Check warning on line 19 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L19

[Google.We] Try to avoid using first-person plural like 'We'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 19, "column": 44}}}, "severity": "WARNING"}

Check warning on line 19 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L19

[Google.We] Try to avoid using first-person plural like 'we'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 19, "column": 95}}}, "severity": "WARNING"}

Check warning on line 19 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L19

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 19, "column": 193}}}, "severity": "WARNING"}

Check warning on line 19 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L19

[Google.We] Try to avoid using first-person plural like 'us'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'us'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 19, "column": 203}}}, "severity": "WARNING"}

Learn more about sharding support in our [documentation](../sharding.md)

Check warning on line 21 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L21

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 21, "column": 38}}}, "severity": "WARNING"}

### 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.

Check failure on line 27 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L27

[Google.EmDash] Don't put a space before or after a dash.
Raw output
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 27, "column": 35}}}, "severity": "ERROR"}
* **Install from binary tarballs** – drop in pre-built binaries for fast setup, even in environments without package managers or container runtimes.

Check failure on line 28 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L28

[Google.EmDash] Don't put a space before or after a dash.
Raw output
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 28, "column": 35}}}, "severity": "ERROR"}

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.

Check warning on line 32 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L32

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 32, "column": 10}}}, "severity": "WARNING"}

### 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.

Check notice on line 38 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L38

[Google.Passive] In general, use active voice instead of passive voice ('being interrupted').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('being interrupted').", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 38, "column": 267}}}, "severity": "INFO"}

Learn more about this and other available environment variables in our [documentation](../install/parameters.md).

Check warning on line 40 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L40

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 40, "column": 68}}}, "severity": "WARNING"}

## Changelog

### New Feature

Check warning on line 44 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L44

[Google.Headings] 'New Feature' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'New Feature' should use sentence-style capitalization.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 44, "column": 5}}}, "severity": "WARNING"}

* [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

Check notice on line 46 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L46

[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 46, "column": 4}}}, "severity": "INFO"}
* [PCSM-195](https://perconadev.atlassian.net/browse/PCSM-195) - Added the ability to clone sharded collections

Check notice on line 47 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L47

[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 47, "column": 4}}}, "severity": "INFO"}
* [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)

Check notice on line 48 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L48

[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 48, "column": 4}}}, "severity": "INFO"}

Check notice on line 48 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L48

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 48, "column": 123}}}, "severity": "INFO"}

### Improvement

* [PCSM-238](https://perconadev.atlassian.net/browse/PCSM-238) - Finalization stage logs now include the namespace for each index

Check notice on line 52 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L52

[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 52, "column": 4}}}, "severity": "INFO"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


### Bugs Fixed

Check warning on line 54 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L54

[Google.Headings] 'Bugs Fixed' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Bugs Fixed' should use sentence-style capitalization.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 54, "column": 5}}}, "severity": "WARNING"}

* [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.

Check notice on line 56 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L56

[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 56, "column": 4}}}, "severity": "INFO"}

Check notice on line 56 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L56

[Google.Passive] In general, use active voice instead of passive voice ('was finished').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('was finished').", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 56, "column": 207}}}, "severity": "INFO"}

* [PCSM-230](https://perconadev.atlassian.net/browse/PCSM-230) - Fixed the issue with incorrect handling of exclude and include filtered during the filtered sync.

Check notice on line 58 in docs/release-notes/0.7.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release-notes/0.7.0.md#L58

[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'PCSM', if it's unfamiliar to the audience.", "location": {"path": "docs/release-notes/0.7.0.md", "range": {"start": {"line": 58, "column": 4}}}, "severity": "INFO"}
3 changes: 2 additions & 1 deletion mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ site_name: Percona ClusterSync for MongoDB
site_description: documentation
site_author: Percona LLC
copyright: >
<a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2025
<a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2026
— <a href="#" onclick="Osano.cm.showDrawer('osano-cm-dom-info-dialog-open')">Cookie Preferences</a>
repo_name: percona/pcsm-docs
repo_url: https://github.com/percona/pcsm-docs
Expand Down Expand Up @@ -186,6 +186,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:
Expand Down
5 changes: 3 additions & 2 deletions variables.yml
Original file line number Diff line number Diff line change
@@ -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'

Expand Down