Giter VIP home page Giter VIP logo

pulumi-provider-boilerplate's Introduction

xyz Pulumi Provider

This repo is a boilerplate showing how to create a native Pulumi provider. You can search-replace xyz with the name of your desired provider as a starting point for creating a provider that manages resources in the target cloud.

Most of the code for the provider implementation is in pkg/provider/provider.go.

An example of using the single resource defined in this example is in examples/simple.

A code generator is available which generates SDKs in TypeScript, Python, Go and .NET which are also checked in to the sdk folder. The SDKs are generated from a schema in schema.json. This file shoudl be kept aligned with the resources, functions and types supported by the provider implementation.

Note that the generated provider plugin (pulumi-resource-xyz) must be on your PATH to be used by Pulumi deployments. If creating a provider for distribution to other users, you should ensure they install this plugin to their PATH.

Build and Test

# build the resource provider plugin
$ go install ./cmd/pulumi-resource-xyz

# build the SDK generator
$ go install ./cmd/pulumi-sdkgen-xyz

# regenerate the SDK
$ rm -rf ./sdk
$ pulumi-sdkgen-xyz ./schema.json ./sdk

# test
$ cd examples/simple
$ npm install
$ pulumi stack init test
$ pulumi up

References

Other resources for learning about the Pulumi resource model:

pulumi-provider-boilerplate's People

Contributors

lukehoban avatar stack72 avatar nickpulumi avatar rafaribe avatar dependabot[bot] avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.