pulumi-provider-boilerplate 0.1.0a1771000829

An example built with pulumi-go-provider.

Pulumi Native Provider Boilerplate

This repository is a boilerplate showing how to create and locally test a native Pulumi provider (with examples of both CustomResource and ComponentResource resource types).

Authoring a Pulumi Native Provider

This boilerplate creates a working Pulumi-owned provider named provider-boilerplate. It implements a random number generator that you can build and test out for yourself and then replace the Random code with code specific to your provider.

Prerequisites

You will need to ensure the following tools are installed and present in your $PATH:

• pulumictl
• Go 1.21 or 1.latest
• NodeJS 14.x. We recommend using nvm to manage NodeJS installations.
• Yarn
• TypeScript
• Python (called as python3). For recent versions of MacOS, the system-installed version is fine.
• .NET

Build & test the boilerplate provider

1. Run make build install to build and install the provider.
2. Run make gen_examples to generate the example programs in examples/ off of the source examples/yaml example program.
3. Run make up to run the example program in examples/yaml.
4. Run make down to tear down the example program.

Creating a new provider repository

Pulumi offers this repository as a GitHub template repository for convenience. From this repository:

1. Click "Use this template".
2. Set the following options:
   • Owner: pulumi
   • Repository name: pulumi-provider-boilerplate (replace "provider-boilerplate" with the name of your provider)
   • Description: Pulumi provider for xyz
   • Repository type: Public
3. Clone the generated repository.

From the templated repository:

1. Run the following command to update files to use the name of your provider (third-party: use your GitHub organization/username):

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

   This will do the following:

   • rename folders in provider/cmd to pulumi-resource-{NAME}
   • replace dependencies in provider/go.mod to reflect your repository name
   • find and replace all instances of provider-boilerplate with the NAME of your provider.
   • find and replace all instances of the boilerplate abc with the ORG of your provider.
   • replace all instances of the github.com/pulumi/pulumi-provider-boilerplate repository with the REPOSITORY location

Build the provider and install the plugin

$ make build install

This will:

1. Create the SDK codegen binary and place it in a ./bin folder (gitignored)
2. Create the provider binary and place it in the ./bin folder (gitignored)
3. Generate the dotnet, Go, Node, and Python SDKs and place them in the ./sdk folder
4. Install the provider on your machine.

Test against the example

$ cd examples/simple
$ yarn link @pulumi/provider-boilerplate
$ yarn install
$ pulumi stack init test
$ pulumi up

Now that you have completed all of the above steps, you have a working provider that generates a random string for you.

A brief repository overview

You now have:

1. A provider/ folder containing the building and implementation logic.
   1. cmd/pulumi-resource-provider-boilerplate/main.go - holds the provider's sample implementation logic.
2. Makefile - targets to help with building and publishing the provider. Run make ci-mgmt to regenerate CI workflows.
3. sdk - holds the generated code libraries created by pulumi gen-sdk.
4. examples a folder of Pulumi programs to try locally and/or use in CI.
5. A Makefile and this README.

Additional Details

This repository depends on the pulumi-go-provider library. For more details on building providers, please check the Pulumi Go Provider docs.

Build Examples

Create an example program using the resources defined in your provider, and place it in the examples/ folder.

You can now repeat the steps for build, install, and test.

Configuring CI and releases

1. Follow the instructions laid out in the deployment templates.

References

Other resources/examples for implementing providers:

• Pulumi Command provider
• Pulumi Go Provider repository