You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/05/18 15:56:47 UTC
[GitHub] [apisix] navendu-pottekkat opened a new pull request, #7076: docs: update "Serverless" Plugins
navendu-pottekkat opened a new pull request, #7076:
URL: https://github.com/apache/apisix/pull/7076
Signed-off-by: Navendu Pottekkat <na...@gmail.com>
### Description
Updates the documentation of the "Serverless" Plugins.
Child PR of #6734
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] navendu-pottekkat commented on a diff in pull request #7076: docs: update "Serverless" Plugins
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #7076:
URL: https://github.com/apache/apisix/pull/7076#discussion_r877708338
##########
docs/en/latest/plugins/openwhisk.md:
##########
@@ -23,34 +28,36 @@ title: openwhisk
## Description
-The `openwhisk` plugin is used to support integration with the [Apache OpenWhisk](https://openwhisk.apache.org) serverless platform and can be set up on a route in place of Upstream, which will take over the request and send it to the OpenWhisk API endpoint.
+The `openwhisk` Plugin is used to integrate APISIX with [Apache OpenWhisk](https://openwhisk.apache.org) serverless platform.
-Users can call the OpenWhisk action via APISIX, pass the request parameters via JSON and get the response content.
+This Plugin can be configured on a Route and requests will be send to the configured OpenWhish API endpoint as the upstream.
## Attributes
-| Name | Type | Requirement | Default | Valid | Description |
-| -- | -- | -- | -- | -- | -- |
-| api_host | string | required | | | OpenWhisk API host (eg. https://localhost:3233) |
-| ssl_verify | boolean | optional | true | | Whether to verify the certificate |
-| service_token | string | required | | | OpenWhisk ServiceToken (The format is `xxx:xxx`，Passed through Basic Auth when calling the API) |
-| namespace | string | required | | | OpenWhisk Namespace (eg. guest) |
-| action | string | required | | | OpenWhisk Action (eg. hello) |
-| result | boolean | optional | true | | Whether to get Action metadata (default to execute function and get response; false to get Action metadata but not execute Action, including runtime, function body, restrictions, etc.) |
-| timeout | integer | optional | 60000ms | [1, 60000]ms | OpenWhisk Action and HTTP call timeout. |
-| keepalive | boolean | optional | true | | HTTP keepalive |
-| keepalive_timeout | integer | optional | 60000ms | [1000,...] | keepalive idle timeout |
-| keepalive_pool | integer | optional | 5 | [1,...] | Connection pool limit |
+| Name | Type | Required | Default | Valid values | Description |
+|-------------------|---------|----------|---------|--------------|------------------------------------------------------------------------------------------------------------|
+| api_host | string | True | | | OpenWhisk API host address. For example, `https://localhost:3233`. |
+| ssl_verify | boolean | False | true | | When set to `true` verifies the SSL certificate. |
+| service_token | string | True | | | OpenWhisk service token. The format is `xxx:xxx` and it is passed through basic auth when calling the API. |
+| namespace | string | True | | | OpenWhisk namespace. For example `guest`. |
+| action | string | True | | | OpenWhisk action. For example `hello`. |
+| result | boolean | False | true | | When set to `true` gets the action metadata (executes the function and gets response). |
+| timeout | integer | False | 60000ms | [1, 60000]ms | OpenWhisk action and HTTP call timeout in ms. |
+| keepalive | boolean | False | true | | When set to `true` keeps the connection alive for reuse. |
+| keepalive_timeout | integer | False | 60000ms | [1000,...] | Time is ms for connection to remain idle without closing. |
+| keepalive_pool | integer | False | 5 | [1,...] | Maximum number of requests that can be sent on this connection before closing it. |
:::note
-- The `timeout` property controls both the time taken by the OpenWhisk Action to execute and the timeout of the HTTP client in APISIX. OpenWhisk Action calls may consume time on pulling the runtime image and starting the container, so if you set the value too small, you may cause a large number of requests to fail. OpenWhisk supports timeouts ranging from 1ms to 60000ms, and we recommended to set at least 1000ms or more.
+The `timeout` attribute sets the time taken by the OpenWhisk action to execute and also the timeout for the HTTP client in APISIX. OpenWhisk action calls may take time to pull the runtime image and start the container. So, if the value is set too small, it may cause a large number of requests to fail.
Review Comment:
Updated.
##########
docs/en/latest/plugins/openwhisk.md:
##########
@@ -23,34 +28,36 @@ title: openwhisk
## Description
-The `openwhisk` plugin is used to support integration with the [Apache OpenWhisk](https://openwhisk.apache.org) serverless platform and can be set up on a route in place of Upstream, which will take over the request and send it to the OpenWhisk API endpoint.
+The `openwhisk` Plugin is used to integrate APISIX with [Apache OpenWhisk](https://openwhisk.apache.org) serverless platform.
-Users can call the OpenWhisk action via APISIX, pass the request parameters via JSON and get the response content.
+This Plugin can be configured on a Route and requests will be send to the configured OpenWhish API endpoint as the upstream.
## Attributes
-| Name | Type | Requirement | Default | Valid | Description |
-| -- | -- | -- | -- | -- | -- |
-| api_host | string | required | | | OpenWhisk API host (eg. https://localhost:3233) |
-| ssl_verify | boolean | optional | true | | Whether to verify the certificate |
-| service_token | string | required | | | OpenWhisk ServiceToken (The format is `xxx:xxx`，Passed through Basic Auth when calling the API) |
-| namespace | string | required | | | OpenWhisk Namespace (eg. guest) |
-| action | string | required | | | OpenWhisk Action (eg. hello) |
-| result | boolean | optional | true | | Whether to get Action metadata (default to execute function and get response; false to get Action metadata but not execute Action, including runtime, function body, restrictions, etc.) |
-| timeout | integer | optional | 60000ms | [1, 60000]ms | OpenWhisk Action and HTTP call timeout. |
-| keepalive | boolean | optional | true | | HTTP keepalive |
-| keepalive_timeout | integer | optional | 60000ms | [1000,...] | keepalive idle timeout |
-| keepalive_pool | integer | optional | 5 | [1,...] | Connection pool limit |
+| Name | Type | Required | Default | Valid values | Description |
+|-------------------|---------|----------|---------|--------------|------------------------------------------------------------------------------------------------------------|
+| api_host | string | True | | | OpenWhisk API host address. For example, `https://localhost:3233`. |
+| ssl_verify | boolean | False | true | | When set to `true` verifies the SSL certificate. |
+| service_token | string | True | | | OpenWhisk service token. The format is `xxx:xxx` and it is passed through basic auth when calling the API. |
+| namespace | string | True | | | OpenWhisk namespace. For example `guest`. |
+| action | string | True | | | OpenWhisk action. For example `hello`. |
+| result | boolean | False | true | | When set to `true` gets the action metadata (executes the function and gets response). |
+| timeout | integer | False | 60000ms | [1, 60000]ms | OpenWhisk action and HTTP call timeout in ms. |
+| keepalive | boolean | False | true | | When set to `true` keeps the connection alive for reuse. |
+| keepalive_timeout | integer | False | 60000ms | [1000,...] | Time is ms for connection to remain idle without closing. |
Review Comment:
Updated.
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] LiteSun commented on a diff in pull request #7076: docs: update "Serverless" Plugins
Posted by GitBox <gi...@apache.org>.
LiteSun commented on code in PR #7076:
URL: https://github.com/apache/apisix/pull/7076#discussion_r877632457
##########
docs/en/latest/plugins/openwhisk.md:
##########
@@ -23,34 +28,36 @@ title: openwhisk
## Description
-The `openwhisk` plugin is used to support integration with the [Apache OpenWhisk](https://openwhisk.apache.org) serverless platform and can be set up on a route in place of Upstream, which will take over the request and send it to the OpenWhisk API endpoint.
+The `openwhisk` Plugin is used to integrate APISIX with [Apache OpenWhisk](https://openwhisk.apache.org) serverless platform.
-Users can call the OpenWhisk action via APISIX, pass the request parameters via JSON and get the response content.
+This Plugin can be configured on a Route and requests will be send to the configured OpenWhish API endpoint as the upstream.
## Attributes
-| Name | Type | Requirement | Default | Valid | Description |
-| -- | -- | -- | -- | -- | -- |
-| api_host | string | required | | | OpenWhisk API host (eg. https://localhost:3233) |
-| ssl_verify | boolean | optional | true | | Whether to verify the certificate |
-| service_token | string | required | | | OpenWhisk ServiceToken (The format is `xxx:xxx`，Passed through Basic Auth when calling the API) |
-| namespace | string | required | | | OpenWhisk Namespace (eg. guest) |
-| action | string | required | | | OpenWhisk Action (eg. hello) |
-| result | boolean | optional | true | | Whether to get Action metadata (default to execute function and get response; false to get Action metadata but not execute Action, including runtime, function body, restrictions, etc.) |
-| timeout | integer | optional | 60000ms | [1, 60000]ms | OpenWhisk Action and HTTP call timeout. |
-| keepalive | boolean | optional | true | | HTTP keepalive |
-| keepalive_timeout | integer | optional | 60000ms | [1000,...] | keepalive idle timeout |
-| keepalive_pool | integer | optional | 5 | [1,...] | Connection pool limit |
+| Name | Type | Required | Default | Valid values | Description |
+|-------------------|---------|----------|---------|--------------|------------------------------------------------------------------------------------------------------------|
+| api_host | string | True | | | OpenWhisk API host address. For example, `https://localhost:3233`. |
+| ssl_verify | boolean | False | true | | When set to `true` verifies the SSL certificate. |
+| service_token | string | True | | | OpenWhisk service token. The format is `xxx:xxx` and it is passed through basic auth when calling the API. |
+| namespace | string | True | | | OpenWhisk namespace. For example `guest`. |
+| action | string | True | | | OpenWhisk action. For example `hello`. |
+| result | boolean | False | true | | When set to `true` gets the action metadata (executes the function and gets response). |
+| timeout | integer | False | 60000ms | [1, 60000]ms | OpenWhisk action and HTTP call timeout in ms. |
+| keepalive | boolean | False | true | | When set to `true` keeps the connection alive for reuse. |
+| keepalive_timeout | integer | False | 60000ms | [1000,...] | Time is ms for connection to remain idle without closing. |
+| keepalive_pool | integer | False | 5 | [1,...] | Maximum number of requests that can be sent on this connection before closing it. |
:::note
-- The `timeout` property controls both the time taken by the OpenWhisk Action to execute and the timeout of the HTTP client in APISIX. OpenWhisk Action calls may consume time on pulling the runtime image and starting the container, so if you set the value too small, you may cause a large number of requests to fail. OpenWhisk supports timeouts ranging from 1ms to 60000ms, and we recommended to set at least 1000ms or more.
+The `timeout` attribute sets the time taken by the OpenWhisk action to execute and also the timeout for the HTTP client in APISIX. OpenWhisk action calls may take time to pull the runtime image and start the container. So, if the value is set too small, it may cause a large number of requests to fail.
Review Comment:
```suggestion
The `timeout` attribute sets the time taken by the OpenWhisk action to execute and the timeout for the HTTP client in APISIX. OpenWhisk action calls may take time to pull the runtime image and start the container. So, if the value is set too small, it may cause a large number of requests to fail.
```
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #7076: docs: update "Serverless" Plugins
Posted by GitBox <gi...@apache.org>.
spacewander merged PR #7076:
URL: https://github.com/apache/apisix/pull/7076
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] hf400159 commented on a diff in pull request #7076: docs: update "Serverless" Plugins
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7076:
URL: https://github.com/apache/apisix/pull/7076#discussion_r877664513
##########
docs/en/latest/plugins/openwhisk.md:
##########
@@ -23,34 +28,36 @@ title: openwhisk
## Description
-The `openwhisk` plugin is used to support integration with the [Apache OpenWhisk](https://openwhisk.apache.org) serverless platform and can be set up on a route in place of Upstream, which will take over the request and send it to the OpenWhisk API endpoint.
+The `openwhisk` Plugin is used to integrate APISIX with [Apache OpenWhisk](https://openwhisk.apache.org) serverless platform.
-Users can call the OpenWhisk action via APISIX, pass the request parameters via JSON and get the response content.
+This Plugin can be configured on a Route and requests will be send to the configured OpenWhish API endpoint as the upstream.
## Attributes
-| Name | Type | Requirement | Default | Valid | Description |
-| -- | -- | -- | -- | -- | -- |
-| api_host | string | required | | | OpenWhisk API host (eg. https://localhost:3233) |
-| ssl_verify | boolean | optional | true | | Whether to verify the certificate |
-| service_token | string | required | | | OpenWhisk ServiceToken (The format is `xxx:xxx`，Passed through Basic Auth when calling the API) |
-| namespace | string | required | | | OpenWhisk Namespace (eg. guest) |
-| action | string | required | | | OpenWhisk Action (eg. hello) |
-| result | boolean | optional | true | | Whether to get Action metadata (default to execute function and get response; false to get Action metadata but not execute Action, including runtime, function body, restrictions, etc.) |
-| timeout | integer | optional | 60000ms | [1, 60000]ms | OpenWhisk Action and HTTP call timeout. |
-| keepalive | boolean | optional | true | | HTTP keepalive |
-| keepalive_timeout | integer | optional | 60000ms | [1000,...] | keepalive idle timeout |
-| keepalive_pool | integer | optional | 5 | [1,...] | Connection pool limit |
+| Name | Type | Required | Default | Valid values | Description |
+|-------------------|---------|----------|---------|--------------|------------------------------------------------------------------------------------------------------------|
+| api_host | string | True | | | OpenWhisk API host address. For example, `https://localhost:3233`. |
+| ssl_verify | boolean | False | true | | When set to `true` verifies the SSL certificate. |
+| service_token | string | True | | | OpenWhisk service token. The format is `xxx:xxx` and it is passed through basic auth when calling the API. |
+| namespace | string | True | | | OpenWhisk namespace. For example `guest`. |
+| action | string | True | | | OpenWhisk action. For example `hello`. |
+| result | boolean | False | true | | When set to `true` gets the action metadata (executes the function and gets response). |
+| timeout | integer | False | 60000ms | [1, 60000]ms | OpenWhisk action and HTTP call timeout in ms. |
+| keepalive | boolean | False | true | | When set to `true` keeps the connection alive for reuse. |
+| keepalive_timeout | integer | False | 60000ms | [1000,...] | Time is ms for connection to remain idle without closing. |
Review Comment:
```suggestion
| keepalive_timeout | integer | False | 60000ms | [1000,...]ms | Time is ms for connection to remain idle without closing. |
```
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] navendu-pottekkat commented on pull request #7076: docs: update "Serverless" Plugins
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on PR #7076:
URL: https://github.com/apache/apisix/pull/7076#issuecomment-1130207604
// @hf400159 @kwanhur @avinal @yzeng25 @juzhiyuan Please review when you are available.
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org