README
¶
Pulumi
Pulumi is a cloud development platform that makes creating cloud programs easy and productive.
Author cloud programs in your favorite favorite language and Pulumi will automatically keep your infrastructure up-to-date. Skip learning yet another YAML dialect. Pulumi is multi-language and multi-cloud, and fully extensible.
To install the latest Pulumi release, run:
$ curl -fsSL https://get.pulumi.com/ | sh
If you are learning about Pulumi for the first time, please visit the project website.
This repo contains the CLI, language SDKs, and the core Pulumi engine. Individual libraries are in their own repos.
Platforms
| Architecture | Build Status |
|---|---|
| Linux/macOS x64 |  |
| Windows x64 |
Languages
| Language | Status | Runtime | Readme |
|---|---|---|---|
| JavaScript | Stable | Node.js 6.x-10.x | Readme |
| TypeScript | Stable | Node.js 6.x-10.x | Readme |
| Python | Beta | Python 2.7 | Readme |
| Go | Preview | Go 1.x | Readme |
Clouds
| Cloud | Status | Docs | Repo |
|---|---|---|---|
| Amazon Web Services | Stable | Docs | pulumi/pulumi-aws |
| Microsoft Azure | Beta | Docs | pulumi/pulumi-azure |
| Google Cloud Platform | Preview | Docs | pulumi/pulumi-gcp |
| Kubernetes | Beta | Docs | pulumi/pulumi-kubernetes |
Libraries
There are several libraries that encapsulate best practices and common patterns:
| Library | Status | Docs | Repo |
|---|---|---|---|
| AWS Serverless | Preview | Docs | pulumi/pulumi-aws-serverless |
| AWS Infrastructure | Beta | Docs | pulumi/pulumi-aws-infra |
| Pulumi Multi-Cloud Framework | Beta | Docs | pulumi/pulumi-cloud |
Examples
A collection of examples for different languages, clouds, and scenarios is available in the pulumi/examples repo.
Development
If you'd like to contribute to Pulumi and/or build from source, this section is for you.
Prerequisites
Pulumi is written in Go, uses Dep for dependency management, and GoMetaLinter for linting:
- Go: https://golang.org/dl
- Dep:
$ go get -u github.com/golang/dep/cmd/dep - GoMetaLinter:
$ go get -u github.com/alecthomas/gometalinter$ gometalinter --install
Building from Source
To install the pre-built SDK, please run curl -fsSL https://get.pulumi.com/ | sh, or see detailed installation
instructions on the project page. Read on if you want to install from source.
To build the Pulumi CLI from source, you may simply run:
$ go get -u github.com/pulumi/pulumi
This installs the pulumi binary to $GOPATH/bin.
To do anything interesting with Pulumi, you will need an SDK for your language of choice. The SDK installation comes
with pre-built language providers, however the make flow below will create a complete SDK distribution for you.
Building and Testing
To build a complete Pulumi SDK, ensure $GOPATH is set, and clone into a standard Go workspace:
$ git clone git@github.com:pulumi/pulumi $GOPATH/src/github.com/pulumi/pulumi
$ cd $GOPATH/src/github.com/pulumi/pulumi
The first time you build, you must make ensure to install dependencies and perform other machine setup:
$ make ensure
In the future, you can synch dependencies simply by running dep ensure explicitly:
$ dep ensure
At this point you can run make to build and run tests:
$ make
This installs the pulumi binary into $GOPATH/bin, which may now be run provided make exited successfully.
The Makefile also supports just running tests (make test_all or make test_fast), just running the linter
(make lint), just running Govet (make vet), and so on. Please just refer to the Makefile for the full list of targets.
Debugging
The Pulumi tools have extensive logging built in. In fact, we encourage liberal logging in new code, and adding new logging when debugging problems. This helps to ensure future debugging endeavors benefit from your sleuthing.
All logging is done using Google's Glog library. It is relatively bare-bones, and adds basic leveled logging, stack dumping, and other capabilities beyond what Go's built-in logging routines offer.
The pulumi command line has two flags that control this logging and that can come in handy when debugging problems.
The --logtostderr flag spews directly to stderr, rather than the default of logging to files in your temp directory.
And the --verbose=n flag (-v=n for short) sets the logging level to n. Anything greater than 3 is reserved for
debug-level logging, greater than 5 is going to be quite verbose, and anything beyond 7 is extremely noisy.
For example, the command
$ pulumi preview --logtostderr -v=5
is a pretty standard starting point during debugging that will show a fairly comprehensive trace log of a compilation.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
pkg
|
|
|
apitype
Package apitype contains the full set of "exchange types" that are serialized and sent across separately versionable boundaries, including service APIs, plugins, and file formats.
|
Package apitype contains the full set of "exchange types" that are serialized and sent across separately versionable boundaries, including service APIs, plugins, and file formats. |
|
backend
Package backend encapsulates all extensibility points required to fully implement a new cloud provider.
|
Package backend encapsulates all extensibility points required to fully implement a new cloud provider. |
|
graph
Package graph defines resource graphs.
|
Package graph defines resource graphs. |
|
graph/dotconv
Package dotconv converts a resource graph into its DOT digraph equivalent.
|
Package dotconv converts a resource graph into its DOT digraph equivalent. |
|
resource/stack
Package stack contains the serialized and configurable state associated with an stack; or, in other words, a deployment target.
|
Package stack contains the serialized and configurable state associated with an stack; or, in other words, a deployment target. |
|
tokens
Package tokens contains the core symbol and token types for referencing resources and related entities.
|
Package tokens contains the core symbol and token types for referencing resources and related entities. |
|
util/archive
Package archive provides support for creating zip archives of local folders and returning the in-memory buffer.
|
Package archive provides support for creating zip archives of local folders and returning the in-memory buffer. |
|
util/rpcutil/rpcerror
Package rpcerror provides helper types and functions for dealing with errors that cross gRPC boundaries.
|
Package rpcerror provides helper types and functions for dealing with errors that cross gRPC boundaries. |
|
sdk
|
|
|
nodejs/cmd/pulumi-language-nodejs
pulumi-language-nodejs serves as the "language host" for Pulumi programs written in NodeJS.
|
pulumi-language-nodejs serves as the "language host" for Pulumi programs written in NodeJS. |
|
proto/go
Package pulumirpc is a generated protocol buffer package.
|
Package pulumirpc is a generated protocol buffer package. |
|
python/cmd/pulumi-language-python
pulumi-language-python serves as the "language host" for Pulumi programs written in Python.
|
pulumi-language-python serves as the "language host" for Pulumi programs written in Python. |
|
tests
|
|