K8SPS-768 Documented the ability to rejoin the replica to the cluste… - #236
Open
nastena1606 wants to merge 2 commits into
Open
K8SPS-768 Documented the ability to rejoin the replica to the cluste…#236nastena1606 wants to merge 2 commits into
nastena1606 wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the ClusterSet replication documentation to cover the supported/manual “rejoin replica” workflow, and wires that guidance into related docs (limitations, statuses, annotations) so users can recover replication after pauses/stops or failed channels.
Changes:
- Documented the “rejoin a replica cluster” procedure (including expected states/conditions and the
percona.com/clusterset-rejoin-clustertrigger). - Updated ClusterSet limitations/status references to point to the new rejoin documentation instead of inline shell commands.
- Added/updated cross-references in pause, CR statuses, ClusterSet CR, and annotations docs to guide users to the rejoin flow.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/replication.md | Updates ClusterSet specifics/limitations to reference the new rejoin procedure. |
| docs/replication-setup.md | Adds a detailed “Rejoin a replica cluster” section and links it from failover recovery guidance. |
| docs/pause.md | Notes that unpausing a ClusterSet replica doesn’t restart ClusterSet replication and points to rejoin steps. |
| docs/cr-statuses.md | Extends status/conditions/events documentation with rejoin-related guidance and terminology. |
| docs/clusterset-cr.md | Documents the rejoin annotation on the ClusterSet CR metadata. |
| docs/annotations.md | Adds the ClusterSet rejoin annotation to the annotations reference table. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| Do not rejoin while a switchover or failover is running, and do not target the current primary. | ||
|
|
||
| * If `SwitchoverInProgress` is `True`, or `spec.primaryCluster` differs from `status.primaryCluster`, wait until switchover finishes. If you trigger the rejoin operation during switchover, the Operator defers the rejoin until it completes. | ||
| * Set the annotation to the replica's InnoDB cluster name (`status.innodbClusterName`), not the Kubernetes Custom Resource name and not the current primary. The Operator ignores a rejoin annotation that names the primary. |
| | `percona.com/configuration-hash` | Services | Used to track and validate configuration changes in the MySQL cluster components | | ||
| | `percona.com/last-config-hash` | Services | Stores the hash of the most recent configuration | | ||
| | `percona.com/passwords-updated`| Secrets | Indicates when passwords were last updated in the Secret | | ||
| | `percona.com/clusterset-rejoin-cluster` | `PerconaServerMySQLClusterSet` | Triggers a rejoin of the named replica to the ClusterSet. Value is the replica's InnoDB cluster name (`status.innodbClusterName`). The Operator removes the annotation after a successful rejoin. See [Rejoin a replica cluster](replication-setup.md#rejoin-a-replica-cluster). | `replicacluster` | |
nastena1606
marked this pull request as ready for review
September 2, 2026 14:02
nastena1606
requested review from
egegunes,
eleo007,
gkech,
hors,
jvpasinatto,
mayankshah1607,
nmarukovich,
pooknull and
valmiranogueira
as code owners
September 2, 2026 14:02
egegunes
reviewed
Sep 3, 2026
|
|
||
| ### Rejoin a replica cluster | ||
|
|
||
| The Operator does not rejoin a replica automatically after you pause or stop it, or after the ClusterSet replication channel stops. It cannot tell when rejoin is safe, so you trigger it. |
Contributor
There was a problem hiding this comment.
It cannot tell when rejoin is safe, so you trigger it.
this sounds a bit unambiguous
maybe we should say something like:
Operator can't tell when rejoin can be safely performed, so it needs to be triggered by you.
Collaborator
Author
There was a problem hiding this comment.
This is outdated. I updated the changes in ce5ed19#diff-0f579a90e39c2d4fa6e8630f6dda37fa5ef73e1decfa3305b6b36dff158c0262R455
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…rset