Fix CRD parameterization: package naming, Value path, and array flattening by guineveresaenger · Pull Request #4261 · pulumi/pulumi-kubernetes

guineveresaenger · 2026-03-30T21:44:05Z

Summary

Fixes three issues blocking end-to-end pulumi package add kubernetes -- -c crds.yaml usage:

Derive package name from CRD groups instead of hardcoding "mycrd". Adds -n/--name flag for explicit naming, falls back to first CRD group name (e.g., gateway.networking.k8s.io → gateway-networking), or "crds" as default.
Implement Parameterize(Value) so subsequent pulumi up runs can reconstruct the CRD schema from saved state in Pulumi.yaml. Previously this was a stub returning nil.
Flatten array-of-objects in OpenAPI specs. flattenOpenAPI only handled direct object properties, missing objects nested inside arrays (e.g., spec.listeners, spec.rules[].backendRefs). These ended up as untyped StringMapArrayInput instead of typed structs like GatewaySpecListenersArgs.

Tested end-to-end with Gateway API CRDs — pulumi package add generates typed SDKs and pulumi up successfully creates resources.

Known limitations

Go module path collision: The generated SDK reuses the base k8s provider's module path, so base k8s resources can't be used alongside CRD resources in the same Go program. This is a Go codegen issue in pulumi/pulumi and will be resolved by extension parameterization.
Hyphenated field names: CRD fields with hyphens aren't normalized to valid identifiers. Tracked as a TODO.

Test plan

Unit tests for derivePackageName, stripK8sSuffix, parseCrdArgs
Unit tests for flattenOpenAPI with array-of-objects and nested arrays
End-to-end: pulumi package add kubernetes -- -v 1.2.1 -c gateway-api-crds.yaml → typed Go SDK → pulumi up

🤖 Generated with Claude Code

Replace the hardcoded "mycrd" package name with a name derived from the CRD API groups. Users can also specify a name explicitly via -n/--name. - Add -n/--name flag to parseCrdArgs - derivePackageName() strips k8s suffixes (.k8s.io, .x-k8s.io, .io) and joins group prefixes with hyphens (e.g. gateway.networking.k8s.io → gateway-networking) - Falls back to "crds" if no groups can be extracted - Add tests for parseCrdArgs, derivePackageName, and stripK8sSuffix Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…t runs The engine calls Parameterize(Value) on subsequent `pulumi up` runs to reconstruct the CRD schema from the parameters persisted in Pulumi.yaml. Previously this was a stub returning nil, meaning parameterized CRD programs would fail on any run after the initial `pulumi package add`. The Value message carries Name, Version, and the serialized OpenAPI spec (stored as the Parameter field in ParameterizationSpec during the Args path). We deserialize it and regenerate the Pulumi schema via the same generateSchema() function used by the Args path. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

flattenOpenAPI only handled direct object properties, missing objects nested inside arrays (e.g., spec.listeners, spec.rules[].backendRefs). These array-of-object fields ended up as generic StringMapArrayInput in the generated SDK, losing all type safety. Now when a property is an array whose items schema is an object with properties, the inner object is hoisted to a top-level definition and the items schema is replaced with a $ref — the same treatment direct object properties already received. This works recursively, so deeply nested structures like rules[].matches[].path are also flattened. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

github-actions · 2026-03-30T21:45:43Z

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

codecov · 2026-03-30T21:47:24Z

Codecov Report

❌ Patch coverage is 20.00000% with 108 lines in your changes missing coverage. Please review.
✅ Project coverage is 44.73%. Comparing base (d4759d6) to head (1179bfe).
⚠️ Report is 10 commits behind head on master.

Files with missing lines	Patch %	Lines
provider/pkg/provider/provider_parameterize.go	21.87%	58 Missing and 17 partials ⚠️
provider/pkg/gen/schema.go	0.00%	17 Missing ⚠️
provider/pkg/gen/typegen.go	35.29%	7 Missing and 4 partials ⚠️
provider/pkg/provider/provider.go	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4261      +/-   ##
==========================================
+ Coverage   44.47%   44.73%   +0.25%     
==========================================
  Files          93       93              
  Lines       10393    10478      +85     
==========================================
+ Hits         4622     4687      +65     
- Misses       5241     5261      +20     
  Partials      530      530

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

pose · 2026-04-01T08:38:52Z

provider/pkg/provider/provider_parameterize_test.go

+
+func TestFlattenOpenAPINestedArrayOfObjects(t *testing.T) {
+	// Simulate rules[].backendRefs[] — nested array-of-objects inside array-of-objects.
+	sw := &spec.Swagger{


(minor/nitpick) I wonder if it's possible creating the nested objects using temporary variables to have this flatter (so it's a bit more legible for humans).

pose

LGTM (even if not an SME)!

pose · 2026-04-01T08:41:10Z

@claude please review this PR as well 🙏 Specially, around k8s and comprehensive Golang aspects (which are not my forte).

guineveresaenger · 2026-04-02T19:02:13Z

/review-again

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

guineveresaenger · 2026-04-03T16:07:07Z

/review-again

guineveresaenger · 2026-04-06T20:12:05Z

/review-again

github-actions

No actionable issues found after checking for bugs and CLAUDE.md compliance (no CLAUDE.md files exist in this repo).

Reviewed the three core changes:

Package naming: derivePackageName / stripK8sSuffix logic is correct; suffix ordering (.x-k8s.io before .k8s.io before .io) is intentional and tested.
parameterizeRequestValue: Correctly deserializes from ParameterizationSpec.Parameter bytes (set in generateSchema via marshaledOpenAPISchema). The serialization contract between the Args and Value paths is sound.
flattenOpenAPI array-of-objects: The shallow copy + shared Properties map pattern is correct — the parent's Items.Schema is replaced with a new $ref schema before the hoisted definition is processed, so no aliasing corruption occurs. Recursive flattening (e.g., rules[].backendRefs[]) is confirmed by TestFlattenOpenAPINestedArrayOfObjects.

The prior open nitpick on test readability (line 313) was addressed by commit 9874ea0ac.

Reviewed by Internal PR Re-Review (Slash Command)

To install this agentic workflow, run
gh aw add pulumi-labs/gh-aw-internal/.github/workflows/gh-aw-pr-rereview.md@734ef41746387a6818fd8ac3e619c9fd81ac6957

Thread packageName through gen.PulumiSchema and gen/typegen.go so that parameterized CRD packages get distinct token prefixes, import paths, and schema metadata from the start — no post-processing rewrite needed. This lets a program import both the base @pulumi/kubernetes SDK and a CRD-generated SDK (e.g., gateway-networking) side by side without Go module path collisions. Also teach the provider runtime to accept resource tokens with the parameterized package prefix by checking crdSchemas.hasPackage() in gvkFromURN, so that resources like gateway-networking:gateway.networking.k8s.io/v1:Gateway are handled correctly. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

guineveresaenger and others added 4 commits March 23, 2026 13:59

Simplify derivePackageName to use first CRD group only

f3ad3b4

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add CHANGELOG entry for CRD parameterization fixes

d02e662

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

guineveresaenger requested a review from a team March 30, 2026 21:58

pose reviewed Apr 1, 2026

View reviewed changes

pose approved these changes Apr 1, 2026

View reviewed changes

Use temp variables in flatten tests for readability

9874ea0

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

guineveresaenger mentioned this pull request Apr 6, 2026

Review submission fails with "Line could not be resolved" when inline comment targets line outside diff hunk pulumi-labs/gh-aw-internal#5

Open

github-actions bot approved these changes Apr 6, 2026

View reviewed changes

guineveresaenger marked this pull request as draft April 10, 2026 16:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix CRD parameterization: package naming, Value path, and array flattening#4261

Fix CRD parameterization: package naming, Value path, and array flattening#4261
guineveresaenger wants to merge 7 commits intomasterfrom
fix-crd-parameterization

guineveresaenger commented Mar 30, 2026

Uh oh!

github-actions bot commented Mar 30, 2026

Uh oh!

codecov bot commented Mar 30, 2026 •

edited

Loading

Uh oh!

pose Apr 1, 2026

Uh oh!

pose left a comment •

edited

Loading

Uh oh!

pose commented Apr 1, 2026

Uh oh!

guineveresaenger commented Apr 2, 2026

Uh oh!

guineveresaenger commented Apr 3, 2026

Uh oh!

guineveresaenger commented Apr 6, 2026

Uh oh!

github-actions bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

guineveresaenger commented Mar 30, 2026

Summary

Known limitations

Test plan

Uh oh!

github-actions bot commented Mar 30, 2026

Does the PR have any schema changes?

Uh oh!

codecov bot commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pose Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

pose left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pose commented Apr 1, 2026

Uh oh!

guineveresaenger commented Apr 2, 2026

Uh oh!

guineveresaenger commented Apr 3, 2026

Uh oh!

guineveresaenger commented Apr 6, 2026

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Mar 30, 2026 •

edited

Loading

pose left a comment •

edited

Loading