Skip to content

Commit 73ea0b7

Browse files
committed
Update uplink Helm configuration reference
Add new and missing helm parameters.
1 parent 787548b commit 73ea0b7

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

Diff for: docs/uplink/installation.md

+29-7
Original file line numberDiff line numberDiff line change
@@ -301,25 +301,47 @@ Overview of inlets-uplink parameters in `values.yaml`.
301301
| Parameter | Description | Default |
302302
| ------------------------ | -------------------------------------------------------------------------------------- | ------------------------------ |
303303
| `pullPolicy` | The a imagePullPolicy applied to inlets-uplink components. | `Always` |
304-
| `operator.image` | Container image used for the uplink operator. | `ghcr.io/openfaasltd/uplink-operator:0.1.5` |
304+
| `tunnelsNamespace` | Deployments, Services and Secrets will be created in this namespace. Leave blank for a cluster-wide scope, with tunnels in multiple namespaces. | `""` |
305+
| `inletsVersion` | Inlets Pro release version for tunnel server Pods. | `0.9.39` |
305306
| `ingress.issuer.name` | Name of cert-manager Issuer. | `letsencrypt-prod` |
306307
| `ingress.issuer.enabled` | Create a cert-manager Issuer. Set to false if you wish to specify your own pre-existing object for each component. | `true` |
307308
| `ingress.issuer.email` | Let's Encrypt email. Only used for certificate renewing notifications. | `""` |
308309
| `ingress.class` | Ingress class for client router ingress. | `nginx` |
309-
| `clientRouter.image` | Container image used for the client router. | `ghcr.io/openfaasltd/uplink-client-router:0.1.5` |
310+
| `operator.image` | Container image used for the uplink operator. | `ghcr.io/openfaasltd/uplink-operator:0.4.32` |
311+
| `operator.tunnelIngress.enabled` | Enable automatic generation of tunnel Ingress resources. | `false` |
312+
| `operator.tunnelIngress.class` | Ingress class name to use for tunnel ingress resources. | `nginx` |
313+
| `operator.tunnelIngress.annotations` | Additional annotations to be added to tunnel ingress resources. | `{}` |
314+
| `operator.tunnelIngress.issuer.name`| Name of cert-manager Issuer used for tunnel ingress. | `letsencrypt-prod-tunnels` |
315+
| `operator.tunnelIngress.issuer.type` | Issuer type used, ClusterIssuer or Issuer. | `ClusterIssuer` |
316+
| `clientRouter.image` | Container image used for the client router. | `ghcr.io/openfaasltd/uplink-client-router:0.4.32` |
310317
| `clientRouter.domain` | Domain name for inlets uplink. Customer tunnels will connect with a URI of: wss://uplink.example.com/namespace/tunnel. | `""` |
311-
| `clientRouter.tls.ingress.enabled` | Enable ingress for the client router. | `enabled` |
318+
| `clientRouter.tls.issuerName` | Name of cert-manager Issuer to be used for the client router. (Use to override global value set by `ingress.issuer.name`) | `""` |
319+
| `clientRouter.tls.ingress.enabled` | Enable ingress for the client router. | `false` |
312320
| `clientRouter.tls.ingress.annotations` | Annotations to be added to the client router ingress resource. | `{}` |
313321
| `clientRouter.tls.istio.enabled` | Use an Istio Gateway for incoming traffic to the client router. | `false` |
314322
| `clientRouter.service.type` | Client router service type | `ClusterIP` |
315323
| `clientRouter.service.nodePort` | Client router service port for NodePort service type, assigned automatically when left empty. (only if clientRouter.service.type is set to "NodePort")| `nil` |
316-
| `tunnelsNamespace` | Deployments, Services and Secrets will be created in this namespace. Leave blank for a cluster-wide scope, with tunnels in multiple namespaces. | `""` |
317-
| `inletsVersion` | Inlets Pro release version for tunnel server Pods. | `0.9.12` |
324+
| `dataRouter.enabled` | Enable data router. | `false` |
325+
| `dataRouter.image` | Container image used for the data router. | `ghcr.io/openfaasltd/uplink-data-router:0.4.32` |
326+
| `dataRouter.wildcardDomain` | Wildcard domain to use for tunnel ingress though the data router. (Leave out the asterix i.e. *.t.example.com would be: t.example.com) | `""` |
327+
| `dataRouter.tls.issuerName` | Name of cert-manager Issuer to be used for the data router. (Use to override global value set by `ingress.issuer.name`) | `""` |
328+
| `dataRouter.tls.ingress.enabled` | Enable ingress for the data router. | `false` |
329+
| `dataRouter.tls.ingress.annotations` | Annotations to be added to the data router ingress resource. | `{}` |
330+
| `dataRouter.service.type` | Data router service type | `ClusterIP` |
331+
| `dataRouter.service.nodePort` | Data router service port for NodePort service type, assigned automatically when left empty. (only if dataRouter.service.type is set to "NodePort")| `nil` |
318332
| `clientApi.enabled` | Enable tunnel management REST API. | `false` |
319-
| `clientApi.image` | Container image used for the client API. | `ghcr.io/openfaasltd/uplink-api:0.1.5` |
333+
| `clientApi.image` | Container image used for the client API. | `ghcr.io/openfaasltd/uplink-api:0.4.32` |
334+
| `clientApi.domain` | Domain name for client api is exposed on. | `""` |
335+
| `clientApi.issuerURl` | Set the issuer URL when using OAuth/OIDC tokens to authenticate the API. | `""` |
336+
| `clientApi.audience` | OAuth audience when using OAuth/OIDC tokens to authenticate the API. | `""` |
337+
| `clientApi.tls.issuerName` | Name of cert-manager Issuer to be used for the client api. (Use to override global value set by `ingress.issuer.name`) | `""` |
338+
| `clientApi.tls.ingress.enabled` | Enable ingress for the client api. | `false` |
339+
| `clientApi.tls.ingress.annotations` | Annotations to be added to the client api ingress resource. | `{}` |
340+
| `clientApi.service.type` | Client api router service type | `ClusterIP` |
341+
| `clientApi.service.nodePort` | Data router service port for NodePort service type, assigned automatically when left empty. (only if clientApi.service.type is set to "NodePort")| `nil` |
320342
| `prometheus.create` | Create the Prometheus monitoring component. | `true` |
321343
| `prometheus.resources` | Resource limits and requests for prometheus containers. | `{}` |
322-
| `prometheus.image` | Container image used for prometheus. | `prom/prometheus:v2.40.1` |
344+
| `prometheus.image` | Container image used for prometheus. | `prom/prometheus:v3.0.1` |
323345
| `prometheus.service.type` | Prometheus service type | `ClusterIP` |
324346
| `prometheus.service.nodePort` | Prometheus service port for NodePort service type, assigned automatically when left empty. (only if prometheus.service.type is set to "NodePort")| `nil` |
325347
| `nodeSelector` | Node labels for pod assignment. | `{}` |

0 commit comments

Comments
 (0)