Skip to content

Add SolrCloud update consistency documentation - #4716

Draft
dsmiley wants to merge 1 commit into
apache:mainfrom
dsmiley:dev-docs-update-internals
Draft

Add SolrCloud update consistency documentation#4716
dsmiley wants to merge 1 commit into
apache:mainfrom
dsmiley:dev-docs-update-internals

Conversation

@dsmiley

@dsmiley dsmiley commented Aug 6, 2026

Copy link
Copy Markdown
Contributor
  • New ref guide page solrcloud-update-consistency.adoc stating the consistency model of /update in SolrCloud: acknowledgment semantics, durability, ordering, atomicity, visibility, optimistic concurrency, retry-ability, and leader failover
  • New dev-docs/distributed-update-internals.adoc: implementation deep-dive of the distributed update path (routing, fan-out, acknowledgment and error handling, shard terms) and versioning/optimistic concurrency, with an eye toward reasoning about idempotency and retries
  • AGENTS.md: add a Developer Docs Index so coding agents discover dev-docs/ when working on related topics

I want more documentation about Solr's consistency model and on how Solr implements it. So I had Claude Fable work on producing this. Ultimately I want to discuss atomicity / idempotency... that's either a follow-on conversation or could very well happen here.

The first commit here is submitted with zero a-priori review; I will review it momentarily here and hopefully others will to.

- New ref guide page solrcloud-update-consistency.adoc stating the consistency model of /update in SolrCloud: acknowledgment semantics, durability, ordering, atomicity, visibility, optimistic concurrency, retry-ability, and leader failover
- New dev-docs/distributed-update-internals.adoc: implementation deep-dive of the distributed update path (routing, fan-out, acknowledgment and error handling, shard terms) and versioning/optimistic concurrency, with an eye toward reasoning about idempotency and retries
- AGENTS.md: add a Developer Docs Index so coding agents discover dev-docs/ when working on related topics

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Comment thread AGENTS.md

Internals:

- `dev-docs/overseer/overseer.adoc` — Overseer: cluster state updates, ZkStateWriter, collection API message flow

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.

This new section looks very useful for agents, like a "map" of where to read more on dev topics. I like it.

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.

2 participants