README
¶
pulumi-terraform-module
EXPERIMENTAL support for running Terraform Modules directly in Pulumi.
Usage
To get started, run this in the context of a Pulumi program:
pulumi package add terraform-module <module> [<version-spec>] <pulumi-package>
For example you can run the following to add the VPC module as a Pulumi package called "vpc":
pulumi package add terraform-module terraform-aws-modules/vpc/aws 5.18.1 vpc
Pulumi will generate a local SDK in your current programming language and print instructions on how to use it. For example, if your program is in TypeScript, you can start provisioning the module as follows:
import * as vpc from "@pulumi/vpc";
const defaultVpc = new vpc.Module("defaultVpc", {cidr: "10.0.0.0/16"});
Local Modules
Local modules are supported. Any directory with .tf files and optionally variables.tf and
outputs.tf is a module. It can be added to a Pulumi program with:
pulumi package add terraform-module <path> <pulumi-package>
For example:
pulumi package add terraform-module ./infra infra
Overcoming "failed to get schema"
You may encounter the following error while this repository is still internal:
error: failed to get schema: could not find latest version for provider terraform-module: 404 HTTP error fetching plugin from https://api.github.com/repos/pulumi/pulumi-terraform-module/releases/latest. If this is a private GitHub repository, try providing a token via the GITHUB_TOKEN environment variable. See: https://github.com/settings/tokens
To overcome, consider exporting the GITHUB_TOKEN. If you have GitHub CLI installed and authenticated, it can automatically generate a working token like so:
export GITHUB_TOKEN=$(gh auth token)
Directories