From 446270c153fde481dbeae943f7cf2e1489950c01 Mon Sep 17 00:00:00 2001 From: lebaudantoine Date: Sun, 1 Dec 2024 22:33:34 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=A9=B9(summary)=20fix=20Helm=20Readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Oopsie, I forgot to update the Helm readme. Fixed it. --- src/helm/meet/README.md | 141 +++++++++++++++++++++++--------------- src/helm/meet/values.yaml | 28 +++++++- 2 files changed, 114 insertions(+), 55 deletions(-) diff --git a/src/helm/meet/README.md b/src/helm/meet/README.md index 9a6c8b63..37a9983d 100644 --- a/src/helm/meet/README.md +++ b/src/helm/meet/README.md @@ -5,9 +5,9 @@ ### General configuration | Name | Description | Value | -| ------------------------------------------ | ---------------------------------------------------- |------------------------| -| `image.repository` | Repository to use to pull impress's container image | `lasuite/meet-backend` | -| `image.tag` | impress's container tag | `latest` | +| ------------------------------------------ | ---------------------------------------------------- | ---------------------- | +| `image.repository` | Repository to use to pull meet's container image | `lasuite/meet-backend` | +| `image.tag` | meet's container tag | `latest` | | `image.pullPolicy` | Container image pull policy | `IfNotPresent` | | `image.credentials.username` | Username for container registry authentication | | | `image.credentials.password` | Password for container registry authentication | | @@ -17,7 +17,7 @@ | `fullnameOverride` | Override the full application name | `""` | | `ingress.enabled` | whether to enable the Ingress or not | `false` | | `ingress.className` | IngressClass to use for the Ingress | `nil` | -| `ingress.host` | Host for the Ingress | `impress.example.com` | +| `ingress.host` | Host for the Ingress | `meet.example.com` | | `ingress.path` | Path to use for the Ingress | `/` | | `ingress.hosts` | Additional host to configure for the Ingress | `[]` | | `ingress.tls.enabled` | Weather to enable TLS for the Ingress | `true` | @@ -26,7 +26,7 @@ | `ingress.customBackends` | Add custom backends to ingress | `[]` | | `ingressAdmin.enabled` | whether to enable the Ingress or not | `false` | | `ingressAdmin.className` | IngressClass to use for the Ingress | `nil` | -| `ingressAdmin.host` | Host for the Ingress | `impress.example.com` | +| `ingressAdmin.host` | Host for the Ingress | `meet.example.com` | | `ingressAdmin.path` | Path to use for the Ingress | `/admin` | | `ingressAdmin.hosts` | Additional host to configure for the Ingress | `[]` | | `ingressAdmin.tls.enabled` | Weather to enable TLS for the Ingress | `true` | @@ -42,6 +42,7 @@ | `backend.replicas` | Amount of backend replicas | `3` | | `backend.shareProcessNamespace` | Enable share process namespace between containers | `false` | | `backend.sidecars` | Add sidecars containers to backend deployment | `[]` | +| `backend.migrateJobAnnotations` | Annotations for the migrate job | `{}` | | `backend.securityContext` | Configure backend Pod security context | `nil` | | `backend.envVars` | Configure backend container environment variables | `undefined` | | `backend.envVars.BY_VALUE` | Example environment variable by setting value directly | | @@ -58,16 +59,16 @@ | `backend.migrate.restartPolicy` | backend migrate job restart policy | `Never` | | `backend.probes.liveness.path` | Configure path for backend HTTP liveness probe | `/__heartbeat__` | | `backend.probes.liveness.targetPort` | Configure port for backend HTTP liveness probe | `undefined` | -| `backend.probes.liveness.initialDelaySeconds` | Configure initial delay for backend liveness probe | `10` | -| `backend.probes.liveness.initialDelaySeconds` | Configure timeout for backend liveness probe | `10` | +| `backend.probes.liveness.initialDelaySeconds` | Configure initial delay for backend liveness probe | `30` | +| `backend.probes.liveness.initialDelaySeconds` | Configure timeout for backend liveness probe | `30` | | `backend.probes.startup.path` | Configure path for backend HTTP startup probe | `undefined` | | `backend.probes.startup.targetPort` | Configure port for backend HTTP startup probe | `undefined` | | `backend.probes.startup.initialDelaySeconds` | Configure initial delay for backend startup probe | `undefined` | | `backend.probes.startup.initialDelaySeconds` | Configure timeout for backend startup probe | `undefined` | | `backend.probes.readiness.path` | Configure path for backend HTTP readiness probe | `/__lbheartbeat__` | | `backend.probes.readiness.targetPort` | Configure port for backend HTTP readiness probe | `undefined` | -| `backend.probes.readiness.initialDelaySeconds` | Configure initial delay for backend readiness probe | `10` | -| `backend.probes.readiness.initialDelaySeconds` | Configure timeout for backend readiness probe | `10` | +| `backend.probes.readiness.initialDelaySeconds` | Configure initial delay for backend readiness probe | `30` | +| `backend.probes.readiness.initialDelaySeconds` | Configure timeout for backend readiness probe | `30` | | `backend.resources` | Resource requirements for the backend container | `{}` | | `backend.nodeSelector` | Node selector for the backend Pod | `{}` | | `backend.tolerations` | Tolerations for the backend Pod | `[]` | @@ -81,48 +82,80 @@ ### frontend -| Name | Description | Value | -| ------------------------------------------------------ | ----------------------------------------------------------------------------------- | ------------------------- | -| `frontend.image.repository` | Repository to use to pull impress's frontend container image | `lasuite/meet-frontend` | -| `frontend.image.tag` | impress's frontend container tag | `latest` | -| `frontend.image.pullPolicy` | frontend container image pull policy | `IfNotPresent` | -| `frontend.command` | Override the frontend container command | `[]` | -| `frontend.args` | Override the frontend container args | `[]` | -| `frontend.replicas` | Amount of frontend replicas | `3` | -| `frontend.shareProcessNamespace` | Enable share process namefrontend between containers | `false` | -| `frontend.sidecars` | Add sidecars containers to frontend deployment | `[]` | -| `frontend.securityContext` | Configure frontend Pod security context | `nil` | -| `frontend.envVars` | Configure frontend container environment variables | `undefined` | -| `frontend.envVars.BY_VALUE` | Example environment variable by setting value directly | | -| `frontend.envVars.FROM_CONFIGMAP.configMapKeyRef.name` | Name of a ConfigMap when configuring env vars from a ConfigMap | | -| `frontend.envVars.FROM_CONFIGMAP.configMapKeyRef.key` | Key within a ConfigMap when configuring env vars from a ConfigMap | | -| `frontend.envVars.FROM_SECRET.secretKeyRef.name` | Name of a Secret when configuring env vars from a Secret | | -| `frontend.envVars.FROM_SECRET.secretKeyRef.key` | Key within a Secret when configuring env vars from a Secret | | -| `frontend.podAnnotations` | Annotations to add to the frontend Pod | `{}` | -| `frontend.service.type` | frontend Service type | `ClusterIP` | -| `frontend.service.port` | frontend Service listening port | `80` | -| `frontend.service.targetPort` | frontend container listening port | `8080` | -| `frontend.service.annotations` | Annotations to add to the frontend Service | `{}` | -| `frontend.probes` | Configure probe for frontend | `{}` | -| `frontend.probes.liveness.path` | Configure path for frontend HTTP liveness probe | | -| `frontend.probes.liveness.targetPort` | Configure port for frontend HTTP liveness probe | | -| `frontend.probes.liveness.initialDelaySeconds` | Configure initial delay for frontend liveness probe | | -| `frontend.probes.liveness.initialDelaySeconds` | Configure timeout for frontend liveness probe | | -| `frontend.probes.startup.path` | Configure path for frontend HTTP startup probe | | -| `frontend.probes.startup.targetPort` | Configure port for frontend HTTP startup probe | | -| `frontend.probes.startup.initialDelaySeconds` | Configure initial delay for frontend startup probe | | -| `frontend.probes.startup.initialDelaySeconds` | Configure timeout for frontend startup probe | | -| `frontend.probes.readiness.path` | Configure path for frontend HTTP readiness probe | | -| `frontend.probes.readiness.targetPort` | Configure port for frontend HTTP readiness probe | | -| `frontend.probes.readiness.initialDelaySeconds` | Configure initial delay for frontend readiness probe | | -| `frontend.probes.readiness.initialDelaySeconds` | Configure timeout for frontend readiness probe | | -| `frontend.resources` | Resource requirements for the frontend container | `{}` | -| `frontend.nodeSelector` | Node selector for the frontend Pod | `{}` | -| `frontend.tolerations` | Tolerations for the frontend Pod | `[]` | -| `frontend.affinity` | Affinity for the frontend Pod | `{}` | -| `frontend.persistence` | Additional volumes to create and mount on the frontend. Used for debugging purposes | `{}` | -| `frontend.persistence.volume-name.size` | Size of the additional volume | | -| `frontend.persistence.volume-name.type` | Type of the additional volume, persistentVolumeClaim or emptyDir | | -| `frontend.persistence.volume-name.mountPath` | Path where the volume should be mounted to | | -| `frontend.extraVolumeMounts` | Additional volumes to mount on the frontend. | `[]` | -| `frontend.extraVolumes` | Additional volumes to mount on the frontend. | `[]` | +| Name | Description | Value | +| ------------------------------------------------------ | ----------------------------------------------------------------------------------- | ----------------------- | +| `frontend.image.repository` | Repository to use to pull meet's frontend container image | `lasuite/meet-frontend` | +| `frontend.image.tag` | meet's frontend container tag | `latest` | +| `frontend.image.pullPolicy` | frontend container image pull policy | `IfNotPresent` | +| `frontend.command` | Override the frontend container command | `[]` | +| `frontend.args` | Override the frontend container args | `[]` | +| `frontend.replicas` | Amount of frontend replicas | `3` | +| `frontend.shareProcessNamespace` | Enable share process namefrontend between containers | `false` | +| `frontend.sidecars` | Add sidecars containers to frontend deployment | `[]` | +| `frontend.securityContext` | Configure frontend Pod security context | `nil` | +| `frontend.envVars` | Configure frontend container environment variables | `undefined` | +| `frontend.envVars.BY_VALUE` | Example environment variable by setting value directly | | +| `frontend.envVars.FROM_CONFIGMAP.configMapKeyRef.name` | Name of a ConfigMap when configuring env vars from a ConfigMap | | +| `frontend.envVars.FROM_CONFIGMAP.configMapKeyRef.key` | Key within a ConfigMap when configuring env vars from a ConfigMap | | +| `frontend.envVars.FROM_SECRET.secretKeyRef.name` | Name of a Secret when configuring env vars from a Secret | | +| `frontend.envVars.FROM_SECRET.secretKeyRef.key` | Key within a Secret when configuring env vars from a Secret | | +| `frontend.podAnnotations` | Annotations to add to the frontend Pod | `{}` | +| `frontend.service.type` | frontend Service type | `ClusterIP` | +| `frontend.service.port` | frontend Service listening port | `80` | +| `frontend.service.targetPort` | frontend container listening port | `8080` | +| `frontend.service.annotations` | Annotations to add to the frontend Service | `{}` | +| `frontend.probes` | Configure probe for frontend | `{}` | +| `frontend.probes.liveness.path` | Configure path for frontend HTTP liveness probe | | +| `frontend.probes.liveness.targetPort` | Configure port for frontend HTTP liveness probe | | +| `frontend.probes.liveness.initialDelaySeconds` | Configure initial delay for frontend liveness probe | | +| `frontend.probes.liveness.initialDelaySeconds` | Configure timeout for frontend liveness probe | | +| `frontend.probes.startup.path` | Configure path for frontend HTTP startup probe | | +| `frontend.probes.startup.targetPort` | Configure port for frontend HTTP startup probe | | +| `frontend.probes.startup.initialDelaySeconds` | Configure initial delay for frontend startup probe | | +| `frontend.probes.startup.initialDelaySeconds` | Configure timeout for frontend startup probe | | +| `frontend.probes.readiness.path` | Configure path for frontend HTTP readiness probe | | +| `frontend.probes.readiness.targetPort` | Configure port for frontend HTTP readiness probe | | +| `frontend.probes.readiness.initialDelaySeconds` | Configure initial delay for frontend readiness probe | | +| `frontend.probes.readiness.initialDelaySeconds` | Configure timeout for frontend readiness probe | | +| `frontend.resources` | Resource requirements for the frontend container | `{}` | +| `frontend.nodeSelector` | Node selector for the frontend Pod | `{}` | +| `frontend.tolerations` | Tolerations for the frontend Pod | `[]` | +| `frontend.affinity` | Affinity for the frontend Pod | `{}` | +| `frontend.persistence` | Additional volumes to create and mount on the frontend. Used for debugging purposes | `{}` | +| `frontend.persistence.volume-name.size` | Size of the additional volume | | +| `frontend.persistence.volume-name.type` | Type of the additional volume, persistentVolumeClaim or emptyDir | | +| `frontend.persistence.volume-name.mountPath` | Path where the volume should be mounted to | | +| `frontend.extraVolumeMounts` | Additional volumes to mount on the frontend. | `[]` | +| `frontend.extraVolumes` | Additional volumes to mount on the frontend. | `[]` | + +### posthog + +| Name | Description | Value | +| -------------------------------------- | ----------------------------------------------------------- | ------------------------- | +| `posthog.ingress.enabled` | Enable or disable the ingress resource creation | `false` | +| `posthog.ingress.className` | Kubernetes ingress class name to use (e.g., nginx, traefik) | `nil` | +| `posthog.ingress.host` | Primary hostname for the ingress resource | `meet.example.com` | +| `posthog.ingress.path` | URL path prefix for the ingress routes (e.g., /) | `/` | +| `posthog.ingress.hosts` | Additional hostnames array to be included in the ingress | `[]` | +| `posthog.ingress.tls.enabled` | Enable or disable TLS/HTTPS for the ingress | `true` | +| `posthog.ingress.tls.additional` | Additional TLS configurations for extra hosts/certificates | `[]` | +| `posthog.ingress.customBackends` | Custom backend service configurations for the ingress | `[]` | +| `posthog.ingress.annotations` | Additional Kubernetes annotations to apply to the ingress | `{}` | +| `posthog.ingressAssets.enabled` | Enable or disable the ingress resource creation | `false` | +| `posthog.ingressAssets.className` | Kubernetes ingress class name to use (e.g., nginx, traefik) | `nil` | +| `posthog.ingressAssets.host` | Primary hostname for the ingress resource | `meet.example.com` | +| `posthog.ingressAssets.path` | URL path prefix for the ingress routes (e.g., /) | `/static` | +| `posthog.ingressAssets.hosts` | Additional hostnames array to be included in the ingress | `[]` | +| `posthog.ingressAssets.tls.enabled` | Enable or disable TLS/HTTPS for the ingress | `true` | +| `posthog.ingressAssets.tls.additional` | Additional TLS configurations for extra hosts/certificates | `[]` | +| `posthog.ingressAssets.customBackends` | Custom backend service configurations for the ingress | `[]` | +| `posthog.ingressAssets.annotations` | Additional Kubernetes annotations to apply to the ingress | `{}` | +| `posthog.service.type` | Service type (e.g. ExternalName, ClusterIP, LoadBalancer) | `ExternalName` | +| `posthog.service.externalName` | External service hostname when type is ExternalName | `eu.i.posthog.com` | +| `posthog.service.port` | Port number for the service | `443` | +| `posthog.service.annotations` | Additional annotations to apply to the service | `{}` | +| `posthog.assetsService.type` | Service type (e.g. ExternalName, ClusterIP, LoadBalancer) | `ExternalName` | +| `posthog.assetsService.externalName` | External service hostname when type is ExternalName | `eu-assets.i.posthog.com` | +| `posthog.assetsService.port` | Port number for the service | `443` | +| `posthog.assetsService.annotations` | Additional annotations to apply to the service | `{}` | + diff --git a/src/helm/meet/values.yaml b/src/helm/meet/values.yaml index ff4ffda0..96f8da6b 100644 --- a/src/helm/meet/values.yaml +++ b/src/helm/meet/values.yaml @@ -264,10 +264,19 @@ frontend: ## @param frontend.extraVolumes Additional volumes to mount on the frontend. extraVolumes: [] -## @section Posthog +## @section posthog posthog: + ## @param posthog.ingress.enabled Enable or disable the ingress resource creation + ## @param posthog.ingress.className Kubernetes ingress class name to use (e.g., nginx, traefik) + ## @param posthog.ingress.host Primary hostname for the ingress resource + ## @param posthog.ingress.path URL path prefix for the ingress routes (e.g., /) + ## @param posthog.ingress.hosts Additional hostnames array to be included in the ingress + ## @param posthog.ingress.tls.enabled Enable or disable TLS/HTTPS for the ingress + ## @param posthog.ingress.tls.additional Additional TLS configurations for extra hosts/certificates + ## @param posthog.ingress.customBackends Custom backend service configurations for the ingress + ## @param posthog.ingress.annotations Additional Kubernetes annotations to apply to the ingress ingress: enabled: false className: null @@ -281,6 +290,15 @@ posthog: customBackends: [ ] annotations: {} + ## @param posthog.ingressAssets.enabled Enable or disable the ingress resource creation + ## @param posthog.ingressAssets.className Kubernetes ingress class name to use (e.g., nginx, traefik) + ## @param posthog.ingressAssets.host Primary hostname for the ingress resource + ## @param posthog.ingressAssets.path URL path prefix for the ingress routes (e.g., /) + ## @param posthog.ingressAssets.hosts Additional hostnames array to be included in the ingress + ## @param posthog.ingressAssets.tls.enabled Enable or disable TLS/HTTPS for the ingress + ## @param posthog.ingressAssets.tls.additional Additional TLS configurations for extra hosts/certificates + ## @param posthog.ingressAssets.customBackends Custom backend service configurations for the ingress + ## @param posthog.ingressAssets.annotations Additional Kubernetes annotations to apply to the ingress ingressAssets: enabled: false className: null @@ -294,12 +312,20 @@ posthog: customBackends: [ ] annotations: {} + ## @param posthog.service.type Service type (e.g. ExternalName, ClusterIP, LoadBalancer) + ## @param posthog.service.externalName External service hostname when type is ExternalName + ## @param posthog.service.port Port number for the service + ## @param posthog.service.annotations Additional annotations to apply to the service service: type: ExternalName externalName: eu.i.posthog.com port: 443 annotations: {} + ## @param posthog.assetsService.type Service type (e.g. ExternalName, ClusterIP, LoadBalancer) + ## @param posthog.assetsService.externalName External service hostname when type is ExternalName + ## @param posthog.assetsService.port Port number for the service + ## @param posthog.assetsService.annotations Additional annotations to apply to the service assetsService: type: ExternalName externalName: eu-assets.i.posthog.com