Skip to content

PCSM-382: Document skipping chunk pre-splitting in PCSM 1.1.0 - #87

Open
rasika-chivate wants to merge 4 commits into
mainfrom
PCSM-382-skip-presplit-docs
Open

rasika-chivate wants to merge 4 commits into
mainfrom
PCSM-382-skip-presplit-docs

Conversation

@rasika-chivate

@rasika-chivate rasika-chivate commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator

PCSM 1.1.0 lets users skip target chunk pre-splitting when they do not want to copy an uneven source layout. This documents the CLI flag, environment variable, and HTTP API option, including the default and explicit false override. The target remains sharded with the source shard key.

Sources: PCSM-382, merged implementation PR #281.

Placement and changed files

  • docs/sharding.md: adds Chunk distribution > Skip pre-splitting, with command-line, API, and environment-variable examples, the 1.1.0 qualifier, balancing considerations, and internal/upstream references. Qualifies existing pre-splitting descriptions as the default and removes the outdated "no flag" statement.
  • docs/pcsm-commands.md: adds --clone-skip-presplit to the start flags.
  • docs/install/parameters.md: adds PCSM_CLONE_SKIP_PRESPLIT to the environment variable table.
  • docs/api.md: adds cloneSkipPresplit to the POST /start request table, including startup configuration fallback.
  • mkdocs-base.yml: explicitly labels the existing sharding page Sharding support. The new subsection appears under Chunk distribution in the rendered page TOC. No new page is needed.

Validation

  • MkDocs build passed using the repository configuration and available documentation dependencies. Git revision-date and git-committers plugins were disabled for this local validation.
  • Verified rendered TOC, three example tabs, version admonition, new internal links/anchors, and JSON example syntax.
  • Reviewed the complete five-file diff against current main.
  • Existing warning: docs/about-docs.md links to missing reference/contributing.md; left unchanged.
  • Vale is unavailable locally; the GitHub Check docs with Vale workflow completed successfully (run #750).
  • Read the Percona Style Guide's voice, headings, callouts, cross-reference, code, and links guidance.

Claim-to-source map

Documentation claim Source and locator
Reason to skip pre-splitting: avoid copying uneven source distribution Jira description; implementation PR Problem
CLI flag, environment variable, API field, default false PR #281: main.go (newStartCmd, startRequest, resolveStartOptions); config/config.go (CloneConfig, bindEnvVars); pcsm/clone/clone.go (Options)
Skip only pre-splitting while retaining the source shard key PR #281: pcsm/clone/clone.go, shardCollection; tests/test_presplit_sharded.py, test_ranged_skip_presplit_keeps_native_layout
Explicit false overrides environment/startup true PR #281: cli_test.go, explicit-false and flag/env precedence cases; main.go, request forwarding and resolveStartOptions
Initial ranged layout and balancer-managed distribution; no guarantee of immediate even distribution MongoDB 8.0 Data partitioning with chunks, Initial chunks and Balancing; Manage sharded cluster balancer; existing sharding guide
Version 1.1.0 User-supplied release and Jira fix version 1.1.0 (unreleased)

The implementation is merged. This PR prepares documentation for the upcoming release. Release notes are maintained separately in PR #85.

Jira backlink verified in comment 479692. Copilot balanced review requested through GitHub's review control; review is pending.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The documentation consistently covers the new option, defaults, overrides, and operational implications across all interfaces.

0 open findings

What changed in this PR

Documents the PCSM 1.1.0 option to skip target chunk pre-splitting while preserving source shard keys.

Changes:

  • Documents CLI, API, and environment variable configuration.
  • Clarifies defaults, overrides, and balancing behavior.
  • Updates navigation and configuration references.
File Description
docs/​sharding.md Adds behavior details and usage examples.
docs/​pcsm-commands.md Documents the new CLI flag.
docs/​install/​parameters.md Documents the environment variable.
docs/​api.md Documents the API request field.
mkdocs-base.yml Labels the sharding navigation entry.

🧠 Review effort: Balanced


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The new API table entry is split into two rendered rows.

1 open finding

🧠 Review effort: Balanced

Comment thread docs/api.md Resolved
…me line to avoid a broken table row'

Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Comment thread docs/sharding.md Resolved
@radoslawszulgo radoslawszulgo mentioned this pull request Oct 29, 2026

This branch was successfully deployed

2 active deployments
PCSM-382-skip-presplit-docs - pcsm-docs PR #87 — b9f5081a Deployed Oct 10, 2026 by rasika-chivate
PCSM-382-skip-presplit-docs - plm-docs PR #87 — b9f5081a Deployed Oct 10, 2026 by nastena1606
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants