Document default and third party providers in YAML reference #12339
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AaronFriel
commented
Jul 22, 2024
| @@ -116,23 +116,34 @@ There are at least two reasons to explicitly define providers in YAML, or explic | |||
| 1. Using explicit versions enables pinning the dependencies used, a technique used to improve build reliability. | |||
| 2. Using explicit providers enables controlling the options for providers used by each resource, as described in [Unlock Programmatic Control by Disabling Default Providers](/blog/disable-default-providers/). | |||
|
|
|||
| #### Resource version | |||
| If a specific provider version is necessary, we prefer the approaches in the order described here. | |||
There was a problem hiding this comment.
Want users to fall into "pit of success" here, a program with default providers is more likely to be correct than one with explicit providers passed to multiple resources or setting these options on individual resources.
AaronFriel
commented
Jul 22, 2024
| #### Explicit provider | ||
|
|
||
| To create an explicit provider instance, preferably with a specific version, use the [`resources`](#resources) section. For the `type` property, prefix the name of the provider with `pulumi:providers`. | ||
| To declare an explicit provider instance for specific resources, declare a provider resource the [`resources`](#resources) section. For the `type` property, prefix the name of the provider with `pulumi:providers`. |
There was a problem hiding this comment.
Bit of a nit fixed here, Pulumi programs don't create resources, they declare them.
AaronFriel
commented
Jul 22, 2024
justinvp
reviewed
Jul 22, 2024
AaronFriel
commented
Jul 22, 2024
|
Your site preview for commit 71fe48b is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-12339-71fe48b4.s3-website.us-west-2.amazonaws.com. |
justinvp
approved these changes
Jul 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Documents how to set a default provider for multiple resources and how to use
pluginDownloadURLwith third party providers, whether community or customer managed.