mirrors
/
pulumi
mirror of https://github.com/pulumi/pulumi.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pulumi/sdk/nodejs
History
Matt Ellis ca2fbca13f Continue to add native modules to NODE_PATH 
While we no longer use the native runtime module, older versions of
@pulumi/pulumi still require it. Let's continue to have the launcher
put the native module location on the `$PATH`. And we'll include them
in the SDK for a while longer.

Fixes #1177
 		2018-04-13 14:26:32 -07:00
..
asset Update the copyright end date to 2018. (#1068) 2018-03-21 12:43:21 -07:00
cmd Fix SxS config (#1175) 2018-04-13 11:26:01 -07:00
dist Continue to add native modules to NODE_PATH 2018-04-13 14:26:32 -07:00
dynamic Make some resource model changes 2018-04-05 08:14:25 -07:00
log Switch to a resource-progress oriented view for pulumi preview/update/destroy (#1116) 2018-04-10 12:03:11 -07:00
proto Add an ID property to ReadResponse (#1145) 2018-04-10 12:58:50 -07:00
runtime Fix SxS config (#1175) 2018-04-13 11:26:01 -07:00
tests Fix SxS config (#1175) 2018-04-13 11:26:01 -07:00
.gitignore Continue to add native modules to NODE_PATH 2018-04-13 14:26:32 -07:00
Makefile Continue to add native modules to NODE_PATH 2018-04-13 14:26:32 -07:00
README.md Update the README 2018-02-14 10:33:18 -08:00
config.ts Switch to a resource-progress oriented view for pulumi preview/update/destroy (#1116) 2018-04-10 12:03:11 -07:00
errors.ts Update the copyright end date to 2018. (#1068) 2018-03-21 12:43:21 -07:00
index.ts Update the copyright end date to 2018. (#1068) 2018-03-21 12:43:21 -07:00
metadata.ts Allow multiple Pulumi SDKs side-by-side (#1132) 2018-04-07 08:02:59 -07:00
package.json Rename pulumi package to @pulumi/pulumi (#917) 2018-02-12 13:13:13 -08:00
resource.ts Simplify resource lookup (#1133) 2018-04-07 10:15:58 -07:00
tsconfig.json Implement scope chain free variable lookup in pure TypeScript (#1139) 2018-04-10 10:04:11 -07:00
tslint.json Update the copyright end date to 2018. (#1068) 2018-03-21 12:43:21 -07:00
version.ts Allow multiple Pulumi SDKs side-by-side (#1132) 2018-04-07 08:02:59 -07:00
yarn.lock Run yarn upgrade and commit all resulting lockfiles 2018-01-30 14:46:44 -08:00

README.md

Pulumi Fabric Node.js SDK

The Pulumi Fabric Node.js SDK lets you write cloud programs in JavaScript.

Installing

For now, we only support developers building from source. Eventually we will have a nice installer.

Prerequisites

To build and install the SDK, you will first need a few things.

First, install Node.js 6.10.2. We recommend nvm, since it makes it easier to switch between versions of Node.js. Afterwards, run nvm install 6.10.2. As part of the build, a custom build of Node.js 6.10.2 will be downloaded and installed alongside the SDK. This Node binary is identical to Node.js 6.10.2, except that it has one extra builtin module containing code that is used by the SDK to serialize JavaScript closures. The custom binary is built from this repo.

Next, we suggest using Yarn for package management. NPM works too, but Yarn is faster and therefore preferred. Please follow the directions on Yarn's website.

Building and Testing

The first time you build, you must make configure to install and prepare native plugins for V8:

$ make configure

Make sure to run this after installing the right version of Node.js above, otherwise it may bind to the wrong version.

To build the SDK, simply run make from the root directory (sdk/nodejs/). This will build the code, run tests, and then "install" the package (by yarn linking the resulting bin/ directory).

We recommend putting bin/ on your $PATH, since the pulumi-langhost-nodejs executable will be loaded dynamically by the pulumi tool whenever it encounters a Node.js program.

The tests will verify that everything works, but feel free to try running pulumi preview and/or pulumi update from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.