Compare commits
55 Commits
neolink-1.
...
oauth2-pro
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2336f09bf8 | ||
|
|
bd76ee081d | ||
|
|
519d381a25 | ||
|
|
c46d2dc089 | ||
|
|
4d7c76e021 | ||
|
|
56b6d69af7 | ||
|
|
edf7b69ca6 | ||
|
|
87863db2ca | ||
|
|
1676ddfb6b | ||
|
|
aa0786fcc8 | ||
|
|
207c6de178 | ||
|
|
e6dfc81f58 | ||
|
|
3dfb279101 | ||
|
|
4dca3dd1b5 | ||
|
|
b3f339dd77 | ||
|
|
22b8975741 | ||
|
|
628d8df6f4 | ||
|
|
d9f263e2ee | ||
|
|
9e4fd47bf8 | ||
|
|
fd53494429 | ||
|
|
d3e72ba792 | ||
|
|
911ad95340 | ||
|
|
1e36d19870 | ||
|
|
bf0126122c | ||
|
|
b85e9b4827 | ||
|
|
9c29315c83 | ||
|
|
32af5c7326 | ||
|
|
248d6027e6 | ||
|
|
1657c203d8 | ||
|
|
181f294aee | ||
|
|
5ba6779f0e | ||
|
|
94315f07b2 | ||
|
|
d81c4b586f | ||
|
|
a4b4eee806 | ||
|
|
bb810f947a | ||
|
|
951cdba374 | ||
|
|
d297f8b474 | ||
|
|
777c2ebcf3 | ||
|
|
edf66a746e | ||
|
|
84120a2a65 | ||
|
|
c0cbc83eaf | ||
|
|
ebfef9e0f8 | ||
|
|
b17621cf73 | ||
|
|
896f9dd5b7 | ||
|
|
11ef99d20a | ||
|
|
1c7d6d403e | ||
|
|
a32e94cfca | ||
|
|
91729b6b53 | ||
|
|
8b932311c1 | ||
|
|
a6edab35b7 | ||
|
|
8c5ade2b2b | ||
|
|
a9218cd798 | ||
|
|
f43d3ab7e7 | ||
|
|
607fb8a01d | ||
|
|
15eb4e4e2b |
26
.devcontainer/Dockerfile
Normal file
26
.devcontainer/Dockerfile
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.154.0/containers/ruby/.devcontainer/base.Dockerfile
|
||||||
|
|
||||||
|
# [Choice] Ruby version: 2, 2.7, 2.6, 2.5
|
||||||
|
ARG VARIANT="2"
|
||||||
|
FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
|
||||||
|
|
||||||
|
ENV DEBIAN_FRONTEND=noninteractive
|
||||||
|
|
||||||
|
COPY Gemfile /tmp/Gemfile
|
||||||
|
|
||||||
|
RUN \
|
||||||
|
apt-get update \
|
||||||
|
&& \
|
||||||
|
apt-get -y install --no-install-recommends \
|
||||||
|
jq \
|
||||||
|
libjq-dev \
|
||||||
|
libonig-dev \
|
||||||
|
gnupg2 \
|
||||||
|
&& \
|
||||||
|
sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin \
|
||||||
|
&& \
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | /bin/bash - \
|
||||||
|
&& \
|
||||||
|
bundle config set system 'true' \
|
||||||
|
&& bundle install --gemfile /tmp/Gemfile \
|
||||||
|
&& rm /tmp/Gemfile
|
||||||
33
.devcontainer/devcontainer.json
Normal file
33
.devcontainer/devcontainer.json
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
|
||||||
|
// https://github.com/microsoft/vscode-dev-containers/tree/v0.154.0/containers/ruby
|
||||||
|
{
|
||||||
|
"name": "Ruby",
|
||||||
|
"build": {
|
||||||
|
"context": "..",
|
||||||
|
"dockerfile": "Dockerfile",
|
||||||
|
"args": {
|
||||||
|
// Update 'VARIANT' to pick a Ruby version: 2, 2.7, 2.6, 2.5
|
||||||
|
"VARIANT": "2.7",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
// Set *default* container specific settings.json values on container create.
|
||||||
|
"settings": {
|
||||||
|
"terminal.integrated.shell.linux": "/bin/bash"
|
||||||
|
},
|
||||||
|
|
||||||
|
// Add the IDs of extensions you want installed when the container is created.
|
||||||
|
"extensions": [
|
||||||
|
"ms-kubernetes-tools.vscode-kubernetes-tools",
|
||||||
|
"rebornix.Ruby"
|
||||||
|
],
|
||||||
|
|
||||||
|
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||||
|
// "forwardPorts": [],
|
||||||
|
|
||||||
|
// Use 'postCreateCommand' to run commands after the container is created.
|
||||||
|
"postCreateCommand": "export RUBYJQ_USE_SYSTEM_LIBRARIES=1 && bundle install",
|
||||||
|
|
||||||
|
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
|
||||||
|
"remoteUser": "vscode"
|
||||||
|
}
|
||||||
2
.github/CODEOWNERS
vendored
Normal file
2
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
# https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
|
||||||
|
* @onedr0p @bjw-s @billimek
|
||||||
4
.github/ISSUE_TEMPLATE/bug-report.md
vendored
4
.github/ISSUE_TEMPLATE/bug-report.md
vendored
@@ -21,6 +21,10 @@ assignees: ''
|
|||||||
|
|
||||||
<!-- Note: This should be a clear and concise description of what the bug is. -->
|
<!-- Note: This should be a clear and concise description of what the bug is. -->
|
||||||
|
|
||||||
|
**Relevant Helm values:**
|
||||||
|
|
||||||
|
<!-- Note: Please include a snippet of the relevant values in (or a Pastebin/similar link to) your values.yaml. -->
|
||||||
|
|
||||||
**What did you expect to happen:**
|
**What did you expect to happen:**
|
||||||
|
|
||||||
**Anything else you would like to add:**
|
**Anything else you would like to add:**
|
||||||
|
|||||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: Ask a question
|
||||||
|
url: https://github.com/k8s-at-home/charts/discussions
|
||||||
|
about: Please ask and answer questions here.
|
||||||
|
- name: Discuss on Discord
|
||||||
|
url: https://discord.com/invite/sTMX7Vh
|
||||||
|
about: Join our Discord community
|
||||||
14
.github/ISSUE_TEMPLATE/question.md
vendored
14
.github/ISSUE_TEMPLATE/question.md
vendored
@@ -1,14 +0,0 @@
|
|||||||
---
|
|
||||||
name: Question
|
|
||||||
about: Ask a question to the maintainer
|
|
||||||
title: ''
|
|
||||||
labels: question
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Details
|
|
||||||
|
|
||||||
**Ask your question:**
|
|
||||||
|
|
||||||
<!-- Note: A clear and concise query of what you want to ask. -->
|
|
||||||
19
.github/PAUL.yaml
vendored
Normal file
19
.github/PAUL.yaml
vendored
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
maintainers:
|
||||||
|
- billimek
|
||||||
|
- bjw-s
|
||||||
|
- carpenike
|
||||||
|
- onedr0p
|
||||||
|
labels: true
|
||||||
|
empty_description_check:
|
||||||
|
enabled: true
|
||||||
|
enforced: false
|
||||||
|
branch_destroyer:
|
||||||
|
enabled: true
|
||||||
|
protected_branches:
|
||||||
|
- master
|
||||||
|
- gh-pages
|
||||||
|
pull_requests:
|
||||||
|
automated_merge: false
|
||||||
|
cats_enabled: true
|
||||||
|
dogs_enabled: true
|
||||||
|
allow_approval: true
|
||||||
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -34,7 +34,7 @@ Also don't be worried if the request is closed or not integrated sometimes our p
|
|||||||
**Checklist** <!-- [Place an '[X]' (no spaces) in all applicable fields. Please remove unrelated fields.] -->
|
**Checklist** <!-- [Place an '[X]' (no spaces) in all applicable fields. Please remove unrelated fields.] -->
|
||||||
- [ ] Chart version bumped in `Chart.yaml` according to [semver](http://semver.org/).
|
- [ ] Chart version bumped in `Chart.yaml` according to [semver](http://semver.org/).
|
||||||
- [ ] Title of the PR starts with chart name (e.g. `[home-assistant]`)
|
- [ ] Title of the PR starts with chart name (e.g. `[home-assistant]`)
|
||||||
- [ ] Chart is using our [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library as a dependency.
|
- [ ] (optional) Chart is using our [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library as a dependency.
|
||||||
- [ ] (optional) Variables are documented in the README.md
|
- [ ] (optional) Variables are documented in the README.md
|
||||||
|
|
||||||
<!-- Keep in mind that if you are submitting a new chart, try to use our [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library as a dependency. This will help maintaining charts here and keep them consistent between each other -->
|
<!-- Keep in mind that if you are submitting a new chart, try to use our [common](https://github.com/k8s-at-home/charts/tree/master/charts/common) library as a dependency. This will help maintaining charts here and keep them consistent between each other -->
|
||||||
|
|||||||
10
.github/ct.yaml
vendored
10
.github/ct.yaml
vendored
@@ -2,10 +2,10 @@ remote: origin
|
|||||||
target-branch: master
|
target-branch: master
|
||||||
helm-extra-args: --timeout 600s
|
helm-extra-args: --timeout 600s
|
||||||
chart-dirs:
|
chart-dirs:
|
||||||
- charts
|
- charts
|
||||||
excluded-charts:
|
excluded-charts:
|
||||||
- common
|
- common
|
||||||
- common-test
|
- common-test
|
||||||
chart-repos:
|
chart-repos:
|
||||||
- bitnami=https://charts.bitnami.com/bitnami
|
- bitnami=https://charts.bitnami.com/bitnami
|
||||||
- k8s-at-home=https://k8s-at-home.com/charts
|
- k8s-at-home=https://k8s-at-home.com/charts
|
||||||
|
|||||||
4
.github/stale.yml
vendored
4
.github/stale.yml
vendored
@@ -8,8 +8,8 @@ daysUntilClose: 5
|
|||||||
|
|
||||||
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
|
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
|
||||||
exemptLabels:
|
exemptLabels:
|
||||||
- on-hold
|
- on-hold
|
||||||
- pinned
|
- pinned
|
||||||
|
|
||||||
# Label to use when marking as stale
|
# Label to use when marking as stale
|
||||||
staleLabel: stale
|
staleLabel: stale
|
||||||
|
|||||||
12
.github/workflows/charts-lint-test.yaml
vendored
12
.github/workflows/charts-lint-test.yaml
vendored
@@ -5,10 +5,14 @@ on:
|
|||||||
paths:
|
paths:
|
||||||
- 'charts/**'
|
- 'charts/**'
|
||||||
- '!charts/**/README.md'
|
- '!charts/**/README.md'
|
||||||
|
- '!charts/**/README.md.gotmpl'
|
||||||
|
- '!charts/**/README_CHANGELOG.md.gotmpl'
|
||||||
|
- '!charts/**/README_CONFIG.md.gotmpl'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint:
|
lint:
|
||||||
runs-on: ubuntu-latest
|
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
outputs:
|
outputs:
|
||||||
changed: ${{ steps.list-changed.outputs.changed }}
|
changed: ${{ steps.list-changed.outputs.changed }}
|
||||||
common: ${{ steps.list-changed.outputs.common }}
|
common: ${{ steps.list-changed.outputs.common }}
|
||||||
@@ -49,7 +53,8 @@ jobs:
|
|||||||
if: steps.list-changed.outputs.changed == 'true' || steps.list-changed.outputs.common == 'true'
|
if: steps.list-changed.outputs.changed == 'true' || steps.list-changed.outputs.common == 'true'
|
||||||
|
|
||||||
unittest:
|
unittest:
|
||||||
runs-on: ubuntu-latest
|
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
needs: lint
|
needs: lint
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
@@ -80,7 +85,8 @@ jobs:
|
|||||||
bundle exec m -r test/charts
|
bundle exec m -r test/charts
|
||||||
|
|
||||||
install:
|
install:
|
||||||
runs-on: ubuntu-latest
|
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
needs: lint
|
needs: lint
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
|
|||||||
47
.github/workflows/charts-release.yaml
vendored
47
.github/workflows/charts-release.yaml
vendored
@@ -7,10 +7,14 @@ on:
|
|||||||
paths:
|
paths:
|
||||||
- 'charts/**'
|
- 'charts/**'
|
||||||
- '!charts/**/README.md'
|
- '!charts/**/README.md'
|
||||||
|
- '!charts/**/README.md.gotmpl'
|
||||||
|
- '!charts/**/README_CHANGELOG.md.gotmpl'
|
||||||
|
- '!charts/**/README_CONFIG.md.gotmpl'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
pre-release:
|
pre-release:
|
||||||
runs-on: ubuntu-latest
|
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
timeout-minutes: 5
|
timeout-minutes: 5
|
||||||
steps:
|
steps:
|
||||||
- name: Block concurrent jobs
|
- name: Block concurrent jobs
|
||||||
@@ -21,8 +25,9 @@ jobs:
|
|||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
release:
|
release:
|
||||||
|
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||||
needs: pre-release
|
needs: pre-release
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-20.04
|
||||||
steps:
|
steps:
|
||||||
- name: Block concurrent jobs
|
- name: Block concurrent jobs
|
||||||
uses: softprops/turnstyle@v1
|
uses: softprops/turnstyle@v1
|
||||||
@@ -47,44 +52,8 @@ jobs:
|
|||||||
version: v3.4.0
|
version: v3.4.0
|
||||||
|
|
||||||
- name: Run chart-releaser
|
- name: Run chart-releaser
|
||||||
uses: helm/chart-releaser-action@v1.1.0
|
uses: helm/chart-releaser-action@v1.2.0
|
||||||
with:
|
with:
|
||||||
charts_repo_url: https://k8s-at-home.com/charts/
|
charts_repo_url: https://k8s-at-home.com/charts/
|
||||||
env:
|
env:
|
||||||
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|
||||||
|
|
||||||
# Update the generated timestamp in the index.yaml
|
|
||||||
# needed until https://github.com/helm/chart-releaser/issues/90
|
|
||||||
# or helm/chart-releaser-action supports this
|
|
||||||
post-release:
|
|
||||||
needs: release
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Block concurrent jobs
|
|
||||||
uses: softprops/turnstyle@v1
|
|
||||||
with:
|
|
||||||
continue-after-seconds: 180
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
with:
|
|
||||||
ref: "gh-pages"
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Configure Git
|
|
||||||
run: |
|
|
||||||
git config user.name "$GITHUB_ACTOR"
|
|
||||||
git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
|
|
||||||
|
|
||||||
- name: Commit and push timestamp updates
|
|
||||||
run: |
|
|
||||||
if [[ -f index.yaml ]]; then
|
|
||||||
git pull
|
|
||||||
export generated_date=$(date --utc +%FT%T.%9NZ)
|
|
||||||
sed -i -e "s/^generated:.*/generated: \"$generated_date\"/" index.yaml
|
|
||||||
git add index.yaml
|
|
||||||
git commit -sm "Update generated timestamp [ci-skip]" || exit 0
|
|
||||||
git push
|
|
||||||
fi
|
|
||||||
|
|||||||
29
.helmdocsignore
Normal file
29
.helmdocsignore
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
charts/adguard-home
|
||||||
|
charts/bitwardenrs
|
||||||
|
charts/blocky
|
||||||
|
charts/comcast
|
||||||
|
charts/deconz
|
||||||
|
charts/digitalocean-dyndns
|
||||||
|
charts/duplicati
|
||||||
|
charts/homebridge
|
||||||
|
charts/icantbelieveitsnotvaletudo
|
||||||
|
charts/intel-gpu-plugin
|
||||||
|
charts/librespeed
|
||||||
|
charts/modem-stats
|
||||||
|
charts/mosquitto
|
||||||
|
charts/node-feature-discovery
|
||||||
|
charts/oauth2-proxy
|
||||||
|
charts/plex
|
||||||
|
charts/powerdns
|
||||||
|
charts/prometheus-nut-exporter
|
||||||
|
charts/rtorrent-flood
|
||||||
|
charts/ser2sock
|
||||||
|
charts/speedtest-prometheus
|
||||||
|
charts/speedtest
|
||||||
|
charts/statping
|
||||||
|
charts/teslamate
|
||||||
|
charts/traefik-forward-auth
|
||||||
|
charts/unifi
|
||||||
|
charts/uptimerobot-prometheus
|
||||||
|
charts/uptimerobot
|
||||||
|
charts/common-test
|
||||||
@@ -1,5 +1,13 @@
|
|||||||
# See https://pre-commit.com for more information
|
# See https://pre-commit.com for more information
|
||||||
repos:
|
repos:
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v3.4.0
|
||||||
|
hooks:
|
||||||
|
- id: trailing-whitespace
|
||||||
|
- id: end-of-file-fixer
|
||||||
|
- id: fix-byte-order-marker
|
||||||
|
- id: mixed-line-ending
|
||||||
|
|
||||||
- repo: local
|
- repo: local
|
||||||
hooks:
|
hooks:
|
||||||
- id: ct-lint
|
- id: ct-lint
|
||||||
|
|||||||
@@ -17,32 +17,41 @@ tasks:
|
|||||||
- check-chart
|
- check-chart
|
||||||
silent: true
|
silent: true
|
||||||
|
|
||||||
|
|
||||||
dependency:
|
dependency:
|
||||||
|
dir: "{{.GIT_ROOT}}/charts/{{.CHART}}"
|
||||||
cmds:
|
cmds:
|
||||||
- test -d {{.GIT_ROOT}}/charts/{{.CHART}}/Chart.lock && rm {{.GIT_ROOT}}/charts/{{.CHART}}/Chart.lock || exit 0
|
- test -d Chart.lock && rm Chart.lock || exit 0
|
||||||
- test -d {{.GIT_ROOT}}/charts/{{.CHART}}/tmpcharts && rm -rf {{.GIT_ROOT}}/charts/{{.CHART}}/tmpcharts || exit 0
|
- test -d tmpcharts && rm -rf tmpcharts || exit 0
|
||||||
- cd {{.GIT_ROOT}}/charts/{{.CHART}} && helm dependency update
|
- helm dependency update
|
||||||
silent: true
|
silent: true
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
desc: lint your chart code
|
desc: lint your chart code
|
||||||
|
dir: "{{.GIT_ROOT}}/charts/{{.CHART}}"
|
||||||
cmds:
|
cmds:
|
||||||
- cd {{.GIT_ROOT}}/charts/{{.CHART}} && helm lint
|
- helm lint
|
||||||
deps:
|
deps:
|
||||||
- dependency
|
- dependency
|
||||||
- check-chart
|
- check-chart
|
||||||
|
|
||||||
test:
|
ct-lint:
|
||||||
desc: test your chart code
|
desc: run `ct lint` on your chart code
|
||||||
cmds:
|
cmds:
|
||||||
- docker run --rm -it --user $(id -u):$(id -g) -e "HELM_CONFIG_HOME=/tmp/helm" -e "HELM_CACHE_HOME=/tmp/helm" -v {{.GIT_ROOT}}:/ci -w /ci quay.io/helmpack/chart-testing:latest ct lint --charts charts/{{.CHART}} --config /ci/.github/ct.yaml
|
- docker run --rm -it --user $(id -u):$(id -g) -e "HELM_CONFIG_HOME=/tmp/helm" -e "HELM_CACHE_HOME=/tmp/helm" -v {{.GIT_ROOT}}:/ci -w /ci quay.io/helmpack/chart-testing:latest ct lint --charts charts/{{.CHART}} --config /ci/.github/ct.yaml
|
||||||
deps:
|
deps:
|
||||||
- check-chart
|
- check-chart
|
||||||
- lint
|
- lint
|
||||||
|
|
||||||
|
helm-docs:
|
||||||
|
desc: generate helm-docs
|
||||||
|
dir: "{{.GIT_ROOT}}/hack"
|
||||||
|
cmds:
|
||||||
|
- ./gen-helm-docs.sh "{{.CHART}}"
|
||||||
|
deps:
|
||||||
|
- check-chart
|
||||||
|
|
||||||
# Checks Parameters
|
# Checks Parameters
|
||||||
check-chart:
|
check-chart:
|
||||||
cmds:
|
cmds:
|
||||||
- cmd: test ! -z "{{.CHART}}" || (echo "Please define CHART parameter"; exit 1)
|
- test ! -z "{{.CHART}}" || (echo "Please define CHART parameter"; exit 1)
|
||||||
silent: true
|
silent: true
|
||||||
|
|||||||
5
.vscode/extensions.json
vendored
Normal file
5
.vscode/extensions.json
vendored
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"recommendations": [
|
||||||
|
"ms-vscode-remote.remote-containers"
|
||||||
|
]
|
||||||
|
}
|
||||||
34
.vscode/launch.json
vendored
Normal file
34
.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
{
|
||||||
|
// Use IntelliSense to learn about possible attributes.
|
||||||
|
// Hover to view descriptions of existing attributes.
|
||||||
|
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "UnitTest - active spec file only",
|
||||||
|
"type": "Ruby",
|
||||||
|
"request": "launch",
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"program": "/usr/local/bin/bundle",
|
||||||
|
"args": [
|
||||||
|
"exec",
|
||||||
|
"m",
|
||||||
|
"-r",
|
||||||
|
"${relativeFile}"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "UnitTest - all spec files",
|
||||||
|
"type": "Ruby",
|
||||||
|
"request": "launch",
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"program": "/usr/local/bin/bundle",
|
||||||
|
"args": [
|
||||||
|
"exec",
|
||||||
|
"m",
|
||||||
|
"-r",
|
||||||
|
"${workspaceFolder}/test/charts"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
132
CODE_OF_CONDUCT.md
Normal file
132
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity
|
||||||
|
and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
* Demonstrating empathy and kindness toward other people
|
||||||
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||||||
|
* Giving and gracefully accepting constructive feedback
|
||||||
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
|
and learning from the experience
|
||||||
|
* Focusing on what is best not just for us as individuals, but for the
|
||||||
|
overall community
|
||||||
|
|
||||||
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery, and sexual attention or
|
||||||
|
advances of any kind
|
||||||
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or email
|
||||||
|
address, without their explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official e-mail address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement at
|
||||||
|
Devin buhl <devin.kray@gmail.com> or Jeff Billimek <jeff@billimek.com>.
|
||||||
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series
|
||||||
|
of actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or
|
||||||
|
permanent ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.0, available at
|
||||||
|
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by
|
||||||
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
||||||
|
at [https://www.contributor-covenant.org/translations][translations].
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
||||||
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||||
|
[FAQ]: https://www.contributor-covenant.org/faq
|
||||||
|
[translations]: https://www.contributor-covenant.org/translations
|
||||||
@@ -48,12 +48,13 @@ sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b .bin
|
|||||||
|
|
||||||
# Create chart
|
# Create chart
|
||||||
PATH=$PATH:$PWD/.bin
|
PATH=$PATH:$PWD/.bin
|
||||||
|
task deps:install
|
||||||
task chart:create CHART=chart_name
|
task chart:create CHART=chart_name
|
||||||
# Don't forgot edit some chart informations in charts/char_name/Chart.yaml and charts/char_name/values.yaml
|
# Don't forgot edit some chart informations in charts/char_name/Chart.yaml and charts/char_name/values.yaml
|
||||||
|
|
||||||
# Lint & Test
|
# Linting
|
||||||
task chart:lint CHART=chart_name
|
task chart:lint CHART=chart_name
|
||||||
task chart:test CHART=chart_name
|
task chart:ct-lint CHART=chart_name
|
||||||
```
|
```
|
||||||
|
|
||||||
### Immutability
|
### Immutability
|
||||||
|
|||||||
6
Gemfile
6
Gemfile
@@ -4,9 +4,9 @@ source 'https://rubygems.org'
|
|||||||
|
|
||||||
group :test do
|
group :test do
|
||||||
gem 'm'
|
gem 'm'
|
||||||
gem 'minitest'
|
gem 'minitest', "5.14.2"
|
||||||
gem 'minitest-implicit-subject'
|
gem 'minitest-implicit-subject'
|
||||||
gem 'minitest-reporters'
|
gem 'minitest-reporters', "1.4.2"
|
||||||
gem 'pry'
|
gem 'pry', "0.13.1"
|
||||||
gem 'ruby-jq'
|
gem 'ruby-jq'
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -23,15 +23,15 @@ You can then run `helm search repo k8s-at-home` to see the charts.
|
|||||||
|
|
||||||
See [Artifact Hub](https://artifacthub.io/packages/search?org=k8s-at-home) or [charts](./charts/) for a complete list.
|
See [Artifact Hub](https://artifacthub.io/packages/search?org=k8s-at-home) or [charts](./charts/) for a complete list.
|
||||||
|
|
||||||
## Common Library
|
## Common library
|
||||||
|
|
||||||
The majority of the charts in this repository are using a common library we built. The reason we went with this pattern is a lot of applications are pretty similar in their requirements for Helm charts. Using a library makes maintaining much easier and keeps charts consistent in features. If contributing a new chart first try to make it using the library we built.
|
The majority of the charts in this repository are using a common library we built. The reason we went with this pattern is a lot of applications are pretty similar in their requirements for Helm charts. Using a library makes maintaining much easier and keeps charts consistent in features. If contributing a new chart first try to make it using the library we built.
|
||||||
|
|
||||||
More information can be found [here](https://github.com/k8s-at-home/charts/tree/master/charts/common).
|
More information can be found in our [wiki](https://github.com/k8s-at-home/charts/wiki) and in the common chart directory [here](https://github.com/k8s-at-home/charts/tree/master/charts/common).
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
- Having problems with a chart or have a feature request? Open a new [issue](https://github.com/k8s-at-home/charts/issues/new/choose).
|
- Having problems with a chart? Open a new [issue](https://github.com/k8s-at-home/charts/issues/new/choose) or discuss in our [Discord](https://discord.gg/sTMX7Vh) in the `#support` channel.
|
||||||
- New idea? Discuss [here](https://github.com/k8s-at-home/charts/discussions) or in our [Discord](https://discord.gg/sTMX7Vh) in the `#charts` channel.
|
- New idea? Discuss [here](https://github.com/k8s-at-home/charts/discussions) or in our [Discord](https://discord.gg/sTMX7Vh) in the `#charts` channel.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|||||||
@@ -1,72 +0,0 @@
|
|||||||
{{- define "repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "helm.path" -}}
|
|
||||||
{{ template "repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "badge.artifactHub" -}}
|
|
||||||
[](https://artifacthub.io/packages/helm/k8s-at-home/{{ template "chart.name" . }})
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "description.multiarch" -}}
|
|
||||||
The default values and container images used in this chart will allow for running in a multi-arch cluster (amd64, arm, arm64)
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
```console
|
|
||||||
$ helm repo add {{ template "repository.organization" . }} {{ template "helm.url" . }}
|
|
||||||
$ helm install {{ template "helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`:
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "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 and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml]({{ template "repository.url" . }}/blob/master/charts/{{ template "chart.name" . }}/values.yaml)
|
|
||||||
file. It has several commented out suggested values.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
For example,
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "helm.path" . }} --values values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
26
charts/airsonic/.helmignore
Normal file
26
charts/airsonic/.helmignore
Normal file
@@ -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
|
||||||
21
charts/airsonic/Chart.yaml
Normal file
21
charts/airsonic/Chart.yaml
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
apiVersion: v2
|
||||||
|
appVersion: 10.6.2
|
||||||
|
description: Airsonic is a Free and Open Source community driven media server
|
||||||
|
name: airsonic
|
||||||
|
version: 1.0.0
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
|
keywords:
|
||||||
|
- airsonic
|
||||||
|
home: https://github.com/k8s-at-home/charts/tree/master/charts/airsonic
|
||||||
|
icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/airsonic-logo.png
|
||||||
|
sources:
|
||||||
|
- https://github.com/airsonic/airsonic
|
||||||
|
- https://github.com/linuxserver/docker-airsonic
|
||||||
|
- https://github.com/k8s-at-home/charts/tree/master/charts/airsonic
|
||||||
|
maintainers:
|
||||||
|
- name: Patricol
|
||||||
|
url: https://patricol.co/
|
||||||
|
dependencies:
|
||||||
|
- name: common
|
||||||
|
repository: https://k8s-at-home.com/charts/
|
||||||
|
version: 3.0.1
|
||||||
132
charts/airsonic/README.md
Normal file
132
charts/airsonic/README.md
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
# airsonic
|
||||||
|
|
||||||
|
 
|
||||||
|
|
||||||
|
Airsonic is a Free and Open Source community driven media server
|
||||||
|
|
||||||
|
**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
|
||||||
|
|
||||||
|
* <https://github.com/airsonic/airsonic>
|
||||||
|
* <https://github.com/linuxserver/docker-airsonic>
|
||||||
|
* <https://github.com/k8s-at-home/charts/tree/master/charts/airsonic>
|
||||||
|
|
||||||
|
## 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 airsonic k8s-at-home/airsonic
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installing the Chart
|
||||||
|
|
||||||
|
To install the chart with the release name `airsonic`
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm install airsonic k8s-at-home/airsonic
|
||||||
|
```
|
||||||
|
|
||||||
|
## Uninstalling the Chart
|
||||||
|
|
||||||
|
To uninstall the `airsonic` deployment
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm uninstall airsonic
|
||||||
|
```
|
||||||
|
|
||||||
|
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 airsonic \
|
||||||
|
--set env.TZ="America/New York" \
|
||||||
|
k8s-at-home/airsonic
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm install airsonic k8s-at-home/airsonic -f values.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
## Custom configuration
|
||||||
|
|
||||||
|
If you plan to use networked storage to store your media or config for Airsonic, (NFS, etc.) please take a look at the
|
||||||
|
Fast Access option in the Airsonic settings. This will help improve the performance of the application
|
||||||
|
by not constantly monitoring media folders.
|
||||||
|
|
||||||
|
## 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/airsonic"` | |
|
||||||
|
| image.tag | string | `"v10.6.2-ls97"` | |
|
||||||
|
| ingress.enabled | bool | `false` | |
|
||||||
|
| persistence.config.emptyDir | bool | `false` | |
|
||||||
|
| persistence.config.enabled | bool | `false` | |
|
||||||
|
| persistence.media.emptyDir | bool | `false` | |
|
||||||
|
| persistence.media.enabled | bool | `false` | |
|
||||||
|
| persistence.media.mountPath | string | `"/media"` | |
|
||||||
|
| persistence.music.emptyDir | bool | `false` | |
|
||||||
|
| persistence.music.enabled | bool | `false` | |
|
||||||
|
| persistence.music.mountPath | string | `"/music"` | |
|
||||||
|
| persistence.playlists.emptyDir | bool | `false` | |
|
||||||
|
| persistence.playlists.enabled | bool | `false` | |
|
||||||
|
| persistence.playlists.mountPath | string | `"/playlists"` | |
|
||||||
|
| persistence.podcasts.emptyDir | bool | `false` | |
|
||||||
|
| persistence.podcasts.enabled | bool | `false` | |
|
||||||
|
| persistence.podcasts.mountPath | string | `"/podcasts"` | |
|
||||||
|
| service.port.port | int | `4040` | |
|
||||||
|
| 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
|
||||||
|
|
||||||
145
charts/airsonic/README.md.gotmpl
Normal file
145
charts/airsonic/README.md.gotmpl
Normal file
@@ -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" . }}
|
||||||
27
charts/airsonic/README_CHANGELOG.md.gotmpl
Normal file
27
charts/airsonic/README_CHANGELOG.md.gotmpl
Normal file
@@ -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 -}}
|
||||||
11
charts/airsonic/README_CONFIG.md.gotmpl
Normal file
11
charts/airsonic/README_CONFIG.md.gotmpl
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
|
## Custom configuration
|
||||||
|
{{- end -}}
|
||||||
|
|
||||||
|
{{- define "custom.custom.configuration" -}}
|
||||||
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
|
If you plan to use networked storage to store your media or config for Airsonic, (NFS, etc.) please take a look at the
|
||||||
|
Fast Access option in the Airsonic settings. This will help improve the performance of the application
|
||||||
|
by not constantly monitoring media folders.
|
||||||
|
{{- end -}}
|
||||||
63
charts/airsonic/values.yaml
Normal file
63
charts/airsonic/values.yaml
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
#
|
||||||
|
# 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/airsonic
|
||||||
|
pullPolicy: IfNotPresent
|
||||||
|
tag: v10.6.2-ls97
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
type: Recreate
|
||||||
|
|
||||||
|
env: {}
|
||||||
|
# TZ: UTC
|
||||||
|
# PUID: "1001"
|
||||||
|
# PGID: "1001"
|
||||||
|
# CONTEXT_PATH: "url-base" # Used to set the base path for reverse proxies eg. /booksonic, /books, etc.
|
||||||
|
# JAVA_OPTS: "" # For passing additional java options. For some reverse proxies, you may need to pass JAVA_OPTS=-Dserver.use-forward-headers=true for airsonic to generate the proper URL schemes.
|
||||||
|
|
||||||
|
|
||||||
|
service:
|
||||||
|
port:
|
||||||
|
port: 4040
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: false
|
||||||
|
|
||||||
|
persistence:
|
||||||
|
config:
|
||||||
|
enabled: false
|
||||||
|
emptyDir: false
|
||||||
|
|
||||||
|
music:
|
||||||
|
enabled: false
|
||||||
|
emptyDir: false
|
||||||
|
mountPath: /music
|
||||||
|
## Persistent Volume Storage Class
|
||||||
|
## If defined, storageClassName: <storageClass>
|
||||||
|
## If set to "-", storageClassName: "", which disables dynamic provisioning
|
||||||
|
## If undefined (the default) or set to null, no storageClassName spec is
|
||||||
|
## set, choosing the default provisioner. (gp2 on AWS, standard on
|
||||||
|
## GKE, AWS & OpenStack)
|
||||||
|
# storageClass: "-"
|
||||||
|
# accessMode: ReadWriteOnce
|
||||||
|
# size: 1Gi
|
||||||
|
## Do not delete the pvc upon helm uninstall
|
||||||
|
# skipuninstall: false
|
||||||
|
# existingClaim: ""
|
||||||
|
playlists:
|
||||||
|
enabled: false
|
||||||
|
emptyDir: false
|
||||||
|
mountPath: /playlists
|
||||||
|
podcasts:
|
||||||
|
enabled: false
|
||||||
|
emptyDir: false
|
||||||
|
mountPath: /podcasts
|
||||||
|
media:
|
||||||
|
enabled: false
|
||||||
|
emptyDir: false
|
||||||
|
mountPath: /media
|
||||||
@@ -22,3 +22,5 @@
|
|||||||
.vscode/
|
.vscode/
|
||||||
# OWNERS file for Kubernetes
|
# OWNERS file for Kubernetes
|
||||||
OWNERS
|
OWNERS
|
||||||
|
# helm-docs templates
|
||||||
|
*.gotmpl
|
||||||
|
|||||||
@@ -2,20 +2,21 @@ apiVersion: v2
|
|||||||
appVersion: 0.4.2
|
appVersion: 0.4.2
|
||||||
description: Bot for Prometheus Alertmanager
|
description: Bot for Prometheus Alertmanager
|
||||||
name: alertmanager-bot
|
name: alertmanager-bot
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
keywords:
|
keywords:
|
||||||
- alertmanager
|
- alertmanager
|
||||||
- telegram
|
- telegram
|
||||||
- bot
|
- bot
|
||||||
- alerting
|
- alerting
|
||||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/alertmanager-bot
|
home: https://github.com/k8s-at-home/charts/tree/master/charts/alertmanager-bot
|
||||||
sources:
|
sources:
|
||||||
- https://hub.docker.com/r/metalmatze/alertmanager-bot
|
- https://hub.docker.com/r/metalmatze/alertmanager-bot
|
||||||
- https://github.com/metalmatze/alertmanager-bot
|
- https://github.com/metalmatze/alertmanager-bot
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: billimek
|
- name: billimek
|
||||||
email: jeff@billimek.com
|
email: jeff@billimek.com
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: common
|
- name: common
|
||||||
repository: https://k8s-at-home.com/charts/
|
repository: https://k8s-at-home.com/charts/
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
@@ -1,61 +1,120 @@
|
|||||||
# alertmanager-bot
|
# alertmanager-bot
|
||||||
|
|
||||||
This is a helm chart for [alertmanager-bot](https://github.com/metalmatze/alertmanager-bot).
|
 
|
||||||
|
|
||||||
|
Bot for Prometheus Alertmanager
|
||||||
|
|
||||||
**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)**
|
**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)**
|
||||||
|
|
||||||
## TL;DR;
|
## Source Code
|
||||||
|
|
||||||
```shell
|
* <https://hub.docker.com/r/metalmatze/alertmanager-bot>
|
||||||
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
* <https://github.com/metalmatze/alertmanager-bot>
|
||||||
$ helm install k8s-at-home/alertmanager-bot
|
|
||||||
|
## 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 alertmanager-bot k8s-at-home/alertmanager-bot
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
To install the chart with the release name `alertmanager-bot`
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install --name my-release k8s-at-home/alertmanager-bot
|
helm install alertmanager-bot k8s-at-home/alertmanager-bot
|
||||||
```
|
```
|
||||||
|
|
||||||
## Uninstalling the Chart
|
## Uninstalling the Chart
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
To uninstall the `alertmanager-bot` deployment
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm delete my-release --purge
|
helm uninstall alertmanager-bot
|
||||||
```
|
```
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/alertmanager-bot/values.yaml)
|
|
||||||
file. It has several commented out suggested values.
|
|
||||||
Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options.
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
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
|
```console
|
||||||
helm install alertmanager-bot \
|
helm install alertmanager-bot \
|
||||||
--set env.TZ="America/New_York" \
|
--set env.TZ="America/New York" \
|
||||||
k8s-at-home/alertmanager-bot
|
k8s-at-home/alertmanager-bot
|
||||||
```
|
```
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
|
|
||||||
chart. For example,
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install alertmanager-bot k8s-at-home/alertmanager-bot --values values.yaml
|
helm install alertmanager-bot k8s-at-home/alertmanager-bot -f values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml
|
## Custom configuration
|
||||||
image:
|
|
||||||
tag: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
N/A
|
||||||
**NOTE**
|
|
||||||
|
|
||||||
If you get
|
## Values
|
||||||
```console
|
|
||||||
Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...`
|
**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/)
|
||||||
```
|
|
||||||
it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`.
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| env.BOLT_PATH | string | `"/data/bot.db"` | |
|
||||||
|
| env.STORE | string | `"bolt"` | |
|
||||||
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| image.repository | string | `"metalmatze/alertmanager-bot"` | |
|
||||||
|
| image.tag | string | `"0.4.2"` | |
|
||||||
|
| ingress.enabled | bool | `false` | |
|
||||||
|
| persistence.data.emptyDir | bool | `false` | |
|
||||||
|
| persistence.data.enabled | bool | `false` | |
|
||||||
|
| service.enabled | bool | `false` | |
|
||||||
|
| 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
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||||
145
charts/alertmanager-bot/README.md.gotmpl
Normal file
145
charts/alertmanager-bot/README.md.gotmpl
Normal file
@@ -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" . }}
|
||||||
27
charts/alertmanager-bot/README_CHANGELOG.md.gotmpl
Normal file
27
charts/alertmanager-bot/README_CHANGELOG.md.gotmpl
Normal file
@@ -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 -}}
|
||||||
9
charts/alertmanager-bot/README_CONFIG.md.gotmpl
Normal file
9
charts/alertmanager-bot/README_CONFIG.md.gotmpl
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
|
## Custom configuration
|
||||||
|
{{- end -}}
|
||||||
|
|
||||||
|
{{- define "custom.custom.configuration" -}}
|
||||||
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
|
N/A
|
||||||
|
{{- end -}}
|
||||||
@@ -1,4 +1,9 @@
|
|||||||
# Default values for alertmanager-bot.
|
#
|
||||||
|
# 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:
|
image:
|
||||||
repository: metalmatze/alertmanager-bot
|
repository: metalmatze/alertmanager-bot
|
||||||
@@ -20,6 +25,9 @@ env:
|
|||||||
service:
|
service:
|
||||||
enabled: false
|
enabled: false
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: false
|
||||||
|
|
||||||
persistence:
|
persistence:
|
||||||
data:
|
data:
|
||||||
enabled: false
|
enabled: false
|
||||||
|
|||||||
@@ -22,3 +22,5 @@
|
|||||||
.vscode/
|
.vscode/
|
||||||
# OWNERS file for Kubernetes
|
# OWNERS file for Kubernetes
|
||||||
OWNERS
|
OWNERS
|
||||||
|
# helm-docs templates
|
||||||
|
*.gotmpl
|
||||||
|
|||||||
@@ -2,19 +2,20 @@ apiVersion: v2
|
|||||||
appVersion: 4.0.5
|
appVersion: 4.0.5
|
||||||
description: AppDaemon is a loosely coupled, multi-threaded, sandboxed python execution environment for writing automation apps for various types of Home Automation Software including Home Assistant and MQTT.
|
description: AppDaemon is a loosely coupled, multi-threaded, sandboxed python execution environment for writing automation apps for various types of Home Automation Software including Home Assistant and MQTT.
|
||||||
name: appdaemon
|
name: appdaemon
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
keywords:
|
keywords:
|
||||||
- appdaemon
|
- appdaemon
|
||||||
- home-automation
|
- home-automation
|
||||||
- home-assistant
|
- home-assistant
|
||||||
- mqtt
|
- mqtt
|
||||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/appdaemon
|
home: https://github.com/k8s-at-home/charts/tree/master/charts/appdaemon
|
||||||
sources:
|
sources:
|
||||||
- https://github.com/AppDaemon/appdaemon
|
- https://github.com/AppDaemon/appdaemon
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: billimek
|
- name: billimek
|
||||||
email: jeff@billimek.com
|
email: jeff@billimek.com
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: common
|
- name: common
|
||||||
repository: https://k8s-at-home.com/charts/
|
repository: https://k8s-at-home.com/charts/
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
@@ -1,67 +1,118 @@
|
|||||||
# appdaemon
|
# appdaemon
|
||||||
|
|
||||||
This is a helm chart for [appdaemon](https://github.com/AppDaemon/appdaemon).
|
 
|
||||||
|
|
||||||
|
AppDaemon is a loosely coupled, multi-threaded, sandboxed python execution environment for writing automation apps for various types of Home Automation Software including Home Assistant and MQTT.
|
||||||
|
|
||||||
**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)**
|
**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)**
|
||||||
|
|
||||||
## TL;DR;
|
## Source Code
|
||||||
|
|
||||||
```shell
|
* <https://github.com/AppDaemon/appdaemon>
|
||||||
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
||||||
$ helm install k8s-at-home/appdaemon
|
## 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 appdaemon k8s-at-home/appdaemon
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
To install the chart with the release name `appdaemon`
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install --name my-release k8s-at-home/appdaemon
|
helm install appdaemon k8s-at-home/appdaemon
|
||||||
```
|
```
|
||||||
|
|
||||||
## Uninstalling the Chart
|
## Uninstalling the Chart
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
To uninstall the `appdaemon` deployment
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm delete my-release --purge
|
helm uninstall appdaemon
|
||||||
```
|
```
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/appdaemon/values.yaml)
|
|
||||||
file. It has several commented out suggested values.
|
|
||||||
Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options.
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
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
|
```console
|
||||||
helm install appdaemon \
|
helm install appdaemon \
|
||||||
--set env.TZ="America/New_York" \
|
--set env.TZ="America/New York" \
|
||||||
k8s-at-home/appdaemon
|
k8s-at-home/appdaemon
|
||||||
```
|
```
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
|
|
||||||
chart. For example,
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install appdaemon k8s-at-home/appdaemon --values values.yaml
|
helm install appdaemon k8s-at-home/appdaemon -f values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml
|
## Custom configuration
|
||||||
image:
|
|
||||||
tag: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
N/A
|
||||||
**NOTE**
|
|
||||||
|
|
||||||
If you get
|
## Values
|
||||||
```console
|
|
||||||
Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...`
|
|
||||||
```
|
|
||||||
it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`.
|
|
||||||
|
|
||||||
---
|
**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/)
|
||||||
|
|
||||||
## Upgrading an existing Release to a new major version
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| env | object | `{}` | |
|
||||||
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| image.repository | string | `"k8sathome/appdaemon"` | |
|
||||||
|
| image.tag | string | `"v4.0.5"` | |
|
||||||
|
| ingress.enabled | bool | `false` | |
|
||||||
|
| persistence.config.emptyDir | bool | `false` | |
|
||||||
|
| persistence.config.enabled | bool | `false` | |
|
||||||
|
| service.port.port | int | `5050` | |
|
||||||
|
| strategy.type | string | `"Recreate"` | |
|
||||||
|
|
||||||
A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions.
|
## 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
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||||
145
charts/appdaemon/README.md.gotmpl
Normal file
145
charts/appdaemon/README.md.gotmpl
Normal file
@@ -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" . }}
|
||||||
27
charts/appdaemon/README_CHANGELOG.md.gotmpl
Normal file
27
charts/appdaemon/README_CHANGELOG.md.gotmpl
Normal file
@@ -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 -}}
|
||||||
9
charts/appdaemon/README_CONFIG.md.gotmpl
Normal file
9
charts/appdaemon/README_CONFIG.md.gotmpl
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
|
## Custom configuration
|
||||||
|
{{- end -}}
|
||||||
|
|
||||||
|
{{- define "custom.custom.configuration" -}}
|
||||||
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
|
N/A
|
||||||
|
{{- end -}}
|
||||||
@@ -1,4 +1,9 @@
|
|||||||
# Default values for Appdaemon.
|
#
|
||||||
|
# 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
|
||||||
|
#
|
||||||
|
|
||||||
# Use our own image at https://github.com/k8s-at-home/container-images/tree/main/appdaemon
|
# Use our own image at https://github.com/k8s-at-home/container-images/tree/main/appdaemon
|
||||||
# until https://github.com/AppDaemon/appdaemon/pull/1002 is merged
|
# until https://github.com/AppDaemon/appdaemon/pull/1002 is merged
|
||||||
|
|||||||
@@ -19,5 +19,8 @@
|
|||||||
.project
|
.project
|
||||||
.idea/
|
.idea/
|
||||||
*.tmproj
|
*.tmproj
|
||||||
|
.vscode/
|
||||||
# OWNERS file for Kubernetes
|
# OWNERS file for Kubernetes
|
||||||
OWNERS
|
OWNERS
|
||||||
|
# helm-docs templates
|
||||||
|
*.gotmpl
|
||||||
|
|||||||
@@ -2,23 +2,24 @@ apiVersion: v2
|
|||||||
appVersion: v0.9.0.5
|
appVersion: v0.9.0.5
|
||||||
description: Bazarr is a companion application to Sonarr and Radarr. It manages and downloads subtitles based on your requirements
|
description: Bazarr is a companion application to Sonarr and Radarr. It manages and downloads subtitles based on your requirements
|
||||||
name: bazarr
|
name: bazarr
|
||||||
version: 5.4.0
|
version: 6.0.1
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
keywords:
|
keywords:
|
||||||
- bazarr
|
- bazarr
|
||||||
- radarr
|
- radarr
|
||||||
- sonarr
|
- sonarr
|
||||||
- subtitles
|
- subtitles
|
||||||
- usenet
|
- usenet
|
||||||
- torrent
|
- torrent
|
||||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/bazarr
|
home: https://github.com/k8s-at-home/charts/tree/master/charts/bazarr
|
||||||
icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/bazarr.png
|
icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/bazarr.png
|
||||||
sources:
|
sources:
|
||||||
- https://hub.docker.com/r/linuxserver/bazarr/
|
- https://hub.docker.com/r/linuxserver/bazarr/
|
||||||
- https://github.com/morpheus65535/bazarr
|
- https://github.com/morpheus65535/bazarr
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: billimek
|
- name: billimek
|
||||||
email: jeff@billimek.com
|
email: jeff@billimek.com
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: common
|
- name: common
|
||||||
repository: https://k8s-at-home.com/charts/
|
repository: https://k8s-at-home.com/charts/
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
@@ -1,78 +1,122 @@
|
|||||||
# Bazarr
|
# bazarr
|
||||||
|
|
||||||
This is a helm chart for [Bazarr](https://github.com/morpheus65535/bazarr).
|
 
|
||||||
|
|
||||||
|
Bazarr is a companion application to Sonarr and Radarr. It manages and downloads subtitles based on your requirements
|
||||||
|
|
||||||
**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)**
|
**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)**
|
||||||
|
|
||||||
## TL;DR;
|
## Source Code
|
||||||
|
|
||||||
```shell
|
* <https://hub.docker.com/r/linuxserver/bazarr/>
|
||||||
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
* <https://github.com/morpheus65535/bazarr>
|
||||||
$ helm install k8s-at-home/bazarr
|
|
||||||
|
## 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 bazarr k8s-at-home/bazarr
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
To install the chart with the release name `bazarr`
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install --name my-release k8s-at-home/bazarr
|
helm install bazarr k8s-at-home/bazarr
|
||||||
```
|
```
|
||||||
|
|
||||||
## Uninstalling the Chart
|
## Uninstalling the Chart
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
To uninstall the `bazarr` deployment
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm delete my-release --purge
|
helm uninstall bazarr
|
||||||
```
|
```
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/bazarr/values.yaml)
|
|
||||||
file. It has several commented out suggested values.
|
|
||||||
Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options.
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
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
|
```console
|
||||||
helm install bazarr \
|
helm install bazarr \
|
||||||
--set env.TZ="America/New_York" \
|
--set env.TZ="America/New York" \
|
||||||
k8s-at-home/bazarr
|
k8s-at-home/bazarr
|
||||||
```
|
```
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
|
|
||||||
chart. For example,
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install bazarr k8s-at-home/bazarr --values values.yaml
|
helm install bazarr k8s-at-home/bazarr -f values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml
|
## Custom configuration
|
||||||
image:
|
|
||||||
tag: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
N/A
|
||||||
**NOTE**
|
|
||||||
|
|
||||||
If you get
|
## Values
|
||||||
```console
|
|
||||||
Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...`
|
|
||||||
```
|
|
||||||
it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`.
|
|
||||||
|
|
||||||
---
|
**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/)
|
||||||
|
|
||||||
## Upgrading an existing Release to a new major version
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| env | object | `{}` | |
|
||||||
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| image.repository | string | `"linuxserver/bazarr"` | |
|
||||||
|
| image.tag | string | `"version-v0.9.0.5"` | |
|
||||||
|
| ingress.enabled | bool | `false` | |
|
||||||
|
| persistence.config.emptyDir | bool | `false` | |
|
||||||
|
| persistence.config.enabled | bool | `false` | |
|
||||||
|
| persistence.media.emptyDir | bool | `false` | |
|
||||||
|
| persistence.media.enabled | bool | `false` | |
|
||||||
|
| persistence.media.mountPath | string | `"/media"` | |
|
||||||
|
| service.port.port | int | `6767` | |
|
||||||
|
| strategy.type | string | `"Recreate"` | |
|
||||||
|
|
||||||
A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions.
|
## Changelog
|
||||||
|
|
||||||
### Upgrading from 3.x.x to 4.x.x
|
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).
|
||||||
|
|
||||||
Due to migrating to a centralized common library some values in `values.yaml` have changed.
|
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).
|
||||||
|
|
||||||
Examples:
|
### [1.0.0]
|
||||||
|
|
||||||
* `service.port` has been moved to `service.port.port`.
|
#### Added
|
||||||
* `persistence.type` has been moved to `controllerType`.
|
|
||||||
|
|
||||||
Refer to the library values.yaml for more configuration options.
|
- 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
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||||
145
charts/bazarr/README.md.gotmpl
Normal file
145
charts/bazarr/README.md.gotmpl
Normal file
@@ -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" . }}
|
||||||
27
charts/bazarr/README_CHANGELOG.md.gotmpl
Normal file
27
charts/bazarr/README_CHANGELOG.md.gotmpl
Normal file
@@ -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 -}}
|
||||||
9
charts/bazarr/README_CONFIG.md.gotmpl
Normal file
9
charts/bazarr/README_CONFIG.md.gotmpl
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
|
## Custom configuration
|
||||||
|
{{- end -}}
|
||||||
|
|
||||||
|
{{- define "custom.custom.configuration" -}}
|
||||||
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
|
N/A
|
||||||
|
{{- end -}}
|
||||||
@@ -1,4 +1,9 @@
|
|||||||
# Default values for Bazarr.
|
#
|
||||||
|
# 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:
|
image:
|
||||||
repository: linuxserver/bazarr
|
repository: linuxserver/bazarr
|
||||||
@@ -8,15 +13,18 @@ image:
|
|||||||
strategy:
|
strategy:
|
||||||
type: Recreate
|
type: Recreate
|
||||||
|
|
||||||
service:
|
|
||||||
port:
|
|
||||||
port: 6767
|
|
||||||
|
|
||||||
env: {}
|
env: {}
|
||||||
# TZ: UTC
|
# TZ: UTC
|
||||||
# PUID: 1001
|
# PUID: 1001
|
||||||
# PGID: 1001
|
# PGID: 1001
|
||||||
|
|
||||||
|
service:
|
||||||
|
port:
|
||||||
|
port: 6767
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: false
|
||||||
|
|
||||||
persistence:
|
persistence:
|
||||||
config:
|
config:
|
||||||
enabled: false
|
enabled: false
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- DirtyCajunRice
|
|
||||||
reviewers:
|
|
||||||
- DirtyCajunRice
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
26
charts/booksonic-air/.helmignore
Normal file
26
charts/booksonic-air/.helmignore
Normal file
@@ -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
|
||||||
@@ -2,19 +2,20 @@ apiVersion: v2
|
|||||||
appVersion: v2009.1.0
|
appVersion: v2009.1.0
|
||||||
description: Booksonic is a platform for accessing the audibooks you own wherever you are
|
description: Booksonic is a platform for accessing the audibooks you own wherever you are
|
||||||
name: booksonic-air
|
name: booksonic-air
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
keywords:
|
keywords:
|
||||||
- booksonic
|
- booksonic
|
||||||
- audiobook
|
- audiobook
|
||||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/booksonic-air
|
home: https://github.com/k8s-at-home/charts/tree/master/charts/booksonic-air
|
||||||
icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/booksonic-air.png
|
icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/booksonic-air.png
|
||||||
sources:
|
sources:
|
||||||
- https://github.com/popeen/Booksonic-Air
|
- https://github.com/popeen/Booksonic-Air
|
||||||
- https://hub.docker.com/r/linuxserver/booksonic-air
|
- https://hub.docker.com/r/linuxserver/booksonic-air
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: wojoinc
|
- name: wojoinc
|
||||||
email: wojoinc@pm.me
|
email: wojoinc@pm.me
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: common
|
- name: common
|
||||||
repository: https://k8s-at-home.com/charts/
|
repository: https://k8s-at-home.com/charts/
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
@@ -1,78 +1,130 @@
|
|||||||
# Booksonic-air
|
# booksonic-air
|
||||||
|
|
||||||
This is a helm chart for [Booksonic-air](https://github.com/popeen/Booksonic-Air).
|
 
|
||||||
Booksonic-air is the successor to [Booksonic](https://github.com/popeen/Booksonic-Air#history).
|
|
||||||
|
Booksonic is a platform for accessing the audibooks you own wherever you are
|
||||||
|
|
||||||
**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)**
|
**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)**
|
||||||
|
|
||||||
This chart leverages the [linuxserver.io](https://hub.docker.com/r/linuxserver/booksonic-air) image. To specify a specific version, or to use a different image (not recommended),
|
## Source Code
|
||||||
see [configuration](#configuration)
|
|
||||||
|
|
||||||
## TL;DR;
|
* <https://github.com/popeen/Booksonic-Air>
|
||||||
|
* <https://hub.docker.com/r/linuxserver/booksonic-air>
|
||||||
|
|
||||||
```shell
|
## Requirements
|
||||||
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
||||||
$ helm install k8s-at-home/booksonic-air
|
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 booksonic-air k8s-at-home/booksonic-air
|
||||||
```
|
```
|
||||||
|
|
||||||
## Storage
|
|
||||||
|
|
||||||
If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the
|
|
||||||
Fast Access option in the Booksonic settings. This will help improve the perfomance of the application
|
|
||||||
by not constantly monitoring media folders.
|
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
To install the chart with the release name `booksonic-air`
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install --name my-release k8s-at-home/booksonic-air
|
helm install booksonic-air k8s-at-home/booksonic-air
|
||||||
```
|
```
|
||||||
|
|
||||||
## Uninstalling the Chart
|
## Uninstalling the Chart
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
To uninstall the `booksonic-air` deployment
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm delete my-release --purge
|
helm uninstall booksonic-air
|
||||||
```
|
```
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/booksonic-air/values.yaml)
|
|
||||||
file. It has several commented out suggested values. Most notably, these include several environment variables used to
|
|
||||||
customize the container.
|
|
||||||
Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options.
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
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
|
```console
|
||||||
helm install booksonic \
|
helm install booksonic-air \
|
||||||
--set env.TZ="America/New_York" \
|
--set env.TZ="America/New York" \
|
||||||
k8s-at-home/booksonic-air
|
k8s-at-home/booksonic-air
|
||||||
```
|
```
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
|
|
||||||
chart. For example,
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install booksonic k8s-at-home/booksonic-air -f values.yaml
|
helm install booksonic-air k8s-at-home/booksonic-air -f values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml
|
## Custom configuration
|
||||||
image:
|
|
||||||
tag: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the
|
||||||
**NOTE**
|
Fast Access option in the Booksonic settings. This will help improve the performance of the application
|
||||||
|
by not constantly monitoring media folders.
|
||||||
|
|
||||||
If you get
|
## Values
|
||||||
```console
|
|
||||||
Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...`
|
|
||||||
```
|
|
||||||
it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`.
|
|
||||||
|
|
||||||
---
|
**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/)
|
||||||
|
|
||||||
## Upgrading an existing Release to a new major version
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| env | object | `{}` | |
|
||||||
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| image.repository | string | `"linuxserver/booksonic-air"` | |
|
||||||
|
| image.tag | string | `"v2009.1.0-ls2"` | |
|
||||||
|
| ingress.enabled | bool | `false` | |
|
||||||
|
| persistence.audiobooks.emptyDir | bool | `false` | |
|
||||||
|
| persistence.audiobooks.enabled | bool | `false` | |
|
||||||
|
| persistence.audiobooks.mountPath | string | `"/audiobooks"` | |
|
||||||
|
| persistence.config.emptyDir | bool | `false` | |
|
||||||
|
| persistence.config.enabled | bool | `false` | |
|
||||||
|
| persistence.othermedia.emptyDir | bool | `false` | |
|
||||||
|
| persistence.othermedia.enabled | bool | `false` | |
|
||||||
|
| persistence.othermedia.mountPath | string | `"/othermedia"` | |
|
||||||
|
| persistence.podcasts.emptyDir | bool | `false` | |
|
||||||
|
| persistence.podcasts.enabled | bool | `false` | |
|
||||||
|
| persistence.podcasts.mountPath | string | `"/podcasts"` | |
|
||||||
|
| service.port.port | int | `4040` | |
|
||||||
|
| strategy.type | string | `"Recreate"` | |
|
||||||
|
|
||||||
A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions.
|
## 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
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||||
145
charts/booksonic-air/README.md.gotmpl
Normal file
145
charts/booksonic-air/README.md.gotmpl
Normal file
@@ -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" . }}
|
||||||
27
charts/booksonic-air/README_CHANGELOG.md.gotmpl
Normal file
27
charts/booksonic-air/README_CHANGELOG.md.gotmpl
Normal file
@@ -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 -}}
|
||||||
11
charts/booksonic-air/README_CONFIG.md.gotmpl
Normal file
11
charts/booksonic-air/README_CONFIG.md.gotmpl
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
|
## Custom configuration
|
||||||
|
{{- end -}}
|
||||||
|
|
||||||
|
{{- define "custom.custom.configuration" -}}
|
||||||
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
|
If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the
|
||||||
|
Fast Access option in the Booksonic settings. This will help improve the performance of the application
|
||||||
|
by not constantly monitoring media folders.
|
||||||
|
{{- end -}}
|
||||||
@@ -1,4 +1,9 @@
|
|||||||
# Default values for Booksonic-air.
|
#
|
||||||
|
# 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:
|
image:
|
||||||
repository: linuxserver/booksonic-air
|
repository: linuxserver/booksonic-air
|
||||||
@@ -8,16 +13,19 @@ image:
|
|||||||
strategy:
|
strategy:
|
||||||
type: Recreate
|
type: Recreate
|
||||||
|
|
||||||
service:
|
|
||||||
port:
|
|
||||||
port: 4040
|
|
||||||
|
|
||||||
env: {}
|
env: {}
|
||||||
# TZ: UTC
|
# TZ: UTC
|
||||||
# PUID: "1001"
|
# PUID: "1001"
|
||||||
# PGID: "1001"
|
# PGID: "1001"
|
||||||
# CONTEXT_PATH=url-base # Used to set the base path for reverse proxies eg. /booksonic, /books, etc.
|
# CONTEXT_PATH=url-base # Used to set the base path for reverse proxies eg. /booksonic, /books, etc.
|
||||||
|
|
||||||
|
service:
|
||||||
|
port:
|
||||||
|
port: 4040
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: false
|
||||||
|
|
||||||
persistence:
|
persistence:
|
||||||
config:
|
config:
|
||||||
enabled: false
|
enabled: false
|
||||||
|
|||||||
@@ -22,3 +22,5 @@
|
|||||||
.vscode/
|
.vscode/
|
||||||
# OWNERS file for Kubernetes
|
# OWNERS file for Kubernetes
|
||||||
OWNERS
|
OWNERS
|
||||||
|
# helm-docs templates
|
||||||
|
*.gotmpl
|
||||||
|
|||||||
@@ -2,19 +2,20 @@ apiVersion: v2
|
|||||||
appVersion: 0.6.9
|
appVersion: 0.6.9
|
||||||
description: Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
|
description: Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
|
||||||
name: calibre-web
|
name: calibre-web
|
||||||
version: 4.4.0
|
version: 5.0.1
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
keywords:
|
keywords:
|
||||||
- calibre
|
- calibre
|
||||||
- ebook
|
- ebook
|
||||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/calibre-web
|
home: https://github.com/k8s-at-home/charts/tree/master/charts/calibre-web
|
||||||
icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/calibre-web-icon.png
|
icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/calibre-web-icon.png
|
||||||
sources:
|
sources:
|
||||||
- https://hub.docker.com/r/linuxserver/calibre-web/
|
- https://hub.docker.com/r/linuxserver/calibre-web/
|
||||||
- https://github.com/janeczku/calibre-web
|
- https://github.com/janeczku/calibre-web
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: wojoinc
|
- name: wojoinc
|
||||||
email: wojoinc@pm.me
|
email: wojoinc@pm.me
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: common
|
- name: common
|
||||||
repository: https://k8s-at-home.com/charts/
|
repository: https://k8s-at-home.com/charts/
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
@@ -1,85 +1,121 @@
|
|||||||
# Calibre-Web
|
# calibre-web
|
||||||
|
|
||||||
This is a helm chart for [Calibre-Web](https://github.com/janeczku/calibre-web).
|
 
|
||||||
|
|
||||||
|
Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
|
||||||
|
|
||||||
**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)**
|
**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)**
|
||||||
|
|
||||||
## TL;DR;
|
## Source Code
|
||||||
|
|
||||||
```shell
|
* <https://hub.docker.com/r/linuxserver/calibre-web/>
|
||||||
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
* <https://github.com/janeczku/calibre-web>
|
||||||
$ helm install k8s-at-home/calibre-web
|
|
||||||
|
## 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 calibre-web k8s-at-home/calibre-web
|
||||||
```
|
```
|
||||||
|
|
||||||
## Storage
|
|
||||||
|
|
||||||
If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the
|
|
||||||
Fast Access option in the Booksonic settings. This will help improve the perfomance of the application
|
|
||||||
by not constantly monitoring media folders.
|
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
To install the chart with the release name `calibre-web`
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install --name my-release k8s-at-home/calibre-web
|
helm install calibre-web k8s-at-home/calibre-web
|
||||||
```
|
```
|
||||||
|
|
||||||
## Uninstalling the Chart
|
## Uninstalling the Chart
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
To uninstall the `calibre-web` deployment
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm delete my-release --purge
|
helm uninstall calibre-web
|
||||||
```
|
```
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/calibre-web/values.yaml)
|
|
||||||
file. It has several commented out suggested values. Most notably, these include several environment variables used to
|
|
||||||
customize the container.
|
|
||||||
Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options.
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
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
|
```console
|
||||||
helm install calibre-web \
|
helm install calibre-web \
|
||||||
--set env.TZ="America/New_York" \
|
--set env.TZ="America/New York" \
|
||||||
k8s-at-home/calibre-web
|
k8s-at-home/calibre-web
|
||||||
```
|
```
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
|
|
||||||
chart. For example,
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install calibre-web k8s-at-home/calibre-web -f values.yaml
|
helm install calibre-web k8s-at-home/calibre-web -f values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml
|
## Custom configuration
|
||||||
image:
|
|
||||||
tag: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
N/A
|
||||||
**NOTE**
|
|
||||||
|
|
||||||
If you get
|
## Values
|
||||||
```console
|
|
||||||
Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...`
|
|
||||||
```
|
|
||||||
it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`.
|
|
||||||
|
|
||||||
---
|
**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/)
|
||||||
|
|
||||||
## Upgrading an existing Release to a new major version
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| env | object | `{}` | |
|
||||||
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| image.repository | string | `"linuxserver/calibre-web"` | |
|
||||||
|
| image.tag | string | `"version-0.6.9"` | |
|
||||||
|
| ingress.enabled | bool | `false` | |
|
||||||
|
| persistence.books.emptyDir | bool | `false` | |
|
||||||
|
| persistence.books.enabled | bool | `false` | |
|
||||||
|
| persistence.config.emptyDir | bool | `false` | |
|
||||||
|
| persistence.config.enabled | bool | `false` | |
|
||||||
|
| service.port.port | int | `8083` | |
|
||||||
|
| strategy.type | string | `"Recreate"` | |
|
||||||
|
|
||||||
A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions.
|
## Changelog
|
||||||
|
|
||||||
### Upgrading from 2.x.x to 3.x.x
|
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).
|
||||||
|
|
||||||
Due to migrating to a centralized common library some values in `values.yaml` have changed.
|
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).
|
||||||
|
|
||||||
Examples:
|
### [1.0.0]
|
||||||
|
|
||||||
* `service.port` has been moved to `service.port.port`.
|
#### Added
|
||||||
* `persistence.type` has been moved to `controllerType`.
|
|
||||||
|
|
||||||
Refer to the library values.yaml for more configuration options.
|
- 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
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||||
145
charts/calibre-web/README.md.gotmpl
Normal file
145
charts/calibre-web/README.md.gotmpl
Normal file
@@ -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" . }}
|
||||||
27
charts/calibre-web/README_CHANGELOG.md.gotmpl
Normal file
27
charts/calibre-web/README_CHANGELOG.md.gotmpl
Normal file
@@ -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 -}}
|
||||||
9
charts/calibre-web/README_CONFIG.md.gotmpl
Normal file
9
charts/calibre-web/README_CONFIG.md.gotmpl
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
|
## Custom configuration
|
||||||
|
{{- end -}}
|
||||||
|
|
||||||
|
{{- define "custom.custom.configuration" -}}
|
||||||
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
|
N/A
|
||||||
|
{{- end -}}
|
||||||
@@ -1,4 +1,9 @@
|
|||||||
# Default values for Calibre-Web.
|
#
|
||||||
|
# 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:
|
image:
|
||||||
repository: linuxserver/calibre-web
|
repository: linuxserver/calibre-web
|
||||||
@@ -8,10 +13,6 @@ image:
|
|||||||
strategy:
|
strategy:
|
||||||
type: Recreate
|
type: Recreate
|
||||||
|
|
||||||
service:
|
|
||||||
port:
|
|
||||||
port: 8083
|
|
||||||
|
|
||||||
env: {}
|
env: {}
|
||||||
# TZ:
|
# TZ:
|
||||||
# PUID:
|
# PUID:
|
||||||
@@ -19,6 +20,13 @@ env: {}
|
|||||||
# UMASK:
|
# UMASK:
|
||||||
# DOCKER_MODS:
|
# DOCKER_MODS:
|
||||||
|
|
||||||
|
service:
|
||||||
|
port:
|
||||||
|
port: 8083
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: false
|
||||||
|
|
||||||
persistence:
|
persistence:
|
||||||
config:
|
config:
|
||||||
enabled: false
|
enabled: false
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
26
charts/common-test/.helmignore
Normal file
26
charts/common-test/.helmignore
Normal file
@@ -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
|
||||||
@@ -1,15 +1,16 @@
|
|||||||
apiVersion: v2
|
apiVersion: v2
|
||||||
name: common-test
|
name: common-test
|
||||||
description: Helper chart to test different use cases of the common library
|
description: Helper chart to test different use cases of the common library
|
||||||
version: 1.0.2
|
version: 1.0.4
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
keywords:
|
keywords:
|
||||||
- k8s-at-home
|
- k8s-at-home
|
||||||
- common
|
- common
|
||||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/common-test
|
home: https://github.com/k8s-at-home/charts/tree/master/charts/common-test
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: bjw-s
|
- name: bjw-s
|
||||||
email: me@bjw-s.dev
|
email: me@bjw-s.dev
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: common
|
- name: common
|
||||||
repository: file://../common
|
repository: file://../common
|
||||||
version: n/a
|
version: n/a
|
||||||
|
|||||||
34
charts/common-test/README.md
Normal file
34
charts/common-test/README.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# common-test
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Helper chart to test different use cases of the common library
|
||||||
|
|
||||||
|
**Homepage:** <https://github.com/k8s-at-home/charts/tree/master/charts/common-test>
|
||||||
|
|
||||||
|
## Maintainers
|
||||||
|
|
||||||
|
| Name | Email | Url |
|
||||||
|
| ---- | ------ | --- |
|
||||||
|
| bjw-s | me@bjw-s.dev | |
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
Kubernetes: `>=1.16.0-0`
|
||||||
|
|
||||||
|
| Repository | Name | Version |
|
||||||
|
|------------|------|---------|
|
||||||
|
| file://../common | common | n/a |
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| image.repository | string | `"b4bz/homer"` | |
|
||||||
|
| image.tag | string | `"latest"` | |
|
||||||
|
| ingress.enabled | bool | `true` | |
|
||||||
|
| service.port.port | int | `8080` | |
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||||
@@ -2,11 +2,12 @@ apiVersion: v2
|
|||||||
name: common
|
name: common
|
||||||
description: Function library for k8s-at-home charts
|
description: Function library for k8s-at-home charts
|
||||||
type: library
|
type: library
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
keywords:
|
keywords:
|
||||||
- k8s-at-home
|
- k8s-at-home
|
||||||
- common
|
- common
|
||||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/common
|
home: https://github.com/k8s-at-home/charts/tree/master/charts/common
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: bjw-s
|
- name: bjw-s
|
||||||
email: me@bjw-s.dev
|
email: me@bjw-s.dev
|
||||||
|
|||||||
@@ -1,4 +1,8 @@
|
|||||||
# Library chart for k8s@home media charts
|
# common
|
||||||
|
|
||||||
|
 
|
||||||
|
|
||||||
|
Function library for k8s-at-home charts
|
||||||
|
|
||||||
**WARNING: THIS CHART IS NOT MEANT TO BE INSTALLED DIRECTLY**
|
**WARNING: THIS CHART IS NOT MEANT TO BE INSTALLED DIRECTLY**
|
||||||
|
|
||||||
@@ -6,43 +10,58 @@ This is a [Helm Library Chart](https://helm.sh/docs/topics/library_charts/#helm)
|
|||||||
|
|
||||||
Since a lot of charts follow the same pattern this library was built to reduce maintenance cost between the charts that use it and try achieve a goal of being DRY.
|
Since a lot of charts follow the same pattern this library was built to reduce maintenance cost between the charts that use it and try achieve a goal of being DRY.
|
||||||
|
|
||||||
## Introduction
|
## Requirements
|
||||||
|
|
||||||
This chart provides common template helpers which can be used to develop new charts using [Helm](https://helm.sh) package manager.
|
Kubernetes: `>=1.16.0-0`
|
||||||
|
|
||||||
## :star2: Changelog
|
## Dependencies
|
||||||
|
|
||||||
Please refer to [CHANGELOG.md](CHANGELOG.md) for an overview of notable changes to the chart. **This is especially important for major version updates!**
|
| Repository | Name | Version |
|
||||||
|
|------------|------|---------|
|
||||||
|
|
||||||
## TL;DR
|
## TL;DR
|
||||||
|
|
||||||
When using one of the many charts that uses this library be sure to view this [values.yaml](./values.yaml) for configuration options. Any setting here can be used to define what values your helm deployment will use.
|
```console
|
||||||
|
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
||||||
For example using the helm CLI tool
|
helm repo update
|
||||||
|
helm install common k8s-at-home/common
|
||||||
```bash
|
|
||||||
helm install node-red \
|
|
||||||
--set image.repository="nodered/node-red" \
|
|
||||||
--set image.tag="1.2.5" \
|
|
||||||
--set env.TZ="America/New_York" \
|
|
||||||
k8s-at-home/node-red
|
|
||||||
```
|
```
|
||||||
|
|
||||||
or
|
## Installing the Chart
|
||||||
|
|
||||||
```yaml
|
To install the chart with the release name `common`
|
||||||
# node-red-values.yaml
|
|
||||||
image:
|
```console
|
||||||
repository: nodered/node-red
|
helm install common k8s-at-home/common
|
||||||
tag: 1.2.5
|
|
||||||
env:
|
|
||||||
TZ: America/New_York
|
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash
|
## Uninstalling the Chart
|
||||||
helm install node-red \
|
|
||||||
--values=./node-red-values.yaml \
|
To uninstall the `common` deployment
|
||||||
k8s-at-home/node-red
|
|
||||||
|
```console
|
||||||
|
helm uninstall common
|
||||||
|
```
|
||||||
|
|
||||||
|
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 common \
|
||||||
|
--set env.TZ="America/New York" \
|
||||||
|
k8s-at-home/common
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm install common k8s-at-home/common -f values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
## Creating a new chart
|
## Creating a new chart
|
||||||
@@ -54,15 +73,19 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
|
|||||||
```yaml
|
```yaml
|
||||||
# Chart.yaml
|
# Chart.yaml
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: common
|
- name: common
|
||||||
version: x.x.x
|
version: 3.0.1
|
||||||
repository: https://k8s-at-home.com/charts/
|
repository: https://k8s-at-home.com/charts/
|
||||||
```
|
```
|
||||||
|
|
||||||
Write a `values.yaml` with some basic defaults you want to present to the user e.g.
|
Write a `values.yaml` with some basic defaults you want to present to the user e.g.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Default values for node-red.
|
#
|
||||||
|
# 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:
|
image:
|
||||||
repository: nodered/node-red
|
repository: nodered/node-red
|
||||||
@@ -72,7 +95,7 @@ image:
|
|||||||
strategy:
|
strategy:
|
||||||
type: Recreate
|
type: Recreate
|
||||||
|
|
||||||
# See more environment varaibles in the node-red documentation
|
# See more environment variables in the node-red documentation
|
||||||
# https://nodered.org/docs/getting-started/docker
|
# https://nodered.org/docs/getting-started/docker
|
||||||
env: {}
|
env: {}
|
||||||
# TZ:
|
# TZ:
|
||||||
@@ -85,6 +108,9 @@ service:
|
|||||||
port:
|
port:
|
||||||
port: 1880
|
port: 1880
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: false
|
||||||
|
|
||||||
persistence:
|
persistence:
|
||||||
data:
|
data:
|
||||||
enabled: false
|
enabled: false
|
||||||
@@ -92,8 +118,307 @@ persistence:
|
|||||||
mountPath: /data
|
mountPath: /data
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If not using a service, set the `service.enabled` to `false`.
|
||||||
|
```yaml
|
||||||
|
...
|
||||||
|
service:
|
||||||
|
enabled: false
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Add files to the `templates` folder.
|
||||||
|
```yaml
|
||||||
|
# templates/common.yaml
|
||||||
|
{{ include "common.all . }}
|
||||||
|
|
||||||
|
# templates/NOTES.txt
|
||||||
|
{{ include "common.notes.defaultNotes" . }}
|
||||||
|
```
|
||||||
|
|
||||||
If testing locally make sure you update the dependencies with:
|
If testing locally make sure you update the dependencies with:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
helm dependency update
|
helm dependency update
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 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 |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| additionalContainers | list | `[]` | |
|
||||||
|
| additionalVolumeMounts | list | `[]` | |
|
||||||
|
| additionalVolumes | list | `[]` | |
|
||||||
|
| addons.codeserver.args[0] | string | `"--auth"` | |
|
||||||
|
| addons.codeserver.args[1] | string | `"none"` | |
|
||||||
|
| addons.codeserver.enabled | bool | `false` | |
|
||||||
|
| addons.codeserver.env | object | `{}` | |
|
||||||
|
| addons.codeserver.image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| addons.codeserver.image.repository | string | `"codercom/code-server"` | |
|
||||||
|
| addons.codeserver.image.tag | string | `"3.7.4"` | |
|
||||||
|
| addons.codeserver.ingress.annotations | object | `{}` | |
|
||||||
|
| addons.codeserver.ingress.enabled | bool | `false` | |
|
||||||
|
| addons.codeserver.ingress.hosts[0].host | string | `"code.chart-example.local"` | |
|
||||||
|
| addons.codeserver.ingress.hosts[0].paths[0].path | string | `"/"` | |
|
||||||
|
| addons.codeserver.ingress.hosts[0].paths[0].pathType | string | `"Prefix"` | |
|
||||||
|
| addons.codeserver.ingress.labels | object | `{}` | |
|
||||||
|
| addons.codeserver.ingress.nameSuffix | string | `"codeserver"` | |
|
||||||
|
| addons.codeserver.ingress.tls | list | `[]` | |
|
||||||
|
| addons.codeserver.securityContext.runAsUser | int | `0` | |
|
||||||
|
| addons.codeserver.service.annotations | object | `{}` | |
|
||||||
|
| addons.codeserver.service.enabled | bool | `true` | |
|
||||||
|
| addons.codeserver.service.labels | object | `{}` | |
|
||||||
|
| addons.codeserver.service.port.name | string | `"codeserver"` | |
|
||||||
|
| addons.codeserver.service.port.port | int | `12321` | |
|
||||||
|
| addons.codeserver.service.port.protocol | string | `"TCP"` | |
|
||||||
|
| addons.codeserver.service.port.targetPort | string | `"codeserver"` | |
|
||||||
|
| addons.codeserver.service.type | string | `"ClusterIP"` | |
|
||||||
|
| addons.codeserver.volumeMounts | list | `[]` | |
|
||||||
|
| addons.codeserver.workingDir | string | `""` | |
|
||||||
|
| addons.vpn.additionalVolumeMounts | list | `[]` | |
|
||||||
|
| addons.vpn.configFile | string | `nil` | |
|
||||||
|
| addons.vpn.enabled | bool | `false` | |
|
||||||
|
| addons.vpn.env | object | `{}` | |
|
||||||
|
| addons.vpn.livenessProbe | object | `{}` | |
|
||||||
|
| addons.vpn.networkPolicy.egress | string | `nil` | |
|
||||||
|
| addons.vpn.networkPolicy.enabled | bool | `false` | |
|
||||||
|
| addons.vpn.openvpn.auth | string | `nil` | |
|
||||||
|
| addons.vpn.openvpn.authSecret | string | `nil` | |
|
||||||
|
| addons.vpn.openvpn.image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| addons.vpn.openvpn.image.repository | string | `"dperson/openvpn-client"` | |
|
||||||
|
| addons.vpn.openvpn.image.tag | string | `"latest"` | |
|
||||||
|
| addons.vpn.scripts.down | string | `nil` | |
|
||||||
|
| addons.vpn.scripts.up | string | `nil` | |
|
||||||
|
| addons.vpn.securityContext.capabilities.add[0] | string | `"NET_ADMIN"` | |
|
||||||
|
| addons.vpn.securityContext.capabilities.add[1] | string | `"SYS_MODULE"` | |
|
||||||
|
| addons.vpn.type | string | `"openvpn"` | |
|
||||||
|
| addons.vpn.wireguard.image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| addons.vpn.wireguard.image.repository | string | `"k8sathome/wireguard"` | |
|
||||||
|
| addons.vpn.wireguard.image.tag | string | `"1.0.20200827"` | |
|
||||||
|
| affinity | object | `{}` | |
|
||||||
|
| args | list | `[]` | |
|
||||||
|
| command | list | `[]` | |
|
||||||
|
| controllerAnnotations | object | `{}` | |
|
||||||
|
| controllerLabels | object | `{}` | |
|
||||||
|
| controllerType | string | `"deployment"` | |
|
||||||
|
| dnsPolicy | string | `"ClusterFirst"` | |
|
||||||
|
| enableServiceLinks | bool | `true` | |
|
||||||
|
| env | object | `{}` | |
|
||||||
|
| envFrom | list | `[]` | |
|
||||||
|
| envTpl | object | `{}` | |
|
||||||
|
| envValueFrom | object | `{}` | |
|
||||||
|
| fullnameOverride | string | `""` | |
|
||||||
|
| hostAliases | list | `[]` | |
|
||||||
|
| hostNetwork | bool | `false` | |
|
||||||
|
| ingress.additionalIngresses | list | `[]` | |
|
||||||
|
| ingress.annotations | object | `{}` | |
|
||||||
|
| ingress.enabled | bool | `false` | |
|
||||||
|
| ingress.hosts[0].host | string | `"chart-example.local"` | |
|
||||||
|
| ingress.hosts[0].paths[0].path | string | `"/"` | |
|
||||||
|
| ingress.hosts[0].paths[0].pathType | string | `"Prefix"` | |
|
||||||
|
| ingress.labels | object | `{}` | |
|
||||||
|
| ingress.tls | list | `[]` | |
|
||||||
|
| initContainers | list | `[]` | |
|
||||||
|
| nameOverride | string | `""` | |
|
||||||
|
| nodeSelector | object | `{}` | |
|
||||||
|
| persistence.config.accessMode | string | `"ReadWriteOnce"` | |
|
||||||
|
| persistence.config.enabled | bool | `false` | |
|
||||||
|
| persistence.config.mountPath | string | `"/config"` | |
|
||||||
|
| persistence.config.size | string | `"1Gi"` | |
|
||||||
|
| persistence.config.skipuninstall | bool | `false` | |
|
||||||
|
| persistence.shared.emptyDir | bool | `true` | |
|
||||||
|
| persistence.shared.enabled | bool | `false` | |
|
||||||
|
| persistence.shared.mountPath | string | `"/shared"` | |
|
||||||
|
| podAnnotations | object | `{}` | |
|
||||||
|
| podSecurityContext | object | `{}` | |
|
||||||
|
| probes.liveness.custom | bool | `false` | |
|
||||||
|
| probes.liveness.enabled | bool | `true` | |
|
||||||
|
| probes.liveness.spec.failureThreshold | int | `3` | |
|
||||||
|
| probes.liveness.spec.initialDelaySeconds | int | `0` | |
|
||||||
|
| probes.liveness.spec.periodSeconds | int | `10` | |
|
||||||
|
| probes.liveness.spec.timeoutSeconds | int | `1` | |
|
||||||
|
| probes.readiness.custom | bool | `false` | |
|
||||||
|
| probes.readiness.enabled | bool | `true` | |
|
||||||
|
| probes.readiness.spec.failureThreshold | int | `3` | |
|
||||||
|
| probes.readiness.spec.initialDelaySeconds | int | `0` | |
|
||||||
|
| probes.readiness.spec.periodSeconds | int | `10` | |
|
||||||
|
| probes.readiness.spec.timeoutSeconds | int | `1` | |
|
||||||
|
| probes.startup.custom | bool | `false` | |
|
||||||
|
| probes.startup.enabled | bool | `true` | |
|
||||||
|
| probes.startup.spec.failureThreshold | int | `30` | |
|
||||||
|
| probes.startup.spec.initialDelaySeconds | int | `0` | |
|
||||||
|
| probes.startup.spec.periodSeconds | int | `5` | |
|
||||||
|
| probes.startup.spec.timeoutSeconds | int | `1` | |
|
||||||
|
| replicas | int | `1` | |
|
||||||
|
| resources | object | `{}` | |
|
||||||
|
| securityContext | object | `{}` | |
|
||||||
|
| service.additionalPorts | list | `[]` | |
|
||||||
|
| service.additionalServices | list | `[]` | |
|
||||||
|
| service.annotations | object | `{}` | |
|
||||||
|
| service.enabled | bool | `true` | |
|
||||||
|
| service.labels | object | `{}` | |
|
||||||
|
| service.port.name | string | `nil` | |
|
||||||
|
| service.port.port | string | `nil` | |
|
||||||
|
| service.port.protocol | string | `"TCP"` | |
|
||||||
|
| service.port.targetPort | string | `nil` | |
|
||||||
|
| service.type | string | `"ClusterIP"` | |
|
||||||
|
| serviceAccount.annotations | object | `{}` | |
|
||||||
|
| serviceAccount.create | bool | `false` | |
|
||||||
|
| serviceAccount.name | string | `""` | |
|
||||||
|
| strategy.type | string | `"RollingUpdate"` | |
|
||||||
|
| tolerations | list | `[]` | |
|
||||||
|
| volumeClaimTemplates | list | `[]` | |
|
||||||
|
|
||||||
|
## 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](../common/README.md).
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
### [3.0.1]
|
||||||
|
|
||||||
|
#### Fixed
|
||||||
|
|
||||||
|
- Fixed `kubeVersion` in `Chart.yaml` not working with people running k8s pre-releases
|
||||||
|
- Added `ingressClassName` to `values.yaml`
|
||||||
|
|
||||||
|
### [3.0.0]
|
||||||
|
|
||||||
|
#### Changed
|
||||||
|
|
||||||
|
- `probes.startupProbe` is now enabled by default. This will allow for quicker `Ready` states on Pods. It will precede the liveness and readiness Probes. *Note:* This requires that you are running [Kubernetes 1.16](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/)
|
||||||
|
- Aligned our default values for liveness and readiness Probes with the Kubernetes defaults:
|
||||||
|
- `initialDelaySeconds` is now `0`
|
||||||
|
- `timeoutSeconds` is now `1`
|
||||||
|
- `failureThreshold` is now `3`
|
||||||
|
|
||||||
|
### [2.5.1]
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
|
- Fixed a small typo in `values.yaml`: `ingress.tls.hostTpl` -> `ingress.tls.hostsTpl`
|
||||||
|
|
||||||
|
### [2.5.0]
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
|
- Allow setting ingress values through Helm templates:
|
||||||
|
- `ingress.hosts.hostTpl`
|
||||||
|
- `ingress.tls.secretNameTpl`
|
||||||
|
- `ingress.tls.hostsTpl`
|
||||||
|
|
||||||
|
### [2.4.0]
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
|
- Allow setting environment variables from Downward API via `envValueFrom`. See [the Kubernetes docs](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/) for more information.
|
||||||
|
|
||||||
|
### [2.3.0]
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
|
- Allow overriding the main container command.
|
||||||
|
- Allow setting Helm templates as environment variables via `envTpl`. The given value is parsed through Helm's `tpl` function, allowing for powerful variable substitution.
|
||||||
|
- Support for defining volumeClaimTemplates for StatefulSet.
|
||||||
|
- Allow the following Pod spec fields to be configurable:
|
||||||
|
- `priorityClassName`
|
||||||
|
- `schedulerName`
|
||||||
|
- `hostname`
|
||||||
|
|
||||||
|
#### Fixed
|
||||||
|
|
||||||
|
- `values.yaml` now contains the following sections, these were already functional but were previously undocumented:
|
||||||
|
- `podSecurityContext`
|
||||||
|
- `securityContext`
|
||||||
|
- `resources`
|
||||||
|
|
||||||
|
### [2.2.1]
|
||||||
|
|
||||||
|
#### Fixed
|
||||||
|
|
||||||
|
- Made explicit that `service.port.targetPort` cannot be a named port.
|
||||||
|
|
||||||
|
### [2.2.0]
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
|
- Allow serviceLinks to be enabled/disabled.
|
||||||
|
- Support for ingressClassName on apiVersion `networking.k8s.io/v1` by setting `ingress.ingressClassName`.
|
||||||
|
- Added some initial proper unit tests for the `common` chart.
|
||||||
|
|
||||||
|
#### Changed
|
||||||
|
|
||||||
|
- `service.port.targetPort` is now used in the container spec instead of `service.port.port` if specified. This allows for different service and container ports. (Implements [#465](https://github.com/k8s-at-home/charts/issues/465)).
|
||||||
|
|
||||||
|
#### Fixed
|
||||||
|
|
||||||
|
- Document setting environment variables for code-server add-on in `values.yaml` (Fixes [#436](https://github.com/k8s-at-home/charts/issues/436)).
|
||||||
|
- Set service targetPort to the service port name first if no `targetPort` value is given.
|
||||||
|
|
||||||
|
### [2.1.0]
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
|
- Allow for additional arguments to be added to code-server runtime via `addons.codeserver.args`
|
||||||
|
|
||||||
|
### [2.0.4]
|
||||||
|
|
||||||
|
#### Fixed
|
||||||
|
|
||||||
|
- `periodSeconds` now works for all probe types.
|
||||||
|
|
||||||
|
### [2.0.0]
|
||||||
|
|
||||||
|
#### Changed
|
||||||
|
|
||||||
|
- :warning: Updated `probes` logic to support custom probes, it is now possible to set your own custom probes by setting the `probes.[liveness|readiness|startup].custom` value to `true` and configuring them. Default is `false`.
|
||||||
|
- :warning: `addon.vpn.imagePullPolicy` is now `addon.vpn.[openvpn|wireguard].image.pullPolicy`. Default is `IfNotPresent`
|
||||||
|
- [code-server](https://github.com/cdr/code-server) is now an `addon` like `vpn`. This enables a code-server container inside the pod which allows you to modify a configuration in a volume attached to the pod. Default for `addons.codeserver.enabled` is `false`
|
||||||
|
- Added `envFrom` for more configuration with environment variables
|
||||||
|
- Added `dnsConfig` to be configurable
|
||||||
|
- Added support for 1.19+ ingress spec
|
||||||
|
- Added this [CHANGELOG.md](CHANGELOG.md)
|
||||||
|
|
||||||
|
#### Fixed
|
||||||
|
|
||||||
|
- `nameOverride` and `fullNameOverride` not in `values.yaml`
|
||||||
|
|
||||||
|
### [1.7.0]
|
||||||
|
|
||||||
|
This is the last version before starting this changelog. All sorts of cool stuff was changed, but only `git log` remembers what that was :slightly_frowning_face:
|
||||||
|
|
||||||
|
[3.0.1]: #3.0.1
|
||||||
|
|
||||||
|
[3.0.0]: #3.0.0
|
||||||
|
|
||||||
|
[2.5.1]: #2.5.1
|
||||||
|
|
||||||
|
[2.5.0]: #2.5.0
|
||||||
|
|
||||||
|
[2.4.0]: #2.4.0
|
||||||
|
|
||||||
|
[2.3.0]: #2.3.0
|
||||||
|
|
||||||
|
[2.2.1]: #2.2.1
|
||||||
|
|
||||||
|
[2.2.0]: #2.2.0
|
||||||
|
|
||||||
|
[2.1.0]: #2.1.0
|
||||||
|
|
||||||
|
[2.0.4]: #2.0.4
|
||||||
|
|
||||||
|
[2.0.0]: #2.0.0
|
||||||
|
|
||||||
|
[1.7.0]: #1.7.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
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||||
147
charts/common/README.md.gotmpl
Normal file
147
charts/common/README.md.gotmpl
Normal file
@@ -0,0 +1,147 @@
|
|||||||
|
{{- 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" -}}
|
||||||
|
**WARNING: THIS CHART IS NOT MEANT TO BE INSTALLED DIRECTLY**
|
||||||
|
|
||||||
|
This is a [Helm Library Chart](https://helm.sh/docs/topics/library_charts/#helm). It's purpose is for grouping common logic between the k8s@home charts.
|
||||||
|
|
||||||
|
Since a lot of charts follow the same pattern this library was built to reduce maintenance cost between the charts that use it and try achieve a goal of being DRY.
|
||||||
|
{{- 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 "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" . }}
|
||||||
@@ -1,18 +1,56 @@
|
|||||||
# Changelog
|
{{- define "custom.changelog.header" -}}
|
||||||
All notable changes to this project will be documented in this file.
|
## 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](../common/README.md).
|
||||||
|
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
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).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
## [2.4.0]
|
### [3.0.1]
|
||||||
|
|
||||||
### Added
|
#### Fixed
|
||||||
|
|
||||||
|
- Fixed `kubeVersion` in `Chart.yaml` not working with people running k8s pre-releases
|
||||||
|
- Added `ingressClassName` to `values.yaml`
|
||||||
|
|
||||||
|
### [3.0.0]
|
||||||
|
|
||||||
|
#### Changed
|
||||||
|
|
||||||
|
- `probes.startupProbe` is now enabled by default. This will allow for quicker `Ready` states on Pods. It will precede the liveness and readiness Probes. *Note:* This requires that you are running [Kubernetes 1.16](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/)
|
||||||
|
- Aligned our default values for liveness and readiness Probes with the Kubernetes defaults:
|
||||||
|
- `initialDelaySeconds` is now `0`
|
||||||
|
- `timeoutSeconds` is now `1`
|
||||||
|
- `failureThreshold` is now `3`
|
||||||
|
|
||||||
|
### [2.5.1]
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
|
- Fixed a small typo in `values.yaml`: `ingress.tls.hostTpl` -> `ingress.tls.hostsTpl`
|
||||||
|
|
||||||
|
### [2.5.0]
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
|
- Allow setting ingress values through Helm templates:
|
||||||
|
- `ingress.hosts.hostTpl`
|
||||||
|
- `ingress.tls.secretNameTpl`
|
||||||
|
- `ingress.tls.hostsTpl`
|
||||||
|
|
||||||
|
### [2.4.0]
|
||||||
|
|
||||||
|
#### Added
|
||||||
|
|
||||||
- Allow setting environment variables from Downward API via `envValueFrom`. See [the Kubernetes docs](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/) for more information.
|
- Allow setting environment variables from Downward API via `envValueFrom`. See [the Kubernetes docs](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/) for more information.
|
||||||
|
|
||||||
## [2.3.0]
|
### [2.3.0]
|
||||||
|
|
||||||
### Added
|
#### Added
|
||||||
|
|
||||||
- Allow overriding the main container command.
|
- Allow overriding the main container command.
|
||||||
- Allow setting Helm templates as environment variables via `envTpl`. The given value is parsed through Helm's `tpl` function, allowing for powerful variable substitution.
|
- Allow setting Helm templates as environment variables via `envTpl`. The given value is parsed through Helm's `tpl` function, allowing for powerful variable substitution.
|
||||||
@@ -22,51 +60,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- `schedulerName`
|
- `schedulerName`
|
||||||
- `hostname`
|
- `hostname`
|
||||||
|
|
||||||
### Fixed
|
#### Fixed
|
||||||
|
|
||||||
- `values.yaml` now contains the following sections, these were already functional but were previously undocumented:
|
- `values.yaml` now contains the following sections, these were already functional but were previously undocumented:
|
||||||
- `podSecurityContext`
|
- `podSecurityContext`
|
||||||
- `securityContext`
|
- `securityContext`
|
||||||
- `resources`
|
- `resources`
|
||||||
|
|
||||||
## [2.2.1]
|
### [2.2.1]
|
||||||
|
|
||||||
### Fixed
|
#### Fixed
|
||||||
|
|
||||||
- Made explicit that `service.port.targetPort` cannot be a named port.
|
- Made explicit that `service.port.targetPort` cannot be a named port.
|
||||||
|
|
||||||
## [2.2.0]
|
### [2.2.0]
|
||||||
|
|
||||||
### Added
|
#### Added
|
||||||
|
|
||||||
- Allow serviceLinks to be enabled/disabled.
|
- Allow serviceLinks to be enabled/disabled.
|
||||||
- Support for ingressClassName on apiVersion `networking.k8s.io/v1` by setting `ingress.ingressClassName`.
|
- Support for ingressClassName on apiVersion `networking.k8s.io/v1` by setting `ingress.ingressClassName`.
|
||||||
- Added some initial proper unit tests for the `common` chart.
|
- Added some initial proper unit tests for the `common` chart.
|
||||||
|
|
||||||
### Changed
|
#### Changed
|
||||||
|
|
||||||
- `service.port.targetPort` is now used in the container spec instead of `service.port.port` if specified. This allows for different service and container ports. (Implements [#465](https://github.com/k8s-at-home/charts/issues/465)).
|
- `service.port.targetPort` is now used in the container spec instead of `service.port.port` if specified. This allows for different service and container ports. (Implements [#465](https://github.com/k8s-at-home/charts/issues/465)).
|
||||||
|
|
||||||
### Fixed
|
#### Fixed
|
||||||
|
|
||||||
- Document setting environment variables for code-server add-on in `values.yaml` (Fixes [#436](https://github.com/k8s-at-home/charts/issues/436)).
|
- Document setting environment variables for code-server add-on in `values.yaml` (Fixes [#436](https://github.com/k8s-at-home/charts/issues/436)).
|
||||||
- Set service targetPort to the service port name first if no `targetPort` value is given.
|
- Set service targetPort to the service port name first if no `targetPort` value is given.
|
||||||
|
|
||||||
## [2.1.0]
|
### [2.1.0]
|
||||||
|
|
||||||
### Added
|
#### Added
|
||||||
|
|
||||||
- Allow for additional arguments to be added to code-server runtime via `addons.codeserver.args`
|
- Allow for additional arguments to be added to code-server runtime via `addons.codeserver.args`
|
||||||
|
|
||||||
## [2.0.4]
|
### [2.0.4]
|
||||||
|
|
||||||
### Fixed
|
#### Fixed
|
||||||
|
|
||||||
- `periodSeconds` now works for all probe types.
|
- `periodSeconds` now works for all probe types.
|
||||||
|
|
||||||
## [2.0.0]
|
### [2.0.0]
|
||||||
|
|
||||||
### Changed
|
#### Changed
|
||||||
|
|
||||||
- :warning: Updated `probes` logic to support custom probes, it is now possible to set your own custom probes by setting the `probes.[liveness|readiness|startup].custom` value to `true` and configuring them. Default is `false`.
|
- :warning: Updated `probes` logic to support custom probes, it is now possible to set your own custom probes by setting the `probes.[liveness|readiness|startup].custom` value to `true` and configuring them. Default is `false`.
|
||||||
- :warning: `addon.vpn.imagePullPolicy` is now `addon.vpn.[openvpn|wireguard].image.pullPolicy`. Default is `IfNotPresent`
|
- :warning: `addon.vpn.imagePullPolicy` is now `addon.vpn.[openvpn|wireguard].image.pullPolicy`. Default is `IfNotPresent`
|
||||||
@@ -76,26 +114,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- Added support for 1.19+ ingress spec
|
- Added support for 1.19+ ingress spec
|
||||||
- Added this [CHANGELOG.md](CHANGELOG.md)
|
- Added this [CHANGELOG.md](CHANGELOG.md)
|
||||||
|
|
||||||
### Fixed
|
#### Fixed
|
||||||
|
|
||||||
- `nameOverride` and `fullNameOverride` not in `values.yaml`
|
- `nameOverride` and `fullNameOverride` not in `values.yaml`
|
||||||
|
|
||||||
## [1.7.0]
|
### [1.7.0]
|
||||||
|
|
||||||
This is the last version before starting this changelog. All sorts of cool stuff was changed, but only `git log` remembers what that was :slightly_frowning_face:
|
This is the last version before starting this changelog. All sorts of cool stuff was changed, but only `git log` remembers what that was :slightly_frowning_face:
|
||||||
|
|
||||||
[2.4.0]: https://github.com/k8s-at-home/charts/tree/common-2.4.0/charts/common
|
[3.0.1]: #3.0.1
|
||||||
|
|
||||||
[2.3.0]: https://github.com/k8s-at-home/charts/tree/common-2.3.0/charts/common
|
[3.0.0]: #3.0.0
|
||||||
|
|
||||||
[2.2.1]: https://github.com/k8s-at-home/charts/tree/common-2.2.1/charts/common
|
[2.5.1]: #2.5.1
|
||||||
|
|
||||||
[2.2.0]: https://github.com/k8s-at-home/charts/tree/common-2.2.0/charts/common
|
[2.5.0]: #2.5.0
|
||||||
|
|
||||||
[2.1.0]: https://github.com/k8s-at-home/charts/tree/common-2.1.0/charts/common
|
[2.4.0]: #2.4.0
|
||||||
|
|
||||||
[2.0.4]: https://github.com/k8s-at-home/charts/tree/common-2.0.4/charts/common
|
[2.3.0]: #2.3.0
|
||||||
|
|
||||||
[2.0.0]: https://github.com/k8s-at-home/charts/tree/common-2.0.0/charts/common
|
[2.2.1]: #2.2.1
|
||||||
|
|
||||||
[1.7.0]: https://github.com/k8s-at-home/charts/tree/common-1.7.0/charts/common
|
[2.2.0]: #2.2.0
|
||||||
|
|
||||||
|
[2.1.0]: #2.1.0
|
||||||
|
|
||||||
|
[2.0.4]: #2.0.4
|
||||||
|
|
||||||
|
[2.0.0]: #2.0.0
|
||||||
|
|
||||||
|
[1.7.0]: #1.7.0
|
||||||
|
{{- end -}}
|
||||||
82
charts/common/README_CONFIG.md.gotmpl
Normal file
82
charts/common/README_CONFIG.md.gotmpl
Normal file
@@ -0,0 +1,82 @@
|
|||||||
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
|
## Creating a new chart
|
||||||
|
{{- end -}}
|
||||||
|
|
||||||
|
{{- define "custom.custom.configuration" -}}
|
||||||
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
|
First be sure to checkout the many charts that already use this like [qBittorrent](../qbittorrent/), [node-red](../node-red/) or the many others in this repository.
|
||||||
|
|
||||||
|
Include this chart as a dependency in your `Chart.yaml` e.g.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Chart.yaml
|
||||||
|
dependencies:
|
||||||
|
- name: common
|
||||||
|
version: {{ template "chart.version" . }}
|
||||||
|
repository: {{ template "custom.helm.url" . }}
|
||||||
|
```
|
||||||
|
Write a `values.yaml` with some basic defaults you want to present to the user e.g.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
#
|
||||||
|
# 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: nodered/node-red
|
||||||
|
pullPolicy: IfNotPresent
|
||||||
|
tag: 1.2.5
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
type: Recreate
|
||||||
|
|
||||||
|
# See more environment variables in the node-red documentation
|
||||||
|
# https://nodered.org/docs/getting-started/docker
|
||||||
|
env: {}
|
||||||
|
# TZ:
|
||||||
|
# NODE_OPTIONS:
|
||||||
|
# NODE_RED_ENABLE_PROJECTS:
|
||||||
|
# NODE_RED_ENABLE_SAFE_MODE:
|
||||||
|
# FLOWS:
|
||||||
|
|
||||||
|
service:
|
||||||
|
port:
|
||||||
|
port: 1880
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: false
|
||||||
|
|
||||||
|
persistence:
|
||||||
|
data:
|
||||||
|
enabled: false
|
||||||
|
emptyDir: false
|
||||||
|
mountPath: /data
|
||||||
|
```
|
||||||
|
|
||||||
|
If not using a service, set the `service.enabled` to `false`.
|
||||||
|
```yaml
|
||||||
|
...
|
||||||
|
service:
|
||||||
|
enabled: false
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Add files to the `templates` folder.
|
||||||
|
```yaml
|
||||||
|
# templates/common.yaml
|
||||||
|
{{"{{"}} include "common.all . {{"}}"}}
|
||||||
|
|
||||||
|
# templates/NOTES.txt
|
||||||
|
{{"{{"}} include "common.notes.defaultNotes" . {{"}}"}}
|
||||||
|
```
|
||||||
|
|
||||||
|
If testing locally make sure you update the dependencies with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
helm dependency update
|
||||||
|
```
|
||||||
|
{{- end -}}
|
||||||
@@ -6,7 +6,7 @@ Default NOTES.txt content.
|
|||||||
1. Get the application URL by running these commands:
|
1. Get the application URL by running these commands:
|
||||||
{{- if .Values.ingress.enabled }}
|
{{- if .Values.ingress.enabled }}
|
||||||
{{- range .Values.ingress.hosts }}
|
{{- range .Values.ingress.hosts }}
|
||||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ .host }}{{ (first .paths).path }}
|
http{{ if $.Values.ingress.tls }}s{{ end }}://{{- if .hostTpl }}{{ tpl .hostTpl $ }}{{ else }}{{ .host }}{{ end }}{{ (first .paths).path }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
{{- else if contains "NodePort" .Values.service.type }}
|
{{- else if contains "NodePort" .Values.service.type }}
|
||||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "common.names.fullname" . }})
|
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "common.names.fullname" . }})
|
||||||
|
|||||||
@@ -38,12 +38,23 @@ spec:
|
|||||||
{{- range .hosts }}
|
{{- range .hosts }}
|
||||||
- {{ . | quote }}
|
- {{ . | quote }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
{{- range .hostsTpl }}
|
||||||
|
- {{ tpl . $ | quote }}
|
||||||
|
{{- end }}
|
||||||
|
{{- if .secretNameTpl }}
|
||||||
|
secretName: {{ tpl .secretNameTpl $ | quote}}
|
||||||
|
{{- else }}
|
||||||
secretName: {{ .secretName }}
|
secretName: {{ .secretName }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
rules:
|
rules:
|
||||||
{{- range $values.hosts }}
|
{{- range $values.hosts }}
|
||||||
|
{{- if .hostTpl }}
|
||||||
|
- host: {{ tpl .hostTpl $ | quote }}
|
||||||
|
{{- else }}
|
||||||
- host: {{ .host | quote }}
|
- host: {{ .host | quote }}
|
||||||
|
{{- end }}
|
||||||
http:
|
http:
|
||||||
paths:
|
paths:
|
||||||
{{- range .paths }}
|
{{- range .paths }}
|
||||||
|
|||||||
@@ -98,10 +98,10 @@ probes:
|
|||||||
## The spec field contains the values for the default livenessProbe.
|
## The spec field contains the values for the default livenessProbe.
|
||||||
## If you selected custom: true, this field holds the definition of the livenessProbe.
|
## If you selected custom: true, this field holds the definition of the livenessProbe.
|
||||||
spec:
|
spec:
|
||||||
initialDelaySeconds: 30
|
initialDelaySeconds: 0
|
||||||
failureThreshold: 5
|
|
||||||
periodSeconds: 10
|
periodSeconds: 10
|
||||||
timeoutSeconds: 10
|
timeoutSeconds: 1
|
||||||
|
failureThreshold: 3
|
||||||
|
|
||||||
readiness:
|
readiness:
|
||||||
enabled: true
|
enabled: true
|
||||||
@@ -110,22 +110,23 @@ probes:
|
|||||||
## The spec field contains the values for the default readinessProbe.
|
## The spec field contains the values for the default readinessProbe.
|
||||||
## If you selected custom: true, this field holds the definition of the readinessProbe.
|
## If you selected custom: true, this field holds the definition of the readinessProbe.
|
||||||
spec:
|
spec:
|
||||||
initialDelaySeconds: 30
|
initialDelaySeconds: 0
|
||||||
failureThreshold: 5
|
|
||||||
periodSeconds: 10
|
periodSeconds: 10
|
||||||
timeoutSeconds: 10
|
timeoutSeconds: 1
|
||||||
|
failureThreshold: 3
|
||||||
|
|
||||||
startup:
|
startup:
|
||||||
enabled: false
|
enabled: true
|
||||||
## Set this to true if you wish to specify your own startupProbe
|
## Set this to true if you wish to specify your own startupProbe
|
||||||
custom: false
|
custom: false
|
||||||
## The spec field contains the values for the default startupProbe.
|
## The spec field contains the values for the default startupProbe.
|
||||||
## If you selected custom: true, this field holds the definition of the startupProbe.
|
## If you selected custom: true, this field holds the definition of the startupProbe.
|
||||||
spec:
|
spec:
|
||||||
initialDelaySeconds: 5
|
initialDelaySeconds: 0
|
||||||
|
timeoutSeconds: 1
|
||||||
|
## This means it has a maximum of 5*30=150 seconds to start up before it fails
|
||||||
|
periodSeconds: 5
|
||||||
failureThreshold: 30
|
failureThreshold: 30
|
||||||
periodSeconds: 10
|
|
||||||
timeoutSeconds: 10
|
|
||||||
|
|
||||||
service:
|
service:
|
||||||
enabled: true
|
enabled: true
|
||||||
@@ -176,16 +177,24 @@ ingress:
|
|||||||
# kubernetes.io/ingress.class: nginx
|
# kubernetes.io/ingress.class: nginx
|
||||||
# kubernetes.io/tls-acme: "true"
|
# kubernetes.io/tls-acme: "true"
|
||||||
labels: {}
|
labels: {}
|
||||||
|
# ingressClassName: "nginx"
|
||||||
hosts:
|
hosts:
|
||||||
- host: chart-example.local
|
- host: chart-example.local
|
||||||
|
## Or a tpl that is evaluated
|
||||||
|
# hostTpl: '{{ include "common.names.fullname" . }}.{{ .Release.Namespace }}.{{ .Values.ingress.domainname }}'
|
||||||
paths:
|
paths:
|
||||||
- path: /
|
- path: /
|
||||||
# Ignored if not kubeVersion >= 1.14-0
|
# Ignored if not kubeVersion >= 1.14-0
|
||||||
pathType: Prefix
|
pathType: Prefix
|
||||||
tls: []
|
tls: []
|
||||||
# - secretName: chart-example-tls
|
# - secretName: chart-example-tls
|
||||||
|
## Or if you need a dynamic secretname
|
||||||
|
# - secretNameTpl: '{{ include "common.names.fullname" . }}-ingress'
|
||||||
# hosts:
|
# hosts:
|
||||||
# - chart-example.local
|
# - chart-example.local
|
||||||
|
## Or a tpl that is evaluated
|
||||||
|
# hostsTpl:
|
||||||
|
# - '{{ include "common.names.fullname" . }}.{{ .Release.Namespace }}.{{ .Values.ingress.domainname }}'
|
||||||
additionalIngresses: []
|
additionalIngresses: []
|
||||||
# - enabled: false
|
# - enabled: false
|
||||||
# nameSuffix: "api"
|
# nameSuffix: "api"
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
apiVersion: v2
|
|
||||||
appVersion: latest
|
|
||||||
description: CouchPotato (CP) is an automatic NZB and torrent downloader.
|
|
||||||
name: couchpotato
|
|
||||||
version: 4.4.0
|
|
||||||
keywords:
|
|
||||||
- couchpotato
|
|
||||||
- usenet
|
|
||||||
- bittorrent
|
|
||||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/couchpotato
|
|
||||||
icon: https://github.com/CouchPotato/CouchPotatoServer/raw/master/couchpotato/static/images/icons/android.png
|
|
||||||
sources:
|
|
||||||
- https://hub.docker.com/r/linuxserver/couchpotato/
|
|
||||||
- https://github.com/CouchPotato/CouchPotatoServer/
|
|
||||||
maintainers:
|
|
||||||
- name: billimek
|
|
||||||
email: jeff@billimek.com
|
|
||||||
dependencies:
|
|
||||||
- name: common
|
|
||||||
repository: https://k8s-at-home.com/charts/
|
|
||||||
version: 2.4.0
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
# Default values for Couchpotato.
|
|
||||||
|
|
||||||
image:
|
|
||||||
repository: linuxserver/couchpotato
|
|
||||||
pullPolicy: Always
|
|
||||||
tag: latest
|
|
||||||
|
|
||||||
strategy:
|
|
||||||
type: Recreate
|
|
||||||
|
|
||||||
service:
|
|
||||||
port:
|
|
||||||
port: 5050
|
|
||||||
|
|
||||||
env: {}
|
|
||||||
# TZ: UTC
|
|
||||||
# PUID: 1001
|
|
||||||
# PGID: 1001
|
|
||||||
|
|
||||||
persistence:
|
|
||||||
config:
|
|
||||||
enabled: false
|
|
||||||
emptyDir: false
|
|
||||||
|
|
||||||
media:
|
|
||||||
enabled: false
|
|
||||||
emptyDir: false
|
|
||||||
mountPath: /media
|
|
||||||
## Persistent Volume Storage Class
|
|
||||||
## If defined, storageClassName: <storageClass>
|
|
||||||
## If set to "-", storageClassName: "", which disables dynamic provisioning
|
|
||||||
## If undefined (the default) or set to null, no storageClassName spec is
|
|
||||||
## set, choosing the default provisioner. (gp2 on AWS, standard on
|
|
||||||
## GKE, AWS & OpenStack)
|
|
||||||
# storageClass: "-"
|
|
||||||
# accessMode: ReadWriteOnce
|
|
||||||
# size: 1Gi
|
|
||||||
## Do not delete the pvc upon helm uninstall
|
|
||||||
# skipuninstall: false
|
|
||||||
# existingClaim: ""
|
|
||||||
@@ -22,3 +22,5 @@
|
|||||||
.vscode/
|
.vscode/
|
||||||
# OWNERS file for Kubernetes
|
# OWNERS file for Kubernetes
|
||||||
OWNERS
|
OWNERS
|
||||||
|
# helm-docs templates
|
||||||
|
*.gotmpl
|
||||||
|
|||||||
@@ -2,19 +2,20 @@ apiVersion: v2
|
|||||||
appVersion: 3.9.1
|
appVersion: 3.9.1
|
||||||
description: Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Providers
|
description: Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Providers
|
||||||
name: ddclient
|
name: ddclient
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
keywords:
|
keywords:
|
||||||
- ddclient
|
- ddclient
|
||||||
- dns
|
- dns
|
||||||
home: https://github.com/ddclient/ddclient
|
home: https://github.com/ddclient/ddclient
|
||||||
icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ddclient-logo.png
|
icon: https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ddclient-logo.png
|
||||||
sources:
|
sources:
|
||||||
- https://github.com/ddclient/ddclient
|
- https://github.com/ddclient/ddclient
|
||||||
- https://hub.docker.com/r/linuxserver/ddclient
|
- https://hub.docker.com/r/linuxserver/ddclient
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: billimek
|
- name: billimek
|
||||||
email: jeff@billimek.com
|
email: jeff@billimek.com
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: common
|
- name: common
|
||||||
repository: https://k8s-at-home.com/charts/
|
repository: https://k8s-at-home.com/charts/
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
@@ -1,61 +1,121 @@
|
|||||||
# ddclient
|
# ddclient
|
||||||
|
|
||||||
This is a helm chart for [ddclient](https://github.com/ddclient/ddclient).
|
 
|
||||||
|
|
||||||
|
Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Providers
|
||||||
|
|
||||||
**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)**
|
**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)**
|
||||||
|
|
||||||
## TL;DR;
|
## Source Code
|
||||||
|
|
||||||
```shell
|
* <https://github.com/ddclient/ddclient>
|
||||||
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
* <https://hub.docker.com/r/linuxserver/ddclient>
|
||||||
$ helm install k8s-at-home/ddclient
|
|
||||||
|
## 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 ddclient k8s-at-home/ddclient
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
To install the chart with the release name `ddclient`
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install --name my-release k8s-at-home/ddclient
|
helm install ddclient k8s-at-home/ddclient
|
||||||
```
|
```
|
||||||
|
|
||||||
## Uninstalling the Chart
|
## Uninstalling the Chart
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
To uninstall the `ddclient` deployment
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm delete my-release --purge
|
helm uninstall ddclient
|
||||||
```
|
```
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/ddclient/values.yaml)
|
|
||||||
file. It has several commented out suggested values.
|
|
||||||
Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options.
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
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
|
```console
|
||||||
helm install ddclient \
|
helm install ddclient \
|
||||||
--set env.TZ="America/New_York" \
|
--set env.TZ="America/New York" \
|
||||||
k8s-at-home/ddclient
|
k8s-at-home/ddclient
|
||||||
```
|
```
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
|
|
||||||
chart. For example,
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
helm install ddclient k8s-at-home/ddclient --values values.yaml
|
helm install ddclient k8s-at-home/ddclient -f values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml
|
## Custom configuration
|
||||||
image:
|
|
||||||
tag: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
N/A
|
||||||
**NOTE**
|
|
||||||
|
|
||||||
If you get
|
## Values
|
||||||
```console
|
|
||||||
Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...`
|
**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/)
|
||||||
```
|
|
||||||
it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`.
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| config | string | `"# This is the configuration for ddclient\n# Inorder for it to function you need to set it up\n# e.g. this is the config for Cloudflare\nuse=web\nweb=dynamicdns.park-your-domain.com/getip\nprotocol=cloudflare\nssl=yes\nttl=1\nlogin=${CF_EMAIL}\npassword=${CF_GLOBAL_APIKEY}\nzone=${DOMAIN}.${TLD}\n${DOMAIN}.${TLD}\n"` | |
|
||||||
|
| env | object | `{}` | |
|
||||||
|
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||||
|
| image.repository | string | `"linuxserver/ddclient"` | |
|
||||||
|
| image.tag | string | `"version-v3.9.1"` | |
|
||||||
|
| ingress.enabled | bool | `false` | |
|
||||||
|
| probes.liveness.enabled | bool | `false` | |
|
||||||
|
| probes.readiness.enabled | bool | `false` | |
|
||||||
|
| probes.startup.enabled | bool | `false` | |
|
||||||
|
| service.enabled | bool | `false` | |
|
||||||
|
| 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
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||||
145
charts/ddclient/README.md.gotmpl
Normal file
145
charts/ddclient/README.md.gotmpl
Normal file
@@ -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" . }}
|
||||||
27
charts/ddclient/README_CHANGELOG.md.gotmpl
Normal file
27
charts/ddclient/README_CHANGELOG.md.gotmpl
Normal file
@@ -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 -}}
|
||||||
9
charts/ddclient/README_CONFIG.md.gotmpl
Normal file
9
charts/ddclient/README_CONFIG.md.gotmpl
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
|
## Custom configuration
|
||||||
|
{{- end -}}
|
||||||
|
|
||||||
|
{{- define "custom.custom.configuration" -}}
|
||||||
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
|
N/A
|
||||||
|
{{- end -}}
|
||||||
@@ -1,10 +1,18 @@
|
|||||||
# Default values for ddclient.
|
#
|
||||||
|
# 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:
|
image:
|
||||||
repository: linuxserver/ddclient
|
repository: linuxserver/ddclient
|
||||||
pullPolicy: IfNotPresent
|
pullPolicy: IfNotPresent
|
||||||
tag: version-v3.9.1
|
tag: version-v3.9.1
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
type: Recreate
|
||||||
|
|
||||||
env: {}
|
env: {}
|
||||||
# TZ:
|
# TZ:
|
||||||
# PUID:
|
# PUID:
|
||||||
@@ -13,6 +21,9 @@ env: {}
|
|||||||
service:
|
service:
|
||||||
enabled: false
|
enabled: false
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
enabled: false
|
||||||
|
|
||||||
probes:
|
probes:
|
||||||
liveness:
|
liveness:
|
||||||
enabled: false
|
enabled: false
|
||||||
@@ -21,9 +32,6 @@ probes:
|
|||||||
startup:
|
startup:
|
||||||
enabled: false
|
enabled: false
|
||||||
|
|
||||||
strategy:
|
|
||||||
type: Recreate
|
|
||||||
|
|
||||||
config: |
|
config: |
|
||||||
# This is the configuration for ddclient
|
# This is the configuration for ddclient
|
||||||
# Inorder for it to function you need to set it up
|
# Inorder for it to function you need to set it up
|
||||||
|
|||||||
@@ -19,6 +19,8 @@
|
|||||||
.project
|
.project
|
||||||
.idea/
|
.idea/
|
||||||
*.tmproj
|
*.tmproj
|
||||||
|
.vscode/
|
||||||
# OWNERS file for Kubernetes
|
# OWNERS file for Kubernetes
|
||||||
OWNERS
|
OWNERS
|
||||||
.vscode/
|
# helm-docs templates
|
||||||
|
*.gotmpl
|
||||||
|
|||||||
@@ -2,19 +2,20 @@ apiVersion: v2
|
|||||||
appVersion: v2.0.3-2201906121747
|
appVersion: v2.0.3-2201906121747
|
||||||
description: Deluge is a torrent download client
|
description: Deluge is a torrent download client
|
||||||
name: deluge
|
name: deluge
|
||||||
version: 1.2.0
|
version: 2.0.1
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
keywords:
|
keywords:
|
||||||
- deluge
|
- deluge
|
||||||
- torrent
|
- torrent
|
||||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/deluge
|
home: https://github.com/k8s-at-home/charts/tree/master/charts/deluge
|
||||||
icon: https://avatars2.githubusercontent.com/u/6733935?v=3&s=200
|
icon: https://avatars2.githubusercontent.com/u/6733935?v=3&s=200
|
||||||
sources:
|
sources:
|
||||||
- https://hub.docker.com/r/linuxserver/deluge/
|
- https://hub.docker.com/r/linuxserver/deluge/
|
||||||
- https://deluge-torrent.org/
|
- https://deluge-torrent.org/
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: mcmarkj
|
- name: mcmarkj
|
||||||
email: mark@markmcw.uk
|
email: mark@markmcw.uk
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: common
|
- name: common
|
||||||
repository: https://k8s-at-home.com/charts/
|
repository: https://k8s-at-home.com/charts/
|
||||||
version: 2.4.0
|
version: 3.0.1
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
approvers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
reviewers:
|
|
||||||
- billimek
|
|
||||||
- onedr0p
|
|
||||||
- bjw-s
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user