Skip to content

docs(inkless): add managed replicas documentation#535

Merged
jeqo merged 1 commit intomainfrom
jeqo/pod-1952-testing-docs
Mar 17, 2026
Merged

docs(inkless): add managed replicas documentation#535
jeqo merged 1 commit intomainfrom
jeqo/pod-1952-testing-docs

Conversation

@jeqo
Copy link
Copy Markdown
Contributor

@jeqo jeqo commented Mar 13, 2026

Add Managed Replicas section to FEATURES.md covering activation, behavior, ISR semantics, partition reassignment, and controller metrics.
Add 6 new FAQ entries for managed replicas operations. Update existing FAQ answers (partition leader, replication, under-replicated partitions) to reflect managed replicas behavior. Update GLOSSARY, README, and CLIENT-BROKER-AZ-ALIGNMENT with managed replicas references.

@jeqo jeqo changed the title Jeqo/pod 1952 testing docs test/docs(diskless): integration tests, Docker demo, and documentation for managed replicas Mar 13, 2026
@jeqo jeqo requested a review from Copilot March 13, 2026 17:20

This comment was marked as outdated.

@jeqo jeqo force-pushed the jeqo/pod-2122-add-partitions-support branch 3 times, most recently from ffa6c82 to 9a37b24 Compare March 16, 2026 16:15
@jeqo jeqo force-pushed the jeqo/pod-1952-testing-docs branch 2 times, most recently from 5cbc58f to 61eb8f3 Compare March 16, 2026 17:10
Base automatically changed from jeqo/pod-2122-add-partitions-support to main March 17, 2026 09:50
@jeqo jeqo force-pushed the jeqo/pod-1952-testing-docs branch 2 times, most recently from 50a130d to e14d1f2 Compare March 17, 2026 12:06
@jeqo jeqo requested a review from Copilot March 17, 2026 12:09

This comment was marked as outdated.

@jeqo jeqo force-pushed the jeqo/pod-1952-testing-docs branch from e14d1f2 to 8befc1c Compare March 17, 2026 12:25
@jeqo jeqo changed the title test/docs(diskless): integration tests, Docker demo, and documentation for managed replicas docs(inkless): add managed replicas documentation Mar 17, 2026
@jeqo jeqo requested a review from Copilot March 17, 2026 12:27
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation across Inkless docs to describe “managed replicas” for diskless topics, including how it changes RF handling, ISR semantics, reassignment behavior, and operational visibility.

Changes:

  • Adds a new “Managed Replicas” section to FEATURES.md describing activation/config, behavior differences vs legacy, ISR semantics, reassignment, and controller metrics.
  • Updates FAQ and glossary entries to explain leader/replica semantics with managed replicas and adds a dedicated managed-replicas FAQ subsection.
  • Cross-links managed replicas from the README and AZ-alignment doc to improve discoverability.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/inkless/README.md Adds a managed-replicas link from the docs index and references where controller-level diskless metrics are documented.
docs/inkless/GLOSSARY.md Extends “Leaderless” definition with managed-replicas nuance and adds a “Managed Replicas” glossary entry.
docs/inkless/FEATURES.md Documents managed replicas and updates API behavior notes (CreateTopics / reassignments).
docs/inkless/FAQ.md Updates existing Q/A to reflect managed replicas behavior and adds a managed replicas FAQ subsection.
docs/inkless/CLIENT-BROKER-AZ-ALIGNMENT.md Adds managed replicas references and expands ISR/leader semantics comparison table for legacy vs managed replicas.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds and cross-references documentation for “managed replicas” in Inkless (diskless topics), including operational semantics (ISR, reassignment) and new controller metrics, and updates existing docs/FAQs to reflect this behavior.

Changes:

  • Document managed replicas in FEATURES.md (activation, behavior, ISR semantics, reassignment, controller metrics).
  • Update FAQ.md, GLOSSARY.md, README.md, and CLIENT-BROKER-AZ-ALIGNMENT.md to reference/describe managed replicas behavior and metrics.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/inkless/README.md Adds links to managed replicas docs and points to controller diskless metrics documentation.
docs/inkless/GLOSSARY.md Updates “Leaderless” definition and adds a “Managed Replicas” glossary entry and comparison table updates.
docs/inkless/FEATURES.md Adds a dedicated “Managed Replicas” section + updates API support notes for create/reassign semantics.
docs/inkless/FAQ.md Updates existing FAQs for managed replicas behavior and adds a new “Managed Replicas” FAQ section.
docs/inkless/CLIENT-BROKER-AZ-ALIGNMENT.md Adds managed replicas references and expands ISR/URP semantics comparison table.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds and cross-links documentation for Inkless “managed replicas” (KRaft-managed replica assignments for diskless topics), updating multiple docs to reflect activation/configuration, ISR semantics, reassignment behavior, and controller metrics.

Changes:

  • Added a new Managed Replicas section to FEATURES.md (activation, behavior, ISR semantics, reassignment, controller metrics).
  • Updated FAQ.md, GLOSSARY.md, and CLIENT-BROKER-AZ-ALIGNMENT.md to describe leader/replication/URP semantics with managed replicas.
  • Updated README.md to link to managed replicas and reference controller-level diskless metrics documentation.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
docs/inkless/README.md Adds managed replicas link and points metrics readers to controller diskless metrics in FEATURES.md.
docs/inkless/GLOSSARY.md Expands “Leaderless” definition and adds a “Managed Replicas” glossary entry + table updates.
docs/inkless/FEATURES.md Introduces Managed Replicas section and updates API support notes for create topics and reassignments.
docs/inkless/FAQ.md Updates existing Q&A for leaders/replication/URPs and adds a new Managed Replicas FAQ section.
docs/inkless/CLIENT-BROKER-AZ-ALIGNMENT.md Adds managed replica references and expands ISR semantics comparison table.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jeqo jeqo force-pushed the jeqo/pod-1952-testing-docs branch from 8c8dbb4 to 468c138 Compare March 17, 2026 13:39
@jeqo jeqo requested a review from Copilot March 17, 2026 13:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation for Inkless “managed replicas” (KRaft-managed replica assignments for diskless topics), updating core feature docs and operational FAQs to describe activation, behavior, ISR semantics, reassignment behavior, and controller-level metrics.

Changes:

  • Documented managed replicas in FEATURES.md, including creation semantics, ISR/reassignment behavior, and controller metrics.
  • Expanded/updated FAQ.md entries to reflect managed replicas operational behavior and tooling/metrics implications.
  • Added managed-replica references across index/glossary/AZ-alignment docs for consistent discoverability.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/inkless/README.md Links “Features” to managed replicas and points readers to controller diskless metrics documentation.
docs/inkless/GLOSSARY.md Adds “Managed Replicas” definition and refines “Leaderless” to distinguish data-plane vs KRaft metadata semantics.
docs/inkless/FEATURES.md Adds a full “Managed Replicas” section (activation, behavior matrix, ISR semantics, reassignment, controller metrics).
docs/inkless/FAQ.md Updates existing FAQs and adds new managed replicas Q&A for enablement/behavior/reassignment.
docs/inkless/CLIENT-BROKER-AZ-ALIGNMENT.md Updates AZ-alignment doc to mention managed replicas and expands ISR semantics comparison table.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds end-user documentation for “managed replicas” in Inkless diskless topics, explaining how KRaft replica assignments become operationally meaningful while the data path remains leaderless.

Changes:

  • Document managed replicas in FEATURES.md (activation, behavior, ISR semantics, reassignment semantics, controller metrics).
  • Expand/update FAQs and glossary entries to reflect managed replicas behavior and operational semantics.
  • Update README and AZ-alignment guide to reference managed replicas and related metrics.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/inkless/README.md Adds managed replicas pointer in docs index and references controller diskless metrics location.
docs/inkless/GLOSSARY.md Defines “Managed Replicas” and clarifies “Leaderless” meaning with/without managed replicas.
docs/inkless/FEATURES.md Adds full “Managed Replicas” section + updates API support notes for create topics / reassignment.
docs/inkless/FAQ.md Updates leader/replication/URP answers and adds managed replicas operational FAQ entries.
docs/inkless/CLIENT-BROKER-AZ-ALIGNMENT.md Adds managed replicas mention and updates ISR semantics comparison table/notes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jeqo jeqo force-pushed the jeqo/pod-1952-testing-docs branch from 3218116 to 3487a6c Compare March 17, 2026 14:02
@jeqo jeqo requested a review from Copilot March 17, 2026 14:03
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds end-to-end documentation for “managed replicas” in Inkless diskless topics so operators understand activation/configuration, KRaft/ISR behavior, reassignment semantics, and relevant metrics/tooling impacts.

Changes:

  • Add a new Managed Replicas section to FEATURES.md, including activation, behavior matrix, ISR semantics, reassignment behavior, and controller JMX metrics.
  • Expand/update FAQ.md to reflect managed replicas behavior (leaders, replication semantics, URPs) and add a managed replicas FAQ subsection.
  • Update references and terminology in README.md, GLOSSARY.md, and CLIENT-BROKER-AZ-ALIGNMENT.md to incorporate managed replicas.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/inkless/README.md Updates docs index and metrics note to link to managed replicas and new controller metrics documentation.
docs/inkless/GLOSSARY.md Extends “Leaderless” definition and adds a “Managed Replicas” glossary entry; updates classic vs diskless comparison table.
docs/inkless/FEATURES.md Documents managed replicas: enablement, RF behavior, ISR semantics, reassignment behavior, and new controller metrics.
docs/inkless/FAQ.md Updates core FAQs and adds new managed replicas operational FAQs.
docs/inkless/CLIENT-BROKER-AZ-ALIGNMENT.md Adds managed replicas references and expands ISR semantics comparison to include managed replicas.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Add Managed Replicas section to FEATURES.md covering activation,
behavior, ISR semantics, partition reassignment, and controller metrics.
Add 6 new FAQ entries for managed replicas operations. Update existing
FAQ answers (partition leader, replication, under-replicated partitions)
to reflect managed replicas behavior. Update GLOSSARY, README, and
CLIENT-BROKER-AZ-ALIGNMENT with managed replicas references.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@jeqo jeqo force-pushed the jeqo/pod-1952-testing-docs branch from 3487a6c to 1b98431 Compare March 17, 2026 14:14
@jeqo jeqo requested a review from Copilot March 17, 2026 14:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation for “managed replicas” in Inkless diskless topics, clarifying how KRaft replica/leader metadata becomes operationally meaningful (placement/tooling/metrics) while the data path remains object-storage-backed and leaderless.

Changes:

  • Documented managed replicas end-to-end (activation, behavior differences, ISR semantics, reassignment behavior, controller metrics).
  • Updated glossary/FAQ/AZ-alignment docs to reflect managed replica behavior and updated operational expectations.
  • Added cross-links from the main Inkless README to managed replicas and controller metric docs.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/inkless/README.md Links to managed replicas and points readers to controller-level diskless metrics in FEATURES.md
docs/inkless/GLOSSARY.md Expands “Leaderless” definition and adds “Managed Replicas” term + comparisons table updates
docs/inkless/FEATURES.md Adds a full “Managed Replicas” section and updates API support notes (CREATE_TOPICS / CREATE_PARTITIONS / reassignment)
docs/inkless/FAQ.md Updates leader/replication/URP answers for managed replicas and adds a managed replicas FAQ subsection
docs/inkless/CLIENT-BROKER-AZ-ALIGNMENT.md Adds managed replicas mentions and refines ISR semantics table to distinguish legacy vs managed replicas

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jeqo jeqo marked this pull request as ready for review March 17, 2026 14:24
@jeqo jeqo merged commit 9185e52 into main Mar 17, 2026
12 checks passed
@jeqo jeqo deleted the jeqo/pod-1952-testing-docs branch March 17, 2026 16:42
AnatolyPopov pushed a commit that referenced this pull request Mar 23, 2026
Add Managed Replicas section to FEATURES.md covering activation,
behavior, ISR semantics, partition reassignment, and controller metrics.
Add 6 new FAQ entries for managed replicas operations. Update existing
FAQ answers (partition leader, replication, under-replicated partitions)
to reflect managed replicas behavior. Update GLOSSARY, README, and
CLIENT-BROKER-AZ-ALIGNMENT with managed replicas references.

(cherry picked from commit 9185e52)
jeqo added a commit that referenced this pull request Mar 23, 2026
Add Managed Replicas section to FEATURES.md covering activation,
behavior, ISR semantics, partition reassignment, and controller metrics.
Add 6 new FAQ entries for managed replicas operations. Update existing
FAQ answers (partition leader, replication, under-replicated partitions)
to reflect managed replicas behavior. Update GLOSSARY, README, and
CLIENT-BROKER-AZ-ALIGNMENT with managed replicas references.
jeqo added a commit that referenced this pull request Mar 23, 2026
Add Managed Replicas section to FEATURES.md covering activation,
behavior, ISR semantics, partition reassignment, and controller metrics.
Add 6 new FAQ entries for managed replicas operations. Update existing
FAQ answers (partition leader, replication, under-replicated partitions)
to reflect managed replicas behavior. Update GLOSSARY, README, and
CLIENT-BROKER-AZ-ALIGNMENT with managed replicas references.

(cherry picked from commit 9185e52)
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.

3 participants