From 5cba3de4cf2ce12d225ba530ee21374c9f671c5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=E1=B4=87=CA=80=C9=B4=E1=B4=85=20S=E1=B4=84=CA=9C?= =?UTF-8?q?=E1=B4=8F=CA=80=C9=A2=E1=B4=87=CA=80s?= Date: Wed, 16 Jun 2021 21:18:54 +0200 Subject: [PATCH] [joplin-server] Migrate to common v3 (#1016) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * [joplin-server] Migrate to common v3 Signed-off-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs * Revert image tag change Signed-off-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs --- charts/stable/joplin-server/Chart.yaml | 8 +- charts/stable/joplin-server/README.md | 55 ++++++++++--- .../joplin-server/README_CHANGELOG.md.gotmpl | 26 +++++++ charts/stable/joplin-server/values.yaml | 78 ++++++++++--------- 4 files changed, 118 insertions(+), 49 deletions(-) diff --git a/charts/stable/joplin-server/Chart.yaml b/charts/stable/joplin-server/Chart.yaml index d97d2f61..7ecd6abd 100644 --- a/charts/stable/joplin-server/Chart.yaml +++ b/charts/stable/joplin-server/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: 1.7.2 description: This server allows you to sync any Joplin client name: joplin-server -version: 2.4.0 +version: 3.0.0 keywords: - joplin - notes @@ -18,4 +18,8 @@ maintainers: dependencies: - name: common repository: https://library-charts.k8s-at-home.com - version: 2.5.0 + version: 3.1.1 + - name: postgresql + version: 10.4.9 + repository: https://charts.bitnami.com/bitnami + condition: postgresql.enabled diff --git a/charts/stable/joplin-server/README.md b/charts/stable/joplin-server/README.md index de9f5a1d..c565d80c 100644 --- a/charts/stable/joplin-server/README.md +++ b/charts/stable/joplin-server/README.md @@ -1,6 +1,6 @@ # joplin-server -![Version: 2.4.0](https://img.shields.io/badge/Version-2.4.0-informational?style=flat-square) ![AppVersion: 1.7.2](https://img.shields.io/badge/AppVersion-1.7.2-informational?style=flat-square) +![Version: 3.0.0](https://img.shields.io/badge/Version-3.0.0-informational?style=flat-square) ![AppVersion: 1.7.2](https://img.shields.io/badge/AppVersion-1.7.2-informational?style=flat-square) This server allows you to sync any Joplin client @@ -18,7 +18,8 @@ This server allows you to sync any Joplin client | Repository | Name | Version | |------------|------|---------| -| https://library-charts.k8s-at-home.com | common | 2.5.0 | +| https://charts.bitnami.com/bitnami | postgresql | 10.4.9 | +| https://library-charts.k8s-at-home.com | common | 3.1.1 | ## TL;DR @@ -75,17 +76,22 @@ N/A | Key | Type | Default | Description | |-----|------|---------|-------------| -| affinity | object | `{}` | Affinity settings for pod assignment of the GUI | +| env | object | See below | environment variables. See [image docs](https://github.com/laurent22/joplin) for more details. | | env.APP_BASE_URL | string | `"https://joplin.domain"` | joplin-server base URL | | env.APP_PORT | int | `22300` | joplin-server listening port (same as Service port) | -| image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"joplin/server"` | joplin-server image | -| image.tag | string | `"1.7.2"` | joplin-server image tag | -| nodeSelector | object | `{}` | Node labels for pod assignment of the GUI | -| podAnnotations | object | `{}` | Pod annotations | -| resources | object | `{}` | | -| service.port.port | int | `22300` | Kubernetes port where the GUI is exposed | -| tolerations | list | `[]` | Toleration labels for pod assignment of the GUI | +| env.DB_CLIENT | string | `nil` | Use pg for postgres | +| env.POSTGRES_DATABASE | string | `nil` | Postgres DB name | +| env.POSTGRES_HOST | string | `nil` | Postgres DB Host | +| env.POSTGRES_PASSWORD | string | `nil` | Postgres DB password | +| env.POSTGRES_PORT | string | `nil` | Postgres DB port | +| env.POSTGRES_USER | string | `nil` | Postgres DB Username | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"joplin/server"` | image repository | +| image.tag | string | `"1.7.2"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| postgresql | object | See values.yaml | Enable and configure postgresql database subchart under this key. For more options see [postgresql chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) | +| service | object | See values.yaml | Configures service settings for the chart. | ## Changelog @@ -93,6 +99,33 @@ All notable changes to this application Helm chart will be documented in this fi The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +### [3.0.0] + +#### Added + +- Added support for installing a postgresql database along with this chart. + +#### Changed + +- **BREAKING**: Upgraded the common library dependency to version 3.1.1. This introduces several breaking changes (`service`, `ingress` and `persistence` keys have been refactored). + Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-3.1.1/charts/stable/common/) for the up-to-date values. + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 + ## Support - See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) diff --git a/charts/stable/joplin-server/README_CHANGELOG.md.gotmpl b/charts/stable/joplin-server/README_CHANGELOG.md.gotmpl index 91bbd3c1..d6f86174 100644 --- a/charts/stable/joplin-server/README_CHANGELOG.md.gotmpl +++ b/charts/stable/joplin-server/README_CHANGELOG.md.gotmpl @@ -9,4 +9,30 @@ All notable changes to this application Helm chart will be documented in this fi The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +### [3.0.0] + +#### Added + +- Added support for installing a postgresql database along with this chart. + +#### Changed + +- **BREAKING**: Upgraded the common library dependency to version 3.1.1. This introduces several breaking changes (`service`, `ingress` and `persistence` keys have been refactored). + Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-3.1.1/charts/stable/common/) for the up-to-date values. + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 {{- end -}} diff --git a/charts/stable/joplin-server/values.yaml b/charts/stable/joplin-server/values.yaml index d45928cd..fe162185 100644 --- a/charts/stable/joplin-server/values.yaml +++ b/charts/stable/joplin-server/values.yaml @@ -1,56 +1,62 @@ -# Default values for joplin-server. +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml +# image: - # -- joplin-server image + # -- image repository repository: joplin/server - # -- joplin-server image tag + # -- image tag tag: 1.7.2 - # joplin-server image pull policy + # -- image pull policy pullPolicy: IfNotPresent -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 - # requests: - # cpu: 100m - # memory: 128Mi - -service: - port: - # -- Kubernetes port where the GUI is exposed - port: 22300 - +# -- environment variables. See [image docs](https://github.com/laurent22/joplin) for more details. +# @default -- See below env: + # -- Set the container timezone + TZ: UTC # -- joplin-server base URL APP_BASE_URL: https://joplin.domain # -- joplin-server listening port (same as Service port) APP_PORT: 22300 # -- Use pg for postgres - # DB_CLIENT : pg + DB_CLIENT: # pg # -- Postgres DB Host - # POSTGRES_HOST : db + POSTGRES_HOST: # joplin-postgresql # -- Postgres DB port - # POSTGRES_PORT : 5432 + POSTGRES_PORT: # 5432 # -- Postgres DB name - # POSTGRES_DATABASE : joplin + POSTGRES_DATABASE: # joplin # -- Postgres DB Username - # POSTGRES_USER : joplin + POSTGRES_USER: # joplin # -- Postgres DB password - # POSTGRES_PASSWORD : password + POSTGRES_PASSWORD: # joplin-pass -# -- Node labels for pod assignment of the GUI -nodeSelector: {} +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 22300 -# -- Toleration labels for pod assignment of the GUI -tolerations: [] +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false -# -- Affinity settings for pod assignment of the GUI -affinity: {} - -# -- Pod annotations -podAnnotations: {} +# -- Enable and configure postgresql database subchart under this key. +# For more options see [postgresql chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) +# @default -- See values.yaml +postgresql: + enabled: false + postgresqlUsername: joplin + postgresqlPassword: joplin-pass + postgresqlDatabase: joplin + persistence: + enabled: false + # storageClass: ""