Skip to content

docs: add architecture diagram and explanation to README - #60

Open
senolcolak wants to merge 2 commits into
mainfrom
docs/add-architecture-diagram
Open

docs: add architecture diagram and explanation to README#60
senolcolak wants to merge 2 commits into
mainfrom
docs/add-architecture-diagram

Conversation

@senolcolak

Copy link
Copy Markdown
Collaborator

Summary

  • Adds the conceptual quorum-resilience architecture diagram (docs/assets/purpose-external-arbiter-operator.png)
  • Adds an Architecture section to the README explaining the problem (2 MONs, no majority after AZ failure), what the operator does, and the solution (3 MONs survive single AZ failure)
  • Includes a scope note clarifying that Arbiter restores control-plane quorum, not data redundancy

Test Plan

  • Verify diagram renders correctly in the GitHub README preview
  • Verify the Architecture section reads clearly and matches the diagram

@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c626bf94-f9b8-4184-b207-2ed7751e8545


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

Comment @coderabbitai help to get the list of available commands.

Adds the conceptual quorum-resilience diagram showing the problem
(2 MONs, no majority after AZ failure), what the operator does
(reserve externalMonID, create remote resources, reconcile), and
the solution (3 MONs survive single AZ failure).

Also clarifies the scope note: Arbiter restores control-plane quorum,
not data redundancy.

Signed-off-by: senol.colak <senol.colak@sap.com>
Signed-off-by: senol.colak <senol.colak@sap.com>
@senolcolak
senolcolak force-pushed the docs/add-architecture-diagram branch from a9a5d46 to 287d73c Compare August 21, 2026 14:32
@marcelradke marcelradke self-assigned this Aug 21, 2026

@marcelradke marcelradke left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM
"just" docu, nothing to harm

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