We have some code that deals with upgrading legacy projects (which had workspace level configuration) to the new format where configuration information was stored SxS with the application. This code requires us to get a list of stacks from the backend (which for hosted stacks means hitting api.pulumi.com) as part of the upgrade process, so we knew all the stacks the user's project has. This is a somewhat slow operation (which we will make faster regardless) but we can structure things such that we don't need to do this often. In the common case, we don't need to actually do upgrading at all (new projects won't need it and once a project is upgraded that project won't need it either) so update the code first to check if we would need to do any work and if so, do the expensive operation of getting stacks from a backend. This should help with the slight pauses we've seen on the command line since the work to default to folks logging in has landed. |
||
---|---|---|
build | ||
cmd | ||
examples | ||
pkg | ||
scripts | ||
sdk | ||
tests | ||
.appveyor.yml | ||
.gitignore | ||
.travis.yml | ||
.yarnrc | ||
build.proj | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
Gometalinter.json | ||
Gopkg.lock | ||
Gopkg.toml | ||
LICENSE | ||
main.go | ||
Makefile | ||
README.md | ||
tslint.json |
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 | |
Windows x64 |
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:
- 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 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.