diff --git a/charts/incubator/cryptpad/.helmignore b/charts/incubator/cryptpad/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/incubator/cryptpad/.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/incubator/cryptpad/Chart.yaml b/charts/incubator/cryptpad/Chart.yaml new file mode 100644 index 00000000..1ccf8b3d --- /dev/null +++ b/charts/incubator/cryptpad/Chart.yaml @@ -0,0 +1,19 @@ +apiVersion: v2 +appVersion: v4.12.0-nginx +description: cryptpad helm package +name: cryptpad +version: 0.1.0 +kubeVersion: ">=1.16.0-0" +keywords: + - cryptpad +home: https://github.com/k8s-at-home/charts/tree/master/charts/incubator/cryptpad +icon: https://cryptpad.fr/customize/CryptPad_logo.svg +sources: + - https://github.com/xwiki-labs/cryptpad-docker +maintainers: + - name: roobre + email: roobre@roobre.es +dependencies: + - name: common + repository: https://library-charts.k8s-at-home.com + version: 4.0.1 diff --git a/charts/incubator/cryptpad/README.md b/charts/incubator/cryptpad/README.md new file mode 100644 index 00000000..425b8bfa --- /dev/null +++ b/charts/incubator/cryptpad/README.md @@ -0,0 +1,127 @@ +# cryptpad + +![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![AppVersion: v4.12.0-nginx](https://img.shields.io/badge/AppVersion-v4.12.0--nginx-informational?style=flat-square) + +cryptpad helm package + +**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://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 cryptpad k8s-at-home/cryptpad +``` + +## Installing the Chart + +To install the chart with the release name `cryptpad` + +```console +helm install cryptpad k8s-at-home/cryptpad +``` + +## Uninstalling the Chart + +To uninstall the `cryptpad` deployment + +```console +helm uninstall cryptpad +``` + +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 cryptpad \ + --set env.TZ="America/New York" \ + k8s-at-home/cryptpad +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install cryptpad k8s-at-home/cryptpad -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 | +|-----|------|---------|-------------| +| config.installMethod | string | `"helm"` | | +| config.logFeedback | bool | `false` | | +| config.logLevel | string | `"info"` | | +| config.logToStdout | bool | `true` | | +| config.verbose | bool | `false` | | +| env | object | See below | environment variables. See more environment variables in the [cryptpad documentation](https://cryptpad.org/docs). | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"promasu/cryptpad"` | image repository | +| image.tag | string | `""` | image tag (overrides appVersion) | +| ingress.main.enabled | bool | `false` | | +| ingress.main.hosts[0].host | string | `"cryptpad.local"` | | +| ingress.main.hosts[0].paths[0].path | string | `"/"` | | +| ingress.main.hosts[1].host | string | `"sec.cryptpad.local"` | | +| ingress.main.hosts[1].paths[0].path | string | `"/"` | | +| ingress.main.ingressClassName | string | `""` | | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | +| 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/incubator/cryptpad/README.md.gotmpl b/charts/incubator/cryptpad/README.md.gotmpl new file mode 100644 index 00000000..358abe31 --- /dev/null +++ b/charts/incubator/cryptpad/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/incubator/cryptpad/README_CHANGELOG.md.gotmpl b/charts/incubator/cryptpad/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..06ad5fb3 --- /dev/null +++ b/charts/incubator/cryptpad/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/incubator/cryptpad/README_CONFIG.md.gotmpl b/charts/incubator/cryptpad/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/incubator/cryptpad/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/incubator/cryptpad/templates/NOTES.txt b/charts/incubator/cryptpad/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/incubator/cryptpad/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/incubator/cryptpad/templates/common.yaml b/charts/incubator/cryptpad/templates/common.yaml new file mode 100644 index 00000000..dafacb4d --- /dev/null +++ b/charts/incubator/cryptpad/templates/common.yaml @@ -0,0 +1,16 @@ +{{/* Make sure all variables are set properly */}} +{{- include "common.values.setup" . }} + +{{/* Append the configMap volume to the volumes */}} +{{- define "cryptpad.configVolume" -}} +enabled: "true" +mountPath: "/cryptpad/config/config.js" +subPath: "config.js" +type: "custom" +volumeSpec: + configMap: + name: {{ template "common.names.fullname" . }}-config +{{- end -}} +{{- $_ := set .Values.persistence "cryptpad-config" (include "cryptpad.configVolume" . | fromYaml) -}} + +{{ include "common.all" . }} diff --git a/charts/incubator/cryptpad/templates/configmap.yaml b/charts/incubator/cryptpad/templates/configmap.yaml new file mode 100644 index 00000000..9650859e --- /dev/null +++ b/charts/incubator/cryptpad/templates/configmap.yaml @@ -0,0 +1,23 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ template "common.names.fullname" . }}-config + labels: + {{- include "common.labels" . | nindent 4 }} +data: + config.js: | + module.exports = { + {{- if and .Values.ingress.main.enabled .Values.ingress.main.tls }} + httpUnsafeOrigin: 'https://{{ (index (.Values.ingress.main.tls | first).hosts 0) }}', + httpSafeOrigin: 'https://{{ (index (.Values.ingress.main.tls | first).hosts 1) }}', + {{- else if .Values.ingress.main.enabled }} + httpUnsafeOrigin: '{{ (index .Values.ingress.main.hosts 0).host }}', + httpSafeOrigin: '{{ (index .Values.ingress.main.hosts 1).host }}', + {{- end }} + + httpAddress: '::', + + {{- range $key, $val := .Values.config }} + {{ $key }}: {{ $val | toJson }}, + {{- end }} + }; diff --git a/charts/incubator/cryptpad/values.yaml b/charts/incubator/cryptpad/values.yaml new file mode 100644 index 00000000..69a4f437 --- /dev/null +++ b/charts/incubator/cryptpad/values.yaml @@ -0,0 +1,78 @@ +# +# 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 +# + +# config.js is derived from this map. +# See: https://github.com/xwiki-labs/cryptpad/blob/main/config/config.example.js +# httpUnsafeOrigin and httpSafeOrigin are automatically derived from the first and second host defined in the main +# ingress, respectively. +config: +# adminKeys: +# - "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]" + logLevel: info + verbose: false + logFeedback: false + logToStdout: true + installMethod: helm + +image: + # -- image repository + repository: promasu/cryptpad + # -- image tag (overrides appVersion) + tag: "" + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [cryptpad documentation](https://cryptpad.org/docs). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + # Main and sandbox domains are automatically fetched from the first and second host defined in the ingress, + # respectively. + # These env vars are used in the internal nginx. + CPAD_MAIN_DOMAIN: "{{ (index .Values.ingress.main.hosts 0).host }}" + CPAD_SANDBOX_DOMAIN: "{{ (index .Values.ingress.main.hosts 1).host }}" + # Internal nginx _forces_ http2 rather than offering it, which breaks many ingress controllers. + CPAD_HTTP2_DISABLE: "true" + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 80 + +ingress: + main: + enabled: false + ingressClassName: "" + hosts: + # You must define two hosts here + - host: cryptpad.local + paths: + - path: / + - host: sec.cryptpad.local + paths: + - path: / + +# -- Configure persistence settings for the chart under this key. +# @default -- See values.yaml +persistence: + # Cryptpad will persist everything here. + data: + enabled: false + type: emptyDir + subPath: + - path: blob + mountPath: /cryptpad/blob + - path: block + mountPath: /cryptpad/block + - path: data + mountPath: /cryptpad/data + - path: datastore + mountPath: /cryptpad/datastore