Skip to content

Components: Refresh Concepts page content #16962

@jkodroff

Description

@jkodroff

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 add for 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):
  • 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

No one assigned

    Labels

    area/docsImprovements or additions to documentationkind/enhancementImprovements or new features

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions