Fix CRD vs CR (Custom Resource) conflation in docs and code - #244
Merged
Conversation
Correct places that said "CRD" (Custom Resource Definition — the schema)
when they actually meant a "CR" (Custom Resource — an instance). CRD is
kept where it genuinely refers to the definition/schema (installing CRDs,
the CRD reference, modifying CRD fields/YAMLs, the v1alpha1 API group,
"CRD kind"/"CRD group").
- Docs: ~30 edits across docs/ and README (e.g. an Engine/Database/
Subscription/Pipeline "CRD" that registers/backs/applies/reconciles ->
"custom resource").
- Code comments: Javadoc/inline comments describing instances being
deployed/read/deleted/owned across hoptimator-api, -jdbc, -util, -kafka,
-mysql, -k8s, -logical.
- Identifiers: rename conflated Crd->Cr in hoptimator-logical and
PipelineGraphBuilder (production + tests kept in sync), e.g.
tableFromCrd->tableFromCr, crdName->crName, mockCrdDeployer->mockCrDeployer.
- Keep CRD-yaml description, generated model, and crd-reference.md in sync
("Name of the Database custom resource backing this tier").
Verified: affected modules compile (main+test), checkstyle passes,
hoptimator-logical unit tests pass.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Code Coverage
|
ryannedolan
approved these changes
Jul 28, 2026
jogrogan
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
2 participants
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.
Fix CRD vs CR (Custom Resource) conflation in docs and code
What & why
Several docs and code comments used CRD (Custom Resource Definition — the schema/blueprint) when they actually meant a CR (Custom Resource — an instance created from that schema). This PR corrects the terminology wherever "CRD" referred to an instance, while deliberately preserving "CRD" wherever it genuinely means the definition.
Rule applied
• Changed → "custom resource" / Cr : a specific instance that is applied, read, reconciled, deleted, owns children, carries labels, backs a tier, points at a URL, or has a metadata.name .
• Kept as "CRD": installing CRDs, the CRD reference doc, modifying a CRD field/YAML, the v1alpha1 API group, .crd.yaml files, and type-level phrases ( CRD kind , CRD group , the CRD's typed-enum fields).
Changes
• Docs (~30 edits) across docs/ + README.md — e.g. "an Engine CRD registers a runtime", "reconciles Hoptimator's CRDs", "a Subscription CRD applied with kubectl apply ", validators inspecting "a CRD" → all now "custom resource(s)".
• Code comments — Javadoc/inline comments describing instances across hoptimator-api , -jdbc , -util , -kafka , -mysql , -k8s , -logical .
• Identifiers renamed Crd → Cr (production + tests kept in sync): tableFromCrd → tableFromCr , crdName → crName (field/param/locals in both LogicalTable deployers + PipelineGraphBuilder ), mockCrdDeployer → mockCrDeployer , dbCrd → dbCr , crds → crs , plus corresponding test-method names.
• Kept in sync: logicaltables.crd.yaml field description ↔ generated V1alpha1LogicalTableSpecTiers.java ↔ docs/kubernetes/crd-reference.md — all now read "Name of the Database custom resource backing this tier."
Testing
• BUILD SUCCESSFUL compiling all affected modules (main + test)
• Checkstyle passes ( hoptimator-logical , -k8s , -jdbc )
• hoptimator-logical unit tests pass
• Bundled in a testing fix for VeniceDeployer
Notes
• No behavioral changes — comments, docs, and internal identifier names only.
• A parallel change for the internal li-hoptimator extension has been made separately.