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

Add yaml instructions for any TF provider #42

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

VenelinMartinov
Copy link
Contributor

This adds instructions for using Any TF provider from YAML.

fixes #41
fixes pulumi/docs#13294

@VenelinMartinov VenelinMartinov requested review from iwahbe and a team November 14, 2024 10:47
@VenelinMartinov VenelinMartinov merged commit 6016223 into main Nov 14, 2024
1 check passed
@VenelinMartinov VenelinMartinov deleted the vvm/add_yaml_instructions branch November 14, 2024 11:05
Comment on lines +230 to +231
properties:
length: 2

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW length defaults to 2 so I assume this isn't required (but perhaps still useful in the example for YAML).

No context was given why it differed from the other choices which called a Pet function with hi / pet value as the unique resource name (which I assume is the resources.pet here, while type: random:RandomPet maps directly to the RandomPet() method of the generated SDK, unlike the other examples that somehow don't map to the SDK method and instead like for JS with new random.Pet("hi"); 🤷‍♂️ )

Refs:

As someone who's never used Pulumi or Terraform but is familiar with the language support, the inconsistency between examples isn't helpful since AFAIK this is two layers of abstraction to grok as a reference to adapt to a real-world configuration.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the way that properties are passed in YAML is a bit less intuitive than in other languages, hence why I added a length parameter there. I think it helps to illustrate how one would pass other parameters.

In general, I wouldn't expect most users to look at the code examples for multiple languages - I'd expect users tend to use one language for pulumi and they would mostly look at that language for examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs for YAML support Describe YAML support for parameterized TF providers
3 participants