Merge pull request #301 from ONLYOFFICE/release/v4.1.0

Merge Helm Chart release/v4.1.0 into master

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change log
 
+## 4.1.0
+
+### New Features
+
+* Added the ability set up annotations for all the deployed resources
+* Added the ability to disable  `PVC` creation when using the S3 storage
+
+### Changes
+
+* Using an already configured image for the `helm test` command
+* Released [v8.0.1](https://github.com/ONLYOFFICE/DocumentServer/blob/master/CHANGELOG.md#801) of ONLYOFFICE Docs
+
+### Fixes
+
+* Fixed a bug when adding multiline annotations to Ingress
+
 ## 4.0.0
 
 ### New Features

Chart.yaml

@@ -4,6 +4,6 @@ description: Helm chart for installing ONLYOFFICE Docs in Kubernetes
 
 type: application
 
-version: 4.0.0
+version: 4.1.0
 
-appVersion: 8.0.0
+appVersion: 8.0.1

sources/scripts/test_ds.py

@@ -37,6 +37,8 @@
 brokerPassword = os.environ.get('AMQP_PWD')
 brokerVhost = os.environ.get('AMQP_VHOST')
 
+storageS3 = os.environ.get('STORAGE_S3')
+
 total_result = {}
 
 
@@ -51,17 +53,7 @@ def init_logger(name):
     logger.info('Running a script to test the availability of DocumentServer and dependencies\n')
 
 
-def install_module(package):
-    try:
-        subprocess.check_call([sys.executable, '-m', 'pip', 'install', package],
-                              stdout=subprocess.DEVNULL,
-                              stderr=subprocess.STDOUT)
-    except Exception as msg_install_module:
-        logger_test_ds.error(f'Error when trying to install the "{package}" package... {msg_install_module}\n')
-
-
 def get_redis_status():
-    install_module('redis')
     import redis
     global rc
     try:
@@ -84,7 +76,6 @@ def get_redis_status():
 
 
 def get_redis_cluster_status():
-    install_module('redis')
     from redis.cluster import RedisCluster as Redis
     from redis.cluster import ClusterNode
     global rc
@@ -107,7 +98,6 @@ def get_redis_cluster_status():
 
 
 def get_redis_sentinel_status():
-    install_module('redis')
     import redis
     from redis import Sentinel
     global rc
@@ -161,7 +151,6 @@ def check_redis():
 
 
 def check_db_postgresql(tbl_dict):
-    install_module('psycopg2')
     import psycopg2
     try:
         dbc = psycopg2.connect(
@@ -196,7 +185,6 @@ def check_db_postgresql(tbl_dict):
 
 
 def check_db_mysql(tbl_dict):
-    install_module('pymysql')
     import pymysql
     try:
         dbc = pymysql.connect(
@@ -240,7 +228,6 @@ def check_db():
 
 
 def check_mq_rabbitmq():
-    install_module('pika')
     import pika
     try:
         mqp = pika.URLParameters(f'{brokerProto}://{brokerUser}:{brokerPassword}@{brokerHost}:{brokerPort}{brokerVhost}')
@@ -303,8 +290,6 @@ def check_mq():
     if brokerType == 'rabbitmq':
         check_mq_rabbitmq()
     elif brokerType == 'activemq':
-        install_module('python-qpid-proton')
-        install_module('func_timeout')
         from func_timeout import func_timeout, FunctionTimedOut
         try:
             activemq_return_status = func_timeout(15, check_mq_activemq)
@@ -316,11 +301,9 @@ def check_mq():
 def check_dir_access():
     logger_test_ds.info('Checking the availability of shared storage...')
     try:
-        add_group = ['groupadd', '-g', '1005', 'ds']
-        add_user = ['useradd', '-g', 'ds', '-u', '101', 'ds']
-        dir_create = ['su', 'ds', '-c', 'mkdir /ds/test/App_Data/cache/files/testds']
-        dir_delete = ['su', 'ds', '-c', 'rm -rf /ds/test/App_Data/cache/files/testds']
-        all_cmd = [add_group, add_user, dir_create, dir_delete]
+        dir_create = ['mkdir', '/ds/test/App_Data/cache/files/testds']
+        dir_delete = ['rm', '-rf', '/ds/test/App_Data/cache/files/testds']
+        all_cmd = [dir_create, dir_delete]
         all_status = []
         for cmd in all_cmd:
             process = subprocess.Popen(cmd)
@@ -341,7 +324,6 @@ def check_dir_access():
 
 
 def get_ds_status():
-    install_module('requests')
     import requests
     from requests.adapters import HTTPAdapter
     logger_test_ds.info('Checking DocumentServer availability...')
@@ -374,7 +356,8 @@ def total_status():
 check_redis()
 check_db()
 check_mq()
-check_dir_access()
+if storageS3 == 'false':
+    check_dir_access()
 get_ds_status()
 total_status()
 

sources/shutdown-ds.yaml

@@ -13,7 +13,7 @@ spec:
           defaultMode: 0755
       containers:
         - name: shutdown-ds
-          image: onlyoffice/docs-utils:8.0.0-1
+          image: onlyoffice/docs-utils:8.0.1-1
           command: ["/bin/sh", "-c"]
           args: ["/scripts/stop.sh"]
           volumeMounts:

templates/RBAC/dashboard-role.yaml

@@ -12,6 +12,9 @@ metadata:
     "helm.sh/hook": post-install,post-upgrade
     "helm.sh/hook-weight": "2"
     "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
+    {{- if .Values.commonAnnotations }}
+    {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+    {{- end }}
 rules:
 - apiGroups: [""]
   resources: ["configmaps"]

templates/RBAC/dashboard-rolebinding.yaml

@@ -12,6 +12,9 @@ metadata:
     "helm.sh/hook": post-install,post-upgrade
     "helm.sh/hook-weight": "3"
     "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
+    {{- if .Values.commonAnnotations }}
+    {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+    {{- end }}
 subjects:
 - kind: ServiceAccount
   name: dashboard-sa

templates/_helpers.tpl

@@ -386,6 +386,18 @@ Get the ds labels
 {{- end }}
 {{- end -}}
 
+{{/*
+Get the ds annotations
+*/}}
+{{- define "ds.annotations.commonAnnotations" -}}
+{{- $annotations := toYaml .keyName }}
+{{- if contains "{{" $annotations }}
+    {{- tpl $annotations .context }}
+{{- else }}
+    {{- $annotations }}
+{{- end }}
+{{- end -}}
+
 {{/*
 Get the ds Service Account name
 */}}

templates/configmaps/dashboard.yaml

@@ -12,6 +12,9 @@ metadata:
     "helm.sh/hook": post-install,post-upgrade
     "helm.sh/hook-weight": "4"
     "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
+    {{- if .Values.commonAnnotations }}
+    {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+    {{- end }}
 data:
   get_dashboard.sh: |-
     #!/bin/bash

templates/configmaps/documentserver.yaml

@@ -7,6 +7,9 @@ metadata:
   labels:
     {{- include "ds.labels.commonLabels" . | trim | nindent 4 }}
   {{- end }}
+  {{- if .Values.commonAnnotations }}
+  annotations: {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+  {{- end }}
 data:
   DB_TYPE: {{ template "ds.db.type" . }}
   DB_USER: {{ .Values.connections.dbUser }}

templates/configmaps/example.yaml

@@ -8,6 +8,9 @@ metadata:
   labels:
     {{- include "ds.labels.commonLabels" . | trim | nindent 4 }}
   {{- end }}
+  {{- if .Values.commonAnnotations }}
+  annotations: {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+  {{- end }}
 data:
   DS_URL: {{ include "ds.example.dsUrl" . }}
 {{- end }}

templates/configmaps/grafana.yaml

@@ -8,6 +8,9 @@ metadata:
   labels:
     {{- include "ds.labels.commonLabels" . | trim | nindent 4 }}
   {{- end }}
+  {{- if .Values.commonAnnotations }}
+  annotations: {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+  {{- end }}
 data:
   grafana.ini: |-
     [server]

templates/configmaps/pre-delete.yaml

@@ -12,6 +12,9 @@ metadata:
     "helm.sh/hook": pre-delete
     "helm.sh/hook-weight": "1"
     "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
+    {{- if .Values.commonAnnotations }}
+    {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+    {{- end }}
 data:
   stop.sh: |-
     #!/bin/bash
@@ -32,6 +35,7 @@ data:
       echo -e "\e[0;31m DB is not available \e[0m"
       exit 1
     fi
+    {{- if not .Values.persistence.storageS3 }}
     FILES_DIR=/var/lib/{{ .Values.product.name }}/documentserver/App_Data/cache/files/
     ls $FILES_DIR > /dev/null
     if [ $? -ne 0 ]; then
@@ -49,6 +53,7 @@ data:
           ;;
       esac
     done
+    {{- end }}
     if [[ "$PRIVATE_CLUSTER" != "true" ]]; then
       wget -O /scripts/{{ .Values.delete.existingConfigmap.tblRemove.keyName }} \
         {{- if eq .Values.connections.dbType "postgres" }}

templates/configmaps/pre-install.yaml

@@ -12,6 +12,9 @@ metadata:
     "helm.sh/hook": pre-install
     "helm.sh/hook-weight": "2"
     "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
+    {{- if .Values.commonAnnotations }}
+    {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+    {{- end }}
 data:
   initdb.sh: |-
     #!/bin/bash

templates/configmaps/pre-rollback.yaml

@@ -11,6 +11,9 @@ metadata:
   annotations:
     "helm.sh/hook": pre-rollback
     "helm.sh/hook-weight": "1"
+    {{- if .Values.commonAnnotations }}
+    {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+    {{- end }}
 data:
   stop.sh: |-
     #!/bin/bash
@@ -31,6 +34,7 @@ data:
       echo -e "\e[0;31m DB is not available \e[0m"
       exit 1
     fi
+    {{- if not .Values.persistence.storageS3 }}
     FILES_DIR=/var/lib/{{ .Values.product.name }}/documentserver/App_Data/cache/files/
     ls $FILES_DIR > /dev/null
     if [ $? -ne 0 ]; then
@@ -48,6 +52,7 @@ data:
           ;;
       esac
     done
+    {{- end }}
     if [[ "$PRIVATE_CLUSTER" != "true" ]]; then
       wget -O /scripts/{{ .Values.rollback.existingConfigmap.tblRemove.keyName }} \
         {{- if eq .Values.connections.dbType "postgres" }}

templates/configmaps/pre-upgrade.yaml

@@ -12,6 +12,9 @@ metadata:
     "helm.sh/hook": pre-upgrade
     "helm.sh/hook-weight": "1"
     "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
+    {{- if .Values.commonAnnotations }}
+    {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+    {{- end }}
 data:
   stop.sh: |-
     #!/bin/bash
@@ -36,6 +39,7 @@ data:
         echo -e "\e[0;31m DB is not available \e[0m"
         exit 1
       fi
+      {{- if not .Values.persistence.storageS3 }}
       FILES_DIR=/var/lib/{{ .Values.product.name }}/documentserver/App_Data/cache/files/
       ls $FILES_DIR > /dev/null
       if [ $? -ne 0 ]; then
@@ -53,6 +57,7 @@ data:
             ;;
         esac
       done
+      {{- end }}
       if [[ "$PRIVATE_CLUSTER" != "true" ]]; then
         wget -O /scripts/{{ .Values.upgrade.existingConfigmap.tblRemove.keyName }} \
           {{- if eq .Values.connections.dbType "postgres" }}

templates/configmaps/welcome-page.yaml

@@ -8,6 +8,9 @@ metadata:
   labels:
     {{- include "ds.labels.commonLabels" . | trim | nindent 4 }}
   {{- end }}
+  {{- if .Values.commonAnnotations }}
+  annotations: {{- include "ds.annotations.commonAnnotations" ( dict "keyName" .Values.commonAnnotations "context" $ ) | nindent 4 }}
+  {{- end }}
 data:
   ds-example.conf: |-
     location /example/ {

templates/deployments/converter.yaml

@@ -8,6 +8,10 @@ metadata:
     {{- if .Values.commonLabels }}
     {{- include "ds.labels.commonLabels" . | trim | nindent 4 }}
     {{- end }}
+  {{- if or .Values.commonAnnotations .Values.converter.annotations }}
+  {{- $dictValue := default .Values.commonAnnotations .Values.converter.annotations }}
+  annotations: {{- include "ds.annotations.commonAnnotations" ( dict "keyName" $dictValue "context" $ ) | nindent 4 }}
+  {{- end }}
 spec:
   {{- if not .Values.converter.autoscaling.enabled }}
   replicas: {{ .Values.converter.replicas }}
@@ -84,9 +88,11 @@ spec:
       - name: {{ .Values.imagePullSecrets }}
       {{- end }}
       volumes:
+        {{- if not .Values.persistence.storageS3 }}
         - name: ds-files
           persistentVolumeClaim:
             claimName: {{ template "ds.pvc.name" . }}
+        {{- end }}
         - name: ds-license
           {{- if .Values.license.existingClaim }}
           persistentVolumeClaim:
@@ -136,8 +142,10 @@ spec:
           - configMapRef:
               name: documentserver
           volumeMounts:
+          {{- if not .Values.persistence.storageS3 }}
           - name: ds-files
             mountPath: /var/lib/{{ .Values.product.name }}/documentserver/App_Data/cache/files
+          {{- end }}
           - name: ds-license
             mountPath: /var/www/{{ .Values.product.name }}/Data
             {{- if not .Values.license.existingClaim }}