Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

kubernetes.yaml.ConfigFile shouldn't pass providers to the child resources it creates #2049

Closed
ringods opened this issue Jun 29, 2022 · 0 comments · Fixed by #2713
Closed
Assignees
Labels
kind/bug Some behavior is incorrect or out of spec language/javascript mro1 Monica's list of 1st tier overlay related issues resolution/fixed This issue was fixed

Comments

@ringods
Copy link
Member

ringods commented Jun 29, 2022

What happened?

When passing explicit providers (plural!) to ConfigFile, one gets this error:

kubernetes:yaml:ConfigFile (guestbook):
    error: Error: Do not supply 'providers' option to a CustomResource. Did you mean 'provider' instead?
        at new CustomResource (/Users/vivek/code/examples/gcp-ts-gke-hello-world/node_modules/@pulumi/resource.ts:769:19)
        at new Service (/Users/vivek/code/examples/gcp-ts-gke-hello-world/node_modules/@pulumi/core/v1/service.ts:152:9)

Steps to reproduce

See the example from @viveklak in pulumi/pulumi#9996

Expected Behavior

ConfigFile implementation should strip providers from the opts before passing it the child resources.

Actual Behavior

The parent is added to the opts to point to the ConfigFile instance. The rest is passed unmodified as well, including providers:

this.resources = pulumi.output(text.then(t => {
try {
return parseYamlDocument({
objs: yamlLoadAll(t, opts),
transformations,
resourcePrefix: config && config.resourcePrefix || undefined
}, {...opts, parent: this})
} catch (e) {
throw Error(`Error fetching YAML file '${fileId}': ${e}`);
}
}));

Versions used

Latest k8s provider still has this bug.

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

@ringods ringods added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team labels Jun 29, 2022
@lblackstone lblackstone added kind/bug Some behavior is incorrect or out of spec and removed needs-triage Needs attention from the triage team kind/bug Some behavior is incorrect or out of spec labels Jun 29, 2022
@mnlumi mnlumi added the mro1 Monica's list of 1st tier overlay related issues label Mar 28, 2023
@EronWright EronWright self-assigned this Dec 12, 2023
EronWright added a commit that referenced this issue Jan 3, 2024
<!--Thanks for your contribution. See [CONTRIBUTING](CONTRIBUTING.md)
    for Pulumi's contribution guidelines.

    Help us merge your changes more quickly by adding more details such
    as labels, milestones, and reviewers.-->

### Proposed changes
Epic: #2254
Fixes: #1938
Fixes: #2049
Fixes: #812

This PR standardizes the option propagation logic for the component
resources in the pulumi-kubernetes NodeJS SDK. The general approach is:
1. In the component resource constructor, compute the child options to
be propagated to any children. The child options consist of the
component as parent, and with `version` and `pluginDownloadURL` if
specified.
2. Compute the invoke options by copying the child options.

### Specification
The component resource is responsible for computing sub-options for
invokes and for child resource declarations. This table outlines the
expected behavior for each [resource
option](https://www.pulumi.com/docs/concepts/options/) when presented to
a component resource.

|  | Propagated | Remarks |
|---|---|---|
| `additionalSecretOutputs` | no | "does not apply to component
resources" |
| `aliases` | no | Inherited via parent-child relationship. |
| `customTimeouts` | no | "does not apply to component resources" |
| `deleteBeforeReplace` | no |  |
| `deletedWith` | no |  |
| `dependsOn` | no | The children implicitly wait for the dependency. |
| `ignoreChanges` | no | Nonsensical to apply directly to children (see
[discussion](pulumi/pulumi#8969)). |
| `import` | no |  |
| `parent` | **yes** | The component becomes the parent. |
| `protect` | no | Inherited. |
| `provider` | no | Combined into providers map, then inherited via
parent-child relationship. |
| `providers` | no | Inherited. |
| `replaceOnChanges` | no | "does not apply to component resources" |
| `retainOnDelete` | no | "does not apply to component resources" |
| `transformations` | no | Inherited. |
| `version` | **yes** | Influences default provider selection logic
during invokes.<br/>Should propagate when child resource is from the
same provider type. |
| `pluginDownloadURL` | **yes** | Influences default provider selection
logic during invokes.<br/>Should propagate when child resource is from
the same provider type. |

### Testing
A new test case is provided ([test
case](https://github.com/pulumi/pulumi-kubernetes/blob/e1ad541a9c86e8eb207bd1d8a276822862425109/tests/sdk/nodejs/nodejs_test.go#L2107),
[test
program](https://github.com/pulumi/pulumi-kubernetes/blob/e1ad541a9c86e8eb207bd1d8a276822862425109/tests/sdk/nodejs/options/index.ts))
that exercises option propagation across the component resources:
-
[kubernetes.helm.sh.v3.Chart](https://www.pulumi.com/registry/packages/kubernetes/api-docs/helm/v3/chart/)
-
[kubernetes.kustomize.Directory](https://www.pulumi.com/registry/packages/kubernetes/api-docs/kustomize/directory/)
-
[kubernetes.yaml.ConfigGroup](https://www.pulumi.com/registry/packages/kubernetes/api-docs/yaml/configgroup/)
-
[kubernetes.yaml.ConfigFile](https://www.pulumi.com/registry/packages/kubernetes/api-docs/yaml/configfile/)

Upgrade testing must be done manually, with an emphasis on avoiding
replacement due to reparenting.

### Related issues (optional)

The p/p NodeJS SDK doesn't propagate the `pluginDownloadURL` option to
the Invoke RPC.
pulumi/pulumi#14839
@pulumi-bot pulumi-bot added the resolution/fixed This issue was fixed label Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Some behavior is incorrect or out of spec language/javascript mro1 Monica's list of 1st tier overlay related issues resolution/fixed This issue was fixed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants