pulumi-opnsense 0.1.3

No project description provided

Pulumi Native Provider Boilerplate

This repository is a boilerplate showing how to create a native Pulumi provider.

Authoring a Pulumi Native Provider

This boilerplate creates a working Pulumi-owned provider named opnsense. 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

Ensure the following tools are installed and present in your $PATH:

• pulumictl
• Go 1.17 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

Creating and Initializing the 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-opnsense-native (replace "opnsense" with the name of your provider)
   • Description: Pulumi provider for opnsense
   • Repository type: Public
3. Clone the generated repository.

From the templated repository:

1. Search-replace opnsense with the name of your desired provider.

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/opnsense
$ 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-opnsense/main.go - holds the provider's sample implementation logic.
2. deployment-templates - a set of files to help you around deployment and publication
3. sdk - holds the generated code libraries created by pulumi-gen-opnsense/main.go
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