-
Notifications
You must be signed in to change notification settings - Fork 262
Open
Labels
area/docsImprovements or additions to documentationImprovements or additions to documentationkind/enhancementImprovements or new featuresImprovements or new features
Description
https://www.pulumi.com/docs/iac/concepts/config/
Refresh the content in the Components concepts page:
- Explain what a component is: a logical grouping of Pulumi resources, encapsulated as a single Pulumi resource. (The cross-cloud examples are a bad example of encapsulation.)
- Note that they are analogous to TF modules or CDK constructs, and add an info block that you can also consume TF modules and CDK constructs and link to the appropriate pages.
- Give some examples where one might want to consume or author a component.
- Explain briefly how components may be referenced, depending on how they are distributed:
- Via native language reference (npm i, etc.) for components that are single-language or multi-language and have pre-published SDKs (like AWSX or EKS)
pulumi package addfor New Components (exact name TBD), optionally with discovery via Pulumi IDP- Pulumi IDP provides a browsable gallery of all of the published components in your Pulumi Cloud organization.
- Give an example of consuming a component (awsx.ec2.Vpc is probably the easiest example):
- Show the how to instantiate a component (and how it's pretty much just like any other resource)
- Show what a component looks like in Pulumi CLI output to illustrate the concept
- most of the time, you will need to add a reference to the component, usually by importing a module
- they're instantiated like any other resource in Pulumi: with a name, arguments (defined by the component's author), and resource options
- one important difference is that resource options passed to component resources either do not work with components or do not work the same way (Resource Options: Missing details about support in Component Resources #11663 Components: Clarify that parent must be explicitly set when authoring #14717)
- Give links to additional resources (guides)
- The note about a stack resource also being a component is interesting trivia, but not helpful to most users
Metadata
Metadata
Assignees
Labels
area/docsImprovements or additions to documentationImprovements or additions to documentationkind/enhancementImprovements or new featuresImprovements or new features