From 4dca3dd1b572798dfad6438b86d98d9ae561d0cb Mon Sep 17 00:00:00 2001 From: Patrick Collins Date: Mon, 22 Feb 2021 04:37:41 -0800 Subject: [PATCH] [mylar] new chart (#612) --- charts/mylar/.helmignore | 26 +++++ charts/mylar/Chart.yaml | 21 ++++ charts/mylar/OWNERS | 10 ++ charts/mylar/README.md | 124 ++++++++++++++++++++ charts/mylar/README.md.gotmpl | 145 ++++++++++++++++++++++++ charts/mylar/README_CHANGELOG.md.gotmpl | 27 +++++ charts/mylar/README_CONFIG.md.gotmpl | 9 ++ charts/mylar/templates/NOTES.txt | 1 + charts/mylar/templates/common.yaml | 1 + charts/mylar/values.yaml | 40 +++++++ 10 files changed, 404 insertions(+) create mode 100644 charts/mylar/.helmignore create mode 100644 charts/mylar/Chart.yaml create mode 100644 charts/mylar/OWNERS create mode 100644 charts/mylar/README.md create mode 100644 charts/mylar/README.md.gotmpl create mode 100644 charts/mylar/README_CHANGELOG.md.gotmpl create mode 100644 charts/mylar/README_CONFIG.md.gotmpl create mode 100644 charts/mylar/templates/NOTES.txt create mode 100644 charts/mylar/templates/common.yaml create mode 100644 charts/mylar/values.yaml diff --git a/charts/mylar/.helmignore b/charts/mylar/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/mylar/.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/mylar/Chart.yaml b/charts/mylar/Chart.yaml new file mode 100644 index 00000000..5a7b64db --- /dev/null +++ b/charts/mylar/Chart.yaml @@ -0,0 +1,21 @@ +apiVersion: v2 +appVersion: 0.4.9.5 +description: Mylar is the automated Comic Book downloader (cbr/cbz) for use with various download clients. +name: mylar +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- mylar +home: https://github.com/k8s-at-home/charts/tree/master/charts/mylar +icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/mylar-icon.png +sources: +- https://github.com/mylar3/mylar3 +- https://github.com/linuxserver/docker-mylar3 +- https://github.com/k8s-at-home/charts/tree/master/charts/mylar +maintainers: +- name: Patricol + url: https://patricol.co/ +dependencies: +- name: common + repository: https://k8s-at-home.com/charts/ + version: 3.0.1 diff --git a/charts/mylar/OWNERS b/charts/mylar/OWNERS new file mode 100644 index 00000000..42f30497 --- /dev/null +++ b/charts/mylar/OWNERS @@ -0,0 +1,10 @@ +approvers: +- billimek +- onedr0p +- bjw-s +- Patricol +reviewers: +- billimek +- onedr0p +- bjw-s +- Patricol diff --git a/charts/mylar/README.md b/charts/mylar/README.md new file mode 100644 index 00000000..ae8fe2f3 --- /dev/null +++ b/charts/mylar/README.md @@ -0,0 +1,124 @@ +# mylar + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 0.4.9.5](https://img.shields.io/badge/AppVersion-0.4.9.5-informational?style=flat-square) + +Mylar is the automated Comic Book downloader (cbr/cbz) for use with various download clients. + +**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://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 mylar k8s-at-home/mylar +``` + +## Installing the Chart + +To install the chart with the release name `mylar` + +```console +helm install mylar k8s-at-home/mylar +``` + +## Uninstalling the Chart + +To uninstall the `mylar` deployment + +```console +helm uninstall mylar +``` + +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 mylar \ + --set env.TZ="America/New York" \ + k8s-at-home/mylar +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install mylar k8s-at-home/mylar -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 | +|-----|------|---------|-------------| +| env | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"linuxserver/mylar3"` | | +| image.tag | string | `"v0.4.9.5-ls14"` | | +| ingress.enabled | bool | `false` | | +| persistence.comics.emptyDir | bool | `false` | | +| persistence.comics.enabled | bool | `false` | | +| persistence.comics.mountPath | string | `"/comics"` | | +| persistence.config.emptyDir | bool | `false` | | +| persistence.config.enabled | bool | `false` | | +| persistence.downloads.emptyDir | bool | `false` | | +| persistence.downloads.enabled | bool | `false` | | +| persistence.downloads.mountPath | string | `"/downloads"` | | +| service.port.port | int | `8090` | | +| 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] + +#### Added + +- N/A + +#### 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 + diff --git a/charts/mylar/README.md.gotmpl b/charts/mylar/README.md.gotmpl new file mode 100644 index 00000000..387904a6 --- /dev/null +++ b/charts/mylar/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" . }} diff --git a/charts/mylar/README_CHANGELOG.md.gotmpl b/charts/mylar/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..e6167dad --- /dev/null +++ b/charts/mylar/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 + +- N/A + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1.0.0 +{{- end -}} diff --git a/charts/mylar/README_CONFIG.md.gotmpl b/charts/mylar/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/mylar/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/mylar/templates/NOTES.txt b/charts/mylar/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/mylar/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/mylar/templates/common.yaml b/charts/mylar/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/mylar/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/mylar/values.yaml b/charts/mylar/values.yaml new file mode 100644 index 00000000..a5c80770 --- /dev/null +++ b/charts/mylar/values.yaml @@ -0,0 +1,40 @@ +# +# 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: linuxserver/mylar3 + pullPolicy: IfNotPresent + tag: v0.4.9.5-ls14 + +strategy: + type: Recreate + +env: {} + # TZ: + # PUID: + # PGID: + # UMASK: + +service: + port: + port: 8090 + +ingress: + enabled: false + +persistence: + config: + enabled: false + emptyDir: false + comics: + enabled: false + emptyDir: false + mountPath: /comics + downloads: + enabled: false + emptyDir: false + mountPath: /downloads