CMR-11022: Update readme for reshard for bootstrap and indexer

[jmaeng72]

Overview

What is the objective?

To update the bootstrap and the indexer readme to be more clear on how to use the reshard APIs

What are the changes?

Update bootstrap and indexer readme

What areas of the application does this impact?

None

Required Checklist

• New and existing unit and int tests pass locally and remotely
• clj-kondo has been run locally and all errors in changed files are corrected
• I have commented my code, particularly in hard-to-understand areas
• I have made changes to the documentation (if necessary)
• My changes generate no new warnings

Additional Checklist

• I have removed unnecessary/dead code and imports in files I have changed
• I have cleaned up integration tests by doing one or more of the following:
  • migrated any are2 tests to are3 in files I have changed
  • de-duped, consolidated, removed dead int tests
  • transformed applicable int tests into unit tests
  • reduced number of system state resets by updating fixtures. Ex) (use-fixtures :each (ingest/reset-fixture {})) to be :once instead of :each

Summary by CodeRabbit

• Documentation
  • Added a clear three-step resharding workflow: Start → Status → Finalize, with guidance to complete one index reshard at a time
  • Standardized and consolidated required-parameter blocks (including shard count and elastic name options) across sections
  • Added a rollback workflow (allowed only before finalize) and emphasized finalizing only when status is COMPLETE
  • Improved example/command formatting and unified wording across resharding docs

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This PR updates resharding documentation in bootstrap-app and indexer-app READMEs: it formalizes a Start → Status → Finalize flow, consolidates Required params blocks (including elastic_name and num_shards), adds an explicit Rollback procedure, and standardizes examples/formatting.

Changes

Cohort / File(s)	Summary
Resharding Indexes (bootstrap) bootstrap-app/README.md	Adds a three-step Resharding Indexes procedure (Start, Get status, Finalize), introduces explicit Required params blocks (num_shards, elastic_name with gran-elastic/elastic options), rewords finalize/rollback notes, and standardizes examples/formatting.
Rollback & Resharding docs (indexer) indexer-app/README.md	Adds a Rollback resharding section (endpoint, required params, condition: cannot rollback after finalize), clarifies finalize prerequisite (only finalize when status is COMPLETE), and fixes curl fencing/formatting.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• CMR-10771: As a CMR Operator, I want to get the resharding status via bootstrap resharding status endpoint. #2322 — related README and resharding status/finalize/rollback flow updates (implements GET reshard status endpoints and supporting changes).

Suggested labels

hacktoberfest-accepted

Suggested reviewers

• DuJuan
• daniel-zamora

Poem

🐰 I hopped through docs with nimble feet,
Start, Status, Finalize — steps neat and sweet,
Rollback waits patient if things go awry,
Params aligned, examples dry and spry,
A carrot for clarity — hop on, bye-bye! 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: updating README files for reshard functionality in bootstrap and indexer components.
Description check	✅ Passed	The description covers the key sections (objective, changes, impacted areas) and includes checklist items, though some sections could be more detailed about the specific improvements made.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@bootstrap-app/README.md`:
- Around line 107-110: The markdown "Required params:" blocks have their
"Options:" sub-lists indented with 4 spaces which violates MD007; locate each
"Required params:" section (e.g., the block containing "num_shards" and
"elastic_name" and its "Options:" sub-list) and reduce the sub-list indentation
from 4 spaces to 2 spaces so the nested list items align as a proper markdown
sub-list; apply the same fix to the other "Required params:" blocks that contain
"num_shards", "elastic_name" and "Options:" occurrences.

In `@indexer-app/README.md`:
- Around line 232-235: The markdown list under "Required params:" violates MD007
due to 4-space indentation on the sub-list; locate the bullet containing
"elastic_name = string (elastic cluster name you want to reshard in)" and the
nested line "Options: `gran-elastic` or `elastic`" and reduce the sub-list
indentation from 4 spaces to 2 spaces so the nested list aligns correctly with
markdownlint expectations.

🧹 Nitpick comments (2)

indexer-app/README.md (1)

226-238: Clarify rollback eligibility wording.

“Rollback will be allowed IF…” reads awkwardly and is easy to misinterpret. Consider a more direct sentence for operator clarity.

Proposed wording tweak

-Rollback will be allowed IF the reshard has not been finalized, else it will not allow
+Rollback is allowed only if the reshard has not been finalized; otherwise it is rejected.

bootstrap-app/README.md (1)

92-106: Tighten resharding wording.

“Going to be resharded” is less direct; “will be resharded” reads cleaner.

Proposed wording tweak

-You MUST give the elastic_name parameter to tell CMR which elastic cluster your index is in that is going to be resharded.
+You MUST give the elastic_name parameter to tell CMR which elastic cluster your index is in that will be resharded.