Go to file
Joe Duffy f2ae3a7afc
Permit plugin versions to float (#1122)
This change lets plugin versions to float in two ways:

1) If a `pulumi plugin install` detects a newer version is available
   already, there's no need to download and install the older version.

2) If the engine attempts to load a plugin at a particular version,
   if a newer version is available, it will be accepted without error.

As part of this, we permit $PATH to have the final say when determining
which version to accept.  That is, it can always override the choice.

Note that I highly suspect, in the limit, that we'll want to stop doing
this for major version incompatibilities. For now, since we don't
envision any such version changes imminently, this will suffice.
2018-04-05 16:37:50 -07:00
build Add sudo when installing machine-wide virtualenv 2018-04-02 14:18:44 -07:00
cmd Permit plugin versions to float (#1122) 2018-04-05 16:37:50 -07:00
examples Run tests against managed stacks backend instead of FnF (#1092) 2018-04-02 21:34:54 -07:00
pkg Permit plugin versions to float (#1122) 2018-04-05 16:37:50 -07:00
scripts Fix logic condition in publish script 2018-04-05 14:43:03 -07:00
sdk Add the ability to read an existing resource 2018-04-05 09:48:09 -07:00
tests Require pulumi login before commands that need a backend 2018-04-05 10:19:41 -07:00
.appveyor.yml Run tests against managed stacks backend instead of FnF (#1092) 2018-04-02 21:34:54 -07:00
.gitignore Download and use a custom Node binary instead of linking against 2018-02-13 14:04:01 -08:00
.travis.yml Run tests against managed stacks backend instead of FnF (#1092) 2018-04-02 21:34:54 -07:00
.yarnrc Pass --network-concurrency 1 to yarn 2018-01-29 11:49:42 -08:00
build.proj Add get-version.cmd and use it 2018-03-16 16:36:27 -07:00
CHANGELOG.md Use per stack key for local stacks instead of per project 2018-01-19 00:50:59 -08:00
CONTRIBUTING.md Remove a few outdated references (#997) 2018-03-04 13:34:20 -08:00
Gometalinter.json Add additional linting (#768) 2017-12-27 17:10:12 -08:00
Gopkg.lock Revert "Upgrade to latest gRPC (#1071)" (#1091) 2018-03-29 22:24:26 -07:00
Gopkg.toml Revert "Upgrade to latest gRPC (#1071)" (#1091) 2018-03-29 22:24:26 -07:00
LICENSE Update the copyright end date to 2018. (#1068) 2018-03-21 12:43:21 -07:00
main.go Update the copyright end date to 2018. (#1068) 2018-03-21 12:43:21 -07:00
Makefile Adopt new version strategy 2018-03-15 18:06:04 -07:00
README.md Tidy up the README ever-so-slightly 2018-03-25 15:14:30 -07:00
tslint.json Enable 'use const' linter rule. (#405) 2017-10-10 14:50:55 -07:00

Pulumi

Pulumi is a framework and toolset for creating reusable cloud services.

This repo contains the core SDKs, CLI, and libraries, most notably the Pulumi Engine itself.

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 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.