Previously, we stored configuration information in the Pulumi.yaml
file. This was a change from the old model where configuration was
stored in a special section of the checkpoint file.
While doing things this way has some upsides with being able to flow
configuration changes with your source code (e.g. fixed values for a
production stack that version with the code) it caused some friction
for the local development scinerio. In this case, setting
configuration values would pend changes to Pulumi.yaml and if you
didn't want to publish these changes, you'd have to remember to remove
them before commiting. It also was problematic for our examples, where
it was not clear if we wanted to actually include values like
`aws:config:region` in our samples. Finally, we found that for our
own pulumi service, we'd have values that would differ across each
individual dev stack, and publishing these values to a global
Pulumi.yaml file would just be adding noise to things.
We now adopt a hybrid model, where by default configuration is stored
locally, in the workspace's settings per project. A new flag `--save`
tests commands to actual operate on the configuration information
stored in Pulumi.yaml.
With the following change, we have have four "slots" configuration
values can end up in:
1. In the Pulumi.yaml file, applies to all stacks
2. In the Pulumi.yaml file, applied to a specific stack
3. In the local workspace.json file, applied to all stacks
4. In the local workspace.json file, applied to a specific stack
When computing the configuration information for a stack, we apply
configuration in the above order, overriding values as we go
along.
We also invert the default behavior of the `pulumi config` commands so
they operate on a specific stack (i.e. how they did before
|
||
---|---|---|
cmd | ||
dist/sdk/nodejs | ||
examples | ||
pkg | ||
scripts | ||
sdk | ||
tests | ||
.appveyor.yml | ||
.gitignore | ||
.gitmodules | ||
.travis.yml | ||
.yarnrc | ||
build.proj | ||
CONTRIBUTING.md | ||
Gometalinter.json | ||
Gopkg.lock | ||
Gopkg.toml | ||
LICENSE | ||
main.go | ||
Makefile | ||
README.md | ||
tslint.json |
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 | |
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 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.