From f3fb87f6081c5ae7626f037fdc86709bf30a51ea 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: Sun, 26 Sep 2021 16:00:14 +0200 Subject: [PATCH] [overleaf] New chart (#1212) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs --- charts/stable/overleaf/.helmignore | 26 ++++ charts/stable/overleaf/Chart.yaml | 28 ++++ charts/stable/overleaf/README.md | 124 +++++++++++++++ charts/stable/overleaf/README.md.gotmpl | 146 ++++++++++++++++++ .../overleaf/README_CHANGELOG.md.gotmpl | 27 ++++ .../stable/overleaf/README_CONFIG.md.gotmpl | 9 ++ charts/stable/overleaf/ci/ct-values.yaml | 15 ++ charts/stable/overleaf/templates/NOTES.txt | 1 + charts/stable/overleaf/templates/common.yaml | 1 + charts/stable/overleaf/values.yaml | 68 ++++++++ 10 files changed, 445 insertions(+) create mode 100644 charts/stable/overleaf/.helmignore create mode 100644 charts/stable/overleaf/Chart.yaml create mode 100644 charts/stable/overleaf/README.md create mode 100644 charts/stable/overleaf/README.md.gotmpl create mode 100644 charts/stable/overleaf/README_CHANGELOG.md.gotmpl create mode 100644 charts/stable/overleaf/README_CONFIG.md.gotmpl create mode 100644 charts/stable/overleaf/ci/ct-values.yaml create mode 100644 charts/stable/overleaf/templates/NOTES.txt create mode 100644 charts/stable/overleaf/templates/common.yaml create mode 100644 charts/stable/overleaf/values.yaml diff --git a/charts/stable/overleaf/.helmignore b/charts/stable/overleaf/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/overleaf/.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 diff --git a/charts/stable/overleaf/Chart.yaml b/charts/stable/overleaf/Chart.yaml new file mode 100644 index 00000000..c5776e10 --- /dev/null +++ b/charts/stable/overleaf/Chart.yaml @@ -0,0 +1,28 @@ +apiVersion: v2 +appVersion: 2.7.1 +description: A web-based collaborative LaTeX editor +name: overleaf +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- overleaf +- sharelatex +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/overleaf +icon: https://avatars.githubusercontent.com/u/6359919?s=200&v=4 +sources: +- https://github.com/overleaf/overleaf +maintainers: +- name: bjw-s + email: me@bjw-s.dev +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.0.1 +- name: redis + version: 14.8.11 + repository: https://charts.bitnami.com/bitnami + condition: redis.enabled +- name: mongodb + version: 10.25.1 + repository: https://charts.bitnami.com/bitnami + condition: mongodb.enabled diff --git a/charts/stable/overleaf/README.md b/charts/stable/overleaf/README.md new file mode 100644 index 00000000..d4b8ea0a --- /dev/null +++ b/charts/stable/overleaf/README.md @@ -0,0 +1,124 @@ +# overleaf + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 2.7.1](https://img.shields.io/badge/AppVersion-2.7.1-informational?style=flat-square) + +A web-based collaborative LaTeX editor + +**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 + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.bitnami.com/bitnami | mongodb | 10.25.1 | +| https://charts.bitnami.com/bitnami | redis | 14.8.11 | +| https://library-charts.k8s-at-home.com | common | 4.0.1 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install overleaf k8s-at-home/overleaf +``` + +## Installing the Chart + +To install the chart with the release name `overleaf` + +```console +helm install overleaf k8s-at-home/overleaf +``` + +## Uninstalling the Chart + +To uninstall the `overleaf` deployment + +```console +helm uninstall overleaf +``` + +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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install overleaf \ + --set env.TZ="America/New York" \ + k8s-at-home/overleaf +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install overleaf k8s-at-home/overleaf -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/library-charts/tree/main/charts/stable/common) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | See below | environment variables. See more environment variables in the [overleaf documentation](https://github.com/overleaf/overleaf/wiki/Configuring-Overleaf). | +| env.REDIS_HOST | string | `nil` | The host name of the Redis instance to use. (Both `SHARELATEX_REDIS_HOST` and `REDIS_HOST` are required) | +| env.SHARELATEX_MONGO_URL | string | `nil` | The URL of the Mongo database to use. | +| env.SHARELATEX_REDIS_HOST | string | `nil` | The host name of the Redis instance to use. (Both `SHARELATEX_REDIS_HOST` and `REDIS_HOST` are required) | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"sharelatex/sharelatex"` | image repository | +| image.tag | string | `"2.7.1"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| mongodb | object | See values.yaml | Enable and configure mongodb database subchart under this key. For more options see [mongodb chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/mongodb) | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | +| redis | object | See values.yaml | Enable and configure redis subchart under this key. For more options see [redis chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/redis) | +| service | object | See values.yaml | Configures service settings for the chart. | + +## 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/library-charts/tree/main/charts/stable/common#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). + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #100 + +## 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/stable/overleaf/README.md.gotmpl b/charts/stable/overleaf/README.md.gotmpl new file mode 100644 index 00000000..358abe31 --- /dev/null +++ b/charts/stable/overleaf/README.md.gotmpl @@ -0,0 +1,146 @@ +{{- 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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/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/library-charts/tree/main/charts/stable/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/stable/overleaf/README_CHANGELOG.md.gotmpl b/charts/stable/overleaf/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..06ad5fb3 --- /dev/null +++ b/charts/stable/overleaf/README_CHANGELOG.md.gotmpl @@ -0,0 +1,27 @@ +{{- 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/library-charts/tree/main/charts/stable/common#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). + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #100 +{{- end -}} diff --git a/charts/stable/overleaf/README_CONFIG.md.gotmpl b/charts/stable/overleaf/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/overleaf/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/stable/overleaf/ci/ct-values.yaml b/charts/stable/overleaf/ci/ct-values.yaml new file mode 100644 index 00000000..d81f0b36 --- /dev/null +++ b/charts/stable/overleaf/ci/ct-values.yaml @@ -0,0 +1,15 @@ +--- +env: + SHARELATEX_REDIS_HOST: overleaf-redis-master + REDIS_HOST: overleaf-redis-master + SHARELATEX_MONGO_URL: mongodb://overleaf-mongodb:27017/sharelatex + +redis: + enabled: true + fullnameOverride: overleaf-redis + replica: + replicaCount: 1 + +mongodb: + enabled: true + fullnameOverride: overleaf-mongodb diff --git a/charts/stable/overleaf/templates/NOTES.txt b/charts/stable/overleaf/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/overleaf/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/overleaf/templates/common.yaml b/charts/stable/overleaf/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/stable/overleaf/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/stable/overleaf/values.yaml b/charts/stable/overleaf/values.yaml new file mode 100644 index 00000000..67af1089 --- /dev/null +++ b/charts/stable/overleaf/values.yaml @@ -0,0 +1,68 @@ +# +# 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: + # -- image repository + repository: sharelatex/sharelatex + # -- image tag + tag: 2.7.1 + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [overleaf documentation](https://github.com/overleaf/overleaf/wiki/Configuring-Overleaf). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + # -- The URL of the Mongo database to use. + SHARELATEX_MONGO_URL: + # -- The host name of the Redis instance to use. (Both `SHARELATEX_REDIS_HOST` and `REDIS_HOST` are required) + SHARELATEX_REDIS_HOST: + # -- The host name of the Redis instance to use. (Both `SHARELATEX_REDIS_HOST` and `REDIS_HOST` are required) + REDIS_HOST: + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 80 + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false + +# -- Configure persistence settings for the chart under this key. +# @default -- See values.yaml +persistence: + data: + enabled: false + mountPath: /var/lib/sharelatex + +# -- Enable and configure redis subchart under this key. +# For more options see [redis chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/redis) +# @default -- See values.yaml +redis: + enabled: false + auth: + enabled: false + +# -- Enable and configure mongodb database subchart under this key. +# For more options see [mongodb chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/mongodb) +# @default -- See values.yaml +mongodb: + enabled: false + architecture: standalone + auth: + enabled: false + persistence: + enabled: false + # storageClass: "" + # size: 8Gi