Back to Suitenumerique

Impress helm chart

src/helm/impress/README.md

5.0.074.3 KB
Original Source

Impress helm chart

Parameters

General configuration

NameDescriptionValue
image.repositoryRepository to use to pull impress's container imagelasuite/impress-backend
image.tagimpress's container taglatest
image.pullPolicyContainer image pull policyIfNotPresent
image.credentials.usernameUsername for container registry authentication
image.credentials.passwordPassword for container registry authentication
image.credentials.registryRegistry url for which the credentials are specified
image.credentials.nameName of the generated secret for imagePullSecrets
nameOverrideOverride the chart name""
fullnameOverrideOverride the full application name""
ingress.enabledwhether to enable the Ingress or notfalse
ingress.classNameIngressClass to use for the Ingressnil
ingress.hostHost for the Ingressimpress.example.com
ingress.pathPath to use for the Ingress/
ingress.hostsAdditional host to configure for the Ingress[]
ingress.tls.enabledWhether to enable TLS for the Ingresstrue
ingress.tls.secretNameSecret name for TLS confignil
ingress.tls.additional[].secretNameSecret name for additional TLS config
ingress.tls.additional[].hosts[]Hosts for additional TLS config
ingress.customBackendsAdd custom backends to ingress[]
ingressCollaborationWS.enabledwhether to enable the Ingress or notfalse
ingressCollaborationWS.classNameIngressClass to use for the Ingressnil
ingressCollaborationWS.hostHost for the Ingressimpress.example.com
ingressCollaborationWS.pathPath to use for the Ingress/collaboration/ws/
ingressCollaborationWS.hostsAdditional host to configure for the Ingress[]
ingressCollaborationWS.tls.enabledWhether to enable TLS for the Ingresstrue
ingressCollaborationWS.tls.secretNameSecret name for TLS confignil
ingressCollaborationWS.tls.additional[].secretNameSecret name for additional TLS config
ingressCollaborationWS.tls.additional[].hosts[]Hosts for additional TLS config
ingressCollaborationWS.customBackendsAdd custom backends to ingress[]
ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/enable-websockettrue
ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/proxy-read-timeout86400
ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/proxy-send-timeout86400
ingressCollaborationWS.annotations.nginx.ingress.kubernetes.io/upstream-hash-by$arg_room
ingressRedirects.enabledwhether to enable the Ingress Redirects or notfalse
ingressRedirects.classNameIngressClass to use for the Ingress Redirectsnil
ingressRedirects.hostHost for the Ingress Redirectsimpress.example.com
ingressRedirects.tls.enabledWhether to enable TLS for the Ingress Redirectstrue
ingressRedirects.tls.secretNameSecret name for TLS confignil
ingressRedirects.tls.additional[].secretNameSecret name for additional TLS config
ingressRedirects.tls.additional[].hosts[]Hosts for additional TLS config
ingressRedirects.rulesRules for the Ingress Redirects[]
ingressCollaborationApi.enabledwhether to enable the Ingress or notfalse
ingressCollaborationApi.classNameIngressClass to use for the Ingressnil
ingressCollaborationApi.hostHost for the Ingressimpress.example.com
ingressCollaborationApi.pathPath to use for the Ingress/collaboration/api/
ingressCollaborationApi.hostsAdditional host to configure for the Ingress[]
ingressCollaborationApi.tls.enabledWhether to enable TLS for the Ingresstrue
ingressCollaborationApi.tls.secretNameSecret name for TLS confignil
ingressCollaborationApi.tls.additional[].secretNameSecret name for additional TLS config
ingressCollaborationApi.tls.additional[].hosts[]Hosts for additional TLS config
ingressCollaborationApi.customBackendsAdd custom backends to ingress[]
ingressCollaborationApi.annotations.nginx.ingress.kubernetes.io/upstream-hash-by$arg_room
ingressAdmin.enabledwhether to enable the Ingress or notfalse
ingressAdmin.classNameIngressClass to use for the Ingressnil
ingressAdmin.hostHost for the Ingressimpress.example.com
ingressAdmin.pathPath to use for the Ingress/admin
ingressAdmin.hostsAdditional host to configure for the Ingress[]
ingressAdmin.tls.enabledWhether to enable TLS for the Ingresstrue
ingressAdmin.tls.secretNameSecret name for TLS confignil
ingressAdmin.tls.additional[].secretNameSecret name for additional TLS config
ingressAdmin.tls.additional[].hosts[]Hosts for additional TLS config
ingressMedia.enabledwhether to enable the Ingress or notfalse
ingressMedia.classNameIngressClass to use for the Ingressnil
ingressMedia.hostHost for the Ingressimpress.example.com
ingressMedia.pathPath to use for the Ingress/media/(.*)
ingressMedia.hostsAdditional host to configure for the Ingress[]
ingressMedia.tls.enabledWhether to enable TLS for the Ingresstrue
ingressMedia.tls.secretNameSecret name for TLS confignil
ingressMedia.tls.additional[].secretNameSecret name for additional TLS config
ingressMedia.tls.additional[].hosts[]Hosts for additional TLS config
ingressMedia.annotations.nginx.ingress.kubernetes.io/auth-urlhttps://impress.example.com/api/v1.0/documents/media-auth/
ingressMedia.annotations.nginx.ingress.kubernetes.io/auth-response-headersAuthorization, X-Amz-Date, X-Amz-Content-SHA256
ingressMedia.annotations.nginx.ingress.kubernetes.io/upstream-vhostminio.impress.svc.cluster.local:9000
ingressMedia.annotations.nginx.ingress.kubernetes.io/configuration-snippet`add_header Content-Security-Policy "default-src 'none'" always;
`
serviceMedia.hostHostname of the media storage backend (S3/MinIO) used by the media ingressminio.impress.svc.cluster.local
serviceMedia.portPort of the media storage backend9000
serviceMedia.annotationsAnnotations to add to the media ExternalName Service{}

backend

NameDescriptionValue
backend.commandOverride the backend container command[]
backend.argsOverride the backend container args[]
backend.replicasAmount of backend replicas3
backend.shareProcessNamespaceEnable share process namespace between containersfalse
backend.sidecarsAdd sidecars containers to backend deployment[]
backend.migrateJobAnnotationsAnnotations for the migrate job{}
backend.jobs.ttlSecondsAfterFinishedPeriod to wait before remove jobs30
backend.jobs.backoffLimitNumbers of jobs retries2
backend.securityContext.allowPrivilegeEscalationWhether to allow privilege escalation for the backend containerfalse
backend.securityContext.capabilities.dropList of capabilities to drop for the backend container["ALL"]
backend.securityContext.runAsNonRootWhether to run the backend container as a non-root usertrue
backend.securityContext.seccompProfile.typeSeccomp profile type for the backend containerRuntimeDefault
backend.envVarsConfigure backend container environment variablesundefined
backend.envVars.BY_VALUEExample environment variable by setting value directly
backend.envVars.FROM_CONFIGMAP.configMapKeyRef.nameName of a ConfigMap when configuring env vars from a ConfigMap
backend.envVars.FROM_CONFIGMAP.configMapKeyRef.keyKey within a ConfigMap when configuring env vars from a ConfigMap
backend.envVars.FROM_SECRET.secretKeyRef.nameName of a Secret when configuring env vars from a Secret
backend.envVars.FROM_SECRET.secretKeyRef.keyKey within a Secret when configuring env vars from a Secret
backend.django.envVarsBackend web deployment specific environment variables (not shared with celery worker)
backend.podAnnotationsAnnotations to add to the backend Pod{}
backend.dpAnnotationsAnnotations to add to the backend Deployment{}
backend.service.typebackend Service typeClusterIP
backend.service.portbackend Service listening port80
backend.service.targetPortbackend container listening port8000
backend.service.annotationsAnnotations to add to the backend Service{}
backend.migrate.commandbackend migrate command["/bin/sh","-c","while ! python manage.py check --database default > /dev/null 2>&1\ndo\n echo \"Database not ready\"\n sleep 2\ndone\n\necho \"Database is ready\"\n\npython manage.py migrate --no-input\n"]
backend.migrate.restartPolicybackend migrate job restart policyNever
backend.createsuperuser.commandbackend migrate command["/bin/sh","-c","while ! python manage.py check --database default > /dev/null 2>&1\ndo\n echo \"Database not ready\"\n sleep 2\ndone\n\necho \"Database is ready\"\n\npython manage.py createsuperuser --email $DJANGO_SUPERUSER_EMAIL --password $DJANGO_SUPERUSER_PASSWORD\n"]
backend.createsuperuser.restartPolicybackend migrate job restart policyNever
backend.jobjob dedicated to run a random management command, for example after a deployment
backend.job.nameThe name to use to describe this job""
backend.job.commandThe management command to execute[]
backend.job.restartPolicyThe restart policy for the job.Never
backend.job.annotationsAnnotations to add to the job [default: argocd.argoproj.io/hook: PostSync]
backend.cronjobsCronjob name, schedule, command[]
backend.probes.liveness.pathConfigure path for backend HTTP liveness probe/__lbheartbeat__
backend.probes.liveness.targetPortConfigure port for backend HTTP liveness probenil
backend.probes.liveness.initialDelaySecondsConfigure initial delay for backend liveness probe10
backend.probes.liveness.timeoutSecondsConfigure timeout for backend liveness probenil
backend.probes.startup.pathConfigure path for backend HTTP startup probe
backend.probes.startup.targetPortConfigure port for backend HTTP startup probe
backend.probes.startup.initialDelaySecondsConfigure initial delay for backend startup probe
backend.probes.startup.timeoutSecondsConfigure timeout for backend startup probe
backend.probes.readiness.pathConfigure path for backend HTTP readiness probe/__heartbeat__
backend.probes.readiness.targetPortConfigure port for backend HTTP readiness probenil
backend.probes.readiness.initialDelaySecondsConfigure initial delay for backend readiness probe10
backend.probes.readiness.timeoutSecondsConfigure timeout for backend readiness probenil
backend.resourcesResource requirements for the backend container{}
backend.nodeSelectorNode selector for the backend Pod{}
backend.tolerationsTolerations for the backend Pod[]
backend.affinityAffinity for the backend Pod{}
backend.persistenceAdditional volumes to create and mount on the backend. Used for debugging purposes{}
backend.persistence.volume-name.sizeSize of the additional volume
backend.persistence.volume-name.typeType of the additional volume, persistentVolumeClaim or emptyDir
backend.persistence.volume-name.mountPathPath where the volume should be mounted to
backend.extraVolumeMountsAdditional volumes to mount on the backend.[]
backend.extraVolumesAdditional volumes to mount on the backend.[]
backend.pdb.enabledEnable pdb on backendtrue
backend.serviceAccountNameOptional service account name to use for backend podsnil
backend.themeCustomization.enabledEnable theme customizationfalse
backend.themeCustomization.file_contentContent of the theme customization file. Must be a json object.""
backend.themeCustomization.mount_pathPath where the customization file will be mounted in the backend deployment./app/impress/configuration/theme
backend.celery.replicasAmount of celery replicas1
backend.celery.commandOverride the celery container command[]
backend.celery.argsOverride the celery container args["celery","-A","impress.celery_app","worker","-l","INFO","-n","impress@%h"]
backend.celery.resourcesResource requirements for the celery container{}
backend.celery.probes.liveness.exec.commandOverride the celery container liveness probe command["/bin/sh","-c","celery -A impress.celery_app inspect ping -d impress@$HOSTNAME"]
backend.celery.probes.liveness.initialDelaySecondsInitial delay for the celery container liveness probe60
backend.celery.probes.liveness.timeoutSecondsTimeout for the celery container liveness probe5
backend.celery.probes.readiness.exec.commandOverride the celery container readiness probe command["/bin/sh","-c","celery -A impress.celery_app inspect ping -d impress@$HOSTNAME"]
backend.celery.probes.readiness.initialDelaySecondsInitial delay for the celery container readiness probe15
backend.celery.probes.readiness.timeoutSecondsTimeout for the celery container readiness probe5
backend.celery.envVarsCelery worker specific environment variables (not shared with the backend web deployment)

frontend

NameDescriptionValue
frontend.image.repositoryRepository to use to pull impress's frontend container imagelasuite/impress-frontend
frontend.image.tagimpress's frontend container taglatest
frontend.image.pullPolicyfrontend container image pull policyIfNotPresent
frontend.commandOverride the frontend container command[]
frontend.argsOverride the frontend container args[]
frontend.replicasAmount of frontend replicas3
frontend.shareProcessNamespaceEnable share process namespace between containersfalse
frontend.sidecarsAdd sidecars containers to frontend deployment[]
frontend.securityContext.allowPrivilegeEscalationWhether to allow privilege escalation for the frontend containerfalse
frontend.securityContext.capabilities.dropList of capabilities to drop for the frontend container["ALL"]
frontend.securityContext.runAsNonRootWhether to run the frontend container as a non-root usertrue
frontend.securityContext.seccompProfile.typeSeccomp profile type for the frontend containerRuntimeDefault
frontend.envVarsConfigure frontend container environment variablesundefined
frontend.envVars.BY_VALUEExample environment variable by setting value directly
frontend.envVars.FROM_CONFIGMAP.configMapKeyRef.nameName of a ConfigMap when configuring env vars from a ConfigMap
frontend.envVars.FROM_CONFIGMAP.configMapKeyRef.keyKey within a ConfigMap when configuring env vars from a ConfigMap
frontend.envVars.FROM_SECRET.secretKeyRef.nameName of a Secret when configuring env vars from a Secret
frontend.envVars.FROM_SECRET.secretKeyRef.keyKey within a Secret when configuring env vars from a Secret
frontend.podAnnotationsAnnotations to add to the frontend Pod{}
frontend.dpAnnotationsAnnotations to add to the frontend Deployment{}
frontend.service.typefrontend Service typeClusterIP
frontend.service.portfrontend Service listening port80
frontend.service.targetPortfrontend container listening port8080
frontend.service.annotationsAnnotations to add to the frontend Service{}
frontend.probesConfigure probe for frontend{}
frontend.probes.liveness.pathConfigure path for frontend HTTP liveness probe
frontend.probes.liveness.targetPortConfigure port for frontend HTTP liveness probe
frontend.probes.liveness.initialDelaySecondsConfigure initial delay for frontend liveness probe
frontend.probes.liveness.initialDelaySecondsConfigure timeout for frontend liveness probe
frontend.probes.startup.pathConfigure path for frontend HTTP startup probe
frontend.probes.startup.targetPortConfigure port for frontend HTTP startup probe
frontend.probes.startup.initialDelaySecondsConfigure initial delay for frontend startup probe
frontend.probes.startup.initialDelaySecondsConfigure timeout for frontend startup probe
frontend.probes.readiness.pathConfigure path for frontend HTTP readiness probe
frontend.probes.readiness.targetPortConfigure port for frontend HTTP readiness probe
frontend.probes.readiness.initialDelaySecondsConfigure initial delay for frontend readiness probe
frontend.probes.readiness.initialDelaySecondsConfigure timeout for frontend readiness probe
frontend.resourcesResource requirements for the frontend container{}
frontend.nodeSelectorNode selector for the frontend Pod{}
frontend.tolerationsTolerations for the frontend Pod[]
frontend.affinityAffinity for the frontend Pod{}
frontend.persistenceAdditional volumes to create and mount on the frontend. Used for debugging purposes{}
frontend.persistence.volume-name.sizeSize of the additional volume
frontend.persistence.volume-name.typeType of the additional volume, persistentVolumeClaim or emptyDir
frontend.persistence.volume-name.mountPathPath where the volume should be mounted to
frontend.extraVolumeMountsAdditional volumes to mount on the frontend.[]
frontend.extraVolumesAdditional volumes to mount on the frontend.[]
frontend.pdb.enabledEnable pdb on frontendtrue
frontend.serviceAccountNameOptional service account name to use for frontend podsnil

posthog

NameDescriptionValue
posthog.ingress.enabledEnable or disable the ingress resource creationfalse
posthog.ingress.classNameKubernetes ingress class name to use (e.g., nginx, traefik)nil
posthog.ingress.hostPrimary hostname for the ingress resourceimpress.example.com
posthog.ingress.pathURL path prefix for the ingress routes (e.g., /)/
posthog.ingress.hostsAdditional hostnames array to be included in the ingress[]
posthog.ingress.tls.enabledEnable or disable TLS/HTTPS for the ingresstrue
posthog.ingress.tls.additionalAdditional TLS configurations for extra hosts/certificates[]
posthog.ingress.customBackendsCustom backend service configurations for the ingress[]
posthog.ingress.annotationsAdditional Kubernetes annotations to apply to the ingress{}
posthog.ingressAssets.enabledEnable or disable the ingress resource creationfalse
posthog.ingressAssets.classNameKubernetes ingress class name to use (e.g., nginx, traefik)nil
posthog.ingressAssets.hostPrimary hostname for the ingress resourceimpress.example.com
posthog.ingressAssets.pathsURL paths prefix for the ingress routes (e.g., /static)["/static","/array"]
posthog.ingressAssets.hostsAdditional hostnames array to be included in the ingress[]
posthog.ingressAssets.tls.enabledEnable or disable TLS/HTTPS for the ingresstrue
posthog.ingressAssets.tls.additionalAdditional TLS configurations for extra hosts/certificates[]
posthog.ingressAssets.customBackendsCustom backend service configurations for the ingress[]
posthog.ingressAssets.annotationsAdditional Kubernetes annotations to apply to the ingress{}
posthog.service.typeService type (e.g. ExternalName, ClusterIP, LoadBalancer)ExternalName
posthog.service.externalNameExternal service hostname when type is ExternalNameeu.i.posthog.com
posthog.service.portPort number for the service443
posthog.service.annotationsAdditional annotations to apply to the service{}
posthog.assetsService.typeService type (e.g. ExternalName, ClusterIP, LoadBalancer)ExternalName
posthog.assetsService.externalNameExternal service hostname when type is ExternalNameeu-assets.i.posthog.com
posthog.assetsService.portPort number for the service443
posthog.assetsService.annotationsAdditional annotations to apply to the service{}

yProvider

NameDescriptionValue
yProvider.image.repositoryRepository to use to pull impress's yProvider container imagelasuite/impress-y-provider
yProvider.image.tagimpress's yProvider container taglatest
yProvider.image.pullPolicyyProvider container image pull policyIfNotPresent
yProvider.commandOverride the yProvider container command[]
yProvider.argsOverride the yProvider container args[]
yProvider.replicasAmount of yProvider replicas3
yProvider.shareProcessNamespaceEnable share process nameyProvider between containersfalse
yProvider.sidecarsAdd sidecars containers to yProvider deployment[]
yProvider.securityContext.allowPrivilegeEscalationWhether to allow privilege escalation for the yProvider containerfalse
yProvider.securityContext.capabilities.dropList of capabilities to drop for the yProvider container["ALL"]
yProvider.securityContext.runAsNonRootWhether to run the yProvider container as a non-root usertrue
yProvider.securityContext.seccompProfile.typeSeccomp profile type for the yProvider containerRuntimeDefault
yProvider.envVarsConfigure yProvider container environment variablesundefined
yProvider.envVars.BY_VALUEExample environment variable by setting value directly
yProvider.envVars.FROM_CONFIGMAP.configMapKeyRef.nameName of a ConfigMap when configuring env vars from a ConfigMap
yProvider.envVars.FROM_CONFIGMAP.configMapKeyRef.keyKey within a ConfigMap when configuring env vars from a ConfigMap
yProvider.envVars.FROM_SECRET.secretKeyRef.nameName of a Secret when configuring env vars from a Secret
yProvider.envVars.FROM_SECRET.secretKeyRef.keyKey within a Secret when configuring env vars from a Secret
yProvider.podAnnotationsAnnotations to add to the yProvider Pod{}
yProvider.dpAnnotationsAnnotations to add to the yProvider Deployment{}
yProvider.service.typeyProvider Service typeClusterIP
yProvider.service.portyProvider Service listening port443
yProvider.service.targetPortyProvider container listening port4444
yProvider.service.annotationsAnnotations to add to the yProvider Service{}
yProvider.probes.liveness.pathConfigure path for yProvider HTTP liveness probe/ping
yProvider.probes.liveness.initialDelaySecondsConfigure initial delay for yProvider liveness probe10
yProvider.probes.liveness.targetPortConfigure port for yProvider HTTP liveness probe
yProvider.probes.liveness.timeoutSecondsConfigure timeout for yProvider liveness probe
yProvider.probes.startup.pathConfigure path for yProvider HTTP startup probe
yProvider.probes.startup.targetPortConfigure port for yProvider HTTP startup probe
yProvider.probes.startup.initialDelaySecondsConfigure initial delay for yProvider startup probe
yProvider.probes.startup.timeoutSecondsConfigure timeout for yProvider startup probe
yProvider.probes.readiness.pathConfigure path for yProvider HTTP readiness probe
yProvider.probes.readiness.targetPortConfigure port for yProvider HTTP readiness probe
yProvider.probes.readiness.initialDelaySecondsConfigure initial delay for yProvider readiness probe
yProvider.probes.readiness.timeoutSecondsConfigure timeout for yProvider readiness probe
yProvider.resourcesResource requirements for the yProvider container{}
yProvider.nodeSelectorNode selector for the yProvider Pod{}
yProvider.tolerationsTolerations for the yProvider Pod[]
yProvider.affinityAffinity for the yProvider Pod{}
yProvider.persistenceAdditional volumes to create and mount on the yProvider. Used for debugging purposes{}
yProvider.persistence.volume-name.sizeSize of the additional volume
yProvider.persistence.volume-name.typeType of the additional volume, persistentVolumeClaim or emptyDir
yProvider.persistence.volume-name.mountPathPath where the volume should be mounted to
yProvider.extraVolumeMountsAdditional volumes to mount on the yProvider.[]
yProvider.extraVolumesAdditional volumes to mount on the yProvider.[]
yProvider.pdb.enabledEnable pdb on yProvidertrue
yProvider.serviceAccountNameOptional service account name to use for yProvider podsnil

docSpec

NameDescriptionValue
docSpec.enabledEnable docSpec deploymentfalse
docSpec.image.repositoryRepository to use to pull docSpec container imageghcr.io/docspecio/api
docSpec.image.tagdocSpec container tag2.6.3
docSpec.image.pullPolicydocSpec container image pull policyIfNotPresent
docSpec.commandOverride the docSpec container command[]
docSpec.argsOverride the docSpec container args[]
docSpec.replicasAmount of docSpec replicas1
docSpec.securityContext.allowPrivilegeEscalationWhether to allow privilege escalation for the docSpec containerfalse
docSpec.securityContext.capabilities.dropList of capabilities to drop for the docSpec container["ALL"]
docSpec.securityContext.runAsNonRootWhether to run the docSpec container as a non-root usertrue
docSpec.securityContext.seccompProfile.typeSeccomp profile type for the docSpec containerRuntimeDefault
docSpec.envVarsConfigure docSpec container environment variables{}
docSpec.service.typedocSpec Service typeClusterIP
docSpec.service.portdocSpec Service listening port4000
docSpec.service.targetPortdocSpec container listening port4000
docSpec.probes.liveness.pathConfigure path for docSpec HTTP liveness probe/health
docSpec.probes.readiness.pathConfigure path for docSpec HTTP readiness probe/health
docSpec.resourcesdocSpec resources{}
docSpec.nodeSelectorNode selector for the docSpec Pod{}
docSpec.tolerationsTolerations for the docSpec Pod[]
docSpec.affinityAffinity for the docSpec Pod{}
docSpec.extraVolumeMountsAdditional volumes to mount on docSpec[]
docSpec.extraVolumesAdditional volumes to mount on docSpec[]