[wallabag] new chart (#575)

2025-01-23 15:39:02 +00:00 · 2021-02-23 21:11:05 -08:00 · 2021-02-23 21:11:05 -08:00 · c2065fba97
commit c2065fba97
parent 2336f09bf8
8 changed files with 408 additions and 0 deletions
--- a/charts/wallabag/Chart.yaml
+++ b/charts/wallabag/Chart.yaml
@ -0,0 +1,19 @@
+apiVersion: v2
+appVersion: 2.4.1
+description: A self hostable application for saving web pages, freely.
+name: wallabag
+version: 1.0.0
+kubeVersion: ">=1.16.0-0"
+keywords:
+- wallabag
+home: https://github.com/k8s-at-home/charts/tree/master/charts/wallabag
+sources:
+- https://github.com/wallabag/docker
+- https://hub.docker.com/wallabag/wallabag
+maintainers:
+- name: Patricol
+  url: https://patricol.co/
+dependencies:
+- name: common
+  repository: https://k8s-at-home.com/charts/
+  version: 3.0.1
--- a/charts/wallabag/README.md
+++ b/charts/wallabag/README.md
@ -0,0 +1,122 @@
+# wallabag
+
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 2.4.1](https://img.shields.io/badge/AppVersion-2.4.1-informational?style=flat-square)
+
+A self hostable application for saving web pages, freely.
+
+**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
+
+* <https://github.com/wallabag/docker>
+* <https://hub.docker.com/wallabag/wallabag>
+
+## Requirements
+
+Kubernetes: `>=1.16.0-0`
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://k8s-at-home.com/charts/ | common | 3.0.1 |
+
+## TL;DR
+
+```console
+helm repo add k8s-at-home https://k8s-at-home.com/charts/
+helm repo update
+helm install wallabag k8s-at-home/wallabag
+```
+
+## Installing the Chart
+
+To install the chart with the release name `wallabag`
+
+```console
+helm install wallabag k8s-at-home/wallabag
+```
+
+## Uninstalling the Chart
+
+To uninstall the `wallabag` deployment
+
+```console
+helm uninstall wallabag
+```
+
+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 wallabag \
+  --set env.TZ="America/New York" \
+    k8s-at-home/wallabag
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install wallabag k8s-at-home/wallabag -f values.yaml
+```
+
+## Custom configuration
+
+Default login is `wallabag:wallabag`.
+
+## 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 |
+|-----|------|---------|-------------|
+| controllerType | string | `"statefulset"` |  |
+| env | object | `{}` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"wallabag/wallabag"` |  |
+| image.tag | string | `"2.4.1"` |  |
+| ingress.enabled | bool | `false` |  |
+| persistence.cache.emptyDir | bool | `false` |  |
+| persistence.cache.enabled | bool | `false` |  |
+| persistence.cache.mountPath | string | `"/var/www/wallabag/var/cache"` |  |
+| persistence.images.emptyDir | bool | `false` |  |
+| persistence.images.enabled | bool | `false` |  |
+| persistence.images.mountPath | string | `"/var/www/wallabag/web/assets/images"` |  |
+| service.port.port | int | `80` |  |
+| strategy.type | string | `"RollingUpdate"` |  |
+
+## 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).
+
+### [1.0.0]
+
+#### Added
+
+- Initial version of the chart
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+[1.0.0]: #1.0.0
+
+## Support
+
+- See the [Wiki](https://github.com/k8s-at-home/charts/wiki)
+- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
+- Ask a [question](https://github.com/k8s-at-home/charts/discussions)
+- Join our [Discord](https://discord.gg/sTMX7Vh) community
+
--- a/charts/wallabag/README.md.gotmpl
+++ b/charts/wallabag/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 [Wiki](https://github.com/k8s-at-home/charts/wiki)
+- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
+- Ask a [question](https://github.com/k8s-at-home/charts/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" . }}
--- a/charts/wallabag/README_CHANGELOG.md.gotmpl
+++ b/charts/wallabag/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/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).
+
+### [1.0.0]
+
+#### Added
+
+- Initial version of the chart
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+[1.0.0]: #1.0.0
+{{- end -}}
--- a/charts/wallabag/README_CONFIG.md.gotmpl
+++ b/charts/wallabag/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" . }}
+
+Default login is `wallabag:wallabag`.
+{{- end -}}
--- a/charts/wallabag/templates/NOTES.txt
+++ b/charts/wallabag/templates/NOTES.txt
@ -0,0 +1 @@
+{{- include "common.notes.defaultNotes" . -}}
--- a/charts/wallabag/templates/common.yaml
+++ b/charts/wallabag/templates/common.yaml
@ -0,0 +1 @@
+{{ include "common.all" . }}
--- a/charts/wallabag/values.yaml
+++ b/charts/wallabag/values.yaml
@ -0,0 +1,84 @@
+#
+# IMPORTANT NOTE
+#
+# This chart inherits from our common library chart. You can check the default values/options here:
+# https://github.com/k8s-at-home/charts/tree/master/charts/common/values.yaml
+#
+
+image:
+  repository: wallabag/wallabag
+  pullPolicy: IfNotPresent
+  # Upgrading the wallabag version generally requires a migration. https://doc.wallabag.org/en/admin/upgrade.html
+  tag: 2.4.1
+
+controllerType: "statefulset"
+strategy:
+  type: RollingUpdate
+
+# See more environment variables in the wallabag documentation
+# https://github.com/wallabag/docker
+env: {}
+  # MYSQL_ROOT_PASSWORD:
+  # POSTGRES_PASSWORD:
+  # POSTGRES_USER:
+  # POPULATE_DATABASE:
+  ## For SYMFONY__ENV__ parameters' documentation, visit https://doc.wallabag.org/en/admin/parameters.html
+  ## redis, rabbitmq, and mailer are optional. database is not optional.
+  # SYMFONY__ENV__DATABASE_DRIVER:
+  # SYMFONY__ENV__DATABASE_DRIVER_CLASS:
+  # SYMFONY__ENV__DATABASE_HOST:
+  # SYMFONY__ENV__DATABASE_PORT:
+  # SYMFONY__ENV__DATABASE_NAME:
+  # SYMFONY__ENV__DATABASE_USER:
+  # SYMFONY__ENV__DATABASE_PASSWORD:
+  # SYMFONY__ENV__DATABASE_PATH:
+  # SYMFONY__ENV__DATABASE_TABLE_PREFIX:
+  # SYMFONY__ENV__DATABASE_SOCKET:
+  # SYMFONY__ENV__DATABASE_CHARSET:
+  # SYMFONY__ENV__DOMAIN_NAME:
+  # SYMFONY__ENV__MAILER_TRANSPORT:
+  # SYMFONY__ENV__MAILER_USER:
+  # SYMFONY__ENV__MAILER_PASSWORD:
+  # SYMFONY__ENV__MAILER_HOST:
+  # SYMFONY__ENV__MAILER_PORT:
+  # SYMFONY__ENV__MAILER_ENCRYPTION:
+  # SYMFONY__ENV__MAILER_AUTH_MODE:
+  # SYMFONY__ENV__LOCALE:
+  # SYMFONY__ENV__SECRET:
+  # SYMFONY__ENV__TWOFACTOR_AUTH:
+  # SYMFONY__ENV__TWOFACTOR_SENDER:
+  # SYMFONY__ENV__FOSUSER_REGISTRATION:
+  # SYMFONY__ENV__FOSUSER_CONFIRMATION:
+  # SYMFONY__ENV__FOS_OAUTH_SERVER_ACCESS_TOKEN_LIFETIME:
+  # SYMFONY__ENV__FOS_OAUTH_SERVER_REFRESH_TOKEN_LIFETIME:
+  # SYMFONY__ENV__FROM_EMAIL:
+  # SYMFONY__ENV__RSS_LIMIT:
+  # SYMFONY__ENV__RABBITMQ_HOST:
+  # SYMFONY__ENV__RABBITMQ_PORT:
+  # SYMFONY__ENV__RABBITMQ_USER:
+  # SYMFONY__ENV__RABBITMQ_PASSWORD:
+  # SYMFONY__ENV__REDIS_SCHEME:
+  # SYMFONY__ENV__REDIS_HOST:
+  # SYMFONY__ENV__REDIS_PORT:
+  # SYMFONY__ENV__REDIS_PATH:
+  # SYMFONY__ENV__REDIS_PASSWORD:
+  # SYMFONY__ENV__SENTRY_DSN:
+  # SYMFONY__ENV__SERVER_NAME:
+
+service:
+  port:
+    port: 80
+
+ingress:
+  enabled: false
+
+persistence:
+  images:
+    enabled: false
+    emptyDir: false
+    mountPath: /var/www/wallabag/web/assets/images
+  cache:
+    ## Note that if you make cache persistent, you may need to clear it (with `bin/console cache:clear --env=prod`) to apply any changes you make to wallabag's parameters.
+    enabled: false
+    emptyDir: false
+    mountPath: /var/www/wallabag/var/cache
				`@ -0,0 +1 @@`
				`{{- include "common.notes.defaultNotes" . -}}`