@ukidevops/rangeos-pulumi-provider
v0.0.2
Published
Downloads
10
Maintainers
Readme
RangeOS Pulumi Native Provider
This repository is responsible for generating the Language SDK and Multi-language components for the RangeOS Pulumi Native Provider.
A brief repository overview
You now have:
- A
provider/
folder containing the building and implementation logiccmd/pulumi-resource-rangeos/main.go
- holds the provider's sample implementation logic.pkg/rangeos/...
- holds the provider's implementation logic.pkg/provider.go
- provider's main entry point.
deployment-templates
- a set of files to help you around deployment and publicationsdk
- holds the generated code libraries created bypulumi-gen-rangeos/main.go
examples
a folder of Pulumi programs to try locally and/or use in CI.- A
Makefile
and thisREADME
.
Development
Publishing
github actions are configured to publish the provider as well as the SDKs.
To trigger the github action, push a tag with the format vX.Y.Z
to the repository.
$ git tag -a v0.0.1 -m "v0.0.1"
$ git push origin v0.0.1
Build & test
- Run
make build install
to build and install the provider. - Run
make gen_examples
to generate the example programs inexamples/
off of the sourceexamples/yaml
example program. - Run
make up
to run the example program inexamples/yaml
. - Run
make down
to tear down the example program.
Build the provider and install the plugin
$ make build install
This will:
- Create the SDK codegen binary and place it in a
./bin
folder (gitignored) - Create the provider binary and place it in the
./bin
folder (gitignored) - Generate the dotnet, Go, Node, and Python SDKs and place them in the
./sdk
folder - Install the provider on your machine.
Test against the example
$ cd examples/simple
$ yarn link @pulumi/rangeos
$ yarn install
$ pulumi stack init test
$ pulumi up
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.
References
Other resources/examples for implementing providers: