docs: audit and rewrite addon architecture documentation#234
Merged
Conversation
… pages Kafka: - Remove non-existent kbagent container; actual containers are kafka + jmx-exporter - Fix jmx-exporter port from 9187 to 5556 (from values.yaml default) - Clarify per-node-type port layout: broker=9092+9094, controller=9093, combined=all three - Add kafkatool init container (copies SASL tools to /shared-tools) for broker/combined pods - Remove incorrect "exclusively in KRaft mode" claim; Kafka 2.7 uses ZooKeeper mode RabbitMQ: - Remove non-existent kbagent and metrics-exporter containers; only one container: rabbitmq - List all ports from the actual ComponentDefinition: 4369, 5672, 15672, 15674, 25672, 15692 - Include web-stomp port 15674 that was missing from the original table Both preview and release-1_0_2 versions updated. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
MongoDB (all pod types: replica set, config-server, shard): - Add init containers: init-syncer (syncer/syncerctl → /tools), init-kubectl (kubectl → dataMountPath/tmp/bin), init-pbm-agent (pbm binaries → /tools) - Add port 3601 (ha replication) to mongodb container in all pod types MySQL (semisync + MGR): - Add port 3601 (ha replication) to mysql container for both architectures - MGR: clarify port description (3306, 3601, 33061) ClickHouse: - Add ClickHouse Keeper pod container description: container named 'clickhouse' with Keeper-specific ports 9181 (ZooKeeper-compatible client) and 9234 (Raft internal); copy-tools init copies nc (not curl) - Expand ClickHouse data pod port list to include all declared ports: 8443 (HTTPS), 9004 (MySQL wire protocol), 9005 (PostgreSQL wire protocol), 9009, 9010, 9440 Both preview and release-1_0_2 versions updated. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Complete restructure of Kafka architecture doc with Combined, Separated, and Kafka 2.x topology sections, each with Resource Hierarchy, Containers, KRaft Consensus (or ZooKeeper Coordination), and Traffic Routing subsections. Adds Partition Leader Election, Automatic Failover, and System Accounts sections. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Complete restructure with clustermode topology section covering Resource Hierarchy, Containers, Erlang Distributed Clustering, High Availability via Quorum Queues, and Traffic Routing. Adds standalone Automatic Failover and System Accounts sections. Corrects container list (single rabbitmq container, no init containers) and system accounts (root only per YAML). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add missing "Containers Inside Each Pod" section to Orchestrator:
mysql container has port 3306 only (no 3601, no syncer wrapper);
init containers are init-data + init-jq (not init-syncer/xtrabackup/jemalloc)
- Add missing per-pod services ({cluster}-mysql-mysql-{n}) to Orchestrator
traffic routing table; note roleSelector:primary on orchestrator service
- Fix system accounts table: orc/orc-proxysql only provision root, kbadmin,
and proxysql; kbdataprotection/kbprobe/kbmonitoring/kbreplicator are
semisync/MGR-only; add Topologies column and clarifying note
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…unt list
- Document all headless Service ports per topology (InstanceSet includes
every declared container port): semisync 3306/3601/9104, MGR adds 33061,
orc omits 3601
- Fix system accounts table: add Topologies column; kbdataprotection /
kbprobe / kbmonitoring / kbreplicator are absent from orc topologies
- Add Containers section to Orchestrator: mysql port 3306 only (no syncer
wrapper), init-data + init-jq init containers
- Add per-pod mysql-mysql-{n} services and orchestrator roleSelector note
to Orchestrator traffic routing table
weicao
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive accuracy review of all addon architecture docs, verified against ComponentDefinition YAML files in kubeblocks-addons. Also rewrites Kafka and RabbitMQ architecture docs to follow the established MySQL doc style.
Accuracy fixes
kbagentcontainer; correct containers tokafka+jmx-exporter(port 5556); addkafkatoolinit container; fix per-topology port tableskbagentandmetrics-exportercontainers; singlerabbitmqcontainer with all 6 ports including missing 15674 (web-stomp)Doc rewrites (MySQL doc style)
All changes applied to both
previewandrelease-1_0_2.Closes #235
Test plan
yarn dev— verify pages render correctly