From 6342a4dabd7a2efd7f1ae9c233fab442cccadfcd Mon Sep 17 00:00:00 2001 From: luhahn Date: Tue, 13 Jul 2021 01:33:38 +0800 Subject: [PATCH] Document breaking changes (#202) Documented some breaking changes. Please have a look and tell me, if I missed something :) Fixes: #194 Co-authored-by: Lucas Hahn Reviewed-on: https://gitea.com/gitea/helm-chart/pulls/202 Reviewed-by: justusbunsi Reviewed-by: Lunny Xiao Co-authored-by: luhahn Co-committed-by: luhahn --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/README.md b/README.md index 50024d2..0655de0 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,62 @@ Dependencies: * Helm 3.0+ * PV provisioner for persistent data support +## Chart upgrade from 3.x.x to 4.0.0 + +:warning: The most recent 4.0.0 update brings some breaking changes. Please note the following changes in the Chart to upgrade successfully. :warning: + +### Ingress changes + +To provide a more flexible Ingress configuration we now support not only host settings but also provide configuration for the path and pathType. So this change changes the hosts from a simple string list, to a list containing a more complex object for more configuration. + + +```diff +ingress: + enabled: false + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" +- hosts: +- - git.example.com ++ hosts: ++ - host: git.example.com ++ paths: ++ - path: / ++ pathType: Prefix + tls: [] + # - secretName: chart-example-tls + # hosts: + # - git.example.com +``` + +If you want everything as it was before, you can simply add the following code to all your host entries. + +```yaml +paths: + - path: / + pathType: Prefix +``` + +### Dropped kebab-case support + +In 3.x.x it was possible to provide an ldap configuration via kebab-case, this support has now been dropped and only camel case is supported. +See [LDAP section](#ldap-settings) for more information. + +### Dependency update + +The chart comes with multiple databases and memcached as dependency, the latest release updated the dependencies. + +- memcached: 4.2.20 -> 5.9.0 +- postgresql: 9.7.2 -> 10.3.17 +- mariadb: 8.0.0 -> 9.3.6 + +If you're using the builtin databases you will most likely redeploy the chart in order to update the database correctly. + +### Execution of initPreScript + +Generally spoken, this might not be a breaking change, but it is worth to be mentioned. +Prior to 4.0.0 only one init container was used to both setup directories and configure Gitea. As of now the actual Gitea configuration is separated from the other pre-execution. This also includes the execution of _initPreScript_. If you have such script, please be aware of this. Dynamically prepare the Gitea setup during execution by e.g. adding environment variables to the execution context won't work anymore. + ## Gitea Version 1.14.X repository ROOT Previously the ROOT folder for the gitea repositories was located at /data/git/gitea-repositories