Skip to content

Commit c59630e

Browse files
authored
[registry] Drop the local-conversion fallback for unconverted versions (#20695)
Publishing a module version converts it, so the "if a version has no package" case is a transient state of the conversion job, not a workflow to document. Remove the section and the matching paragraph in the Terraform module guide, and stop offering `pulumi package add hcl module tf.pulumi.com/...` as something readers run. Mention the hcl provider once, as what the conversion job uses under the hood: it derives the schema with `pulumi package get-schema hcl module <address>` and publishes it as a package version.
1 parent f11e078 commit c59630e

2 files changed

Lines changed: 4 additions & 20 deletions

File tree

content/docs/iac/guides/building-extending/using-existing-tools/use-terraform-module.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,7 @@ pulumi package add <name>-<system> [<version>]
9494

9595
A module published as `acme-corp/vpc/aws` installs as `vpc-aws`. This is the same as any other Pulumi package: you get a generated SDK in your language, an [API reference](/docs/idp/concepts/private-registry/#api-documentation) on the package's page, and [usage tracking](/docs/idp/concepts/private-registry/#usage-tracking) showing which of your stacks depend on it and which are behind the latest version. Installing a converted package requires Pulumi CLI 3.248.0 or newer; see [Download & Install Pulumi](/docs/install/) to upgrade.
9696

97-
The package's page in Pulumi Cloud shows whether a given version has converted. If a version you need has no package, you can convert the module locally instead, against the module address rather than the package name:
98-
99-
```bash
100-
pulumi package add hcl module tf.pulumi.com/<namespace>/<name>/<system> [<version>]
101-
```
102-
103-
This converts the module on your machine and generates an SDK for your project. Nothing is published to the registry, so this route has no package page, API reference, or usage tracking, and a module the registry could not convert may well fail here for the same reason. The version is optional; omit it to resolve the latest published version. Self-hosted Pulumi Cloud installations use their own host (`<your-pulumi-host>/<namespace>/<name>/<system>`).
97+
The package's page in Pulumi Cloud shows whether a given version has converted.
10498

10599
See [Terraform Modules in the Pulumi Cloud Registry](/docs/idp/concepts/terraform-modules/) for the publishing side and the broader module workflow.
106100

content/docs/idp/concepts/terraform-modules.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ Publishing a module version also converts it into a Pulumi package, with no extr
9090

9191
Conversion runs per version, so a module can have some versions with packages and some without. The package's page in Pulumi Cloud shows which versions have converted and gives you the command to install one.
9292

93+
Under the hood, the conversion job derives the package schema by reading the module through Pulumi's [`hcl`](https://github.com/pulumi/pulumi-hcl) parameterized provider (`pulumi package get-schema hcl module <address>`) and publishes that schema as a package version. SDKs and API documentation come from the schema, the same as for any other package.
94+
9395
## Consume from a Pulumi program
9496

9597
Once a version has converted, install it by package name:
@@ -108,19 +110,7 @@ Usage tracking only counts consumption through the converted package. A stack or
108110
Installing a converted package requires Pulumi CLI 3.248.0 or newer. See [Download & Install Pulumi](/docs/install/) to install or upgrade.
109111
{{% /notes %}}
110112

111-
### If a version has no package
112-
113-
Installing by package name is the path to reach for. If a version you need has no package, you can convert the module locally instead, against the module address rather than the package name:
114-
115-
```bash
116-
pulumi package add hcl module tf.pulumi.com/<namespace>/<name>/<system> [<version>]
117-
```
118-
119-
`hcl` is a parameterized provider. The `module` keyword selects module mode, followed by the module address and an optional version. Omit the version to resolve the latest published version; pass one to pin it.
120-
121-
This converts the module on your machine, using your local `hcl` provider, and generates an SDK for your project. Nothing is published: there is no package in the registry, and so no package page, no API reference, and no usage tracking, and a teammate who needs the module runs the same command rather than installing what you produced. A module the registry could not convert may well fail here for the same reason.
122-
123-
Both commands resolve using your Pulumi credentials. See [Use a Terraform Module in Pulumi](/docs/iac/guides/building-extending/using-existing-tools/use-terraform-module/) for examples.
113+
The install resolves using your Pulumi credentials. See [Use a Terraform Module in Pulumi](/docs/iac/guides/building-extending/using-existing-tools/use-terraform-module/) for examples.
124114

125115
## Consume from OpenTofu or Terraform
126116

0 commit comments

Comments
 (0)