compose command compiles composition code to a portable JSON format. The
deploy command deploys JSON-encoded compositions. These commands are intended
as a minimal complement to the OpenWhisk CLI. The OpenWhisk CLI already has the
capability to configure, invoke, and delete compositions since these are just
OpenWhisk actions but lacks the capability to create composition actions. The
deploy commands bridge this gap. They make it possible to deploy
compositions as part of the development cycle or in shell scripts. They do not
replace the OpenWhisk CLI however as they do not duplicate existing OpenWhisk
Usage: compose composition.js [flags] Flags: --ast only output the ast for the composition -v, --version output the composer version
object (for example demo.js) and compiles this object to a
portable JSON format on the standard output.
compose demo.js > demo.json
--ast option is specified, the
compose command only outputs a JSON
representation of the Abstract Syntax Tree for the composition.
Usage: deploy composition composition.json [flags] Flags: -a, --annotation KEY=VALUE add KEY annotation with VALUE -A, --annotation-file KEY=FILE add KEY annotation with FILE content --apihost HOST API HOST -i, --insecure bypass certificate checking -u, --auth KEY authorization KEY -v, --version output the composer version -w, --overwrite overwrite actions if already defined
deploy command deploys a JSON-encoded composition with the given name.
deploy demo demo.json -w
ok: created /_/authenticate,/_/success,/_/failure,/_/demo
deploy command synthesizes and deploys a conductor action that implements
the composition with the given name. It also deploys the composed actions for
which definitions are provided as part of the composition.
deploy command outputs the list of deployed actions or an error result. If
an error occurs during deployment, the state of the various actions is unknown.
-w option authorizes the
deploy command to overwrite existing
definitions. More precisely, it deletes the deployed actions before recreating
them. As a result, default parameters, limits, and annotations on preexisting
actions are lost.
deploy command implicitly annotates the deployed composition action with
conductor annotations. Other annotations may be specified by
means of the flags:
-a, --annotation KEY=VALUE add KEY annotation with VALUE -A, --annotation-file KEY=FILE add KEY annotation with FILE content
Like the OpenWhisk CLI, the
deploy command supports the following flags for
specifying the OpenWhisk instance to use:
--apihost HOST API HOST -i, --insecure bypass certificate checking -u, --auth KEY authorization KEY
--apihost flag is absent, the environment variable
used in its place. If neither is available, the
deploy command extracts the
APIHOST key from the whisk property file for the current user.
--auth flag is absent, the environment variable
__OW_API_KEY is used
in its place. If neither is available, the
deploy command extracts the
key from the whisk property file for the current user.
The default path for the whisk property file is
$HOME/.wskprops. It can be
altered by setting the
WSK_CONFIG_FILE environment variable.