You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: chart/queue-worker/README.md
+34-5Lines changed: 34 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,16 @@
1
1
# JetStream for OpenFaaS queue-worker
2
2
3
-
Deploy additional, named OpenFaaS queues.
3
+
Use this chart to [deploy additional queues and queue-workers](https://docs.openfaas.com/reference/async/#dedicated-queues), for functions which need to be separated out from the default queue.
4
4
5
-
Named queues requires OpenFaaS Enterprise. Please reach out to us if you're an existing OpenFaaS Pro customer and need this feature.
5
+
> Note: This chart requires OpenFaaS for Enterprises. Please [reach out to us](https://openfaas.com/pricing) to discuss upgrading your installation.
6
6
7
-
## Install an additional queue
7
+
Reasons why you may want an additional queue-worker:
8
+
9
+
* You run workloads for your own product, and for tenants, and want to separate the two
10
+
* You want to run some queues with different settings, such as `maxInflight` (perhaps a function has a specific amount of requests it can handle at once), `upstreamTimeout` (longer timeouts), `mode` (static/function based consumers)
11
+
* Certain long-running invocations may "clog up" the queue and starve requests from other functions, so you want to run those separately
When installing from the faas-netes repository on your local computer, whilst making changes or customising the chart, you can run this command from within the `faas-netes` folder.
25
+
Upon start-up, the queue-worker will create a NATS JetStream stream named `slow-queue`. Depending on the queue mode either one static consumer will be created, or if the mode is set to `function`, a consumer will be created for each function that has invocations pending.
26
+
27
+
Remember to set the `com.openfaas.queue` annotation for your functions, so that their requests get submitted to the correct queue (NATS JetStream Stream).
28
+
29
+
For example:
30
+
31
+
```bash
32
+
# Runs on the slow queue
33
+
faas-cli store deploy sleep --name slow-fn --annotation com.openfaas.queue=slow-queue
34
+
35
+
# Runs on the default queue
36
+
faas-cli store deploy env --name fast-fn
37
+
```
38
+
39
+
## Install a development version of the chart
40
+
41
+
The below instructions are for development on the chart itself, or if you want to test changes to the chart's templates that have not yet been released.
0 commit comments