Add parameterized provider support to YAML #616
Conversation
Frassle
force-pushed
the
fraser/yamlparam
branch
2 times, most recently
from
dac6515
to
01ae27b
Compare
Frassle
force-pushed
the
fraser/yamlparam
branch
4 times, most recently
from
3d644fa
to
da2797b
Compare
Frassle
force-pushed
the
fraser/yamlparam
branch
from
da2797b
to
9bda4c0
Compare
Frassle
force-pushed
the
fraser/yamlparam
branch
from
5d5a867
to
4b46d23
Compare
There was a problem hiding this comment.
Some minor comments but I think this is good to go. One thing I think of is if we'd ever want to put multiple packages in a single lock file, but I think this is fine -- we could introduce a top-level packages key and look for that first (optionally bumping the lockfile version).
| @@ -0,0 +1,162 @@ | |||
| // Copyright 2024, Pulumi Corporation. All rights reserved. | |||
There was a problem hiding this comment.
Note to self -- we should sort the licence headers in this repo
| "gopkg.in/yaml.v3" | ||
| ) | ||
|
|
||
| type ParameterizationDecl struct { |
There was a problem hiding this comment.
Some doc comments on the public interface structs would be nice I reckon.
pkg/pulumiyaml/packages/file.go
Outdated
| Parameterization *ParameterizationDecl `yaml:"parameterization,omitempty"` | ||
| } | ||
|
|
||
| func (p *PackageDecl) Valid() bool { |
There was a problem hiding this comment.
Worth changing this to Validate() error so we can have better failure reasons?
There was a problem hiding this comment.
Could do now we've got PackageDeclartionVersion. I was worried about err'ing on too many files before.
pkg/pulumiyaml/packages/file.go
Outdated
| func SearchPackageDecls(directory string) ([]PackageDecl, error) { | ||
| if directory == "" { | ||
| directory = "." | ||
| } |
There was a problem hiding this comment.
Any benefit to doing this rather than letting the caller just specify "."?
There was a problem hiding this comment.
Not really, lets be strict.
pkg/pulumiyaml/run.go
Outdated
| @@ -343,6 +378,14 @@ func (r *Runner) setDefaultProviders() { | |||
| contract.IgnoreError(diags) | |||
| } | |||
|
|
|||
| // Set the runners package descriptors from the templates package decls. | |||
There was a problem hiding this comment.
| // Set the runners package descriptors from the templates package decls. | |
| // Set the runner's package descriptors from the templates package decls. |
pkg/pulumiyaml/run.go
Outdated
| // Register package refs for all packages we know upfront | ||
| packageDescriptors, err := packages.ToPackageDescriptors(r.t.Packages) | ||
| r.packageDescriptors = packageDescriptors | ||
| return err |
There was a problem hiding this comment.
Should we always set even if there is an error?
pkg/pulumiyaml/run.go
Outdated
| } | ||
|
|
||
| var parameterization *pulumirpc.Parameterization | ||
| if pkg.Parameterization != nil { |
There was a problem hiding this comment.
Minor but we could combine these ifs to avoid the double check (cheap as it is). Happy either way. Same is true of ToPackageDescriptors earlier too if we feel like it.
|
This PR has been shipped in release v1.11.0. |
This adds parameterized provider support to YAML.
This is done via new "package declaration" files, which are generated by
gen-sdk. On startup the yaml runtime searches for these files and will use them to register provider packages with the engine. These can include parameterized values, thus supporting parameterized providers.The schema loader code paths have also been updated to use these package declarations to allow type checking of resources from parameterized packages as well.
Fixes #626.