paulmataruso/docker-zulip
1
0
Fork 0
mirror of https://github.com/zulip/docker-zulip.git synced 2025-10-30 19:43:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

yaml: Use consistent comment styling.

Browse Source 
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
2024-11-19 11:46:05 -08:00
parent 14b1f0b49e
commit bbbbbd139c
3 changed files with 99 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
kubernetes/chart/zulip/Chart.yaml
View File

@@ -3,15 +3,17 @@ description: Zulip is an open source threaded team chat that helps teams stay pr
name: zulip name: zulip
type: application type: application
icon: https://raw.githubusercontent.com/zulip/zulip/main/static/images/logo/zulip-icon-square.svg 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 ## This is the chart version. This version number should be
# to the chart and its templates, including the app version. ## incremented each time you make changes to the chart and its
# Versions are expected to follow Semantic Versioning (https://semver.org/) ## templates, including the app version. Versions are expected to
## follow Semantic Versioning (https://semver.org/)
version: 0.9.20 version: 0.9.20
# This is the version number of the application being deployed. This version number should be ## This is the version number of the application being deployed. This
# incremented each time you make changes to the application. Versions are not expected to ## version number should be incremented each time you make changes to
# follow Semantic Versioning. They should reflect the version the application is using. ## the application. Versions are not expected to follow Semantic
# It is recommended to use it with quotes. ## Versioning. They should reflect the version the application is
## using. It is recommended to use it with quotes.
appVersion: "9.2-0" appVersion: "9.2-0"
dependencies: dependencies:
- name: memcached - name: memcached
@@ -33,7 +35,7 @@ dependencies:
repository: oci://registry-1.docker.io/bitnamicharts repository: oci://registry-1.docker.io/bitnamicharts
tags: tags:
- postgresql - 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 version: 15.5.32
sources: sources:

161
kubernetes/chart/zulip/values.yaml
View File

@@ -1,59 +1,61 @@
# Default values for zulip. ## Default values for zulip.
# This is a YAML-formatted file. ## 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 ## Declare variables to be passed into your templates.
# with: ## 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 ## ```
# ``` ## docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
## ```
image: 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 repository: zulip/docker-zulip
# -- Pull policy for Zulip docker image. ## Pull policy for Zulip docker image.
# Ref: https://kubernetes.io/docs/user-guide/images/#pre-pulling-images ## Ref: https://kubernetes.io/docs/user-guide/images/#pre-pulling-images
pullPolicy: IfNotPresent pullPolicy: IfNotPresent
# -- Zulip image tag (immutable tags are recommended) ## Zulip image tag (immutable tags are recommended)
tag: "9.2-0" tag: "9.2-0"
# -- Global Docker registry secret names as an array. ## Global Docker registry secret names as an array.
imagePullSecrets: [] imagePullSecrets: []
# -- Partially override common.names.fullname template (will maintain the release name). ## Partially override common.names.fullname template (will maintain the release name).
nameOverride: "" nameOverride: ""
# -- Fully override common.names.fullname template. ## Fully override common.names.fullname template.
fullnameOverride: "" fullnameOverride: ""
serviceAccount: serviceAccount:
# -- Specifies whether a service account should be created. ## Specifies whether a service account should be created.
create: true create: true
# -- Annotations to add to the service account. ## Annotations to add to the service account.
annotations: {} annotations: {}
# -- The name of the service account to use. ## The name of the service account to use.
# If not set and create is true, a name is generated using the fullname template ## If not set and create is true, a name is generated using the fullname template
name: "" name: ""
# -- Custom labels to add to the Zulip StatefulSet. ## Custom labels to add to the Zulip StatefulSet.
statefulSetLabels: {} statefulSetLabels: {}
# -- Custom annotations to add to the Zulip StatefulSet. ## Custom annotations to add to the Zulip StatefulSet.
statefulSetAnnotations: {} statefulSetAnnotations: {}
# -- Custom labels to add to the Zulip Pod. ## Custom labels to add to the Zulip Pod.
podLabels: {} podLabels: {}
# -- Custom annotations to add to the Zulip Pod. ## Custom annotations to add to the Zulip Pod.
podAnnotations: {} podAnnotations: {}
# -- Can be used to override the default PodSecurityContext (fsGroup, runAsUser ## Can be used to override the default PodSecurityContext (fsGroup,
# and runAsGroup) of the Zulip _Pod_. ## runAsUser and runAsGroup) of the Zulip _Pod_.
podSecurityContext: podSecurityContext:
{} {}
# fsGroup: 1000 # fsGroup: 1000
# runAsUser: 1000 # runAsUser: 1000
# runAsGroup: 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: securityContext:
{} {}
# capabilities: # capabilities:
@@ -63,30 +65,31 @@ securityContext:
# runAsNonRoot: true # runAsNonRoot: true
# runAsUser: 1000 # runAsUser: 1000
# -- Service type and port for the Kubernetes service that connects to Zulip. ## Service type and port for the Kubernetes service that connects to
# Default: ClusterIP, needs an Ingress to be used. ## Zulip. Default of ClusterIP needs an Ingress to be used.
service: service:
type: ClusterIP type: ClusterIP
port: 80 port: 80
ingress: 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 enabled: false
# -- Can be used to add custom Ingress annotations. ## Can be used to add custom Ingress annotations.
annotations: annotations:
{} {}
# kubernetes.io/ingress.class: nginx # kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true" # kubernetes.io/tls-acme: "true"
hosts: hosts:
# -- Host for the Ingress. Should be the same as ## Host for the Ingress. Should be the same as
# `zulip.environment.SETTING_EXTERNAL_HOST`. ## `zulip.environment.SETTING_EXTERNAL_HOST`.
- host: zulip.example.com - host: zulip.example.com
# -- Serves Zulip root of the chosen host domain. ## Serves Zulip root of the chosen host domain.
paths: paths:
- path: / - path: /
# -- Set a specific secret to read the TLS certificate from. If you use ## Set a specific secret to read the TLS certificate from. If you
# cert-manager, it will save the TLS secret here. If you do not, you need to ## use cert-manager, it will save the TLS secret here. If you do
# manually create a secret with your TLS certificate. ## not, you need to manually create a secret with your TLS
## certificate.
tls: [] tls: []
# - secretName: chart-example-tls # - secretName: chart-example-tls
# hosts: # hosts:
@@ -94,10 +97,12 @@ ingress:
resources: resources:
{} {}
# We usually recommend not to specify default resources and to leave this as a conscious ## We usually recommend not to specify default resources and to
# choice for the user. This also increases chances charts run on environments with little ## leave this as a conscious choice for the user. This also
# resources, such as Minikube. If you do want to specify resources, uncomment the following ## increases chances charts run on environments with little
# lines, adjust them as necessary, and remove the curly braces after 'resources:'. ## 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: # limits:
# cpu: 100m # cpu: 100m
# memory: 128Mi # memory: 128Mi
@@ -105,32 +110,33 @@ resources:
# cpu: 100m # cpu: 100m
# memory: 128Mi # memory: 128Mi
# -- Optionally add a nodeSelector to the Zulip pod, so it runs on a specific ## Optionally add a nodeSelector to the Zulip pod, so it runs on a specific
# node. ## node.
# Ref: https://kubernetes.io/docs/user-guide/node-selection/ ## Ref: https://kubernetes.io/docs/user-guide/node-selection/
nodeSelector: {} nodeSelector: {}
# -- Tolerations for pod assignment. ## Tolerations for pod assignment.
# Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ ## Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
tolerations: [] tolerations: []
# -- Affinity for pod assignment. ## Affinity for pod assignment.
# Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity ## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
affinity: {} affinity: {}
zulip: 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: environment:
# -- Disables HTTPS if set to "true". ## Disable the default Zulip requirement of HTTPS. HTTPS and
# HTTPS and certificates are managed by the Kubernetes cluster, so ## certificates are managed by the Kubernetes cluster, so by
# by default it's disabled inside the container ## default it's disabled inside the container.
DISABLE_HTTPS: true DISABLE_HTTPS: true
# -- Set SSL certificate generation to self-signed because Kubernetes ## Set SSL certificate generation to self-signed because
# manages the client-facing SSL certs. ## Kubernetes manages the client-facing SSL certs.
SSL_CERTIFICATE_GENERATION: self-signed SSL_CERTIFICATE_GENERATION: self-signed
# -- Domain Zulip is hosted on. ## Domain Zulip is hosted on.
SETTING_EXTERNAL_HOST: zulip.example.com SETTING_EXTERNAL_HOST: zulip.example.com
# -- SMTP email password. ## SMTP email password.
SECRETS_email_password: "123456789" SECRETS_email_password: "123456789"
SETTING_ZULIP_ADMINISTRATOR: "admin@example.com" SETTING_ZULIP_ADMINISTRATOR: "admin@example.com"
SETTING_EMAIL_HOST: "" # e.g. smtp.example.com SETTING_EMAIL_HOST: "" # e.g. smtp.example.com
@@ -139,18 +145,19 @@ zulip:
SETTING_EMAIL_USE_SSL: "False" SETTING_EMAIL_USE_SSL: "False"
SETTING_EMAIL_USE_TLS: "True" SETTING_EMAIL_USE_TLS: "True"
ZULIP_AUTH_BACKENDS: "EmailAuthBackend" ZULIP_AUTH_BACKENDS: "EmailAuthBackend"
# -- If `persistence.existingClaim` is not set, a PVC is generated with these ## If `persistence.existingClaim` is not set, a PVC (Persistent
# specifications. ## Volume Claim) is generated with these specifications.
persistence: persistence:
enabled: true enabled: true
accessMode: ReadWriteOnce accessMode: ReadWriteOnce
size: 10Gi size: 10Gi
# -- Set storageClass to use. ## Set storageClass to use.
storageClass: storageClass:
# existingClaim: "" # Use an already existing PVC ## Use an already existing PVC
# existingClaim: ""
# -- Liveness probe values. ## Liveness probe values.
# Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes ## Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
livenessProbe: livenessProbe:
enabled: true enabled: true
initialDelaySeconds: 10 initialDelaySeconds: 10
@@ -158,8 +165,8 @@ livenessProbe:
timeoutSeconds: 5 timeoutSeconds: 5
failureThreshold: 3 failureThreshold: 3
successThreshold: 1 successThreshold: 1
# -- Startup probe values. ## Startup probe values.
# Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes ## Ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
startupProbe: startupProbe:
enabled: true enabled: true
initialDelaySeconds: 10 initialDelaySeconds: 10
@@ -169,18 +176,18 @@ startupProbe:
successThreshold: 1 successThreshold: 1
postSetup: postSetup:
# -- The Docker entrypoint script runs commands from `/data/post-setup.d` after ## 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 ## the Zulip application's Setup phase has completed. Scripts can be added here
# as `script_filename: <script contents>` and they will be mounted in ## as `script_filename: <script contents>` and they will be mounted in
# `/data/post-setup.d/script_filename`. ## `/data/post-setup.d/script_filename`.
scripts: scripts:
{} {}
# scriptName.sh: | # scriptName.sh: |
# #!/bin/bash # #!/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 ## 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. ## uploading backups to a bucket, and mounting the volume for Zulip.
# sidecars: # sidecars:
# - image: minio/mc # - image: minio/mc
# name: minio-client # name: minio-client
@@ -190,12 +197,12 @@ postSetup:
sidecars: sidecars:
[] []
# -- PostgreSQL settings, see [Requirements](#Requirements). ## PostgreSQL settings, see [Requirements](#Requirements).
postgresql: postgresql:
primary: primary:
containerSecurityContext: containerSecurityContext:
runAsUser: 0 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: image:
repository: zulip/zulip-postgresql repository: zulip/zulip-postgresql
tag: 14 tag: 14
@@ -203,19 +210,19 @@ postgresql:
username: zulip username: zulip
database: zulip database: zulip
# -- Rabbitmq settings, see [Requirements](#Requirements). ## Rabbitmq settings, see [Requirements](#Requirements).
rabbitmq: rabbitmq:
auth: auth:
username: zulip 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: persistence:
enabled: false enabled: false
# -- Memcached settings, see [Requirements](#Requirements). ## Memcached settings, see [Requirements](#Requirements).
memcached: memcached:
memcachedUsername: "zulip@localhost" memcachedUsername: "zulip@localhost"
# -- Redis settings, see [Requirements](#Requirements). ## Redis settings, see [Requirements](#Requirements).
redis: redis:
architecture: standalone architecture: standalone
master: master:

9
kubernetes/manual/zulip-rc.yml
View File

@@ -92,7 +92,8 @@ spec:
cpu: 100m cpu: 100m
memory: 3584Mi memory: 3584Mi
env: 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 - name: DB_HOST
value: "localhost" value: "localhost"
- name: MEMCACHED_HOST - name: MEMCACHED_HOST
@@ -110,7 +111,7 @@ spec:
- name: SETTING_ZULIP_ADMINISTRATOR - name: SETTING_ZULIP_ADMINISTRATOR
value: "admin@example.com" value: "admin@example.com"
- name: SETTING_EMAIL_HOST - name: SETTING_EMAIL_HOST
value: "" # E.g. 'smtp.example.com' value: ""
- name: SETTING_EMAIL_HOST_USER - name: SETTING_EMAIL_HOST_USER
value: "noreply@example.com" value: "noreply@example.com"
- name: ZULIP_USER_EMAIL - name: ZULIP_USER_EMAIL
@@ -121,7 +122,7 @@ spec:
value: "123456789" value: "123456789"
- name: SECRETS_secret_key - name: SECRETS_secret_key
value: "REPLCAE_WITH_SECURE_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 - name: SECRETS_postgres_password
value: "REPLACE_WITH_SECURE_POSTGRES_PASSWORD" value: "REPLACE_WITH_SECURE_POSTGRES_PASSWORD"
- name: SECRETS_memcached_password - name: SECRETS_memcached_password
@@ -132,7 +133,7 @@ spec:
value: "REPLACE_WITH_SECURE_REDIS_PASSWORD" value: "REPLACE_WITH_SECURE_REDIS_PASSWORD"
- name: SSL_CERTIFICATE_GENERATION - name: SSL_CERTIFICATE_GENERATION
value: "self-signed" 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 # - name: SETTING_PUSH_NOTIFICATION_BOUNCER_URL
# value: 'https://push.zulipchat.com' # value: 'https://push.zulipchat.com'
ports: ports: