Skip to content

Commit d9b2b24

Browse files
committed
Update README with offline options in openfaas chart
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent c636494 commit d9b2b24

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

chart/openfaas/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -474,9 +474,7 @@ See [values.yaml](./values.yaml) for detailed configuration.
474474
| ----------------------- | ---------------------------------- | ---------------------------------------------------------- |
475475
| `affinity`| Global [affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) rules assigned to deployments | `{}` |
476476
| `async` | Enables asynchronous function invocations. If `.nats.external.enabled` is `false`, also deploys NATS | `true` |
477-
| `queueMode` | Set to `jetstream` to run the async system backed by NATS JetStream. By default the async system uses NATS Streaming|
478477
| `basic_auth` | Enable basic authentication on the gateway and Prometheus. Warning: do not disable. | `true` |
479-
| `generateBasicAuth` | Generate admin password for basic authentication | `true` |
480478
| `basicAuthPlugin.image` | Container image used for basic-auth-plugin | See [values.yaml](./values.yaml) |
481479
| `basicAuthPlugin.replicas` | Replicas of the basic-auth-plugin | `1` |
482480
| `basicAuthPlugin.resources` | Resource limits and requests for basic-auth-plugin containers | See [values.yaml](./values.yaml) |
@@ -485,17 +483,21 @@ See [values.yaml](./values.yaml) for detailed configuration.
485483
| `exposeServices` | Expose `NodePorts/LoadBalancer` | `true` |
486484
| `functionNamespace` | Functions namespace, preferred `openfaas-fn` | `openfaas-fn` |
487485
| `gatewayExternal.annotations` | Annotation for getaway-external service | `{}` |
486+
| `generateBasicAuth` | Generate admin password for basic authentication | `true` |
488487
| `httpProbe` | Setting to true will use HTTP for readiness and liveness probe on the OpenFaaS system Pods (compatible with Istio >= 1.1.5) | `true` |
488+
| `imagePullSecrets` | Image pull secrets to be attached to all Deployments within chart, given as an array such as `- name: SECRET_NAME` | `[]` |
489489
| `ingress.enabled` | Create ingress resources | `false` |
490490
| `istio.mtls` | Create Istio policies and destination rules to enforce mTLS for OpenFaaS components and functions | `false` |
491-
| `kubernetesDNSDomain` | Domain name of the Kubernetes cluster | `cluster.local` |
492491
| `k8sVersionOverride` | Override kubeVersion for the ingress creation, this should be left blank. | `""` |
492+
| `kubernetesDNSDomain` | Domain name of the Kubernetes cluster | `cluster.local` |
493493
| `nodeSelector` | Global [NodeSelector](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) | `{}` |
494+
| `oem` | Deploy OpenFaaS oem | `false` |
494495
| `openfaasImagePullPolicy` | Image pull policy for openfaas components, can change to `IfNotPresent` in offline env | `Always` |
495496
| `openfaasPro` | Deploy OpenFaaS Pro | `false` |
496-
| `oem` | Deploy OpenFaaS oem | `false` |
497497
| `psp` | Enable [Pod Security Policy](https://kubernetes.io/docs/concepts/policy/pod-security-policy/) for OpenFaaS accounts | `false` |
498+
| `queueMode` | Set to `jetstream` to run the async system backed by NATS JetStream. By default the async system uses NATS Streaming|
498499
| `rbac` | Enable RBAC | `true` |
500+
| `registryPrefix` | Adds a prefix or replaces the server prefix for all images in chart i.e. `nats:2.11.6` becomes `registryPrefix/nats:2.11.6` | `""` |
499501
| `securityContext` | Give a `securityContext` template to be applied to each of the various containers in this chart, set to `{}` to disable, if required for Istio side-car injection. | See values.yaml |
500502
| `serviceType` | Type of external service to use `NodePort/LoadBalancer` | `NodePort` |
501503
| `tolerations` | Global [Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) | `[]` |

0 commit comments

Comments
 (0)