docs(platform): add resource tree and version table#102
Merged
Conversation
The README explained the shared contract but never answered the first question a reader has: what does applying a Platform actually create, and which versions does it pull? Both facts were only discoverable by reading the Composition, the wrapped flux-init module and an EnvironmentConfig. Adds a "What gets created" section — a mermaid tree plus a table of every composed resource with its real name pattern, what emits it, and the condition — and a "Versions" table covering the package pins, the KCL module and the two versions an XR normally sets (flux-operator chart, Flux distribution). Name patterns are taken from xplane-flux-init's main.k, not invented; the trace output is from the live kind1 run. The diagram sticks to <br/> and plain labels: mermaid-cli cannot render here (needs chromium), so the syntax is kept to what GitHub certainly supports rather than what looks nicest unverified. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
patrick-hermann-sva
temporarily deployed
to
linting
July 16, 2026 13:59 — with
GitHub Actions
Inactive
Contributor
📦 ttl.sh preview packagesPreview OCI packages for the Configurations changed in this PR, pushed to the public, ephemeral ttl.sh registry. No auth required — install on any Crossplane v2 cluster: 📦
|
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.
The README explained the shared contract well but never answered the first question a reader actually has: what does applying a
Platformcreate, and which versions does it pull? Both were only discoverable by reading the Composition, then the wrappedflux-initmodule, then an EnvironmentConfig.What's added
## What gets created— a mermaid tree plus a table of every composed resource: real name pattern, which Configuration emits it, and the condition. It makes the two-level structure explicit —platformcomposes child XRs, and the managed resources appear one level deeper, fromflux-init's own Composition. Includes thecrossplane beta traceoutput from the live kind1 run.## Versions— every package pin (dependsOn, Crossplane floor), thexplane-flux-initOCI module, the fact that platform's own KCL is inline (nothing to publish), and the only two versions an XR normally sets: flux-operator chart0.55.0and Flux distribution2.x, both from theflux-defaultsEnvironmentConfig.Accuracy
{}-flux-operator,{}-flux-instance,{}-flux-instance-uses-operator,{}-observe-rc,{}-source-{},{}-sops-age) are read out ofxplane-flux-init/main.k, and{}-flux-initout of platform's Composition — not invented.crossplane.yamlandflux-init/examples/environment-config.yaml.Platformcomposes four objects, not five.On the diagram
mermaid-clican't run in this environment (it needs chromium), so I could not render-validate it — only check it structurally (every referenced node declared, every node reachable and classed). Because of that I deliberately kept the syntax to<br/>and plain labels instead of<b>/<code>, which are less certain to render on GitHub. Worth a quick look at the rendered preview before merging.🤖 Generated with Claude Code