add genericdocument compatible serialization of nodepools#5206
Merged
Conversation
This was referenced May 11, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates NodePool Cosmos DB persistence to support a migration from the current custom Cosmos document shape to a GenericDocument[api.HCPOpenShiftClusterNodePool]-compatible shape by inlining the internal API NodePool object into the stored document, while retaining legacy fields for backward compatibility.
Changes:
- Inline
api.HCPOpenShiftClusterNodePoolinto the stored NodePool document properties to make the document shape compatible withGenericDocument. - Update NodePool conversion logic to populate the new inlined field and adjust ETag propagation to avoid selector ambiguity introduced by embedding.
- Refresh integration-test Cosmos fixture JSON to include the newly persisted fields (id/name/type/systemData/provisioningState/serviceProviderProperties/etc).
Reviewed changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 22 comments.
Show a summary per file
| File | Description |
|---|---|
| test-integration/frontend/artifacts/FrontendCRUD/NodePool/read-old-data/09-cosmosCompare-confirm-update/nodepool-basic-node-pool.json | Updates expected Cosmos NodePool document to include inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/NodePool/read-old-data/09-cosmosCompare-confirm-update/nodepool-02.json | Updates expected Cosmos NodePool document to include inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/NodePool/read-old-data/01-load-old-data/nodepool-node-pool-02.json | Updates “old data” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/NodePool/read-old-data/01-load-old-data/nodepool-basic-node-pool.json | Updates “old data” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/NodePool/create-current/06-cosmosCompare-confirm-content/nodepool-node-pool-02.json | Updates “create current” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/NodePool/create-current/06-cosmosCompare-confirm-content/nodepool-basic-node-pool.json | Updates “create current” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/Migration/read-new-data/18-cosmosCompare-confirm/nodepool-node-pool-02.json | Updates migration “read new data” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/Migration/read-new-data/18-cosmosCompare-confirm/nodepool-basic-node-pool.json | Updates migration “read new data” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/Migration/read-new-data/01-load-old-data/nodepool-node-pool-02.json | Updates migration fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/Migration/read-new-data/01-load-old-data/nodepool-basic-node-pool.json | Updates migration fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/Migration/migrate-old-data/99-cosmosCompare-confirm-migration/nodepool-node-pool-02.json | Updates migration “confirm migration” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/Migration/migrate-old-data/99-cosmosCompare-confirm-migration/nodepool-basic-node-pool.json | Updates migration “confirm migration” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/Migration/migrate-old-data/01-load-old-data/nodepool-node-pool-02.json | Updates migration “load old data” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/Migration/migrate-old-data/01-load-old-data/nodepool-basic-node-pool.json | Updates migration “load old data” fixture to include new inlined NodePool fields. |
| test-integration/frontend/artifacts/FrontendCRUD/Cluster/delete-with-pending-nodepool-operation/05-cosmosCompare-final-state/nodepool-test-nodepool.json | Updates expected Cosmos NodePool document for delete scenario to include inlined NodePool fields. |
| test-integration/backend/controllers/mismatches/artifacts/nodepool/remove_orphaned_nodepool_descendents/00-load-initial-state/nodepool-basic.json | Updates backend mismatch fixture to include new inlined NodePool fields. |
| test-integration/backend/controllers/mismatches/artifacts/nodepool/present_nodepool/99-cosmosCompare-end-state/nodepool-basic.json | Updates backend mismatch fixture end-state to include new inlined NodePool fields. |
| test-integration/backend/controllers/mismatches/artifacts/nodepool/present_nodepool/00-load-initial-state/nodepool-basic.json | Updates backend mismatch fixture initial-state to include new inlined NodePool fields. |
| test-integration/backend/controllers/mismatches/artifacts/externalauth/remove_orphaned_externalauth_descendents/99-cosmosCompare-end-state/nodepool-basic.json | Updates backend mismatch fixture end-state to include new inlined NodePool fields. |
| test-integration/backend/controllers/mismatches/artifacts/externalauth/remove_orphaned_externalauth_descendents/00-load-initial-state/nodepool-basic.json | Updates backend mismatch fixture initial-state to include new inlined NodePool fields. |
| test-integration/backend/controllers/mismatches/artifacts/delete_orphaned_cosmos/all_parents_exist/99-cosmosCompare-end-state/nodepool-basic.json | Updates backend mismatch fixture end-state to include new inlined NodePool fields. |
| test-integration/backend/controllers/mismatches/artifacts/delete_orphaned_cosmos/all_parents_exist/00-load-initial-state/nodepool-basic.json | Updates backend mismatch fixture initial-state to include new inlined NodePool fields. |
| test-integration/backend/controllers/mismatches/artifacts/cluster/remove_orphaned_cluster_descendents/00-load-initial-state/nodepool-basic.json | Updates backend mismatch fixture to include new inlined NodePool fields. |
| internal/database/types_nodepool.go | Embeds api.HCPOpenShiftClusterNodePool into NodePool document properties for GenericDocument compatibility. |
| internal/database/convert_nodepool.go | Populates the new embedded field and updates ETag mapping to avoid ambiguity from embedding. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
Author
|
We're not fiddling with unverifed fields in a serialization we're three commits from removing. |
Collaborator
Author
|
/retest |
Contributor
|
/lgtm |
|
|
||
| // some pieces of data in the internalNodePool conflict with ResourceDocument fields. We may evolve over time, but for | ||
| // now avoid persisting those. | ||
| cosmosObj.InternalState.InternalAPI.TrackedResource = arm.TrackedResource{ |
Collaborator
There was a problem hiding this comment.
Why are we removing this?
| // which is where we want to end up. | ||
| // * to be compatible with prior versions, we must continue writing all previous fields and this new field | ||
| // * to be compatible with prior versions, we must continue reading only from previous fields | ||
| api.HCPOpenShiftClusterNodePool `json:",inline"` |
Collaborator
There was a problem hiding this comment.
Is there some reason it's a value and not a pointer?
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
deads2k
force-pushed
the
cs-172-nodepool-compatible
branch
from
b1fbee1 to
4fdd053
Compare
Collaborator
Author
|
simple rebase. reapplying lgtm |
Collaborator
Author
|
/retest |
Collaborator
Author
|
/label lgtm |
|
@deads2k: The label(s) DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Contributor
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: deads2k, stevekuznetsov The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
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.
This stores all the data necessary to switch from custom cluster storage to the generic document storage for nodepools.
Part of a multi-step plan