From 60f85c84ebd10d7d5ba37146bf30e4e8fed3f3d6 Mon Sep 17 00:00:00 2001 From: Nathan Pawelek Date: Mon, 23 Nov 2020 15:04:40 -0600 Subject: [PATCH] [freshrss] new chart (#193) --- charts/freshrss/.helmignore | 24 ++++++++++ charts/freshrss/Chart.yaml | 20 ++++++++ charts/freshrss/OWNERS | 4 ++ charts/freshrss/README.md | 67 +++++++++++++++++++++++++++ charts/freshrss/ci/ct-values.yaml | 2 + charts/freshrss/templates/NOTES.txt | 1 + charts/freshrss/templates/common.yaml | 1 + charts/freshrss/values.yaml | 23 +++++++++ 8 files changed, 142 insertions(+) create mode 100644 charts/freshrss/.helmignore create mode 100644 charts/freshrss/Chart.yaml create mode 100644 charts/freshrss/OWNERS create mode 100644 charts/freshrss/README.md create mode 100644 charts/freshrss/ci/ct-values.yaml create mode 100644 charts/freshrss/templates/NOTES.txt create mode 100644 charts/freshrss/templates/common.yaml create mode 100644 charts/freshrss/values.yaml diff --git a/charts/freshrss/.helmignore b/charts/freshrss/.helmignore new file mode 100644 index 00000000..ede8444e --- /dev/null +++ b/charts/freshrss/.helmignore @@ -0,0 +1,24 @@ +# 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/ +.vscode/ +*.tmproj +# OWNERS file for Kubernetes +OWNERS diff --git a/charts/freshrss/Chart.yaml b/charts/freshrss/Chart.yaml new file mode 100644 index 00000000..c359ad4b --- /dev/null +++ b/charts/freshrss/Chart.yaml @@ -0,0 +1,20 @@ +apiVersion: v2 +appVersion: 1.17.0 +description: FreshRSS is a self-hosted RSS feed aggregator +name: freshrss +version: 1.0.0 +keywords: + - freshrss + - rss +home: https://github.com/k8s-at-home/charts/tree/master/charts/freshrss +icon: https://github.com/FreshRSS/FreshRSS/blob/master/docs/img/FreshRSS-logo.png?raw=true +sources: + - https://github.com/FreshRSS/FreshRSS + - https://hub.docker.com/r/linuxserver/freshrss +maintainers: + - name: npawelek + email: nathan@nathanpawelek.com +dependencies: + - name: common + repository: https://k8s-at-home.com/charts/ + version: 1.6.1 diff --git a/charts/freshrss/OWNERS b/charts/freshrss/OWNERS new file mode 100644 index 00000000..85c7d03e --- /dev/null +++ b/charts/freshrss/OWNERS @@ -0,0 +1,4 @@ +approvers: +- npawelek +reviewers: +- npawelek diff --git a/charts/freshrss/README.md b/charts/freshrss/README.md new file mode 100644 index 00000000..9e9a098d --- /dev/null +++ b/charts/freshrss/README.md @@ -0,0 +1,67 @@ +# FreshRSS + +This is a helm chart for [FreshRSS](https://github.com/FreshRSS/FreshRSS). + +**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)** + +## TL;DR; + +```shell +$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ +$ helm install k8s-at-home/freshrss +``` + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +helm install --name my-release k8s-at-home/freshrss +``` + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```console +helm delete my-release --purge +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration +Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/freshrss/values.yaml) +file. It has several commented out suggested values. +Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +```console +helm install freshrss \ + --set env.TZ="America/New_York" \ + k8s-at-home/freshrss +``` +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the +chart. For example, +```console +helm install freshrss k8s-at-home/freshrss --values values.yaml +``` + +```yaml +image: + tag: ... +``` + +--- +**NOTE** + +If you get +```console +Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` +``` +it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. + +--- + +## Upgrading an existing Release to a new major version + +A major chart version change (like 1.0.1 -> 2.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. diff --git a/charts/freshrss/ci/ct-values.yaml b/charts/freshrss/ci/ct-values.yaml new file mode 100644 index 00000000..f6ccc628 --- /dev/null +++ b/charts/freshrss/ci/ct-values.yaml @@ -0,0 +1,2 @@ +ingress: + enabled: true diff --git a/charts/freshrss/templates/NOTES.txt b/charts/freshrss/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/freshrss/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/freshrss/templates/common.yaml b/charts/freshrss/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/freshrss/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/freshrss/values.yaml b/charts/freshrss/values.yaml new file mode 100644 index 00000000..321a637f --- /dev/null +++ b/charts/freshrss/values.yaml @@ -0,0 +1,23 @@ +# Default values for FreshRSS. + +image: + repository: linuxserver/freshrss + pullPolicy: IfNotPresent + tag: version-1.17.0 + +strategy: + type: Recreate + +service: + port: + port: 80 + +env: {} + # TZ: UTC + # PUID: 1001 + # PGID: 1001 + +persistence: + config: + enabled: false + emptyDir: false