From 1d7ea8edcde48deaa50f790954441ce5d55650dd Mon Sep 17 00:00:00 2001 From: Julien Cabillot Date: Thu, 30 Dec 2021 15:56:47 -0500 Subject: [PATCH] cleanup --- charts/cv/README.md | 160 +-------------------------- charts/cv/README.md.gotmpl | 146 ------------------------ charts/cv/README_CHANGELOG.md.gotmpl | 56 ---------- charts/cv/README_CONFIG.md.gotmpl | 9 -- 4 files changed, 1 insertion(+), 370 deletions(-) delete mode 100644 charts/cv/README.md.gotmpl delete mode 100644 charts/cv/README_CHANGELOG.md.gotmpl delete mode 100644 charts/cv/README_CONFIG.md.gotmpl diff --git a/charts/cv/README.md b/charts/cv/README.md index ec1e9ff..022fc5a 100644 --- a/charts/cv/README.md +++ b/charts/cv/README.md @@ -1,160 +1,2 @@ -# lidarr +# cv-helm -![Version: 13.1.1](https://img.shields.io/badge/Version-13.1.1-informational?style=flat-square) ![AppVersion: v1.0.0.2255](https://img.shields.io/badge/AppVersion-v1.0.0.2255-informational?style=flat-square) - -Looks and smells like Sonarr but made for music - -**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 | 4.2.0 | - -## TL;DR - -```console -helm repo add k8s-at-home https://k8s-at-home.com/charts/ -helm repo update -helm install lidarr k8s-at-home/lidarr -``` - -## Installing the Chart - -To install the chart with the release name `lidarr` - -```console -helm install lidarr k8s-at-home/lidarr -``` - -## Uninstalling the Chart - -To uninstall the `lidarr` deployment - -```console -helm uninstall lidarr -``` - -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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). - -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. - -```console -helm install lidarr \ - --set env.TZ="America/New York" \ - k8s-at-home/lidarr -``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. - -```console -helm install lidarr k8s-at-home/lidarr -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/library-charts/tree/main/charts/stable/common) - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| env | object | See below | environment variables. | -| env.TZ | string | `"UTC"` | Set the container timezone | -| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | -| image.repository | string | `"ghcr.io/k8s-at-home/lidarr"` | image repository | -| image.tag | string | `"v1.0.0.2255"` | image tag | -| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | -| metrics.enabled | bool | See values.yaml | Enable and configure Exportarr sidecar and Prometheus serviceMonitor. | -| metrics.exporter.env.additionalMetrics | bool | `false` | Set to true to enable gathering of additional metrics (slow) | -| metrics.exporter.env.port | int | `9792` | metrics port | -| metrics.exporter.env.unknownQueueItems | bool | `false` | Set to true to enable gathering unknown queue items | -| metrics.exporter.image.pullPolicy | string | `"IfNotPresent"` | image pull policy | -| metrics.exporter.image.repository | string | `"ghcr.io/onedr0p/exportarr"` | image repository | -| metrics.exporter.image.tag | string | `"v0.6.2"` | image tag | -| metrics.prometheusRule | object | See values.yaml | Enable and configure Prometheus Rules for the chart under this key. | -| metrics.prometheusRule.rules | list | See prometheusrules.yaml | Configure additionial rules for the chart under this key. | -| metrics.serviceMonitor.interval | string | `"3m"` | | -| metrics.serviceMonitor.labels | object | `{}` | | -| metrics.serviceMonitor.scrapeTimeout | string | `"1m"` | | -| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | -| probes | object | See values.yaml | Configures the probes for the main Pod. | -| service | object | See values.yaml | Configures service settings for the chart. | - -## 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/library-charts/tree/main/charts/stable/common#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). - -### [13.0.0] - -#### Changed - -- **BREAKING**: Refactored Prometheus metrics section to add rules. Enabling metrics automatically enables the serviceMonitor and exporter sidecar. - -### [12.0.0] - -#### Changed - -- Refactoring of the Exportarr sidecar and Prometheus podMonitor. This is a breaking change if it was enabled previously. - -### [11.0.0] - -#### Changed - -- Upgraded the common library dependency to version 4.0.0. This introduced (potentially) breaking changes to `initContainers` and `additionalContainers`. Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-4.0.0/charts/stable/common/) for the up-to-date values. - -### [10.0.0] - -#### Changed - -- **BREAKING**: Upgraded the common library dependency to version 3.0.2. This introduces several breaking changes (`service`, `ingress` and `persistence` keys have been refactored). - Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-3.0.2/charts/stable/common/) for the up-to-date values. -- Changed image tag to `v1.0.0.2226`. - -### [9.0.0] - -#### Changed - -- **Breaking**: swap linuxserver.io images for k8s@home image - -### [1.0.0] - -#### Added - -- Initial version - -[13.0.0]: #1300 -[12.0.0]: #1200 -[11.0.0]: #1100 -[10.0.0]: #1000 -[9.0.0]: #900 -[1.0.0]: #100 - -## 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) diff --git a/charts/cv/README.md.gotmpl b/charts/cv/README.md.gotmpl deleted file mode 100644 index 358abe3..0000000 --- a/charts/cv/README.md.gotmpl +++ /dev/null @@ -1,146 +0,0 @@ -{{- 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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/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/library-charts/tree/main/charts/stable/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/cv/README_CHANGELOG.md.gotmpl b/charts/cv/README_CHANGELOG.md.gotmpl deleted file mode 100644 index 05b0de4..0000000 --- a/charts/cv/README_CHANGELOG.md.gotmpl +++ /dev/null @@ -1,56 +0,0 @@ -{{- 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/library-charts/tree/main/charts/stable/common#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). - -### [13.0.0] - -#### Changed - -- **BREAKING**: Refactored Prometheus metrics section to add rules. Enabling metrics automatically enables the serviceMonitor and exporter sidecar. - -### [12.0.0] - -#### Changed - -- Refactoring of the Exportarr sidecar and Prometheus podMonitor. This is a breaking change if it was enabled previously. - -### [11.0.0] - -#### Changed - -- Upgraded the common library dependency to version 4.0.0. This introduced (potentially) breaking changes to `initContainers` and `additionalContainers`. Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-4.0.0/charts/stable/common/) for the up-to-date values. - -### [10.0.0] - -#### Changed - -- **BREAKING**: Upgraded the common library dependency to version 3.0.2. This introduces several breaking changes (`service`, `ingress` and `persistence` keys have been refactored). - Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-3.0.2/charts/stable/common/) for the up-to-date values. -- Changed image tag to `v1.0.0.2226`. - -### [9.0.0] - -#### Changed - -- **Breaking**: swap linuxserver.io images for k8s@home image - -### [1.0.0] - -#### Added - -- Initial version - -[13.0.0]: #1300 -[12.0.0]: #1200 -[11.0.0]: #1100 -[10.0.0]: #1000 -[9.0.0]: #900 -[1.0.0]: #100 -{{- end -}} diff --git a/charts/cv/README_CONFIG.md.gotmpl b/charts/cv/README_CONFIG.md.gotmpl deleted file mode 100644 index e93d80b..0000000 --- a/charts/cv/README_CONFIG.md.gotmpl +++ /dev/null @@ -1,9 +0,0 @@ -{{- define "custom.custom.configuration.header" -}} -## Custom configuration -{{- end -}} - -{{- define "custom.custom.configuration" -}} -{{ template "custom.custom.configuration.header" . }} - -N/A -{{- end -}}