Document dependsOn limitations for ComponentResource resources (Helm, YAML, Kustomize)

[lblackstone]

Hello!

• Vote on this issue by adding a 👍 reaction
• If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

dependsOn doesn't await child resource creation for several resources in the k8s provider (helm.Chart, yaml.ConfigFile, yaml.ConfigGroup, kustomize.Directory). There is ongoing work to resolve this limitation, but we should document it more clearly in the meantime.

Related to #861

Edit:

Actually, pulumi/pulumi#5642 is done, so we could implement the ready attribute workaround in all SDKs as an alternative.

Affected area/feature

API docs

[lblackstone]

I think we should do pulumi/docs#6740 before this so that we don't duplicate efforts across multiple repos.

[EronWright]

Update: the core problem has been fixed in the "v2" implementations of ConfigFile and ConfigGroup, see #1833 (comment).

We'll leave this issue open until the problem is fixed for the other resources.

[EronWright]

Update: Chart "v4" is out and works great with dependsOn, likewise for Kustomize Directory "v2".

For Chart v3, a ready attribute was introduced for most SDKs and has a usage example in the apidocs:

• NodeJS: [sdk/nodejs] Add a ready attribute to await Helm Charts #1364
• Python: [sdk/python] Add ready attribute to await Helm charts #1782
• Go: [sdk/go] Add ready attribute to await Helm charts #1784
• .NET: [sdk/dotnet] Add ready attribute to await Helm charts #1785

The outstanding task appears to be to add info about dependsOn to the overlay resources.
Update: we added links to the newer version and to the associated blog post.