Skip to content

Commit ec36671

Browse files
weltekialexellis
authored andcommitted
Add JetStream parameters to openfaas chart README
Signed-off-by: Han Verstraete (OpenFaaS Ltd) <[email protected]>
1 parent 552febb commit ec36671

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

chart/openfaas/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,9 @@ See [values.yaml](./values.yaml) for detailed configuration.
428428
| Parameter | Description | Default |
429429
| ----------------------- | ---------------------------------- | ---------------------------------------------------------- |
430430
| `affinity`| Global [affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) rules assigned to deployments | `{}` |
431-
| `async` | Enables asynchronous function invocations. If `.nats.external.enabled` is `false`, also deploys NATS Streaming | `true` |
431+
yaml) |
432+
| `async` | Enables asynchronous function invocations. If `.nats.external.enabled` is `false`, also deploys NATS | `true` |
433+
| `queueMode` | Set to `jetstream` to run the async system backed by NATS JetStream. By default the async system uses NATS Streaming|
432434
| `basic_auth` | Enable basic authentication on the gateway and Prometheus. Warning: do not disable. | `true` |
433435
| `basicAuthPlugin.image` | Container image used for basic-auth-plugin | See [values.yaml](./values.yaml) |
434436
| `basicAuthPlugin.replicas` | Replicas of the basic-auth-plugin | `1` |
@@ -509,7 +511,11 @@ See [values.yaml](./values.yaml) for detailed configuration.
509511

510512
| Parameter | Description | Default |
511513
| ----------------------- | ---------------------------------- | ---------------------------------------------------------- |
512-
| `nats.channel` | The name of the NATS Streaming channel to use for asynchronous function invocations | `faas-request` |
514+
| `jetstreamQueueWorker.durableName` | Durable name used by JetStream consumers | `faas-workers` |
515+
| `jetstreamQueueWorker.image` | Container image used for the queue-worker when the `queueMode` is `jetstream` | See [values.yaml](./values.yaml) |
516+
| `jetstreamQueueWorker.logs.debug` | Log debug messages | `false` |
517+
| `jetstreamQueueWorker.logs.format` | Set the log format, supports `console` or `json` | `console` |
518+
| `nats.channel` | The name of the NATS Streaming channel or NATS JetStream stream to use for asynchronous function invocations | `faas-request` |
513519
| `nats.enableMonitoring` | Enable the NATS monitoring endpoints on port `8222` for NATS Streaming deployments managed by this chart | `false` |
514520
| `nats.external.clusterName` | The name of the externally-managed NATS Streaming server | `""` |
515521
| `nats.external.enabled` | Whether to use an externally-managed NATS Streaming server | `false` |
@@ -519,6 +525,7 @@ See [values.yaml](./values.yaml) for detailed configuration.
519525
| `nats.metrics.enabled` | Export Prometheus metrics for NATS, no multi-arch support | `false` |
520526
| `nats.metrics.image` | Container image used for the NATS Prometheus exporter | See [values.yaml](./values.yaml) |
521527
| `nats.resources` | Resource limits and requests for the nats pods | See [values.yaml](./values.yaml) |
528+
| `nats.streamReplication` | JetStream stream replication factor. For production a value of at least 3 is recommended. | `1` |
522529
| `queueWorker.ackWait` | Max duration of any async task/request | `60s` |
523530
| `queueWorker.image` | Container image used for the CE edition of the queue-worker| See [values.yaml](./values.yaml) |
524531
| `queueWorker.maxInflight` | Control the concurrent invocations | `1` |
@@ -533,6 +540,7 @@ See [values.yaml](./values.yaml) for detailed configuration.
533540
| `queueWorkerPro.maxRetryWait` | Maximum amount of time to wait between retries | `120s` |
534541
| `queueWorkerPro.printResponseBody` | Print the function response body | `false` |
535542
| `queueWorkerPro.printRequestBody` | Print the request body| `false` |
543+
| `stan.image` | Container image used for NATS streaming server | See [values.yaml](./values.yaml) |
536544

537545
### Dashboard (OpenFaaS Pro)
538546

0 commit comments

Comments
 (0)