[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs URL: https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175910182 ## File path: docs/actions.md ## @@ -31,6 +31,7 @@ Learn how to create, invoke, and debug actions in your preferred development env In addition, learn about: * [Watching action output](#watching-action-output) +* [Getting actions](#getting-actions) Review comment: ah. my bad. i misread the section header and was thinking of the action metadata associated with the action (i.e. memory limit, timeout, etc).. ihmo, it's the use of the unqualified word `metadata` that lead to my confusion. it's used in the `Getting actions` section and in the `Accessing action metadata...` section, but each represent a different set of properties. maybe the qualification is `action configuration metadata` vs `action runtime metadata`. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175907988
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
Review comment:
:+1: i saw some old output that had the `code` by default
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175907988
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
Review comment:
:+1: i saw some old output that had the `code` be default
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs URL: https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175824240 ## File path: docs/actions.md ## @@ -31,6 +31,7 @@ Learn how to create, invoke, and debug actions in your preferred development env In addition, learn about: * [Watching action output](#watching-action-output) +* [Getting actions](#getting-actions) Review comment: oh.. maybe move `Accessing action metadata within the action body` underneath this `Getting Actions` section since it's all related to action retrieval. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs URL: https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175823953 ## File path: docs/actions.md ## @@ -31,6 +31,7 @@ Learn how to create, invoke, and debug actions in your preferred development env In addition, learn about: * [Watching action output](#watching-action-output) +* [Getting actions](#getting-actions) Review comment: ok. makes sense. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175737539
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
+"binary": false
+},
+"annotations": [
+{
+"key": "exec",
+"value": "nodejs:6"
+}
+],
+"limits": {
+"timeout": 6,
+"memory": 256,
+"logs": 10
+},
+"publish": false
+}
+```
+
+### Getting an action URL
+
+An action can be invoked through the REST interface via an HTTPS request. To
get an action URL, execute the following command:
Review comment:
@rabbah - the `action get --url` will return the web action (i.e.
`/api/v1/web`) url for web actions, not the non-web action (i.e.
`/api/v1/namespaces`) url.
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175602013
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
Review comment:
if so, i'm thinking the example reflect that..
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175601826
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
+"binary": false
+},
+"annotations": [
+{
+"key": "exec",
+"value": "nodejs:6"
+}
+],
+"limits": {
+"timeout": 6,
+"memory": 256,
+"logs": 10
+},
+"publish": false
+}
+```
+
+### Getting an action URL
+
+An action can be invoked through the REST interface via an HTTPS request. To
get an action URL, execute the following command:
+
+```
+wsk action get actionName --url
+```
+```
+ok: got action actionName
+https://${APIHOST}/api/v1/namespaces/${NAMESPACE}/actions/actionName
+```
+
+**Note:** Authentication must be provided when invoking an action via an HTTPS
request. For more information regarding
+action invocations using the REST interface, see
+[Using REST APIs with OpenWhisk](rest_api.md#actions).
+
+### Saving action code
+
+Code associated with an existing action is fetched and saved locally. Saving
is performed on all actions except sequences and docker actions. When saving
action code to a file, the code is saved in the current working directory, and
the saved file path is displayed.
Review comment:
lol. imho, the `is` is a bit misleading as the code is only saved when the
`--save` or `--save-as` flag is used. let's see what @jpkessle says.
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175532243
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
+"binary": false
+},
+"annotations": [
+{
+"key": "exec",
+"value": "nodejs:6"
+}
+],
+"limits": {
+"timeout": 6,
+"memory": 256,
+"logs": 10
+},
+"publish": false
+}
+```
+
+### Getting an action URL
+
+An action can be invoked through the REST interface via an HTTPS request. To
get an action URL, execute the following command:
+
+```
+wsk action get actionName --url
+```
+```
+ok: got action actionName
+https://${APIHOST}/api/v1/namespaces/${NAMESPACE}/actions/actionName
+```
+
+**Note:** Authentication must be provided when invoking an action via an HTTPS
request. For more information regarding
+action invocations using the REST interface, see
+[Using REST APIs with OpenWhisk](rest_api.md#actions).
+
+### Saving action code
+
+Code associated with an existing action is fetched and saved locally. Saving
is performed on all actions except sequences and docker actions. When saving
action code to a file, the code is saved in the current working directory, and
the saved file path is displayed.
Review comment:
"Code associated with an existing action `can be` fetched and saved locally."
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175532475
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
+"binary": false
+},
+"annotations": [
+{
+"key": "exec",
+"value": "nodejs:6"
+}
+],
+"limits": {
+"timeout": 6,
+"memory": 256,
+"logs": 10
+},
+"publish": false
+}
+```
+
+### Getting an action URL
+
+An action can be invoked through the REST interface via an HTTPS request. To
get an action URL, execute the following command:
+
+```
+wsk action get actionName --url
+```
+```
+ok: got action actionName
+https://${APIHOST}/api/v1/namespaces/${NAMESPACE}/actions/actionName
+```
+
+**Note:** Authentication must be provided when invoking an action via an HTTPS
request. For more information regarding
+action invocations using the REST interface, see
+[Using REST APIs with OpenWhisk](rest_api.md#actions).
+
+### Saving action code
+
+Code associated with an existing action is fetched and saved locally. Saving
is performed on all actions except sequences and docker actions. When saving
action code to a file, the code is saved in the current working directory, and
the saved file path is displayed.
+
+1. Save action code to a filename that corresponds with an existing action
name. A file extension that corresponds to the action kind is used, or an
extension of `.zip` will be used for action code that is a zip file.
Review comment:
extra space in `...action kind is used..`
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175529235
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
Review comment:
by default, for `nodejs` kinds, is the `code` also returned?
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175533787
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
+"binary": false
+},
+"annotations": [
+{
+"key": "exec",
+"value": "nodejs:6"
+}
+],
+"limits": {
+"timeout": 6,
+"memory": 256,
+"logs": 10
+},
+"publish": false
+}
+```
+
+### Getting an action URL
+
+An action can be invoked through the REST interface via an HTTPS request. To
get an action URL, execute the following command:
+
+```
+wsk action get actionName --url
+```
+```
+ok: got action actionName
+https://${APIHOST}/api/v1/namespaces/${NAMESPACE}/actions/actionName
+```
+
+**Note:** Authentication must be provided when invoking an action via an HTTPS
request. For more information regarding
Review comment:
if the action is a web action, authentication is not required... not sure
how/if web action caveats need to be in this doc..
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI
docs
URL:
https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175533109
##
File path: docs/actions.md
##
@@ -1219,6 +1184,71 @@ This command starts a polling loop that continuously
checks for logs from activa
Similarly, whenever you run the poll utility, you see in real time the logs
for any actions running on your behalf in OpenWhisk.
+## Getting actions
+
+Metadata that describes existing actions can be retrieved via the `wsk action
get` command.
+
+```
+wsk action get hello
+ok: got action hello
+{
+"namespace": "u...@email.com",
+"name": "hello",
+"version": "0.0.1",
+"exec": {
+"kind": "nodejs:6",
+"binary": false
+},
+"annotations": [
+{
+"key": "exec",
+"value": "nodejs:6"
+}
+],
+"limits": {
+"timeout": 6,
+"memory": 256,
+"logs": 10
+},
+"publish": false
+}
+```
+
+### Getting an action URL
+
+An action can be invoked through the REST interface via an HTTPS request. To
get an action URL, execute the following command:
+
+```
+wsk action get actionName --url
+```
+```
+ok: got action actionName
+https://${APIHOST}/api/v1/namespaces/${NAMESPACE}/actions/actionName
+```
+
+**Note:** Authentication must be provided when invoking an action via an HTTPS
request. For more information regarding
+action invocations using the REST interface, see
+[Using REST APIs with OpenWhisk](rest_api.md#actions).
+
+### Saving action code
+
+Code associated with an existing action is fetched and saved locally. Saving
is performed on all actions except sequences and docker actions. When saving
action code to a file, the code is saved in the current working directory, and
the saved file path is displayed.
+
+1. Save action code to a filename that corresponds with an existing action
name. A file extension that corresponds to the action kind is used, or an
extension of `.zip` will be used for action code that is a zip file.
+ ```
+ wsk action get actionName --save
+ ```
+ ```
+ ok: saved action code to /absolutePath/currentDirectory/actionName.js
+ ```
+
+2. Instead of allowing the CLI to determine the filename and extension of the
saved code, a custom filename and extension can be provided by using the
`--save-as` flag.
Review comment:
extra space in `..filename and extension of the saved code..`
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs
mdeuser commented on a change in pull request #3464: Add wsk action get to CLI docs URL: https://github.com/apache/incubator-openwhisk/pull/3464#discussion_r175470396 ## File path: docs/actions.md ## @@ -31,6 +31,7 @@ Learn how to create, invoke, and debug actions in your preferred development env In addition, learn about: * [Watching action output](#watching-action-output) +* [Getting actions](#getting-actions) Review comment: currently, only one action can be retrieved at a time... plural not needed here..? i.e. `Getting an action` `Getting` vs `Retrieving` or `Obtaining`..? This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
