openwhisk-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [openwhisk] mrutkows commented on a change in pull request #4713: Document optional .wskprops related to provider-specific API Gateway …
Date Wed, 06 Nov 2019 15:07:09 GMT
mrutkows commented on a change in pull request #4713: Document optional .wskprops related to
provider-specific API Gateway …
URL: https://github.com/apache/openwhisk/pull/4713#discussion_r343138734
 
 

 ##########
 File path: docs/cli.md
 ##########
 @@ -51,10 +51,25 @@ 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:
+
+- **NAMESPACE** - Optional, provider-relative identifier for a namespace to be used when
managing OpenWhisk entities (e.g. Actions, Triggers, Rules, etc.) with the CLI.
 
 Review comment:
   NAMESPACE is still in the go-client... 
   https://github.com/apache/openwhisk-client-go/blob/master/whisk/wskprops.go
   and listed as a mandatory param in its readme:
   https://github.com/apache/openwhisk-client-go#configuration
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message