# Impress helm chart ## Parameters ### General configuration | Name | Description | Value | | -------------------------------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------------------- | | `image.repository` | Repository to use to pull impress's container image | `lasuite/impress-backend` | | `image.tag` | impress'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 | | | `image.credentials.registry` | Registry url for which the credentials are specified | | | `image.credentials.name` | Name of the generated secret for imagePullSecrets | | | `nameOverride` | Override the chart name | `""` | | `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.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` | | `ingress.tls.secretName` | Secret name for TLS config | `nil` | | `ingress.tls.additional[].secretName` | Secret name for additional TLS config | | | `ingress.tls.additional[].hosts[]` | Hosts for additional TLS config | | | `ingress.customBackends` | Add custom backends to ingress | `[]` | | `ingressCollaborationWS.enabled` | whether to enable the Ingress or not | `false` | | `ingressCollaborationWS.className` | IngressClass to use for the Ingress | `nil` | | `ingressCollaborationWS.host` | Host for the Ingress | `impress.example.com` | | `ingressCollaborationWS.path` | Path to use for the Ingress | `/collaboration/ws/` | | `ingressCollaborationWS.hosts` | Additional host to configure for the Ingress | `[]` | | `ingressCollaborationWS.tls.enabled` | Weather to enable TLS for the Ingress | `true` | | `ingressCollaborationWS.tls.secretName` | Secret name for TLS config | `nil` | | `ingressCollaborationWS.tls.additional[].secretName` | Secret name for additional TLS config | | | `ingressCollaborationWS.tls.additional[].hosts[]` | Hosts for additional TLS config | | | `ingressCollaborationWS.customBackends` | Add custom backends to ingress | `[]` | | `ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/auth-response-headers` | | `Authorization, X-Can-Edit, X-User-Id` | | `ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/auth-url` | | `https://impress.example.com/api/v1.0/documents/collaboration-auth/` | | `ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/enable-websocket` | | `true` | | `ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/proxy-read-timeout` | | `86400` | | `ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/proxy-send-timeout` | | `86400` | | `ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/upstream-hash-by` | | `$arg_room` | | `ingressCollaborationApi.enabled` | whether to enable the Ingress or not | `false` | | `ingressCollaborationApi.className` | IngressClass to use for the Ingress | `nil` | | `ingressCollaborationApi.host` | Host for the Ingress | `impress.example.com` | | `ingressCollaborationApi.path` | Path to use for the Ingress | `/collaboration/api/` | | `ingressCollaborationApi.hosts` | Additional host to configure for the Ingress | `[]` | | `ingressCollaborationApi.tls.enabled` | Weather to enable TLS for the Ingress | `true` | | `ingressCollaborationApi.tls.secretName` | Secret name for TLS config | `nil` | | `ingressCollaborationApi.tls.additional[].secretName` | Secret name for additional TLS config | | | `ingressCollaborationApi.tls.additional[].hosts[]` | Hosts for additional TLS config | | | `ingressCollaborationApi.customBackends` | Add custom backends to ingress | `[]` | | `ingressCollaborationApi.annotations.nginx.ingress.kubernetes.io/upstream-hash-by` | | `$arg_room` | | `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.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` | | `ingressAdmin.tls.secretName` | Secret name for TLS config | `nil` | | `ingressAdmin.tls.additional[].secretName` | Secret name for additional TLS config | | | `ingressAdmin.tls.additional[].hosts[]` | Hosts for additional TLS config | | | `ingressMedia.enabled` | whether to enable the Ingress or not | `false` | | `ingressMedia.className` | IngressClass to use for the Ingress | `nil` | | `ingressMedia.host` | Host for the Ingress | `impress.example.com` | | `ingressMedia.path` | Path to use for the Ingress | `/media/(.*)` | | `ingressMedia.hosts` | Additional host to configure for the Ingress | `[]` | | `ingressMedia.tls.enabled` | Weather to enable TLS for the Ingress | `true` | | `ingressMedia.tls.secretName` | Secret name for TLS config | `nil` | | `ingressMedia.tls.additional[].secretName` | Secret name for additional TLS config | | | `ingressMedia.tls.additional[].hosts[]` | Hosts for additional TLS config | | | `ingressMedia.annotations.nginx.ingress.kubernetes.io/auth-url` | | `https://impress.example.com/api/v1.0/documents/media-auth/` | | `ingressMedia.annotations.nginx.ingress.kubernetes.io/auth-response-headers` | | `Authorization, X-Amz-Date, X-Amz-Content-SHA256` | | `ingressMedia.annotations.nginx.ingress.kubernetes.io/upstream-vhost` | | `minio.impress.svc.cluster.local:9000` | | `serviceMedia.host` | | `minio.impress.svc.cluster.local` | | `serviceMedia.port` | | `9000` | | `serviceMedia.annotations` | | `{}` | ### backend | Name | Description | Value | | ----------------------------------------------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `backend.command` | Override the backend container command | `[]` | | `backend.args` | Override the backend container args | `[]` | | `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 | | | `backend.envVars.FROM_CONFIGMAP.configMapKeyRef.name` | Name of a ConfigMap when configuring env vars from a ConfigMap | | | `backend.envVars.FROM_CONFIGMAP.configMapKeyRef.key` | Key within a ConfigMap when configuring env vars from a ConfigMap | | | `backend.envVars.FROM_SECRET.secretKeyRef.name` | Name of a Secret when configuring env vars from a Secret | | | `backend.envVars.FROM_SECRET.secretKeyRef.key` | Key within a Secret when configuring env vars from a Secret | | | `backend.podAnnotations` | Annotations to add to the backend Pod | `{}` | | `backend.dpAnnotations` | Annotations to add to the backend Deployment | `{}` | | `backend.service.type` | backend Service type | `ClusterIP` | | `backend.service.port` | backend Service listening port | `80` | | `backend.service.targetPort` | backend container listening port | `8000` | | `backend.service.annotations` | Annotations to add to the backend Service | `{}` | | `backend.migrate.command` | backend migrate command | `["python","manage.py","migrate","--no-input"]` | | `backend.migrate.restartPolicy` | backend migrate job restart policy | `Never` | | `backend.createsuperuser.command` | backend migrate command | `["/bin/sh","-c","python manage.py createsuperuser --email $DJANGO_SUPERUSER_EMAIL --password $DJANGO_SUPERUSER_PASSWORD\n"]` | | `backend.createsuperuser.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.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.resources` | Resource requirements for the backend container | `{}` | | `backend.nodeSelector` | Node selector for the backend Pod | `{}` | | `backend.tolerations` | Tolerations for the backend Pod | `[]` | | `backend.affinity` | Affinity for the backend Pod | `{}` | | `backend.persistence` | Additional volumes to create and mount on the backend. Used for debugging purposes | `{}` | | `backend.persistence.volume-name.size` | Size of the additional volume | | | `backend.persistence.volume-name.type` | Type of the additional volume, persistentVolumeClaim or emptyDir | | | `backend.persistence.volume-name.mountPath` | Path where the volume should be mounted to | | | `backend.extraVolumeMounts` | Additional volumes to mount on the backend. | `[]` | | `backend.extraVolumes` | Additional volumes to mount on the backend. | `[]` | ### frontend | Name | Description | Value | | ------------------------------------------------------ | ----------------------------------------------------------------------------------- | -------------------------- | | `frontend.image.repository` | Repository to use to pull impress's frontend container image | `lasuite/impress-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.dpAnnotations` | Annotations to add to the frontend Deployment | `{}` | | `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 | `impress.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 | `impress.example.com` | | `posthog.ingressAssets.paths` | URL paths prefix for the ingress routes (e.g., /static) | `["/static","/array"]` | | `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 | `{}` | ### yProvider | Name | Description | Value | | ------------------------------------------------------- | ------------------------------------------------------------------------------------ | ---------------------------- | | `yProvider.image.repository` | Repository to use to pull impress's yProvider container image | `lasuite/impress-y-provider` | | `yProvider.image.tag` | impress's yProvider container tag | `latest` | | `yProvider.image.pullPolicy` | yProvider container image pull policy | `IfNotPresent` | | `yProvider.command` | Override the yProvider container command | `[]` | | `yProvider.args` | Override the yProvider container args | `[]` | | `yProvider.replicas` | Amount of yProvider replicas | `3` | | `yProvider.shareProcessNamespace` | Enable share process nameyProvider between containers | `false` | | `yProvider.sidecars` | Add sidecars containers to yProvider deployment | `[]` | | `yProvider.securityContext` | Configure yProvider Pod security context | `nil` | | `yProvider.envVars` | Configure yProvider container environment variables | `undefined` | | `yProvider.envVars.BY_VALUE` | Example environment variable by setting value directly | | | `yProvider.envVars.FROM_CONFIGMAP.configMapKeyRef.name` | Name of a ConfigMap when configuring env vars from a ConfigMap | | | `yProvider.envVars.FROM_CONFIGMAP.configMapKeyRef.key` | Key within a ConfigMap when configuring env vars from a ConfigMap | | | `yProvider.envVars.FROM_SECRET.secretKeyRef.name` | Name of a Secret when configuring env vars from a Secret | | | `yProvider.envVars.FROM_SECRET.secretKeyRef.key` | Key within a Secret when configuring env vars from a Secret | | | `yProvider.podAnnotations` | Annotations to add to the yProvider Pod | `{}` | | `yProvider.dpAnnotations` | Annotations to add to the yProvider Deployment | `{}` | | `yProvider.service.type` | yProvider Service type | `ClusterIP` | | `yProvider.service.port` | yProvider Service listening port | `443` | | `yProvider.service.targetPort` | yProvider container listening port | `4444` | | `yProvider.service.annotations` | Annotations to add to the yProvider Service | `{}` | | `yProvider.probes.liveness.path` | Configure path for yProvider HTTP liveness probe | | | `yProvider.probes.liveness.targetPort` | Configure port for yProvider HTTP liveness probe | | | `yProvider.probes.liveness.initialDelaySeconds` | Configure initial delay for yProvider liveness probe | | | `yProvider.probes.liveness.initialDelaySeconds` | Configure timeout for yProvider liveness probe | | | `yProvider.probes.startup.path` | Configure path for yProvider HTTP startup probe | | | `yProvider.probes.startup.targetPort` | Configure port for yProvider HTTP startup probe | | | `yProvider.probes.startup.initialDelaySeconds` | Configure initial delay for yProvider startup probe | | | `yProvider.probes.startup.initialDelaySeconds` | Configure timeout for yProvider startup probe | | | `yProvider.probes.readiness.path` | Configure path for yProvider HTTP readiness probe | | | `yProvider.probes.readiness.targetPort` | Configure port for yProvider HTTP readiness probe | | | `yProvider.probes.readiness.initialDelaySeconds` | Configure initial delay for yProvider readiness probe | | | `yProvider.probes.readiness.initialDelaySeconds` | Configure timeout for yProvider readiness probe | | | `yProvider.probes.liveness.path` | | `/ping` | | `yProvider.probes.liveness.initialDelaySeconds` | | `10` | | `yProvider.resources` | Resource requirements for the yProvider container | `{}` | | `yProvider.nodeSelector` | Node selector for the yProvider Pod | `{}` | | `yProvider.tolerations` | Tolerations for the yProvider Pod | `[]` | | `yProvider.affinity` | Affinity for the yProvider Pod | `{}` | | `yProvider.persistence` | Additional volumes to create and mount on the yProvider. Used for debugging purposes | `{}` | | `yProvider.persistence.volume-name.size` | Size of the additional volume | | | `yProvider.persistence.volume-name.type` | Type of the additional volume, persistentVolumeClaim or emptyDir | | | `yProvider.persistence.volume-name.mountPath` | Path where the volume should be mounted to | | | `yProvider.extraVolumeMounts` | Additional volumes to mount on the yProvider. | `[]` | | `yProvider.extraVolumes` | Additional volumes to mount on the yProvider. | `[]` |