mirror of
https://github.com/zulip/docker-zulip.git
synced 2025-10-23 04:51:58 +00:00
yaml: Use consistent comment styling.
This follows Zulip's current convention for sysadmin-facing template files that prose are prefixed by ##, while code to be uncommented is prefixed by a single #.
This commit is contained in:
Tim Abbott
@@ -3,15 +3,17 @@ description: Zulip is an open source threaded team chat that helps teams stay pr
|
||||
name: zulip
|
||||
type: application
|
||||
icon: https://raw.githubusercontent.com/zulip/zulip/main/static/images/logo/zulip-icon-square.svg
|
||||
# This is the chart version. This version number should be incremented each time you make changes
|
||||
# to the chart and its templates, including the app version.
|
||||
# Versions are expected to follow Semantic Versioning (https://semver.org/)
|
||||
## This is the chart version. This version number should be
|
||||
## incremented each time you make changes to the chart and its
|
||||
## templates, including the app version. Versions are expected to
|
||||
## follow Semantic Versioning (https://semver.org/)
|
||||
version: 0.9.20
|
||||
|
||||
# This is the version number of the application being deployed. This version number should be
|
||||
# incremented each time you make changes to the application. Versions are not expected to
|
||||
# follow Semantic Versioning. They should reflect the version the application is using.
|
||||
# It is recommended to use it with quotes.
|
||||
## This is the version number of the application being deployed. This
|
||||
## version number should be incremented each time you make changes to
|
||||
## the application. Versions are not expected to follow Semantic
|
||||
## Versioning. They should reflect the version the application is
|
||||
## using. It is recommended to use it with quotes.
|
||||
appVersion: "9.2-0"
|
||||
dependencies:
|
||||
- name: memcached
|
||||
@@ -33,7 +35,7 @@ dependencies:
|
||||
repository: oci://registry-1.docker.io/bitnamicharts
|
||||
tags:
|
||||
- postgresql
|
||||
# Note: values.yaml overwrites posgresql image to zulip/zulip-postgresql:14
|
||||
## Note: values.yaml overwrites posgresql image to zulip/zulip-postgresql:14
|
||||
version: 15.5.32
|
||||
|
||||
sources:
|
||||
|
||||
@@ -1,59 +1,61 @@
|
||||
# Default values for zulip.
|
||||
# This is a YAML-formatted file.
|
||||
# Declare variables to be passed into your templates.
|
||||
# If you make any changes to the documentation here, regenerate the README.md
|
||||
# with:
|
||||
#
|
||||
# ```
|
||||
# docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
|
||||
# ```
|
||||
## Default values for zulip.
|
||||
## This is a YAML-formatted file.
|
||||
##
|
||||
## Declare variables to be passed into your templates.
|
||||
## If you make any changes to the documentation here, regenerate the README.md
|
||||
## with:
|
||||
##
|
||||
## ```
|
||||
## docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
|
||||
## ```
|
||||
|
||||
image:
|
||||
# -- Defaults to hub.docker.com/zulip/docker-zulip, but can be overwritten with a full HTTPS address.
|
||||
## Defaults to https://hub.docker.com/zulip/docker-zulip, but can be
|
||||
## overwritten with a full HTTPS address.
|
||||
repository: zulip/docker-zulip
|
||||
# -- Pull policy for Zulip docker image.
|
||||
# Ref: https://kubernetes.io/docs/user-guide/images/#pre-pulling-images
|
||||
## Pull policy for Zulip docker image.
|
||||
## Ref: https://kubernetes.io/docs/user-guide/images/#pre-pulling-images
|
||||
pullPolicy: IfNotPresent
|
||||
# -- Zulip image tag (immutable tags are recommended)
|
||||
## Zulip image tag (immutable tags are recommended)
|
||||
tag: "9.2-0"
|
||||
|
||||
# -- Global Docker registry secret names as an array.
|
||||
## Global Docker registry secret names as an array.
|
||||
imagePullSecrets: []
|
||||
|
||||
# -- Partially override common.names.fullname template (will maintain the release name).
|
||||
## Partially override common.names.fullname template (will maintain the release name).
|
||||
nameOverride: ""
|
||||
|
||||
# -- Fully override common.names.fullname template.
|
||||
## Fully override common.names.fullname template.
|
||||
fullnameOverride: ""
|
||||
|
||||
serviceAccount:
|
||||
# -- Specifies whether a service account should be created.
|
||||
## Specifies whether a service account should be created.
|
||||
create: true
|
||||
# -- Annotations to add to the service account.
|
||||
## Annotations to add to the service account.
|
||||
annotations: {}
|
||||
# -- The name of the service account to use.
|
||||
# If not set and create is true, a name is generated using the fullname template
|
||||
## The name of the service account to use.
|
||||
## If not set and create is true, a name is generated using the fullname template
|
||||
name: ""
|
||||
|
||||
# -- Custom labels to add to the Zulip StatefulSet.
|
||||
## Custom labels to add to the Zulip StatefulSet.
|
||||
statefulSetLabels: {}
|
||||
# -- Custom annotations to add to the Zulip StatefulSet.
|
||||
## Custom annotations to add to the Zulip StatefulSet.
|
||||
statefulSetAnnotations: {}
|
||||
|
||||
# -- Custom labels to add to the Zulip Pod.
|
||||
## Custom labels to add to the Zulip Pod.
|
||||
podLabels: {}
|
||||
# -- Custom annotations to add to the Zulip Pod.
|
||||
## Custom annotations to add to the Zulip Pod.
|
||||
podAnnotations: {}
|
||||
|
||||
# -- Can be used to override the default PodSecurityContext (fsGroup, runAsUser
|
||||
# and runAsGroup) of the Zulip _Pod_.
|
||||
## Can be used to override the default PodSecurityContext (fsGroup,
|
||||
## runAsUser and runAsGroup) of the Zulip _Pod_.
|
||||
podSecurityContext:
|
||||
{}
|
||||
# fsGroup: 1000
|
||||
# runAsUser: 1000
|
||||
# runAsGroup: 1000
|
||||
|
||||
# -- Can be used to override the default SecurityContext of the Zulip _container_.
|
||||
## Can be used to override the default SecurityContext of the Zulip _container_.
|
||||
securityContext:
|
||||
{}
|
||||
# capabilities:
|
||||
@@ -63,30 +65,31 @@ securityContext:
|
||||
# runAsNonRoot: true
|
||||
# runAsUser: 1000
|
||||
|
||||
# -- Service type and port for the Kubernetes service that connects to Zulip.
|
||||
# Default: ClusterIP, needs an Ingress to be used.
|
||||
## Service type and port for the Kubernetes service that connects to
|
||||
## Zulip. Default of ClusterIP needs an Ingress to be used.
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 80
|
||||
|
||||
ingress:
|
||||
# -- Enable this to use an Ingress to reach the Zulip service.
|
||||
## Enable this to use an Ingress to reach the Zulip service.
|
||||
enabled: false
|
||||
# -- Can be used to add custom Ingress annotations.
|
||||
## Can be used to add custom Ingress annotations.
|
||||
annotations:
|
||||
{}
|
||||
# kubernetes.io/ingress.class: nginx
|
||||
# kubernetes.io/tls-acme: "true"
|
||||
hosts:
|
||||
# -- Host for the Ingress. Should be the same as
|
||||
# `zulip.environment.SETTING_EXTERNAL_HOST`.
|
||||
## Host for the Ingress. Should be the same as
|
||||
## `zulip.environment.SETTING_EXTERNAL_HOST`.
|
||||
- host: zulip.example.com
|
||||
# -- Serves Zulip root of the chosen host domain.
|
||||
## Serves Zulip root of the chosen host domain.
|
||||
paths:
|
||||
- path: /
|
||||
# -- 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.
|
||||
## 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.
|
||||
tls: []
|
||||
# - secretName: chart-example-tls
|
||||
# hosts:
|
||||
@@ -94,10 +97,12 @@ ingress:
|
||||
|
||||
resources:
|
||||
{}
|
||||
# We usually recommend not to specify default resources and to leave this as a conscious
|
||||
# choice for the user. This also increases chances charts run on environments with little
|
||||
# resources, such as Minikube. If you do want to specify resources, uncomment the following
|
||||
# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
|
||||
## We usually recommend not to specify default resources and to
|
||||
## leave this as a conscious choice for the user. This also
|
||||
## increases chances charts run on environments with little
|
||||
## resources, such as Minikube. If you do want to specify resources,
|
||||
## uncomment the following lines, adjust them as necessary, and
|
||||
## remove the curly braces after 'resources:'.
|
||||
# limits:
|
||||
# cpu: 100m
|
||||
# memory: 128Mi
|
||||
@@ -105,32 +110,33 @@ resources:
|
||||
# cpu: 100m
|
||||
# memory: 128Mi
|
||||
|
||||
# -- Optionally add a nodeSelector to the Zulip pod, so it runs on a specific
|
||||
# node.
|
||||
# Ref: https://kubernetes.io/docs/user-guide/node-selection/
|
||||
## Optionally add a nodeSelector to the Zulip pod, so it runs on a specific
|
||||
## node.
|
||||
## Ref: https://kubernetes.io/docs/user-guide/node-selection/
|
||||
nodeSelector: {}
|
||||
|
||||
# -- Tolerations for pod assignment.
|
||||
# Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
|
||||
## Tolerations for pod assignment.
|
||||
## Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
|
||||
tolerations: []
|
||||
|
||||
# -- Affinity for pod assignment.
|
||||
# Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
|
||||
## Affinity for pod assignment.
|
||||
## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
|
||||
affinity: {}
|
||||
|
||||
zulip:
|
||||
# Environment variables based on https://github.com/zulip/docker-zulip/blob/master/docker-compose.yml#L63
|
||||
## Environment variables based on
|
||||
## https://github.com/zulip/docker-zulip/blob/master/docker-compose.yml#L63
|
||||
environment:
|
||||
# -- Disables HTTPS if set to "true".
|
||||
# HTTPS and certificates are managed by the Kubernetes cluster, so
|
||||
# by default it's disabled inside the container
|
||||
## Disable the default Zulip requirement of HTTPS. HTTPS and
|
||||
## certificates are managed by the Kubernetes cluster, so by
|
||||
## default it's disabled inside the container.
|
||||
DISABLE_HTTPS: true
|
||||
# -- Set SSL certificate generation to self-signed because Kubernetes
|
||||
# manages the client-facing SSL certs.
|
||||
## Set SSL certificate generation to self-signed because
|
||||
## Kubernetes manages the client-facing SSL certs.
|
||||
SSL_CERTIFICATE_GENERATION: self-signed
|
||||
# -- Domain Zulip is hosted on.
|
||||
## Domain Zulip is hosted on.
|
||||
SETTING_EXTERNAL_HOST: zulip.example.com
|
||||
# -- SMTP email password.
|
||||
## SMTP email password.
|
||||
SECRETS_email_password: "123456789"
|
||||
SETTING_ZULIP_ADMINISTRATOR: "admin@example.com"
|
||||
SETTING_EMAIL_HOST: "" # e.g. smtp.example.com
|
||||
@@ -139,18 +145,19 @@ zulip:
|
||||
SETTING_EMAIL_USE_SSL: "False"
|
||||
SETTING_EMAIL_USE_TLS: "True"
|
||||
ZULIP_AUTH_BACKENDS: "EmailAuthBackend"
|
||||
# -- If `persistence.existingClaim` is not set, a PVC is generated with these
|
||||
# specifications.
|
||||
## If `persistence.existingClaim` is not set, a PVC (Persistent
|
||||
## Volume Claim) is generated with these specifications.
|
||||
persistence:
|
||||
enabled: true
|
||||
accessMode: ReadWriteOnce
|
||||
size: 10Gi
|
||||
# -- Set storageClass to use.
|
||||
## Set storageClass to use.
|
||||
storageClass:
|
||||
# existingClaim: "" # Use an already existing PVC
|
||||
## Use an already existing PVC
|
||||
# existingClaim: ""
|
||||
|
||||
# -- Liveness probe values.
|
||||
# Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
|
||||
## Liveness probe values.
|
||||
## Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
|
||||
livenessProbe:
|
||||
enabled: true
|
||||
initialDelaySeconds: 10
|
||||
@@ -158,8 +165,8 @@ livenessProbe:
|
||||
timeoutSeconds: 5
|
||||
failureThreshold: 3
|
||||
successThreshold: 1
|
||||
# -- Startup probe values.
|
||||
# Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
|
||||
## Startup probe values.
|
||||
## Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
|
||||
startupProbe:
|
||||
enabled: true
|
||||
initialDelaySeconds: 10
|
||||
@@ -169,18 +176,18 @@ startupProbe:
|
||||
successThreshold: 1
|
||||
|
||||
postSetup:
|
||||
# -- 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`.
|
||||
## 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`.
|
||||
scripts:
|
||||
{}
|
||||
# scriptName.sh: |
|
||||
# #!/bin/bash
|
||||
# echo "This is a script that gets executed in the Zulip container after installation, once migrations are complete"
|
||||
# echo "This script is executed in the Zulip container after installation/migrations."
|
||||
|
||||
# -- You can add any sidecar to Zulip, like a minio client to use for
|
||||
# uploading backups to a bucket, and mounting the volume for Zulip.
|
||||
## You can add any sidecar to Zulip, like a minio client to use for
|
||||
## uploading backups to a bucket, and mounting the volume for Zulip.
|
||||
# sidecars:
|
||||
# - image: minio/mc
|
||||
# name: minio-client
|
||||
@@ -190,12 +197,12 @@ postSetup:
|
||||
sidecars:
|
||||
[]
|
||||
|
||||
# -- PostgreSQL settings, see [Requirements](#Requirements).
|
||||
## PostgreSQL settings, see [Requirements](#Requirements).
|
||||
postgresql:
|
||||
primary:
|
||||
containerSecurityContext:
|
||||
runAsUser: 0
|
||||
# We need to override the Postgresql image to get all the plugins Zulip needs
|
||||
## We need to override the Postgresql image to get all the plugins Zulip needs
|
||||
image:
|
||||
repository: zulip/zulip-postgresql
|
||||
tag: 14
|
||||
@@ -203,19 +210,19 @@ postgresql:
|
||||
username: zulip
|
||||
database: zulip
|
||||
|
||||
# -- Rabbitmq settings, see [Requirements](#Requirements).
|
||||
## Rabbitmq settings, see [Requirements](#Requirements).
|
||||
rabbitmq:
|
||||
auth:
|
||||
username: zulip
|
||||
# Set this to true if you need the rabbitmq to be persistent
|
||||
## Set this to true if you need the rabbitmq to be persistent
|
||||
persistence:
|
||||
enabled: false
|
||||
|
||||
# -- Memcached settings, see [Requirements](#Requirements).
|
||||
## Memcached settings, see [Requirements](#Requirements).
|
||||
memcached:
|
||||
memcachedUsername: "zulip@localhost"
|
||||
|
||||
# -- Redis settings, see [Requirements](#Requirements).
|
||||
## Redis settings, see [Requirements](#Requirements).
|
||||
redis:
|
||||
architecture: standalone
|
||||
master:
|
||||
|
||||
@@ -92,7 +92,8 @@ spec:
|
||||
cpu: 100m
|
||||
memory: 3584Mi
|
||||
env:
|
||||
# Please take a look at the environment variables in docker-compose.yml for all required env variables!
|
||||
## Please take a look at the environment variables in
|
||||
## docker-compose.yml for all required env variables!
|
||||
- name: DB_HOST
|
||||
value: "localhost"
|
||||
- name: MEMCACHED_HOST
|
||||
@@ -110,7 +111,7 @@ spec:
|
||||
- name: SETTING_ZULIP_ADMINISTRATOR
|
||||
value: "admin@example.com"
|
||||
- name: SETTING_EMAIL_HOST
|
||||
value: "" # E.g. 'smtp.example.com'
|
||||
value: ""
|
||||
- name: SETTING_EMAIL_HOST_USER
|
||||
value: "noreply@example.com"
|
||||
- name: ZULIP_USER_EMAIL
|
||||
@@ -121,7 +122,7 @@ spec:
|
||||
value: "123456789"
|
||||
- name: SECRETS_secret_key
|
||||
value: "REPLCAE_WITH_SECURE_SECRET_KEY"
|
||||
# These should match the passwords configured above
|
||||
## These should match the passwords configured above
|
||||
- name: SECRETS_postgres_password
|
||||
value: "REPLACE_WITH_SECURE_POSTGRES_PASSWORD"
|
||||
- name: SECRETS_memcached_password
|
||||
@@ -132,7 +133,7 @@ spec:
|
||||
value: "REPLACE_WITH_SECURE_REDIS_PASSWORD"
|
||||
- name: SSL_CERTIFICATE_GENERATION
|
||||
value: "self-signed"
|
||||
# Uncomment this when configuring the mobile push notifications service
|
||||
## Uncomment this when configuring the mobile push notifications service
|
||||
# - name: SETTING_PUSH_NOTIFICATION_BOUNCER_URL
|
||||
# value: 'https://push.zulipchat.com'
|
||||
ports:
|
||||
|
||||
Reference in New Issue
Block a user