This release is a pre-release and may not be stable for production use.
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
- Run
make build installto build and install the provider. - Run
make gen_examplesto generate the example programs inexamples/off of the sourceexamples/yamlexample program. - Run
make upto run the example program inexamples/yaml. - Run
make downto tear down the example program.
Creating a new provider repository
Pulumi offers this repository as a GitHub template repository for convenience. From this repository:
- Click "Use this template".
- 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
- Clone the generated repository.
From the templated repository:
-
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/cmdtopulumi-resource-{NAME} - replace dependencies in
provider/go.modto reflect your repository name - find and replace all instances of
provider-boilerplatewith theNAMEof your provider. - find and replace all instances of the boilerplate
abcwith theORGof your provider. - replace all instances of the
github.com/pulumi/pulumi-provider-boilerplaterepository with theREPOSITORYlocation
- rename folders in
Build the provider and install the plugin
$ make build install
This will:
- Create the SDK codegen binary and place it in a
./binfolder (gitignored) - Create the provider binary and place it in the
./binfolder (gitignored) - Generate the dotnet, Go, Node, and Python SDKs and place them in the
./sdkfolder - 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:
- A
provider/folder containing the building and implementation logic.cmd/pulumi-resource-provider-boilerplate/main.go- holds the provider's sample implementation logic.
Makefile- targets to help with building and publishing the provider. Runmake ci-mgmtto regenerate CI workflows.sdk- holds the generated code libraries created bypulumi gen-sdk.examplesa folder of Pulumi programs to try locally and/or use in CI.- A
Makefileand thisREADME.
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
- Follow the instructions laid out in the deployment templates.
References
Other resources/examples for implementing providers:
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pulumi_provider_boilerplate-0.1.0a1783008178.tar.gz.
File metadata
- Download URL: pulumi_provider_boilerplate-0.1.0a1783008178.tar.gz
- Upload date:
- Size: 11.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
285ffe8da8776d3d93a781f28400d22a013af086b5e2f13edef205a3a00bece5
|
|
| MD5 |
24e73ecca05d8c179492e5964711aef7
|
|
| BLAKE2b-256 |
e9b3436216b2e324bfb3a6928c0a718f390d71a53a2a0c1159c2ad3333ba9bdb
|
File details
Details for the file pulumi_provider_boilerplate-0.1.0a1783008178-py3-none-any.whl.
File metadata
- Download URL: pulumi_provider_boilerplate-0.1.0a1783008178-py3-none-any.whl
- Upload date:
- Size: 14.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4440eaab063fab2def2a385c577b41ca786e9528ee6e474024608a9f49b3c384
|
|
| MD5 |
44b895ab431ceb3147d22531bb271821
|
|
| BLAKE2b-256 |
5af31d46f13077afe2ba19d6ba5c1c0bb32846813510c7ed7924ddf1de252551
|
