Skip to content

Commit 4a4397b

Browse files
committed
Add link to workshop and issue re: localhost
Signed-off-by: Alex Ellis (VMware) <[email protected]>
1 parent 1611a0d commit 4a4397b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/deployment/troubleshooting.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Troubleshooting guide
22

3+
The most common questions and user-issues can be resolved by reading the documentation carefully. After consulting this page, please work through the <a href="https://github.com/openfaas/workshop/">OpenFaaS workshop</a> where many concepts are explained in detail with worked-examples.
4+
35
## Asynchronous functions
46

57
Any function can be invoked asynchronously by changing the route on the gateway from `/function/<name>` to `/async-function/<name>`. A `202 Accepted` message will be issued in response to asynchronous calls.
@@ -35,6 +37,23 @@ The following additional request headers will be set when invoking the call back
3537
| X-Duration-Seconds | Time taken in seconds to execute the original function call |
3638
| X-Function-Status | [HTTP status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) returned by the original function call |
3739

40+
## Chaining / workflows
41+
42+
> See also <a href="#Timeouts">Timeouts</a> (below)
43+
44+
When chaning or invoking another function, do this by calling it via the gateway either using the external IP address of the cluster / gateway, or by the internal DNS name.
45+
46+
A common user-error is to try to invoke the gateway from within a function using `http://127.0.0.1` or `localhost` - this address simply points back to the container the function is running in and is invalid.
47+
48+
> Note: If you access the gateway via its DNS entry/name then it is recommended to configure the gateway URL via an environmental variable (such as `gateway_url`) to make sure you can port the function between OpenFaaS providers.
49+
50+
### On Kubernetes
51+
52+
The default address for the gateway on Kubernetes is `http://gateway.openfaas:8080`.
53+
54+
### On Docker Swarm
55+
56+
The default address for the gateway is `http://gateway:8080`
3857

3958
## Timeouts
4059

0 commit comments

Comments
 (0)