openwhisk-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From csantan...@apache.org
Subject [incubator-openwhisk-devtools] branch master updated: Add information on some env variables to README (#101)
Date Tue, 27 Feb 2018 22:46:31 GMT
This is an automated email from the ASF dual-hosted git repository.

csantanapr pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-devtools.git


The following commit(s) were added to refs/heads/master by this push:
     new e054c51  Add information on some env variables to README (#101)
e054c51 is described below

commit e054c51631deaf795149d03c45945a62e2adf063
Author: Rob Allen <rob@akrabat.com>
AuthorDate: Tue Feb 27 17:46:29 2018 -0500

    Add information on some env variables to README (#101)
---
 docker-compose/README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/docker-compose/README.md b/docker-compose/README.md
index 19d7af5..7d0d08d 100644
--- a/docker-compose/README.md
+++ b/docker-compose/README.md
@@ -40,10 +40,19 @@ At the end of the execution it prints the output of the function:
 }
 ```
 
-If `PROJECT_HOME` variable is set ( i.e. `PROJECT_HOME=/path/to/openwhisk make quick-start`)
+If `OPENWHISK_PROJECT_HOME` variable is set ( i.e. `OPENWHISK_PROJECT_HOME=/path/to/openwhisk
make quick-start`)
 then the command skips downloading the `master` branch and uses instead the source code found
in the `PROJECT_HOME` folder.
 This is useful for working with a local clone, making changes to the code, and run it with
`docker-compose`.
 
+This is the set of environment variables that can be set:
+
+* `OPENWHISK_PROJECT_HOME` - a checkout of [openwhisk](https://github.com/apache/incubator-openwhisk)
+* `OPENWHISK_CATALOG_HOME` - a checkout of [openwhisk-catalog](https://github.com/apache/incubator-openwhisk-catalog)
+* `WSK_CLI` - the directory where the [`wsk` command line tool](https://github.com/apache/incubator-openwhisk-cli)
can be found
+* `DOCKER_IMAGE_PREFIX` - the prefix of the docker images used for actions. If you are building
and testing checkouts of runtimes locally, then consider setting this to `whisk`.
+
+Note that these are all optional and only need to be set if you have a local checkout that
you want to use.
+
 ## Updating OpenWhisk Invoker or Controller
 
 To update the OpenWhisk Invoker or Controller without restarting everything, run:

-- 
To stop receiving notification emails like this one, please contact
csantanapr@apache.org.

Mime
View raw message