You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openwhisk.apache.org by st...@apache.org on 2024/02/02 22:43:59 UTC
(openwhisk) branch master updated: Update README.md (#5335)
This is an automated email from the ASF dual-hosted git repository.
style95 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk.git
The following commit(s) were added to refs/heads/master by this push:
new 6d99fd1c4 Update README.md (#5335)
6d99fd1c4 is described below
commit 6d99fd1c4ae92741994457a367df3384c052ef2d
Author: Moritz Raho <ra...@gmail.com>
AuthorDate: Fri Feb 2 23:43:54 2024 +0100
Update README.md (#5335)
---
core/standalone/README.md | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/core/standalone/README.md b/core/standalone/README.md
index 17e0ffe35..c3ea2e636 100644
--- a/core/standalone/README.md
+++ b/core/standalone/README.md
@@ -396,10 +396,6 @@ The script will start the standalone controller with Docker, and will also try t
The default standalone controller image is published as `openwhisk/standalone:nightly` for convenience.
-You can specify a different image to this script and also pass additional parameters to Docker. The general format is:
-
-`bash <(curl -sL https://s.apache.org/openwhisk.sh) [<image-name>] [<additional-docker-parameters>...]`
-
If you do not want to execute arbitrary code straight from the net, you can look at [this script](start.sh), check it and run it when you feel safe.
If the playground is not enough, you can then install the [wsk CLI](https://github.com/apache/openwhisk-cli/releases) and retrieve the command line to configure `wsk` with:
@@ -412,11 +408,17 @@ To properly shut down OpenWhisk and any additional containers it has created, us
### Extra Args for the Standalone OpenWhisk Docker Image
-When running OpenWhisk Standalone using the docker image, you can set environment variables to pass extra args with the `-e` flag.
+You can specify a different image to this script and/or pass additional parameters to Docker and/or to the standalone jar. The general format is:
+
+`bash <(curl -sL https://s.apache.org/openwhisk.sh) [<docker-parameters>...] [<image-name>] [<standalone-jar-options>...]`
+
+e.g.
+
+`bash <(curl -sL https://s.apache.org/openwhisk.sh) -e SOME_DOCKER_ENV=a openwhisk/standalone:nightly --no-ui`
Extra args are useful to configure the JVM running OpenWhisk and to propagate additional environment variables to containers running images. This feature is useful for example to enable debugging for actions.
-You can pass additional parameters (for example set system properties) to the JVM running OpenWhisk setting the environment variable `JVM_EXTRA_ARGS`. For example `-e JVM_EXTRA_ARGS=-Dconfig.loads` allows to enable tracing of configuration. You can set any OpenWhisk parameter with feature.
+You can pass additional parameters (for example set system properties) to the JVM running OpenWhisk setting the environment variable `JVM_EXTRA_ARGS`. For example `-e JVM_EXTRA_ARGS=-Dconfig.loads` allows to enable tracing of configuration. You can set any OpenWhisk parameter with this feature.
You can also set additional environment variables for each container running actions invoked by OpenWhisk by setting `CONTAINER_EXTRA_ENV`. For example, setting `-e CONTAINER_EXTRA_ENV=__OW_DEBUG_PORT=8081` enables debugging for those images supporting starting the action under a debugger, like the typescript runtime.