File modified: @@ -4,448 +4,60 @@ This repository contains boilerplate code for building a new Pulumi provider der This repository is set up as a fictitious provider named "xyz" to demonstrate a resource, a data source and configuration derived from a Terraform provider. -Read our complete [guide for authoring and publishing a Pulumi Package](https://www.pulumi.com/docs/iac/packages-and-automation/pulumi-packages/authoring/) in our docs. +Read the [setup instructions](SETUP.md) for step-by-step instructions on how to bridge a new provider and refer to our complete docs [guide for authoring and publishing a Pulumi Package](https://www.pulumi.com/docs/iac/packages-and-automation/pulumi-packages/authoring/). -## Creating a Pulumi Terraform Bridge Provider +# Xyz Resource Provider -The following instructions cover: +The Xyz Resource Provider lets you manage [Xyz](http://example.com) resources. -- providers maintained by Pulumi (denoted with a "Pulumi Official" checkmark on the Pulumi registry) -- providers published and maintained by the Pulumi community, referred to as "third-party" providers +## Installing -We showcase a Pulumi-owned provider based on an upstream provider named `terraform-provider-foo`. Substitute appropriate values below for your use case. +This package is available for several languages/platforms: -> 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. +### Node.js (JavaScript/TypeScript) -### Prerequisites - -Ensure the following tools are installed and present in your `$PATH`: - -- [`pulumictl`](https://github.com/pulumi/pulumictl#installation) -- [Go](https://golang.org/dl/) or 1.latest -- [`golangci-lint`](https://golangci-lint.run/welcome/install/) -- [NodeJS](https://nodejs.org/en/) Active or maintenance version ([Node.js Releases](https://nodejs.org/en/about/previous-releases)). We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage NodeJS installations. -- [Yarn](https://yarnpkg.com/) -- [TypeScript](https://www.typescriptlang.org/) -- [Python](https://www.python.org/downloads/) (called as `python3`). For recent versions of MacOS, the system-installed version is fine. -- [.NET](https://dotnet.microsoft.com/download) - -### Creating and Initializing the Repository - -Pulumi offers this repository as a [GitHub template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) for convenience. From this repository: - -1. Click "Use this template". -1. Set the following options: - - Owner: pulumi (third-party: your GitHub organization/username) - - Repository name: pulumi-foo (third-party: preface your repo name with "pulumi" as standard practice) - - Description: Pulumi provider for Foo - - Repository type: Public -1. Clone the generated repository. - -From the templated repository: - -1. Run the init program and follow the prompts to replace the name "xyz" with the name of your provider: - - ```bash - ./init.sh - ``` - - Note: This program can also be run non-interactively, passing the options via arguments. Run `./init.sh -h` for the usage instructions. - - Third-party providers who intend to publish on the Pulumi registry will want to update the `DisplayName`, `Publisher`, and `Homepage` values in `provider/resources.go` to use your desired casing. - -1. Review the updated `README.md` to include the following: - - Any desired build status badges. - - An introductory paragraph describing the type of resources the provider manages, e.g. "The Foo provider for Pulumi manages resources for [Foo](http://example.com/). - - In the "Installing" section, correct package names for the various SDK libraries in the languages Pulumi supports. - - In the "Configuration" section, any configurable options for the provider. These may include, but are not limited to, environment variables or options that can be s