58a75cbbf4
If a resource's options bag does not specify `protect` or `provider`, pull a default value from the resource's parent. In order to allow a parent resource to specify providers for multiple resource types, component resources now accept an optional map from package name to provider instance. When a custom resource needs a default provider from its parent, it checks its parent provider bag for an entry under its package. If a component resource does not have a provider bag, its pulls a default from its parent. These changes also add a `parent` field to `InvokeOptions` s.t. calls to invoke can use the same behavior as resource creation w.r.t. providers. Fixes #1735, #1736. |
||
---|---|---|
.. | ||
asset | ||
cmd | ||
dist | ||
dynamic | ||
log | ||
proto | ||
runtime | ||
tests | ||
.gitignore | ||
Makefile | ||
README.md | ||
config.ts | ||
errors.ts | ||
index.ts | ||
invoke.ts | ||
metadata.ts | ||
package.json | ||
resource.ts | ||
tsconfig.json | ||
tslint.json | ||
version.ts | ||
yarn.lock |
README.md
Pulumi Node.js SDK
The Pulumi Node.js SDK lets you write cloud programs in JavaScript.
Installation
Using npm:
$ npm install --save @pulumi/pulumi
Using yarn:
$ yarn add @pulumi/pulumi
This SDK is meant for use with the Pulumi CLI. Please visit pulumi.io for installation instructions.
Building and Testing
For anybody who wants to build from source, here is how you do it.
Prerequisites
This SDK uses Node.js and we support the Active LTS and Current releases, as defined by this table. We support both NPM and Yarn for package management.
At the moment, we only support building on macOS and Linux, where standard GNU tools like make
are available.
Make Targets
The first time you build, run make ensure
to install and prepare native plugins for V8:
$ make ensure
This is only necessary if you intend to produce a build that is capable of running older versions of the SDK
contained in this directory. If you do intend to do this, you must have node 6.10.2
installed.
To build the SDK, simply run make
from the root directory (where this README
lives, at sdk/nodejs/
from the repo's
root). This will build the code, run tests, and install the package and its supporting artifacts.
At the moment, for local development, we install everything into /opt/pulumi
. You will want this on your $PATH
.
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.