Go to file
Pat Gavlin 94645c313a
Merge pull request #643 from pulumi/LateDecrypt
Decrypt configuration nearer to its use.
2017-12-04 17:27:59 -08:00
build Publish after building in CI (before testing) 2017-12-03 19:21:37 -08:00
cmd Don't filter out the pulumi:pulumi:Stack 2017-12-04 11:13:34 -08:00
dist/sdk/nodejs Adopt new makefile system 2017-11-16 23:56:29 -08:00
examples Return all computed inputs from Provider.Check. 2017-12-03 09:33:16 -08:00
pkg Merge pull request #643 from pulumi/LateDecrypt 2017-12-04 17:27:59 -08:00
scripts Fix publishing scripts to include package.json 2017-11-17 15:46:48 -08:00
sdk Return all computed inputs from Provider.Check. 2017-12-03 09:33:16 -08:00
tests Fix cloud tests 2017-12-03 06:34:06 -08:00
.appveyor.yml Use VS2017 2017-10-31 15:43:48 -07:00
.gitignore Move program uploads to the CLI (#571) 2017-11-15 13:27:28 -08:00
.gitmodules Remove stale submodules 2017-05-15 10:33:22 -07:00
.travis.yml Adjust to the fact that on OSX pip is now spelled pip2.7 2017-11-28 22:01:03 -08:00
.yarnrc Restore TESTPARALLELISM to 10 2017-10-16 10:47:37 -07:00
build.proj Publish after building in CI (before testing) 2017-12-03 19:21:37 -08:00
CONTRIBUTING.md Adopt new pulumi/home repo name 2017-09-21 14:09:35 -07:00
Gometalinter.json Add (back) component outputs 2017-11-20 17:38:09 -08:00
Gopkg.lock Better progress reporting 2017-12-02 15:17:59 -08:00
Gopkg.toml Better progress reporting 2017-12-02 15:17:59 -08:00
LICENSE Clarify aspects of using the DCO 2017-06-26 14:46:34 -07:00
main.go Add a manifest to checkpoint files (#630) 2017-12-01 13:50:32 -08:00
Makefile Publish after building in CI (before testing) 2017-12-03 19:21:37 -08:00
README.md Pass branch name to AppVeyor badge 2017-11-03 11:40:39 -07:00
tslint.json Enable 'use const' linter rule. (#405) 2017-10-10 14:50:55 -07:00

Pulumi Fabric

The Pulumi Fabric ("Pulumi") is a framework and toolset for creating reusable cloud services.

If you are learning about Pulumi for the first time, please visit our docs website.

Build Status

Architecture Build Status
Linux x64 Linux x64 Build Status
Windows x64 Windows x64 Build Status

Installing

To install Pulumi from source, simply run:

$ go get -u github.com/pulumi/pulumi

A GOPATH must be set. A good default value is ~/go. In fact, this is the default in Go 1.8.

This installs the pulumi binary to $GOPATH/bin.

To do anything interesting with Pulumi, you will need an SDK for your language of choice. Please see sdk/README.md for information about how to obtain, install, and use such an SDK.

Development

This section is for Pulumi developers.

Prerequisites

Pulumi is written in Go, uses Dep for dependency management, and GoMetaLinter for linting:

Building and Testing

To build Pulumi, 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 configure to install dependencies and perform other machine setup:

$ make configure

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), 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 eval --logtostderr -v=5

is a pretty standard starting point during debugging that will show a fairly comprehensive trace log of a compilation.