From dc4d6fd58329f6326f29fe24ace819627bc1b23a Mon Sep 17 00:00:00 2001 From: Ryan Walter Date: Wed, 18 Aug 2021 17:02:50 -0500 Subject: [PATCH] [littlelink-server] Added littlelink-server (#1126) --- charts/stable/littlelink-server/.helmignore | 26 ++++ charts/stable/littlelink-server/Chart.yaml | 20 +++ charts/stable/littlelink-server/README.md | 117 ++++++++++++++ .../stable/littlelink-server/README.md.gotmpl | 146 ++++++++++++++++++ .../README_CHANGELOG.md.gotmpl | 27 ++++ .../littlelink-server/README_CONFIG.md.gotmpl | 9 ++ .../littlelink-server/templates/NOTES.txt | 1 + .../littlelink-server/templates/common.yaml | 1 + charts/stable/littlelink-server/values.yaml | 73 +++++++++ 9 files changed, 420 insertions(+) create mode 100644 charts/stable/littlelink-server/.helmignore create mode 100644 charts/stable/littlelink-server/Chart.yaml create mode 100644 charts/stable/littlelink-server/README.md create mode 100644 charts/stable/littlelink-server/README.md.gotmpl create mode 100644 charts/stable/littlelink-server/README_CHANGELOG.md.gotmpl create mode 100644 charts/stable/littlelink-server/README_CONFIG.md.gotmpl create mode 100644 charts/stable/littlelink-server/templates/NOTES.txt create mode 100644 charts/stable/littlelink-server/templates/common.yaml create mode 100644 charts/stable/littlelink-server/values.yaml diff --git a/charts/stable/littlelink-server/.helmignore b/charts/stable/littlelink-server/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/littlelink-server/.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/stable/littlelink-server/Chart.yaml b/charts/stable/littlelink-server/Chart.yaml new file mode 100644 index 00000000..1f4820ef --- /dev/null +++ b/charts/stable/littlelink-server/Chart.yaml @@ -0,0 +1,20 @@ +apiVersion: v2 +appVersion: 1.0.0 +description: "A lightweight open source alternative to linktree" +name: littlelink-server +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: +- littlelink-server +home: "https://github.com/k8s-at-home/charts/tree/master/charts/stable/littlelink-server" +icon: https://camo.githubusercontent.com/edebb9bce46a8d4a75fa8c4f50f20996c3fe55ace28ecfbfdc5da3794cc90e9a/68747470733a2f2f63646e2e636f74746c652e636c6f75642f6c6974746c656c696e6b2f736f6369616c2d636972636c652e706e67 +sources: +- https://github.com/techno-tim/littlelink-server +- https://github.com/sethcottle/littlelink +maintainers: +- name: rwaltr + email: rwaltr@pm.me +dependencies: +- name: common + repository: https://library-charts.k8s-at-home.com + version: 4.0.0 diff --git a/charts/stable/littlelink-server/README.md b/charts/stable/littlelink-server/README.md new file mode 100644 index 00000000..8cc1024b --- /dev/null +++ b/charts/stable/littlelink-server/README.md @@ -0,0 +1,117 @@ +# littlelink-server + +![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) + +A lightweight open source alternative to linktree + +**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.0.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install littlelink-server k8s-at-home/littlelink-server +``` + +## Installing the Chart + +To install the chart with the release name `littlelink-server` + +```console +helm install littlelink-server k8s-at-home/littlelink-server +``` + +## Uninstalling the Chart + +To uninstall the `littlelink-server` deployment + +```console +helm uninstall littlelink-server +``` + +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 littlelink-server \ + --set env.TZ="America/New York" \ + k8s-at-home/littlelink-server +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install littlelink-server k8s-at-home/littlelink-server -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 [littlelink-server documentation](https://github.com/techno-tim/littlelink-server). | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"ghcr.io/techno-tim/littlelink-server"` | image repository | +| image.tag | string | `"latest"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| 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). + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1126 + +## 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/stable/littlelink-server/README.md.gotmpl b/charts/stable/littlelink-server/README.md.gotmpl new file mode 100644 index 00000000..358abe31 --- /dev/null +++ b/charts/stable/littlelink-server/README.md.gotmpl @@ -0,0 +1,146 @@ +{{- 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/stable/littlelink-server/README_CHANGELOG.md.gotmpl b/charts/stable/littlelink-server/README_CHANGELOG.md.gotmpl new file mode 100644 index 00000000..24dd1892 --- /dev/null +++ b/charts/stable/littlelink-server/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/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). + +### [1.0.0] + +#### Added + +- Initial version + +#### Changed + +- N/A + +#### Removed + +- N/A + +[1.0.0]: #1126 +{{- end -}} diff --git a/charts/stable/littlelink-server/README_CONFIG.md.gotmpl b/charts/stable/littlelink-server/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..e93d80bf --- /dev/null +++ b/charts/stable/littlelink-server/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/stable/littlelink-server/templates/NOTES.txt b/charts/stable/littlelink-server/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/littlelink-server/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/littlelink-server/templates/common.yaml b/charts/stable/littlelink-server/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/stable/littlelink-server/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/stable/littlelink-server/values.yaml b/charts/stable/littlelink-server/values.yaml new file mode 100644 index 00000000..e8848801 --- /dev/null +++ b/charts/stable/littlelink-server/values.yaml @@ -0,0 +1,73 @@ +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml +# + +image: + # -- image repository + repository: ghcr.io/techno-tim/littlelink-server + # -- image tag + tag: latest + # -- image pull policy + pullPolicy: IfNotPresent + +# -- environment variables. See more environment variables in the [littlelink-server documentation](https://github.com/techno-tim/littlelink-server). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + META_TITLE: Techno Tim + META_DESCRIPTION: Techno Tim Link page + META_AUTHOR: Techno Tim + THEME: Dark + FAVICON_URL: https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_200x200.jpg + AVATAR_URL: https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_200x200.jpg + AVATAR_2X_URL: https://pbs.twimg.com/profile_images/1286144221217316864/qIAsKOpB_400x400.jpg + AVATAR_ALT: Techno Tim Profile Pic + NAME: TechnoTim + BIO: Hey! Just a place where you can connect with me! + GITHUB: https://github.com/timothystewart6 + # TWITTER: https://twitter.com/TechnoTimLive + # INSTAGRAM: https://www.instagram.com/techno.tim + # YOUTUBE: https://www.youtube.com/channel/UCOk-gHyjcWZNj3Br4oxwh0A + # TWITCH: https://www.twitch.tv/technotim/ + # DISCORD: https://discord.gg/DJKexrJ + # TIKTOK: https://www.tiktok.com/@technotim + # KIT: https://kit.co/TechnoTim + # FACEBOOK: https://facebook.com + # FACEBOOK_MESSENGER: https://facebook.com + # LINKED_IN: https://linkedin.com + # PRODUCT_HUNT: https://www.producthunt.com/ + # SNAPCHAT: https://www.snapchat.com/ + # SPOTIFY: https://www.spotify.com/ + # REDDIT: https://www.reddit.com/ + # MEDIUM: https://medium.com + # PINTEREST: https://www.pinterest.com/ + # EMAIL: you@example.com + # EMAIL_ALT: you@example.com + # SOUND_CLOUD: https://souncloud.com + # FIGMA: https://figma.com + # TELEGRAM: https://telegram.org/ + # TUMBLR: https://www.tumblr.com/ + # STEAM: https://steamcommunity.com/ + # VIMEO: https://vimeo.com/ + # WORDPRESS: https://wordpress.com/ + # GOODREADS: https://www.goodreads.com/ + # SKOOB: https://www.skoob.com.br/ + FOOTER: Thanks for stopping by! + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 3000 + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false