diff --git a/charts/calibre/.helmignore b/charts/calibre/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/calibre/.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/calibre/Chart.yaml b/charts/calibre/Chart.yaml new file mode 100644 index 00000000..fbd7b859 --- /dev/null +++ b/charts/calibre/Chart.yaml @@ -0,0 +1,22 @@ +--- + +apiVersion: v2 +appVersion: 5.13.0 +description: Calibre is a powerful and easy to use e-book manager. +name: calibre +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: + - calibre +home: https://github.com/kovidgoyal/calibre/ +icon: https://github.com/kovidgoyal/calibre/raw/master/resources/images/lt.png +sources: + - https://hub.docker.com/r/linuxserver/calibre/ + - https://github.com/kovidgoyal/calibre/ +maintainers: + - name: rolfberkenbosch + email: rolf@berkenbosch.nl +dependencies: + - name: common + repository: https://library-charts.k8s-at-home.com + version: 1.0.0 diff --git a/charts/calibre/README.md b/charts/calibre/README.md new file mode 100644 index 00000000..8b9cb4b3 --- /dev/null +++ b/charts/calibre/README.md @@ -0,0 +1,68 @@ +# calibre + +![Version: 5.13.0](https://img.shields.io/badge/Version-5.13.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) + +Calibre is a powerful and easy to use e-book manager. + +**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 | 1.0.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install calibre k8s-at-home/calibre +``` + +## Installing the Chart + +To install the chart with the release name `calibre` + +```console +helm install calibre k8s-at-home/calibre +``` + +## Uninstalling the Chart + +To uninstall the `calibre` deployment + +```console +helm uninstall calibre +``` + +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 calibre \ + --set env.TZ="America/New York" \ + k8s-at-home/calibre +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install calibre k8s-at-home/calibre -f values.yaml +``` + diff --git a/charts/calibre/README.md.gotmpl b/charts/calibre/README.md.gotmpl new file mode 100644 index 00000000..8b868671 --- /dev/null +++ b/charts/calibre/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" . }} diff --git a/charts/calibre/README_CHANGELOG.md.gotmpl b/charts/calibre/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..33014cdd --- /dev/null +++ b/charts/calibre/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). + +### [0.0.1] + +#### Added + +- First version of the helm chart for wikijs + +#### Changed + +- N/A + +#### Removed + +- N/A + +[0.0.1]: #0.0.1 +{{- end -}} diff --git a/charts/calibre/README_CONFIG.md.gotmpl b/charts/calibre/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/calibre/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/calibre/templates/NOTES.txt b/charts/calibre/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/calibre/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/calibre/templates/common.yaml b/charts/calibre/templates/common.yaml new file mode 100644 index 00000000..c53fdc73 --- /dev/null +++ b/charts/calibre/templates/common.yaml @@ -0,0 +1,3 @@ +--- + +{{ include "common.all" . }} diff --git a/charts/calibre/values.yaml b/charts/calibre/values.yaml new file mode 100644 index 00000000..6861f595 --- /dev/null +++ b/charts/calibre/values.yaml @@ -0,0 +1,54 @@ +--- + +# +# 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 +# + +# -- This is the default, you can also use requarks/wiki +image: + repository: linuxserver/calibre + pullPolicy: IfNotPresent + tag: version-v5.13.0 + +strategy: + type: Recreate + +env: + # -- Set the time zone, e.g. Europe/Amsterdam + TZ: + # -- for UserID + PUID: "1000" + # -- for GroupID + PGID: "1000" + # -- Username for the calibre desktop gui + GUAC_USER: + # -- Password's md5 hash for the calibre desktop gui + GUAC_PASS: + # -- for umask setting of Calibre, default if left unset is 022. + UMASK_SET: "022" + # -- Optionally pass cli start arguments to calibre. + CLI_ARGS: + +service: + # -- The default port is 8080 + port: + port: 8080 + targetPort: 8080 + name: desktopgui + +ingress: + # enable this if you would like to access you wiki + enabled: false + +nodeSelector: + kubernetes.io/arch: amd64 + +persistence: + config: + enabled: false + emptyDir: false + accessMode: "ReadWriteOnce" + size: "1Gi"