Skip to content

Commit bb6ef19

Browse files
committed
Update for OpenFaaS pro health check features
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 3000267 commit bb6ef19

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

docs/openfaas-pro/retries.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ There are two primary use-cases for retrying asynchronous messages:
1313

1414
You can install the Pro version of the queue worker by editing the values.yaml file of the [OpenFaaS chart](https://github.com/openfaas/faas-netes/tree/master/chart/openfaas).
1515

16+
You must also set:
17+
1618
```yaml
17-
# Requires OpenFaaS Pro subscription
19+
openfaasPro: true
20+
1821
queueWorkerPro:
1922
image: ghcr.io/openfaas/queue-worker-pro:0.1.0-rc4
20-
enabled: false
2123
maxRetryAttempts: "10"
2224
maxRetryWait: "120s"
2325
initialRetryWait: "10s"
@@ -34,7 +36,6 @@ The `httpRetryCodes` is a comma-separated list of HTTP status codes which the qu
3436

3537
To test the retry functionality, you can use our chaos function, which allows a function to be configured to return a canned response, or to timeout with a given duration.
3638

37-
3839
```bash
3940
git clone https://github.com/alexellis/chaos-fn
4041

docs/reference/workloads.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -163,14 +163,17 @@ Use of the [OpenFaaS next-gen of-watchdog](https://github.com/openfaas/of-watchd
163163

164164
On Kubernetes is possible to run any container image as an OpenFaaS function as long as your application exposes port 8080 and has a HTTP health check endpoint.
165165

166-
#### Custom HTTP health check
166+
#### Custom HTTP health checks
167+
168+
> This feature is available for OpenFaaS Pro customers only
167169

168170
You can specify the HTTP path of your health check and the initial check delay duration with the following annotations:
169171

170172
* `com.openfaas.health.http.path`
171173
* `com.openfaas.health.http.initialDelay`
174+
* `com.openfaas.health.http.periodSeconds`
172175

173-
Stack file example:
176+
For example, you may have a function that takes 30s to initialise, but then only needs to be checked every 5s after that.
174177

175178
```yaml
176179
functions:
@@ -180,6 +183,7 @@ functions:
180183
annotations:
181184
com.openfaas.health.http.path: "/healthz"
182185
com.openfaas.health.http.initialDelay: "30s"
186+
com.openfaas.health.http.periodSeconds: 5s
183187
```
184188

185189
> Note: The initial delay value must be a valid Go duration e.g. `80s` or `3m`.

0 commit comments

Comments
 (0)