This is an automated email from the ASF dual-hosted git repository.
mrutkowski 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 d47f4ec Document optional .wskprops related to provider-specific API
Gateway … (#4713)
d47f4ec is described below
commit d47f4ec91d467295ffcfa894401ddb113984c108
Author: Matt Rutkowski <[email protected]>
AuthorDate: Fri Nov 8 08:32:33 2019 -0600
Document optional .wskprops related to provider-specific API Gateway …
(#4713)
* Document optional .wskprops related to provider-specific API Gateway
services
* Document optional .wskprops related to provider-specific API Gateway
services
---
docs/cli.md | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/docs/cli.md b/docs/cli.md
index 901a7dd..1a91665 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -51,10 +51,23 @@ you can run the following command from your `openwhisk`
directory:
./bin/wsk property set --auth `cat ansible/files/auth.guest`
```
-**Tip:** The OpenWhisk CLI stores the properties set in `~/.wskprops` by
default. The location of this file can be altered by setting the
`WSK_CONFIG_FILE` environment variable.
+**Tip:** The OpenWhisk CLI stores properties in the `~/.wskprops`
configuration file by default. The location of this file can be altered by
setting the `WSK_CONFIG_FILE` environment variable.
+
+The required properties described above have the following keys in the
`.wskprops` file:
+
+- **APIHOST** - Required key for the API host value.
+- **AUTH** - Required key for the Authorization key.
To verify your CLI setup, try [creating and running an action](./samples.md).
+### Optional Whisk Properties
+
+Some OpenWhisk providers make use of optional properties that can be added to
the `.wskprops` file. The following keys are optional:
+
+- **APIGW_ACCESS_TOKEN** - Optional, provider-specific authorization token for
an independently hosted API Gateway service used for managing OpenWhisk API
endpoints.
+
+- **APIGW_TENANT_ID** - Optional, provider-relative identifier of the tenant
(owner for access control purposes) of any API endpoints that are created by
the CLI.
+
### Configure command completion for Openwhisk CLI
For bash command completion to work, bash 4.1 or newer is required. The most
recent Linux distributions should have the correct version of bash but Mac
users will most likely have an older version.
