fix(element-call): add global (and improve docs)

element-call/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: element-call
 description: Run Element-Call and his dependencies
 type: application
-version: "0.1.7"
+version: "0.1.8"
 # renovate: image=ghcr.io/element-hq/element-call
 appVersion: "0.7.1"
 maintainers:

element-call/README.md

@@ -7,7 +7,7 @@ description: "Run Element-Call and his dependencies"
 
 # element-call
 
-![Version: 0.1.7](https://img.shields.io/badge/Version-0.1.7-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.7.1](https://img.shields.io/badge/AppVersion-0.7.1-informational?style=flat-square)
+![Version: 0.1.8](https://img.shields.io/badge/Version-0.1.8-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.7.1](https://img.shields.io/badge/AppVersion-0.7.1-informational?style=flat-square)
 
 Run Element-Call and his dependencies
 
@@ -41,6 +41,29 @@ helm uninstall element-call-release
 
 ## Values
 
+### livekit JWT
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| service.lkJWT.config.key | string | `"devkey"` | key to livekit |
+| service.lkJWT.config.secret | string | `"secret"` | secret to livekit |
+| service.lkJWT.config.url | string | `""` | url to livekit |
+| service.lkJWT.enabled | bool | `true` | enable to deploy livekit jwt service for element-call |
+| service.lkJWT.image.pullPolicy | string | `"IfNotPresent"` | This sets the pull policy for images. (could be overwritten by global.image.pullPolicy) |
+| service.lkJWT.image.registry | string | `"ghcr.io"` | image registry (could be overwritten by global.image.registry) |
+| service.lkJWT.image.repository | string | `"element-hq/lk-jwt-service"` | image repository |
+| service.lkJWT.image.tag | string | `"sha-4a29504"` | image tag |
+| service.lkJWT.networkPolicy.egress.enabled | bool | `false` | activate egress no networkpolicy |
+| service.lkJWT.networkPolicy.egress.extra | list | `[]` | egress rules |
+| service.lkJWT.networkPolicy.ingress.http | list | `[]` | ingress for http port (e.g. ingress-controller) |
+| service.lkJWT.replicaCount | int | `1` | replicas |
+| service.lkJWT.serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
+| service.lkJWT.serviceAccount.automount | bool | `true` | Automatically mount a ServiceAccount's API credentials? |
+| service.lkJWT.serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| service.lkJWT.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+
+### Other Values
+
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | autoscaling.enabled | bool | `false` |  |
@@ -58,10 +81,10 @@ helm uninstall element-call-release
 | nameOverride | string | `""` |  |
 | service.call.affinity | object | `{}` |  |
 | service.call.config | object | `{}` |  |
-| service.call.image.pullPolicy | string | `"IfNotPresent"` |  |
+| service.call.image.pullPolicy | string | `"IfNotPresent"` | This sets the pull policy for images. (could be overwritten by global.image.pullPolicy) |
-| service.call.image.registry | string | `"ghcr.io"` |  |
+| service.call.image.registry | string | `"ghcr.io"` | image registry (could be overwritten by global.image.registry) |
-| service.call.image.repository | string | `"element-hq/element-call"` |  |
+| service.call.image.repository | string | `"element-hq/element-call"` | image repository |
-| service.call.image.tag | string | `nil` | Overrides the image tag whose default is the chart appVersion. |
+| service.call.image.tag | string | `nil` | image tag - Overrides the image tag whose default is the chart appVersion |
 | service.call.ingress.host | string | `nil` |  |
 | service.call.livenessProbe.httpGet.path | string | `"/"` |  |
 | service.call.livenessProbe.httpGet.port | string | `"http"` |  |
@@ -75,7 +98,7 @@ helm uninstall element-call-release
 | service.call.podSecurityContext | object | `{}` |  |
 | service.call.readinessProbe.httpGet.path | string | `"/"` |  |
 | service.call.readinessProbe.httpGet.port | string | `"http"` |  |
-| service.call.replicaCount | int | `1` |  |
+| service.call.replicaCount | int | `1` | replicas |
 | service.call.resources | object | `{}` |  |
 | service.call.securityContext | object | `{}` |  |
 | service.call.serviceAccount.annotations | object | `{}` |  |
@@ -84,34 +107,18 @@ helm uninstall element-call-release
 | service.call.serviceAccount.name | string | `""` |  |
 | service.call.tolerations | list | `[]` |  |
 | service.lkJWT.affinity | object | `{}` |  |
-| service.lkJWT.config.key | string | `"devkey"` |  |
-| service.lkJWT.config.secret | string | `"secret"` |  |
-| service.lkJWT.config.url | string | `""` |  |
-| service.lkJWT.enabled | bool | `true` |  |
-| service.lkJWT.image.pullPolicy | string | `"IfNotPresent"` |  |
-| service.lkJWT.image.registry | string | `"ghcr.io"` |  |
-| service.lkJWT.image.repository | string | `"element-hq/lk-jwt-service"` |  |
-| service.lkJWT.image.tag | string | `"sha-4a29504"` |  |
 | service.lkJWT.ingress.host | string | `nil` |  |
 | service.lkJWT.livenessProbe.httpGet.path | string | `"/healthz"` |  |
 | service.lkJWT.livenessProbe.httpGet.port | string | `"http"` |  |
-| service.lkJWT.networkPolicy.egress.enabled | bool | `false` | activate egress no networkpolicy |
-| service.lkJWT.networkPolicy.egress.extra | list | `[]` | egress rules |
 | service.lkJWT.networkPolicy.enabled | bool | `false` |  |
-| service.lkJWT.networkPolicy.ingress.http | list | `[]` | ingress for http port (e.g. ingress-controller) |
 | service.lkJWT.nodeSelector | object | `{}` |  |
 | service.lkJWT.podAnnotations | object | `{}` |  |
 | service.lkJWT.podLabels | object | `{}` |  |
 | service.lkJWT.podSecurityContext | object | `{}` |  |
 | service.lkJWT.readinessProbe.httpGet.path | string | `"/healthz"` |  |
 | service.lkJWT.readinessProbe.httpGet.port | string | `"http"` |  |
-| service.lkJWT.replicaCount | int | `1` |  |
 | service.lkJWT.resources | object | `{}` |  |
 | service.lkJWT.securityContext | object | `{}` |  |
-| service.lkJWT.serviceAccount.annotations | object | `{}` |  |
-| service.lkJWT.serviceAccount.automount | bool | `true` |  |
-| service.lkJWT.serviceAccount.create | bool | `true` |  |
-| service.lkJWT.serviceAccount.name | string | `""` |  |
 | service.lkJWT.tolerations | list | `[]` |  |
 
 Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

element-call/values.yaml

@@ -27,12 +27,16 @@ autoscaling:
 
 service:
   call:
+    # -- replicas
     replicaCount: 1
     image:
+      # -- image registry (could be overwritten by global.image.registry)
       registry: ghcr.io
+      # -- image repository
       repository: element-hq/element-call
+      # -- This sets the pull policy for images. (could be overwritten by global.image.pullPolicy)
       pullPolicy: IfNotPresent
-      # -- Overrides the image tag whose default is the chart appVersion.
+      # -- image tag - Overrides the image tag whose default is the chart appVersion
       tag:
     config: {}
     ingress:
@@ -85,16 +89,34 @@ service:
     affinity: {}
 
   lkJWT:
+    # -- enable to deploy livekit jwt service for element-call
+    # @section -- livekit JWT
     enabled: true
+    # -- replicas
+    # @section -- livekit JWT
     replicaCount: 1
     image:
+      # -- image registry (could be overwritten by global.image.registry)
+      # @section -- livekit JWT
       registry: ghcr.io
+      # -- image repository
+      # @section -- livekit JWT
       repository: element-hq/lk-jwt-service
+      # -- This sets the pull policy for images. (could be overwritten by global.image.pullPolicy)
+      # @section -- livekit JWT
       pullPolicy: IfNotPresent
+      # -- image tag
+      # @section -- livekit JWT
       tag: sha-4a29504
     config:
+      # -- url to livekit
+      # @section -- livekit JWT
       url: ""
+      # -- key to livekit
+      # @section -- livekit JWT
       key: "devkey"
+      # -- secret to livekit
+      # @section -- livekit JWT
       secret: "secret"
     ingress:
       host:
@@ -102,11 +124,14 @@ service:
       enabled: false
       ingress:
         # -- ingress for http port (e.g. ingress-controller)
+        # @section -- livekit JWT
         http: []
       egress:
         # -- activate egress no networkpolicy
+        # @section -- livekit JWT
         enabled: false
         # -- egress rules
+        # @section -- livekit JWT
         extra: []
     livenessProbe:
       httpGet:
@@ -118,14 +143,18 @@ service:
         port: http
     resources: {}
     serviceAccount:
-      # Specifies whether a service account should be created
+      # -- Specifies whether a service account should be created
+      # @section -- livekit JWT
       create: true
-      # Automatically mount a ServiceAccount's API credentials?
+      # -- Automatically mount a ServiceAccount's API credentials?
+      # @section -- livekit JWT
       automount: true
-      # Annotations to add to the service account
+      # -- Annotations to add to the service account
+      # @section -- livekit JWT
       annotations: {}
-      # The name of the service account to use.
+      # -- The name of the service account to use.
       # If not set and create is true, a name is generated using the fullname template
+      # @section -- livekit JWT
       name: ""
 
     podAnnotations: {}