|
1 | 1 | # Zulip
|
2 | 2 |
|
3 |
| -   |
| 3 | +   |
4 | 4 |
|
5 | 5 | [Zulip](https://zulip.com/) is an open source threaded team chat that helps teams stay productive and focused.
|
6 | 6 |
|
@@ -68,52 +68,71 @@ Now you're ready to follow [the installation instructions above](#installation).
|
68 | 68 |
|
69 | 69 | | Key | Type | Default | Description |
|
70 | 70 | |-----|------|---------|-------------|
|
71 |
| -| affinity | object | `{}` | Affinity for pod assignment. Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity | |
72 |
| -| fullnameOverride | string | `""` | Fully override common.names.fullname template. | |
73 |
| -| image.pullPolicy | string | `"IfNotPresent"` | Pull policy for Zulip docker image. Ref: https://kubernetes.io/docs/user-guide/images/#pre-pulling-images | |
74 |
| -| image.repository | string | `"zulip/docker-zulip"` | Defaults to hub.docker.com/zulip/docker-zulip, but can be overwritten with a full HTTPS address. | |
75 |
| -| image.tag | string | `"9.3-0"` | Zulip image tag (immutable tags are recommended) | |
76 |
| -| imagePullSecrets | list | `[]` | Global Docker registry secret names as an array. | |
77 |
| -| ingress.annotations | object | `{}` | Can be used to add custom Ingress annotations. | |
78 |
| -| ingress.enabled | bool | `false` | Enable this to use an Ingress to reach the Zulip service. | |
79 |
| -| ingress.hosts[0] | object | `{"host":"zulip.example.com","paths":[{"path":"/"}]}` | Host for the Ingress. Should be the same as `zulip.environment.SETTING_EXTERNAL_HOST`. | |
80 |
| -| ingress.hosts[0].paths | list | `[{"path":"/"}]` | Serves Zulip root of the chosen host domain. | |
81 |
| -| ingress.tls | list | `[]` | Set a specific secret to read the TLS certificate from. If you use cert-manager, it will save the TLS secret here. If you do not, you need to manually create a secret with your TLS certificate. | |
82 |
| -| livenessProbe | object | `{"enabled":true,"failureThreshold":3,"initialDelaySeconds":10,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5}` | Liveness probe values. Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes | |
83 |
| -| memcached | object | `{"memcachedUsername":"zulip@localhost"}` | Memcached settings, see [Requirements](#Requirements). | |
84 |
| -| nameOverride | string | `""` | Partially override common.names.fullname template (will maintain the release name). | |
85 |
| -| nodeSelector | object | `{}` | Optionally add a nodeSelector to the Zulip pod, so it runs on a specific node. Ref: https://kubernetes.io/docs/user-guide/node-selection/ | |
86 |
| -| podAnnotations | object | `{}` | Custom annotations to add to the Zulip Pod. | |
87 |
| -| podLabels | object | `{}` | Custom labels to add to the Zulip Pod. | |
88 |
| -| podSecurityContext | object | `{}` | Can be used to override the default PodSecurityContext (fsGroup, runAsUser and runAsGroup) of the Zulip _Pod_. | |
89 |
| -| postSetup.scripts | object | `{}` | The Docker entrypoint script runs commands from `/data/post-setup.d` after the Zulip application's Setup phase has completed. Scripts can be added here as `script_filename: <script contents>` and they will be mounted in `/data/post-setup.d/script_filename`. | |
90 |
| -| postgresql | object | `{"auth":{"database":"zulip","username":"zulip"},"image":{"repository":"zulip/zulip-postgresql","tag":14},"primary":{"containerSecurityContext":{"runAsUser":0}}}` | PostgreSQL settings, see [Requirements](#Requirements). | |
91 |
| -| rabbitmq | object | `{"auth":{"username":"zulip"},"persistence":{"enabled":false}}` | Rabbitmq settings, see [Requirements](#Requirements). | |
92 |
| -| redis | object | `{"architecture":"standalone","master":{"persistence":{"enabled":false}}}` | Redis settings, see [Requirements](#Requirements). | |
| 71 | +| affinity | object | `{}` | | |
| 72 | +| fullnameOverride | string | `""` | | |
| 73 | +| image.pullPolicy | string | `"IfNotPresent"` | | |
| 74 | +| image.repository | string | `"zulip/docker-zulip"` | | |
| 75 | +| image.tag | string | `"9.4-0"` | | |
| 76 | +| imagePullSecrets | list | `[]` | | |
| 77 | +| ingress.annotations | object | `{}` | | |
| 78 | +| ingress.enabled | bool | `false` | | |
| 79 | +| ingress.hosts[0].host | string | `"zulip.example.com"` | | |
| 80 | +| ingress.hosts[0].paths[0].path | string | `"/"` | | |
| 81 | +| ingress.tls | list | `[]` | | |
| 82 | +| livenessProbe.enabled | bool | `true` | | |
| 83 | +| livenessProbe.failureThreshold | int | `3` | | |
| 84 | +| livenessProbe.initialDelaySeconds | int | `10` | | |
| 85 | +| livenessProbe.periodSeconds | int | `10` | | |
| 86 | +| livenessProbe.successThreshold | int | `1` | | |
| 87 | +| livenessProbe.timeoutSeconds | int | `5` | | |
| 88 | +| memcached.memcachedUsername | string | `"zulip@localhost"` | | |
| 89 | +| nameOverride | string | `""` | | |
| 90 | +| nodeSelector | object | `{}` | | |
| 91 | +| podAnnotations | object | `{}` | | |
| 92 | +| podLabels | object | `{}` | | |
| 93 | +| podSecurityContext | object | `{}` | | |
| 94 | +| postSetup.scripts | object | `{}` | | |
| 95 | +| postgresql.auth.database | string | `"zulip"` | | |
| 96 | +| postgresql.auth.username | string | `"zulip"` | | |
| 97 | +| postgresql.image.repository | string | `"zulip/zulip-postgresql"` | | |
| 98 | +| postgresql.image.tag | int | `14` | | |
| 99 | +| postgresql.primary.containerSecurityContext.runAsUser | int | `0` | | |
| 100 | +| rabbitmq.auth.username | string | `"zulip"` | | |
| 101 | +| rabbitmq.persistence.enabled | bool | `false` | | |
| 102 | +| redis.architecture | string | `"standalone"` | | |
| 103 | +| redis.master.persistence.enabled | bool | `false` | | |
93 | 104 | | resources | object | `{}` | |
|
94 |
| -| securityContext | object | `{}` | Can be used to override the default SecurityContext of the Zulip _container_. | |
95 |
| -| service | object | `{"port":80,"type":"ClusterIP"}` | Service type and port for the Kubernetes service that connects to Zulip. Default: ClusterIP, needs an Ingress to be used. | |
96 |
| -| serviceAccount.annotations | object | `{}` | Annotations to add to the service account. | |
97 |
| -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created. | |
98 |
| -| 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 | |
| 105 | +| securityContext | object | `{}` | | |
| 106 | +| service.port | int | `80` | | |
| 107 | +| service.type | string | `"ClusterIP"` | | |
| 108 | +| serviceAccount.annotations | object | `{}` | | |
| 109 | +| serviceAccount.create | bool | `true` | | |
| 110 | +| serviceAccount.name | string | `""` | | |
99 | 111 | | sidecars | list | `[]` | |
|
100 |
| -| startupProbe | object | `{"enabled":true,"failureThreshold":30,"initialDelaySeconds":10,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5}` | Startup probe values. Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes | |
101 |
| -| statefulSetAnnotations | object | `{}` | Custom annotations to add to the Zulip StatefulSet. | |
102 |
| -| statefulSetLabels | object | `{}` | Custom labels to add to the Zulip StatefulSet. | |
103 |
| -| tolerations | list | `[]` | Tolerations for pod assignment. Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ | |
104 |
| -| zulip.environment.DISABLE_HTTPS | bool | `true` | Disables HTTPS if set to "true". HTTPS and certificates are managed by the Kubernetes cluster, so by default it's disabled inside the container | |
105 |
| -| zulip.environment.SECRETS_email_password | string | `"123456789"` | SMTP email password. | |
| 112 | +| startupProbe.enabled | bool | `true` | | |
| 113 | +| startupProbe.failureThreshold | int | `30` | | |
| 114 | +| startupProbe.initialDelaySeconds | int | `10` | | |
| 115 | +| startupProbe.periodSeconds | int | `10` | | |
| 116 | +| startupProbe.successThreshold | int | `1` | | |
| 117 | +| startupProbe.timeoutSeconds | int | `5` | | |
| 118 | +| statefulSetAnnotations | object | `{}` | | |
| 119 | +| statefulSetLabels | object | `{}` | | |
| 120 | +| tolerations | list | `[]` | | |
| 121 | +| zulip.environment.DISABLE_HTTPS | bool | `true` | | |
| 122 | +| zulip.environment.SECRETS_email_password | string | `"123456789"` | | |
106 | 123 | | zulip.environment.SETTING_EMAIL_HOST | string | `""` | |
|
107 | 124 | | zulip.environment.SETTING_EMAIL_HOST_USER | string | `"[email protected]"` | |
|
108 | 125 | | zulip.environment.SETTING_EMAIL_PORT | string | `"587"` | |
|
109 | 126 | | zulip.environment.SETTING_EMAIL_USE_SSL | string | `"False"` | |
|
110 | 127 | | zulip.environment.SETTING_EMAIL_USE_TLS | string | `"True"` | |
|
111 |
| -| zulip.environment.SETTING_EXTERNAL_HOST | string | `"zulip.example.com"` | Domain Zulip is hosted on. | |
| 128 | +| zulip.environment.SETTING_EXTERNAL_HOST | string | `"zulip.example.com"` | | |
112 | 129 | | zulip.environment.SETTING_ZULIP_ADMINISTRATOR | string | `"[email protected]"` | |
|
113 |
| -| zulip.environment.SSL_CERTIFICATE_GENERATION | string | `"self-signed"` | Set SSL certificate generation to self-signed because Kubernetes manages the client-facing SSL certs. | |
| 130 | +| zulip.environment.SSL_CERTIFICATE_GENERATION | string | `"self-signed"` | | |
114 | 131 | | zulip.environment.ZULIP_AUTH_BACKENDS | string | `"EmailAuthBackend"` | |
|
115 |
| -| zulip.persistence | object | `{"accessMode":"ReadWriteOnce","enabled":true,"size":"10Gi","storageClass":null}` | If `persistence.existingClaim` is not set, a PVC is generated with these specifications. | |
116 |
| -| zulip.persistence.storageClass | string | `nil` | Set storageClass to use. | |
| 132 | +| zulip.persistence.accessMode | string | `"ReadWriteOnce"` | | |
| 133 | +| zulip.persistence.enabled | bool | `true` | | |
| 134 | +| zulip.persistence.size | string | `"10Gi"` | | |
| 135 | +| zulip.persistence.storageClass | string | `nil` | | |
117 | 136 |
|
118 | 137 | ## About this helm chart
|
119 | 138 |
|
|
0 commit comments