From ddc96939160bbfbb374f139555d7b9a96a029530 Mon Sep 17 00:00:00 2001 From: auricom Date: Tue, 16 Mar 2021 12:25:26 +0100 Subject: [PATCH] [joplin-server] new chart (#678) * [joplin-server] new chart * fix --- charts/joplin-server/.helmignore | 26 ++++ charts/joplin-server/Chart.yaml | 21 +++ charts/joplin-server/README.md | 105 +++++++++++++ charts/joplin-server/README.md.gotmpl | 145 ++++++++++++++++++ .../joplin-server/README_CHANGELOG.md.gotmpl | 12 ++ charts/joplin-server/README_CONFIG.md.gotmpl | 9 ++ charts/joplin-server/templates/NOTES.txt | 1 + charts/joplin-server/templates/common.yaml | 1 + charts/joplin-server/values.yaml | 56 +++++++ 9 files changed, 376 insertions(+) create mode 100644 charts/joplin-server/.helmignore create mode 100644 charts/joplin-server/Chart.yaml create mode 100644 charts/joplin-server/README.md create mode 100644 charts/joplin-server/README.md.gotmpl create mode 100644 charts/joplin-server/README_CHANGELOG.md.gotmpl create mode 100644 charts/joplin-server/README_CONFIG.md.gotmpl create mode 100644 charts/joplin-server/templates/NOTES.txt create mode 100644 charts/joplin-server/templates/common.yaml create mode 100644 charts/joplin-server/values.yaml diff --git a/charts/joplin-server/.helmignore b/charts/joplin-server/.helmignore new file mode 100644 index 00000000..2a482c10 --- /dev/null +++ b/charts/joplin-server/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl \ No newline at end of file diff --git a/charts/joplin-server/Chart.yaml b/charts/joplin-server/Chart.yaml new file mode 100644 index 00000000..eeb90e6a --- /dev/null +++ b/charts/joplin-server/Chart.yaml @@ -0,0 +1,21 @@ +apiVersion: v2 +appVersion: 1.7.2 +description: This server allows you to sync any Joplin client +name: joplin-server +version: 1.0.0 +keywords: + - joplin + - notes +home: https://github.com/k8s-at-home/charts/tree/master/charts/jopplin-server +icon: https://raw.githubusercontent.com/laurent22/joplin/master/Assets/LinuxIcons/256x256.png?raw=true +sources: + - https://github.com/laurent22/joplin/tree/dev/packages/server + - https://github.com/laurent22/joplin + - https://hub.docker.com/r/joplin/server +maintainers: + - name: auricom + email: k8s-at-home@xpander.eml.cc +dependencies: + - name: common + repository: https://library-charts.k8s-at-home.com + version: 1.0.0 diff --git a/charts/joplin-server/README.md b/charts/joplin-server/README.md new file mode 100644 index 00000000..4f56c783 --- /dev/null +++ b/charts/joplin-server/README.md @@ -0,0 +1,105 @@ +# joplin-server + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.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 + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** + +## Source Code + +* +* +* + +## Requirements + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.k8s-at-home.com | common | 1.0.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install joplin-server k8s-at-home/joplin-server +``` + +## Installing the Chart + +To install the chart with the release name `joplin-server` + +```console +helm install joplin-server k8s-at-home/joplin-server +``` + +## Uninstalling the Chart + +To uninstall the `joplin-server` deployment + +```console +helm uninstall joplin-server +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install joplin-server \ + --set env.TZ="America/New York" \ + k8s-at-home/joplin-server +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install joplin-server k8s-at-home/joplin-server -f values.yaml +``` + +## Custom configuration + +N/A + +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity settings for pod assignment of the GUI | +| 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 | int | `22300` | Kubernetes port where the GUI is exposed | +| service.type | string | `"ClusterIP"` | Kubernetes service type for the GUI | +| tolerations | list | `[]` | Toleration labels for pod assignment of the GUI | + +## Changelog + +All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +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). + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/joplin-server/README.md.gotmpl b/charts/joplin-server/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/joplin-server/README.md.gotmpl @@ -0,0 +1,145 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "chart.sourcesSection" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} diff --git a/charts/joplin-server/README_CHANGELOG.md.gotmpl b/charts/joplin-server/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..99310a72 --- /dev/null +++ b/charts/joplin-server/README_CHANGELOG.md.gotmpl @@ -0,0 +1,12 @@ +{{- define "custom.changelog.header" -}} +## Changelog +{{- end -}} + +{{- define "custom.changelog" -}} +{{ template "custom.changelog.header" . }} + +All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog). + +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). + +{{- end -}} diff --git a/charts/joplin-server/README_CONFIG.md.gotmpl b/charts/joplin-server/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/joplin-server/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/joplin-server/templates/NOTES.txt b/charts/joplin-server/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/joplin-server/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/joplin-server/templates/common.yaml b/charts/joplin-server/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/joplin-server/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/joplin-server/values.yaml b/charts/joplin-server/values.yaml new file mode 100644 index 00000000..d45928cd --- /dev/null +++ b/charts/joplin-server/values.yaml @@ -0,0 +1,56 @@ +# Default values for joplin-server. + +image: + # -- joplin-server image + repository: joplin/server + # -- joplin-server image tag + tag: 1.7.2 + # joplin-server 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 + +env: + # -- 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 + # -- Postgres DB Host + # POSTGRES_HOST : db + # -- Postgres DB port + # POSTGRES_PORT : 5432 + # -- Postgres DB name + # POSTGRES_DATABASE : joplin + # -- Postgres DB Username + # POSTGRES_USER : joplin + # -- Postgres DB password + # POSTGRES_PASSWORD : password + +# -- Node labels for pod assignment of the GUI +nodeSelector: {} + +# -- Toleration labels for pod assignment of the GUI +tolerations: [] + +# -- Affinity settings for pod assignment of the GUI +affinity: {} + +# -- Pod annotations +podAnnotations: {}