Repository navigation
operator: include the Broker CRD in the CRD reference - #1986
Merged
Merged
Conversation
Stop ignoring the Broker types in crd-ref-docs-config.yaml so the generated CRD reference documents the Broker resource. Keep the BrokerPool types ignored: they're StretchCluster internals. Add a Broker type description, list the BrokerPhase values, and move the implementation note on BrokerPodTemplate out of its doc comment.
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
JakeSCahill
marked this pull request as ready for review
October 23, 2026 20:34
JakeSCahill
requested review from
RafalKorepta,
andrewstucki,
chrisseto,
gene-redpanda and
hidalgopl
as code owners
October 23, 2026 20:34
hidalgopl
approved these changes
Oct 26, 2026
| DefaultNodePoolName = "default" | ||
| ) | ||
|
|
||
| // Broker represents a single Redpanda broker and owns its Pod and |
Contributor
There was a problem hiding this comment.
using "owns" here may be a bit misleading; Pod is owned by Broker CR, PVC isn't (but it's lifetime is tied to Broker CR lifetime).
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.
Removes the Broker types from the crd-ref-docs ignore list so the generated CRD reference documents the Broker resource, for the 26.3 docs (https://github.com/redpanda-data/docs/pull/2237). The BrokerPool types stay ignored.
Also adds a Broker type description, lists the BrokerPhase values, and moves the implementation note on BrokerPodTemplate out of its doc comment. Regenerated testdata/crd-docs.adoc and the Broker CRD with controller-gen 0.20.1 and crd-ref-docs 0.3.0.