Added miniflux chart (#690)

Signed-off-by: Travis Lyons <trly@users.noreply.github.com> Co-authored-by: ᗪєνιη ᗷυнʟ <onedr0p@users.noreply.github.com>
2025-02-02 23:39:03 +00:00 · 2021-03-20 11:05:30 -04:00 · 2021-03-20 11:05:30 -04:00 · bb2432755e
commit bb2432755e
parent 04da77a004
10 changed files with 450 additions and 0 deletions
--- a/charts/stable/miniflux/.helmignore
+++ b/charts/stable/miniflux/.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
--- a/charts/stable/miniflux/Chart.yaml
+++ b/charts/stable/miniflux/Chart.yaml
@ -0,0 +1,25 @@
+apiVersion: v2
+appVersion: 2.0.28
+description: Miniflux is a minimalist and opinionated feed reader.
+name: miniflux
+version: 1.0.0
+kubeVersion: ">=1.16.0-0"
+keywords:
+- miniflux
+- rss
+- news
+home: https://github.com/k8s-at-home/charts/tree/master/charts/miniflux
+icon: https://raw.githubusercontent.com/miniflux/logo/master/icon.svg
+sources:
+- https://github.com/miniflux/v2
+maintainers:
+- name: trly
+  email: trly@users.noreply.github.com
+dependencies:
+- name: common
+  repository: https://library-charts.k8s-at-home.com
+  version: 1.0.0
+- name: postgresql
+  version: 10.3.7
+  repository: https://charts.bitnami.com/bitnami
+  condition: postgresql.enabled
--- a/charts/stable/miniflux/README.md
+++ b/charts/stable/miniflux/README.md
@ -0,0 +1,127 @@
+# miniflux
+
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 2.0.28](https://img.shields.io/badge/AppVersion-2.0.28-informational?style=flat-square)
+
+Miniflux is a minimalist and opinionated feed reader.
+
+**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/miniflux/v2>
+
+## Requirements
+
+Kubernetes: `>=1.16.0-0`
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://charts.bitnami.com/bitnami | postgresql | 10.3.7 |
+| 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 miniflux k8s-at-home/miniflux
+```
+
+## Installing the Chart
+
+To install the chart with the release name `miniflux`
+
+```console
+helm install miniflux k8s-at-home/miniflux
+```
+
+## Uninstalling the Chart
+
+To uninstall the `miniflux` deployment
+
+```console
+helm uninstall miniflux
+```
+
+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 miniflux \
+  --set env.TZ="America/New York" \
+    k8s-at-home/miniflux
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install miniflux k8s-at-home/miniflux -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 |
+|-----|------|---------|-------------|
+| command[0] | string | `"/usr/bin/miniflux"` |  |
+| command[1] | string | `"-c"` |  |
+| command[2] | string | `"/etc/miniflux.conf"` |  |
+| config.admin.password | string | `"miniflux"` |  |
+| config.admin.username | string | `"admin"` |  |
+| env.CREATE_ADMIN | string | `"1"` |  |
+| env.RUN_MIGRATIONS | string | `"1"` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"miniflux/miniflux"` |  |
+| image.tag | string | `"2.0.28"` |  |
+| ingress.enabled | bool | `false` |  |
+| postgresql | object | `{"enabled":true,"persistence":{"enabled":false},"postgresqlDatabase":"miniflux","postgresqlPassword":"miniflux","postgresqlUsername":"postgres"}` | Bitnami postgres chart. For more options see https://github.com/bitnami/charts/tree/master/bitnami/postgresql |
+| postgresql.enabled | bool | `true` | true: use bitnami postgres instance -- false: use your own postgres instance |
+| postgresql.persistence.enabled | bool | `false` | if database is stored to a PVC. Set to true when you are done testing. |
+| postgresql.postgresqlDatabase | string | `"miniflux"` | Postgres database |
+| postgresql.postgresqlPassword | string | `"miniflux"` | Postgres user password |
+| postgresql.postgresqlUsername | string | `"postgres"` | Postgres user -- Needs to be superuser to create hstore extension |
+| probes.liveness.custom | bool | `true` |  |
+| probes.liveness.enabled | bool | `true` |  |
+| probes.liveness.spec.failureThreshold | int | `3` |  |
+| probes.liveness.spec.httpGet.path | string | `"/healthcheck"` |  |
+| probes.liveness.spec.httpGet.port | int | `8080` |  |
+| probes.liveness.spec.initialDelaySeconds | int | `30` |  |
+| probes.liveness.spec.periodSeconds | int | `10` |  |
+| probes.liveness.spec.timeoutSeconds | int | `1` |  |
+| service.port.port | int | `8080` |  |
+| strategy.type | string | `"Recreate"` |  |
+
+## 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]
+
+- Initial chart release
+
+[1.0.0]: https://github.com/k8s-at-home/charts/tree/miniflux-1.0.0/charts/home-assistant
+
+## 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)
--- a/charts/stable/miniflux/README.md.gotmpl
+++ b/charts/stable/miniflux/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" . }}
--- a/charts/stable/miniflux/README_CHANGELOG.md.gotmpl
+++ b/charts/stable/miniflux/README_CHANGELOG.md.gotmpl
@ -0,0 +1,17 @@
+{{- 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]
+
+- Initial chart release
+
+[1.0.0]: https://github.com/k8s-at-home/charts/tree/miniflux-1.0.0/charts/home-assistant
+{{- end -}}
--- a/charts/stable/miniflux/README_CONFIG.md.gotmpl
+++ b/charts/stable/miniflux/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 -}}
--- a/charts/stable/miniflux/templates/NOTES.txt
+++ b/charts/stable/miniflux/templates/NOTES.txt
@ -0,0 +1 @@
+{{- include "common.notes.defaultNotes" . -}}
--- a/charts/stable/miniflux/templates/common.yaml
+++ b/charts/stable/miniflux/templates/common.yaml
@ -0,0 +1,27 @@
+{{/* Make sure all variables are set properly */}}
+{{- include "common.values.setup" . }}
+
+{{/* Append the configMap to the additionalVolumes */}}
+{{- define "miniflux.config.volume" -}}
+name: config
+secret:
+  secretName: {{ template "common.names.fullname" . }}-config
+{{- end -}}
+
+{{- $volume := include "miniflux.config.volume" . | fromYaml -}}
+{{- $additionalVolumes := append .Values.additionalVolumes $volume }}
+{{- $_ := set .Values "additionalVolumes" (deepCopy $additionalVolumes) -}}
+
+{{/* Append the config secret volume to the additionalVolumeMounts */}}
+{{- define "miniflux.config.volumeMount" -}}
+name: config
+mountPath: /etc/miniflux.conf
+subPath: miniflux.conf
+{{- end -}}
+
+{{- $volumeMount := include "miniflux.config.volumeMount" . | fromYaml -}}
+{{- $additionalVolumeMounts := append .Values.additionalVolumeMounts $volumeMount }}
+{{- $_ := set .Values "additionalVolumeMounts" (deepCopy $additionalVolumeMounts) -}}
+
+{{/* Render the templates */}}
+{{ include "common.all" . }}
--- a/charts/stable/miniflux/templates/config.yaml
+++ b/charts/stable/miniflux/templates/config.yaml
@ -0,0 +1,9 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ include "common.names.fullname" . }}-config
+stringData:
+  miniflux.conf: |
+    ADMIN_USERNAME={{ .Values.config.admin.username }}
+    ADMIN_PASSWORD={{ .Values.config.admin.password }}
+    DATABASE_URL=postgres://{{ .Values.postgresql.postgresqlUsername }}:{{ .Values.postgresql.postgresqlPassword }}@{{ include "common.names.fullname" .}}-postgresql/{{ .Values.postgresql.postgresqlDatabase }}?sslmode=disable
--- a/charts/stable/miniflux/values.yaml
+++ b/charts/stable/miniflux/values.yaml
@ -0,0 +1,64 @@
+#
+# 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
+#
+
+command: ['/usr/bin/miniflux', '-c', '/etc/miniflux.conf']
+
+image:
+  repository: miniflux/miniflux
+  pullPolicy: IfNotPresent
+  tag: 2.0.28
+
+strategy:
+  type: Recreate
+
+# See more environment variables in the miniflux documentation
+# https://miniflux.app/docs/configuration.html
+env:
+  RUN_MIGRATIONS: '1'
+  CREATE_ADMIN: '1'
+
+service:
+  port:
+    port: 8080
+
+ingress:
+  enabled: false
+
+config:
+  admin:
+    username: admin
+    password: miniflux
+
+probes:
+  liveness:
+    enabled: true
+    custom: true
+    spec:
+      initialDelaySeconds: 30
+      periodSeconds: 10
+      timeoutSeconds: 1
+      failureThreshold: 3
+      httpGet:
+        path: /healthcheck
+        port: 8080
+
+# -- Bitnami postgres chart. For more options see https://github.com/bitnami/charts/tree/master/bitnami/postgresql
+postgresql:
+  # -- true: use bitnami postgres instance
+  # -- false: use your own postgres instance
+  enabled: true
+  # -- Postgres database
+  postgresqlDatabase: miniflux
+  # -- Postgres user
+  # -- Needs to be superuser to create hstore extension
+  postgresqlUsername: postgres
+  # -- Postgres user password
+  postgresqlPassword: miniflux
+  persistence:
+    # -- if database is stored to a PVC. Set to true when you are done testing.
+    enabled: false
+    # storageClass: ""
				`@ -0,0 +1 @@`
				`{{- include "common.notes.defaultNotes" . -}}`