As part of pulumi/pulumi-fabric#331, we've been exploring just using undefined to indicate that a property value is absent during planning. We also considered blocking the message loop to simplify the overall programming model, so that all asynchrony is hidden. It turns out ThereBeDragons 🐲 anytime you try to block the message loop. So, we aren't quite sure about that bit. But the part we are convicted about is that this Computed/Property model is far too complex. Furthermore, it's very close to promises, and yet frustratingly so far away. Indeed, the original thinking in pulumi/pulumi-fabric#271 was simply to use promises, but we wanted to encourage dataflow styles, rather than control flow. But we muddied up our thinking by worrying about awaiting a promise that would never resolve. It turns out we can achieve a middle ground: resolve planning promises to undefined, so that they don't lead to hangs, but still use promises so that asynchrony is explicit in the system. This also avoids blocking the message loop. Who knows, this may actually be a fine final destination. |
||
---|---|---|
cmd | ||
docs | ||
examples | ||
pkg | ||
scripts | ||
sdk | ||
.gitignore | ||
.gitmodules | ||
.travis.yml | ||
CONTRIBUTING.md | ||
Gometalinter.json | ||
Gopkg.lock | ||
Gopkg.toml | ||
LICENSE | ||
Makefile | ||
README.md | ||
tslint.json |
Pulumi Fabric
The Pulumi Fabric ("Lumi") is a framework and toolset for creating reusable cloud services.
If you are learning about Lumi for the first time, please see the overview document.
Installing
To install Lumi from source, simply run:
$ go get -u github.com/pulumi/pulumi-fabric/cmd/lumi
A GOPATH
must be set. A good default value is ~/go
. In fact, this is the default in Go 1.8.
This installs the lumi
binary to $GOPATH/bin
.
To do anything interesting with Lumi, 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 Lumi developers.
Prerequisites
Lumi 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 Lumi, ensure $GOPATH
is set, and clone into a standard Go workspace:
$ git clone git@github.com:pulumi/pulumi-fabric $GOPATH/src/github.com/pulumi/pulumi-fabric
$ cd $GOPATH/src/github.com/pulumi/pulumi-fabric
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 lumi
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 Lumi 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 Lumi 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
$ lumi eval --logtostderr -v=5
is a pretty standard starting point during debugging that will show a fairly comprehensive trace log of a compilation.