1- # Default values for zulip.
2- # This is a YAML-formatted file.
3- # Declare variables to be passed into your templates.
4- # If you make any changes to the documentation here, regenerate the README.md
5- # with:
6- #
7- # ```
8- # docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
9- # ```
1+ # # Default values for zulip.
2+ # # This is a YAML-formatted file.
3+ # #
4+ # # Declare variables to be passed into your templates.
5+ # # If you make any changes to the documentation here, regenerate the README.md
6+ # # with:
7+ # #
8+ # # ```
9+ # # docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
10+ # # ```
1011
1112image :
12- # -- Defaults to hub.docker.com/zulip/docker-zulip, but can be overwritten with a full HTTPS address.
13+ # # Defaults to https://hub.docker.com/zulip/docker-zulip, but can be
14+ # # overwritten with a full HTTPS address.
1315 repository : zulip/docker-zulip
14- # -- Pull policy for Zulip docker image.
15- # Ref: https://kubernetes.io/docs/user-guide/images/#pre-pulling-images
16+ # # Pull policy for Zulip docker image.
17+ # # Ref: https://kubernetes.io/docs/user-guide/images/#pre-pulling-images
1618 pullPolicy : IfNotPresent
17- # -- Zulip image tag (immutable tags are recommended)
19+ # # Zulip image tag (immutable tags are recommended)
1820 tag : " 9.2-0"
1921
20- # -- Global Docker registry secret names as an array.
22+ # # Global Docker registry secret names as an array.
2123imagePullSecrets : []
2224
23- # -- Partially override common.names.fullname template (will maintain the release name).
25+ # # Partially override common.names.fullname template (will maintain the release name).
2426nameOverride : " "
2527
26- # -- Fully override common.names.fullname template.
28+ # # Fully override common.names.fullname template.
2729fullnameOverride : " "
2830
2931serviceAccount :
30- # -- Specifies whether a service account should be created.
32+ # # Specifies whether a service account should be created.
3133 create : true
32- # -- Annotations to add to the service account.
34+ # # Annotations to add to the service account.
3335 annotations : {}
34- # -- The name of the service account to use.
35- # If not set and create is true, a name is generated using the fullname template
36+ # # The name of the service account to use.
37+ # # If not set and create is true, a name is generated using the fullname template
3638 name : " "
3739
38- # -- Custom labels to add to the Zulip StatefulSet.
40+ # # Custom labels to add to the Zulip StatefulSet.
3941statefulSetLabels : {}
40- # -- Custom annotations to add to the Zulip StatefulSet.
42+ # # Custom annotations to add to the Zulip StatefulSet.
4143statefulSetAnnotations : {}
4244
43- # -- Custom labels to add to the Zulip Pod.
45+ # # Custom labels to add to the Zulip Pod.
4446podLabels : {}
45- # -- Custom annotations to add to the Zulip Pod.
47+ # # Custom annotations to add to the Zulip Pod.
4648podAnnotations : {}
4749
48- # -- Can be used to override the default PodSecurityContext (fsGroup, runAsUser
49- # and runAsGroup) of the Zulip _Pod_.
50+ # # Can be used to override the default PodSecurityContext (fsGroup,
51+ # # runAsUser and runAsGroup) of the Zulip _Pod_.
5052podSecurityContext :
5153 {}
5254 # fsGroup: 1000
5355 # runAsUser: 1000
5456 # runAsGroup: 1000
5557
56- # -- Can be used to override the default SecurityContext of the Zulip _container_.
58+ # # Can be used to override the default SecurityContext of the Zulip _container_.
5759securityContext :
5860 {}
5961 # capabilities:
@@ -63,74 +65,78 @@ securityContext:
6365 # runAsNonRoot: true
6466 # runAsUser: 1000
6567
66- # -- Service type and port for the Kubernetes service that connects to Zulip.
67- # Default: ClusterIP, needs an Ingress to be used.
68+ # # Service type and port for the Kubernetes service that connects to
69+ # # Zulip. Default of ClusterIP needs an Ingress to be used.
6870service :
6971 type : ClusterIP
7072 port : 80
7173
7274ingress :
73- # -- Enable this to use an Ingress to reach the Zulip service.
75+ # # Enable this to use an Ingress to reach the Zulip service.
7476 enabled : false
75- # -- Can be used to add custom Ingress annotations.
77+ # # Can be used to add custom Ingress annotations.
7678 annotations :
7779 {}
7880 # kubernetes.io/ingress.class: nginx
7981 # kubernetes.io/tls-acme: "true"
8082 hosts :
81- # -- Host for the Ingress. Should be the same as
82- # `zulip.environment.SETTING_EXTERNAL_HOST`.
83+ # # Host for the Ingress. Should be the same as
84+ # # `zulip.environment.SETTING_EXTERNAL_HOST`.
8385 - host : zulip.example.com
84- # -- Serves Zulip root of the chosen host domain.
86+ # # Serves Zulip root of the chosen host domain.
8587 paths :
8688 - path : /
87- # -- Set a specific secret to read the TLS certificate from. If you use
88- # cert-manager, it will save the TLS secret here. If you do not, you need to
89- # manually create a secret with your TLS certificate.
89+ # # Set a specific secret to read the TLS certificate from. If you
90+ # # use cert-manager, it will save the TLS secret here. If you do
91+ # # not, you need to manually create a secret with your TLS
92+ # # certificate.
9093 tls : []
9194 # - secretName: chart-example-tls
9295 # hosts:
9396 # - zulip.example.com
9497
9598resources :
9699 {}
97- # We usually recommend not to specify default resources and to leave this as a conscious
98- # choice for the user. This also increases chances charts run on environments with little
99- # resources, such as Minikube. If you do want to specify resources, uncomment the following
100- # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
100+ # # We usually recommend not to specify default resources and to
101+ # # leave this as a conscious choice for the user. This also
102+ # # increases chances charts run on environments with little
103+ # # resources, such as Minikube. If you do want to specify resources,
104+ # # uncomment the following lines, adjust them as necessary, and
105+ # # remove the curly braces after 'resources:'.
101106 # limits:
102107 # cpu: 100m
103108 # memory: 128Mi
104109 # requests:
105110 # cpu: 100m
106111 # memory: 128Mi
107112
108- # -- Optionally add a nodeSelector to the Zulip pod, so it runs on a specific
109- # node.
110- # Ref: https://kubernetes.io/docs/user-guide/node-selection/
113+ # # Optionally add a nodeSelector to the Zulip pod, so it runs on a specific
114+ # # node.
115+ # # Ref: https://kubernetes.io/docs/user-guide/node-selection/
111116nodeSelector : {}
112117
113- # -- Tolerations for pod assignment.
114- # Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
118+ # # Tolerations for pod assignment.
119+ # # Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
115120tolerations : []
116121
117- # -- Affinity for pod assignment.
118- # Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
122+ # # Affinity for pod assignment.
123+ # # Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
119124affinity : {}
120125
121126zulip :
122- # Environment variables based on https://github.com/zulip/docker-zulip/blob/master/docker-compose.yml#L63
127+ # # Environment variables based on
128+ # # https://github.com/zulip/docker-zulip/blob/master/docker-compose.yml#L63
123129 environment :
124- # -- Disables HTTPS if set to "true".
125- # HTTPS and certificates are managed by the Kubernetes cluster, so
126- # by default it's disabled inside the container
130+ # # Disable the default Zulip requirement of HTTPS. HTTPS and
131+ # # certificates are managed by the Kubernetes cluster, so by
132+ # # default it's disabled inside the container.
127133 DISABLE_HTTPS : true
128- # -- Set SSL certificate generation to self-signed because Kubernetes
129- # manages the client-facing SSL certs.
134+ # # Set SSL certificate generation to self-signed because
135+ # # Kubernetes manages the client-facing SSL certs.
130136 SSL_CERTIFICATE_GENERATION : self-signed
131- # -- Domain Zulip is hosted on.
137+ # # Domain Zulip is hosted on.
132138 SETTING_EXTERNAL_HOST : zulip.example.com
133- # -- SMTP email password.
139+ # # SMTP email password.
134140 SECRETS_email_password : " 123456789"
135141 SETTING_ZULIP_ADMINISTRATOR :
" [email protected] " 136142 SETTING_EMAIL_HOST : " " # e.g. smtp.example.com
@@ -139,27 +145,28 @@ zulip:
139145 SETTING_EMAIL_USE_SSL : " False"
140146 SETTING_EMAIL_USE_TLS : " True"
141147 ZULIP_AUTH_BACKENDS : " EmailAuthBackend"
142- # -- If `persistence.existingClaim` is not set, a PVC is generated with these
143- # specifications.
148+ # # If `persistence.existingClaim` is not set, a PVC (Persistent
149+ # # Volume Claim) is generated with these specifications.
144150 persistence :
145151 enabled : true
146152 accessMode : ReadWriteOnce
147153 size : 10Gi
148- # -- Set storageClass to use.
154+ # # Set storageClass to use.
149155 storageClass :
150- # existingClaim: "" # Use an already existing PVC
156+ # # Use an already existing PVC
157+ # existingClaim: ""
151158
152- # -- Liveness probe values.
153- # Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
159+ # # Liveness probe values.
160+ # # Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
154161livenessProbe :
155162 enabled : true
156163 initialDelaySeconds : 10
157164 periodSeconds : 10
158165 timeoutSeconds : 5
159166 failureThreshold : 3
160167 successThreshold : 1
161- # -- Startup probe values.
162- # Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
168+ # # Startup probe values.
169+ # # Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
163170startupProbe :
164171 enabled : true
165172 initialDelaySeconds : 10
@@ -169,18 +176,18 @@ startupProbe:
169176 successThreshold : 1
170177
171178postSetup :
172- # -- The Docker entrypoint script runs commands from `/data/post-setup.d` after
173- # the Zulip application's Setup phase has completed. Scripts can be added here
174- # as `script_filename: <script contents>` and they will be mounted in
175- # `/data/post-setup.d/script_filename`.
179+ # # The Docker entrypoint script runs commands from `/data/post-setup.d` after
180+ # # the Zulip application's Setup phase has completed. Scripts can be added here
181+ # # as `script_filename: <script contents>` and they will be mounted in
182+ # # `/data/post-setup.d/script_filename`.
176183 scripts :
177184 {}
178185 # scriptName.sh: |
179186 # #!/bin/bash
180- # echo "This is a script that gets executed in the Zulip container after installation, once migrations are complete "
187+ # echo "This script is executed in the Zulip container after installation/ migrations. "
181188
182- # -- You can add any sidecar to Zulip, like a minio client to use for
183- # uploading backups to a bucket, and mounting the volume for Zulip.
189+ # # You can add any sidecar to Zulip, like a minio client to use for
190+ # # uploading backups to a bucket, and mounting the volume for Zulip.
184191 # sidecars:
185192 # - image: minio/mc
186193 # name: minio-client
@@ -190,32 +197,32 @@ postSetup:
190197sidecars :
191198 []
192199
193- # -- PostgreSQL settings, see [Requirements](#Requirements).
200+ # # PostgreSQL settings, see [Requirements](#Requirements).
194201postgresql :
195202 primary :
196203 containerSecurityContext :
197204 runAsUser : 0
198- # We need to override the Postgresql image to get all the plugins Zulip needs
205+ # # We need to override the Postgresql image to get all the plugins Zulip needs
199206 image :
200207 repository : zulip/zulip-postgresql
201208 tag : 14
202209 auth :
203210 username : zulip
204211 database : zulip
205212
206- # -- Rabbitmq settings, see [Requirements](#Requirements).
213+ # # Rabbitmq settings, see [Requirements](#Requirements).
207214rabbitmq :
208215 auth :
209216 username : zulip
210- # Set this to true if you need the rabbitmq to be persistent
217+ # # Set this to true if you need the rabbitmq to be persistent
211218 persistence :
212219 enabled : false
213220
214- # -- Memcached settings, see [Requirements](#Requirements).
221+ # # Memcached settings, see [Requirements](#Requirements).
215222memcached :
216223 memcachedUsername : " zulip@localhost"
217224
218- # -- Redis settings, see [Requirements](#Requirements).
225+ # # Redis settings, see [Requirements](#Requirements).
219226redis :
220227 architecture : standalone
221228 master :
0 commit comments