Terraform Bridge Provider Boilerplate

This repository contains boilerplate code for building a new Pulumi provider which wraps an existing Terraform provider, if the existing provider uses Go Modules.

Modify this README to describe:

• The type of resources the provider manages
• Add a build status image from Travis at the top of the README
• Update package names in the information below
• Add any important documentation of concepts (e.g. the "serverless" components in the AWS provider).

Creating a Pulumi Terraform Bridge Provider

Note: Go 1.12 is needed to build Pulumi providers using Go Modules. Currently, we recommend pinning the version in .travis.yml to 1.12.1 to work around an issue with running later versions on Travis CI.

First, clone this repo with the name of the desired provider in place of github:

git clone https://github.com/pulumi/pulumi-tf-provider-boilerplate pulumi-github

Second, replace references to github with the name of your provider:

make prepare NAME=foo REPOSITORY=github.com/pulumi/pulumi-foo

Next, list the configuration points for the provider in the area of the README.

Note: If the name of the desired Pulumi provider differs from the name of the Terraform provider, you will need to carefully distinguish between the references - see https://github.com/pulumi/pulumi-azure for an example.

Add dependencies

In order to properly build the sdks, the following tools are expected:

• tf2pulumi (See the project's README for installation instructions: https://github.com/pulumi/tf2pulumi)
• pandoc (brew install pandoc)

In the root of the repository, run:

• go get github.com/pulumi/scripts/gomod-doccopy (Note: do not set GO111MODULE=on here)
• GO111MODULE=on go get github.com/pulumi/pulumi-terraform@master
• GO111MODULE=on go get github.com/terraform-providers/terraform-provider-github (where github is the name of the provider)
• GO111MODULE=on go mod vendor
• make ensure

Build the provider:

• Edit resources.go to map each resource, and specify provider information
• Enumerate any examples in examples/examples_test.go
• make

Installing

This package is available in many languages in the standard packaging formats.

Node.js (Java/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

$ npm install @ibrasho/pulumi-github

or yarn:

$ yarn add @ibrasho/pulumi-github

Python

To use from Python, install using pip:

$ pip install pulumi_github

Go

To use from Go, use go get to grab the latest version of the library

$ go get github.com/ibrasho/pulumi-github/sdk/go/...

Configuration

The following configuration points are available for the github provider:

• token - (Optional) This is the GitHub personal access token. It must be provided, but it can also be sourced from the GITHUB_TOKEN environment variable.

• organization - (Optional) This is the target GitHub organization to manage. The account corresponding to the token will need "owner" privileges for this organization. It must be provided, but it can also be sourced from the GITHUB_ORGANIZATION environment variable.

• base_url - (Optional) This is the target GitHub base API endpoint. Providing a value is a requirement when working with GitHub Enterprise. It is optional to provide this value and it can also be sourced from the GITHUB_BASE_URL environment variable. The value must end with a slash, and generally includes the API version, for instance https://github.someorg.example/api/v3/.

• insecure - (Optional) Whether server should be accessed without verifying the TLS certificate. As the name suggests this is insecure and should not be used beyond experiments, accessing local (non-production) GHE instance etc. There is a number of ways to obtain trusted certificate for free, e.g. from Let's Encrypt. Such trusted certificate does not require this option to be enabled. Defaults to false.

• individual: (Optional) Whether to run outside an organization.

Reference

For detailed reference documentation, please visit the API docs.