Repository navigation
docs(book,plans): a Conformity Language Reference appendix, and the adminless plan with what shipped - #444
Merged
Conversation
…dminless plan with what shipped The book teaches the conformity language in its Conformity Checks chapter, but had no place that lists every field, value kind, rule id, report field and lint code. A new appendix does, after the version matrix; the chapter, the CLI Reference, the Reference part's intro and the README point to it. It is written against main as of #443: - a key set twice to the same value is a lint error that fmt fixes (#437); - with rbac.scope=namespace, zones, skew and rack awareness read the EndpointSlices of the brokers' headless Service when nodes can't be listed, and podMonitor looks in the Kafka namespace only (#439); - a refused get of the Kafka resource is a 503 naming the grant (#439), which the API Reference now says too; - the chart sets the checked namespace and cluster from networkPolicy.kafka.namespace and kafka.clusterName (#441). plans/adminless-kubernetes.md is the plan behind #439, with a status block naming what shipped in #439 and #441-#443, where the work departed from it (EndpointSlice zones; orphan recovery left on), and what is still open.
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
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.
Why
The Conformity Checks chapter (#431) teaches the
KafkaReferencelanguage step by step. The book had no single place that lists every field, value kind, rule id, report field and lint code. This adds one as an appendix, after the version matrix, and commits the plan behind #439.Both files sat uncommitted in the main checkout while ten PRs (#434–#443) landed. Three of those changed what the appendix described, so it's brought up to date with main here.
What changes
docs/book/appendix-conformity-language.md: Conformity Language Reference. It covers:Aligned with main:
fmtfixes, not a warning. This covers the prose in The Document and theduplicate-keyrow, as handed over from that PR.rbac.scope=namespace:zones,skewandkafka.rackAwareness(sourcecr) read the zones from the EndpointSlices of<cluster>-kafka-brokers;monitoring.podMonitorlooks in the Kafka namespace only, and is UNKNOWN when none there selects the brokers;Kafkaresource is a 503 that names the grant.networkPolicy.kafka.namespaceandkafka.clusterName.Links to it:
_quarto.ymlandREADME.mdlist it.11-api-reference.md: the conformity endpoint's 503 now also covers a Kubernetes API that refuses the Kafka resource (#439). Before, it covered only an unreachable one.plans/adminless-kubernetes.md: the plan behind #439. A status block at the top records:KATES_CHAOS_ORPHAN_RECOVERY_ENABLED=false.dns-detectrunning before the node check;sourcethat names nodes for EndpointSlice zones;kates watchdefault namespaces;targetNamespace: kates.Tests
Run locally, for the jobs
docs/book/**triggers:scripts/check-book-style.shpasses; the structure ratchet holds.scripts/check-book-contrast.pypasses.scripts/gen-version-matrix.sh --checkandscripts/gen-chart-table.sh --checkpass. I ran both in a clean worktree, because this checkout has a leftover, untrackedcharts/miniodirectory that only trips them locally.prepare-book-render.sh,quarto render --to html) shows no warnings.check-book-fragments.pypasses: all 7,981 fragment links in 40 pages land on an id.--to pdf -M keep-tex:true) builds, with the appendix in it. The only missing glyphs are the six emoji (⏳ ⛔ ✅ ❌ 📊 🔥) this Mac always lacks; the new text adds only…, which the book already uses.