From 73ac9b443756f66f139d465c4a75758af3be3a1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Skyler=20M=C3=A4ntysaari?= Date: Thu, 27 Oct 2022 12:28:50 +0300 Subject: [PATCH] Current chart progress --- charts/piped/.helmignore | 26 +++++++ charts/piped/Chart.yaml | 42 ++++++++++ charts/piped/README.md | 111 +++++++++++++++++++++++++++ charts/piped/README_CONFIG.md.gotmpl | 9 +++ charts/piped/templates/NOTES.txt | 1 + charts/piped/templates/common.yaml | 11 +++ charts/piped/values.yaml | 77 +++++++++++++++++++ 7 files changed, 277 insertions(+) create mode 100644 charts/piped/.helmignore create mode 100644 charts/piped/Chart.yaml create mode 100644 charts/piped/README.md create mode 100644 charts/piped/README_CONFIG.md.gotmpl create mode 100644 charts/piped/templates/NOTES.txt create mode 100644 charts/piped/templates/common.yaml create mode 100644 charts/piped/values.yaml diff --git a/charts/piped/.helmignore b/charts/piped/.helmignore new file mode 100644 index 0000000..4379e2b --- /dev/null +++ b/charts/piped/.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/piped/Chart.yaml b/charts/piped/Chart.yaml new file mode 100644 index 0000000..53449a8 --- /dev/null +++ b/charts/piped/Chart.yaml @@ -0,0 +1,42 @@ +apiVersion: v2 +appVersion: 1.0.0 +description: An alternative privacy-friendly YouTube frontend which is efficient by design. +name: piped +version: 1.0.0 +kubeVersion: ">=1.19.0-0" +keywords: + - YouTube + - piped +home: https://github.com/TeamPiped/Piped-Kubernetes +icon: https://${CHARTNAME}.org/icon +sources: + - https://github.com/TeamPiped/Piped-Kubernetes + - https://github.com/TeamPiped/Piped-Docker + - https://github.com/TeamPiped/Piped +maintainers: + - name: samip5 + url: https://github.com/samip5 +dependencies: + - name: common + repository: https://bjw-s.github.io/helm-charts/ + version: 0.2.2 + - name: common + alias: frontend + repository: https://bjw-s.github.io/helm-charts/ + version: 0.2.2 + - name: common + alias: backend + repository: https://bjw-s.github.io/helm-charts/ + version: 0.2.2 + - name: common + alias: ytproxy + repository: https://bjw-s.github.io/helm-charts/ + version: 0.2.2 + - name: common + alias: varnish + repository: https://bjw-s.github.io/helm-charts/ + version: 0.2.2 +annotations: + artifacthub.io/changes: | + - kind: added + description: Initial version diff --git a/charts/piped/README.md b/charts/piped/README.md new file mode 100644 index 0000000..5bb88d1 --- /dev/null +++ b/charts/piped/README.md @@ -0,0 +1,111 @@ +# ${CHARTNAME} + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) + +${CHARTNAME} helm package + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/samipsolutions/helm-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.0.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://helm.samipsolutions.fi/ +helm repo update +helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} +``` + +## Installing the Chart + +To install the chart with the release name `${CHARTNAME}` + +```console +helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} +``` + +## Uninstalling the Chart + +To uninstall the `${CHARTNAME}` deployment + +```console +helm uninstall ${CHARTNAME} +``` + +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 ${CHARTNAME} \ + --set env.TZ="America/New York" \ + k8s-at-home/${CHARTNAME} +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} -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. See more environment variables in the [${CHARTNAME} documentation](https://${CHARTNAME}.org/docs). | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"${CHARTNAME}/${CHARTNAME}"` | image repository | +| image.tag | string | chart.appVersion | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | +| service | object | See values.yaml | Configures service settings for the chart. | + +## Changelog + +### Version 1.0.0 + +#### Added + +- Initial version + +#### Changed + +N/A + +#### Fixed + +N/A + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/samipsolutions/helm-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/piped/README_CONFIG.md.gotmpl b/charts/piped/README_CONFIG.md.gotmpl new file mode 100644 index 0000000..e93d80b --- /dev/null +++ b/charts/piped/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/piped/templates/NOTES.txt b/charts/piped/templates/NOTES.txt new file mode 100644 index 0000000..90f7b65 --- /dev/null +++ b/charts/piped/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/piped/templates/common.yaml b/charts/piped/templates/common.yaml new file mode 100644 index 0000000..81a8414 --- /dev/null +++ b/charts/piped/templates/common.yaml @@ -0,0 +1,11 @@ +{{ $components := list "frontend" "backend" "ytproxy" "varnish" }} +{{- range $components -}} + {{- include "common.values.setup" (index $.Subcharts .) }} + {{- with (index $.Values .) }} + {{- with .image }} + {{- $_ := set . "tag" (default $.Chart.AppVersion .tag) -}} + {{- end -}} + {{- include "common.all" (index $.Subcharts .) }} + {{- end -}} +{{- end -}} + diff --git a/charts/piped/values.yaml b/charts/piped/values.yaml new file mode 100644 index 0000000..364c435 --- /dev/null +++ b/charts/piped/values.yaml @@ -0,0 +1,77 @@ +# +# IMPORTANT NOTE +# +# This chart inherits from bjw-s common lib chart. You can check the default values/options here: +# https://github.com/bjw-s/helm-charts/tree/main/charts/library/common +# + +image: + # -- image repository + repository: ${CHARTNAME}/${CHARTNAME} + # -- image tag + # @default -- chart.appVersion + tag: + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [${CHARTNAME} documentation](https://${CHARTNAME}.org/docs). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 1880 + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false + +# -- Configure persistence settings for the chart under this key. +# @default -- See values.yaml +persistence: {} + # data: + # enabled: false + # mountPath: /data + +frontend: + image: + repository: 1337kavin/piped-frontend + # -- image tag + # @default -- chart.appVersion + tag: + # -- image pull policy + pullPolicy: Always + +ytproxy: + image: + repository: 1337kavin/ytproxy + # -- image tag + # @default -- chart.appVersion + tag: + # -- image pull policy + pullPolicy: Always + +backend: + image: + repository: 1337kavin/piped + # -- image tag + # @default -- chart.appVersion + tag: + # -- image pull policy + pullPolicy: Always + service: + main: + ports: + http: + enabled: true + config: + PORT: 8080 + HTTP_WORKERS: 2