Compare commits
34 Commits
intel-gpu-
...
dsmr-reade
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
11d18f1fe5 | ||
|
|
14c1ea96e3 | ||
|
|
9b04daa026 | ||
|
|
54074cc4a4 | ||
|
|
8eb2c6f8bd | ||
|
|
8b2a8b906c | ||
|
|
5119815aea | ||
|
|
060d27f9e7 | ||
|
|
76ca8d4fa3 | ||
|
|
959bdc6d6a | ||
|
|
5a0a792cc7 | ||
|
|
a5bdcad97b | ||
|
|
de46063893 | ||
|
|
70ea338e4e | ||
|
|
abf2d3b857 | ||
|
|
5b57026d00 | ||
|
|
d6fadad88f | ||
|
|
ddc9693916 | ||
|
|
6283f771be | ||
|
|
802ee07407 | ||
|
|
6a48d3fdb0 | ||
|
|
4a02be7d10 | ||
|
|
837f1c396e | ||
|
|
1b751c7d3e | ||
|
|
b191930b0c | ||
|
|
7b746e514d | ||
|
|
f6f548e7fb | ||
|
|
ab6cbbb1b0 | ||
|
|
194990c6c0 | ||
|
|
761d9996f6 | ||
|
|
e238de9de2 | ||
|
|
b648e8cddc | ||
|
|
8993e6d60b | ||
|
|
beaf1d697a |
87
.all-contributorsrc
Normal file
87
.all-contributorsrc
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
{
|
||||||
|
"files": [
|
||||||
|
"README.md"
|
||||||
|
],
|
||||||
|
"imageSize": 100,
|
||||||
|
"commit": false,
|
||||||
|
"contributors": [
|
||||||
|
{
|
||||||
|
"login": "devfaz",
|
||||||
|
"name": "Fabian Zimmermann",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/4060372?v=4",
|
||||||
|
"profile": "https://github.com/devfaz",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "angelnu",
|
||||||
|
"name": "Vegetto",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/4406403?v=4",
|
||||||
|
"profile": "https://github.com/angelnu",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "trly",
|
||||||
|
"name": "Travis Lyons",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/212733?v=4",
|
||||||
|
"profile": "https://github.com/trly",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "bjw-s",
|
||||||
|
"name": "Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/6213398?v=4",
|
||||||
|
"profile": "https://github.com/bjw-s",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "Ornias1993",
|
||||||
|
"name": "Kjeld Schouten-Lebbing",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/7613738?v=4",
|
||||||
|
"profile": "http://schouten-lebbing.nl",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "rolfberkenbosch",
|
||||||
|
"name": "Rolf Berkenbosch",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/30292281?v=4",
|
||||||
|
"profile": "https://www.meetup.com/nl-NL/I-I-Inspiratie-Innovatie/",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "auricom",
|
||||||
|
"name": "auricom",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/27022259?v=4",
|
||||||
|
"profile": "https://github.com/auricom",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "acjohnson",
|
||||||
|
"name": "Aaron Johnson",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/1386238?v=4",
|
||||||
|
"profile": "http://aaronjohnson.io",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"contributorsPerLine": 7,
|
||||||
|
"projectName": "charts",
|
||||||
|
"projectOwner": "k8s-at-home",
|
||||||
|
"repoType": "github",
|
||||||
|
"repoHost": "https://github.com",
|
||||||
|
"skipCi": true
|
||||||
|
}
|
||||||
10
.github/ct-install.yaml
vendored
10
.github/ct-install.yaml
vendored
@@ -2,11 +2,13 @@ remote: origin
|
|||||||
target-branch: master
|
target-branch: master
|
||||||
helm-extra-args: --timeout 600s
|
helm-extra-args: --timeout 600s
|
||||||
chart-dirs:
|
chart-dirs:
|
||||||
- charts
|
- charts/incubator
|
||||||
|
- charts/stable
|
||||||
excluded-charts:
|
excluded-charts:
|
||||||
- alertmanager-bot
|
- charts/stable/alertmanager-bot
|
||||||
- dnsmadeeasy-webhook
|
- charts/stable/dnsmadeeasy-webhook
|
||||||
- zigbee2mqtt
|
- charts/stable/ser2sock
|
||||||
|
- charts/stable/zigbee2mqtt
|
||||||
chart-repos:
|
chart-repos:
|
||||||
- bitnami=https://charts.bitnami.com/bitnami
|
- bitnami=https://charts.bitnami.com/bitnami
|
||||||
- k8s-at-home-libraries=https://library-charts.k8s-at-home.com
|
- k8s-at-home-libraries=https://library-charts.k8s-at-home.com
|
||||||
|
|||||||
3
.github/ct-lint.yaml
vendored
3
.github/ct-lint.yaml
vendored
@@ -2,7 +2,8 @@ remote: origin
|
|||||||
target-branch: master
|
target-branch: master
|
||||||
helm-extra-args: --timeout 600s
|
helm-extra-args: --timeout 600s
|
||||||
chart-dirs:
|
chart-dirs:
|
||||||
- charts
|
- charts/incubator
|
||||||
|
- charts/stable
|
||||||
excluded-charts:
|
excluded-charts:
|
||||||
chart-repos:
|
chart-repos:
|
||||||
- bitnami=https://charts.bitnami.com/bitnami
|
- bitnami=https://charts.bitnami.com/bitnami
|
||||||
|
|||||||
2
.github/workflows/charts-helm-docs.yaml
vendored
2
.github/workflows/charts-helm-docs.yaml
vendored
@@ -1,7 +1,7 @@
|
|||||||
name: "Charts: helm-docs"
|
name: "Charts: helm-docs"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
schedule:
|
schedule:
|
||||||
- cron: "0 0 * * *"
|
- cron: "0 0 * * *"
|
||||||
|
|
||||||
|
|||||||
190
.github/workflows/charts-lint-test.yaml
vendored
190
.github/workflows/charts-lint-test.yaml
vendored
@@ -10,11 +10,91 @@ on:
|
|||||||
- '!charts/**/README_CONFIG.md.gotmpl'
|
- '!charts/**/README_CONFIG.md.gotmpl'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint:
|
changes-lint:
|
||||||
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||||
|
name: Detect changes for linting
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-20.04
|
||||||
outputs:
|
outputs:
|
||||||
changed: ${{ steps.list-changed.outputs.changed }}
|
matrix: |
|
||||||
|
{
|
||||||
|
"chart": ${{ steps.list-changed.outputs.charts }}
|
||||||
|
}
|
||||||
|
detected: ${{ steps.list-changed.outputs.detected }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Set up chart-testing
|
||||||
|
uses: helm/chart-testing-action@v2.0.1
|
||||||
|
|
||||||
|
- name: Install Dev tools
|
||||||
|
run: |
|
||||||
|
sudo wget https://github.com/mikefarah/yq/releases/download/v4.2.0/yq_linux_amd64 -O /usr/bin/yq
|
||||||
|
sudo chmod +x /usr/bin/yq
|
||||||
|
|
||||||
|
- name: Run chart-testing (list-changed)
|
||||||
|
id: list-changed
|
||||||
|
run: |
|
||||||
|
EXCLUDED=$(yq eval -j '.excluded-charts // []' .github/ct-lint.yaml)
|
||||||
|
CHARTS=$(ct list-changed --config .github/ct-lint.yaml)
|
||||||
|
CHARTS_JSON=$(echo "${CHARTS}" | jq -R -s -c 'split("\n")[:-1]')
|
||||||
|
OUTPUT_JSON=$(echo "{\"excluded\": ${EXCLUDED}, \"all\": ${CHARTS_JSON}}" | jq -c '.all-.excluded')
|
||||||
|
echo ::set-output name=charts::${OUTPUT_JSON}
|
||||||
|
if [[ $(echo ${OUTPUT_JSON} | jq -c '. | length') -gt 0 ]]; then
|
||||||
|
echo "::set-output name=detected::true"
|
||||||
|
fi
|
||||||
|
|
||||||
|
changes-install:
|
||||||
|
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||||
|
name: Detect changes for install
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
|
outputs:
|
||||||
|
matrix: |
|
||||||
|
{
|
||||||
|
"chart": ${{ steps.list-changed.outputs.charts }}
|
||||||
|
}
|
||||||
|
detected: ${{ steps.list-changed.outputs.detected }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Set up chart-testing
|
||||||
|
uses: helm/chart-testing-action@v2.0.1
|
||||||
|
|
||||||
|
- name: Install Dev tools
|
||||||
|
run: |
|
||||||
|
sudo wget https://github.com/mikefarah/yq/releases/download/v4.2.0/yq_linux_amd64 -O /usr/bin/yq
|
||||||
|
sudo chmod +x /usr/bin/yq
|
||||||
|
|
||||||
|
- name: Run chart-testing (list-changed)
|
||||||
|
id: list-changed
|
||||||
|
run: |
|
||||||
|
EXCLUDED=$(yq eval -j '.excluded-charts // []' .github/ct-install.yaml)
|
||||||
|
CHARTS=$(ct list-changed --config .github/ct-install.yaml)
|
||||||
|
CHARTS_JSON=$(echo "${CHARTS}" | jq -R -s -c 'split("\n")[:-1]')
|
||||||
|
OUTPUT_JSON=$(echo "{\"excluded\": ${EXCLUDED}, \"all\": ${CHARTS_JSON}}" | jq -c '.all-.excluded')
|
||||||
|
echo ::set-output name=charts::${OUTPUT_JSON}
|
||||||
|
if [[ $(echo ${OUTPUT_JSON} | jq -c '. | length') -gt 0 ]]; then
|
||||||
|
echo "::set-output name=detected::true"
|
||||||
|
fi
|
||||||
|
|
||||||
|
lint:
|
||||||
|
needs:
|
||||||
|
- changes-lint
|
||||||
|
if: |
|
||||||
|
!contains(github.event.head_commit.message, '[ci-skip]')
|
||||||
|
&&
|
||||||
|
needs.changes-lint.outputs.detected == 'true'
|
||||||
|
name: Lint charts
|
||||||
|
strategy:
|
||||||
|
matrix: ${{ fromJson(needs.changes-lint.outputs.matrix) }}
|
||||||
|
fail-fast: true
|
||||||
|
max-parallel: 15
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
@@ -26,6 +106,47 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
version: v3.5.3
|
version: v3.5.3
|
||||||
|
|
||||||
|
- name: Get version
|
||||||
|
id: version-get
|
||||||
|
run: |
|
||||||
|
shopt -s extglob
|
||||||
|
OUTPUT=$(helm inspect chart ${{ matrix.chart }} | grep "^version:")
|
||||||
|
VERSION=${OUTPUT#"version:"}
|
||||||
|
echo "::set-output name=version::${VERSION##*( )}"
|
||||||
|
shopt -u extglob
|
||||||
|
|
||||||
|
- name: Parse version
|
||||||
|
id: version-parse
|
||||||
|
uses: apexskier/github-semver-parse@v1
|
||||||
|
with:
|
||||||
|
version: ${{ steps.version-get.outputs.version }}
|
||||||
|
|
||||||
|
- name: Check version
|
||||||
|
id: version-check
|
||||||
|
run: |
|
||||||
|
if [[ ${{ matrix.chart }} =~ ^charts\/(.*)\/.* ]]; then
|
||||||
|
TYPE="${BASH_REMATCH[1]}"
|
||||||
|
case $TYPE in
|
||||||
|
stable)
|
||||||
|
if [[ ${{ steps.version-parse.outputs.major }} -lt 1 ]]; then
|
||||||
|
echo "Chart version for \"$TYPE\" charts must be >= 1.0.0"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
|
||||||
|
incubator)
|
||||||
|
if [[ ${{ steps.version-parse.outputs.major }} -gt 0 ]]; then
|
||||||
|
echo "Chart version for \"$TYPE\" charts must be < 1.0.0"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
|
||||||
|
*)
|
||||||
|
echo "Unhandled chart type: $TYPE"
|
||||||
|
exit 1
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
- uses: actions/setup-python@v2
|
- uses: actions/setup-python@v2
|
||||||
with:
|
with:
|
||||||
python-version: 3.7
|
python-version: 3.7
|
||||||
@@ -33,23 +154,29 @@ jobs:
|
|||||||
- name: Set up chart-testing
|
- name: Set up chart-testing
|
||||||
uses: helm/chart-testing-action@v2.0.1
|
uses: helm/chart-testing-action@v2.0.1
|
||||||
|
|
||||||
- name: Run chart-testing (list-changed)
|
|
||||||
id: list-changed
|
|
||||||
run: |
|
|
||||||
changed=$(ct list-changed --config .github/ct-lint.yaml)
|
|
||||||
if [[ -n "$changed" ]]; then
|
|
||||||
echo "::set-output name=changed::true"
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Run chart-testing (lint)
|
- name: Run chart-testing (lint)
|
||||||
id: lint
|
id: lint
|
||||||
run: ct lint --config .github/ct-lint.yaml
|
run: ct lint --config .github/ct-lint.yaml --charts ${{ matrix.chart }}
|
||||||
if: steps.list-changed.outputs.changed == 'true'
|
|
||||||
|
# Summarize matrix https://github.community/t/status-check-for-a-matrix-jobs/127354/7
|
||||||
|
lint_success:
|
||||||
|
needs:
|
||||||
|
- lint
|
||||||
|
if: ${{ always() }}
|
||||||
|
name: Lint successful
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
|
steps:
|
||||||
|
- name: Check lint matrix status
|
||||||
|
if: ${{ needs.lint.result != 'success' }}
|
||||||
|
run: exit 1
|
||||||
|
|
||||||
unittest:
|
unittest:
|
||||||
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
needs:
|
||||||
|
- lint_success
|
||||||
|
if: |
|
||||||
|
!contains(github.event.head_commit.message, '[ci-skip]')
|
||||||
|
name: Run unit tests
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-20.04
|
||||||
needs: lint
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
@@ -70,18 +197,29 @@ jobs:
|
|||||||
ruby-version: 2.7
|
ruby-version: 2.7
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
|
env:
|
||||||
|
RUBYJQ_USE_SYSTEM_LIBRARIES: 1
|
||||||
run: |
|
run: |
|
||||||
export RUBYJQ_USE_SYSTEM_LIBRARIES=1
|
|
||||||
bundle install
|
bundle install
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: |
|
run: |
|
||||||
bundle exec m -r test/charts
|
bundle exec m -r ./test/
|
||||||
|
|
||||||
install:
|
install:
|
||||||
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
needs:
|
||||||
|
- changes-install
|
||||||
|
- lint_success
|
||||||
|
if: |
|
||||||
|
!contains(github.event.head_commit.message, '[ci-skip]')
|
||||||
|
&&
|
||||||
|
needs.changes-install.outputs.detected == 'true'
|
||||||
|
name: Install charts
|
||||||
|
strategy:
|
||||||
|
matrix: ${{ fromJson(needs.changes-install.outputs.matrix) }}
|
||||||
|
fail-fast: true
|
||||||
|
max-parallel: 15
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-20.04
|
||||||
needs: lint
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
@@ -104,8 +242,18 @@ jobs:
|
|||||||
uses: nolar/setup-k3d-k3s@v1
|
uses: nolar/setup-k3d-k3s@v1
|
||||||
with:
|
with:
|
||||||
version: v1.19
|
version: v1.19
|
||||||
if: needs.lint.outputs.changed == 'true'
|
|
||||||
|
|
||||||
- name: Run chart-testing (install)
|
- name: Run chart-testing (install)
|
||||||
run: ct install --config .github/ct-install.yaml
|
run: ct install --config .github/ct-install.yaml --charts ${{ matrix.chart }}
|
||||||
if: needs.lint.outputs.changed == 'true'
|
|
||||||
|
# Summarize matrix https://github.community/t/status-check-for-a-matrix-jobs/127354/7
|
||||||
|
install_success:
|
||||||
|
needs:
|
||||||
|
- install
|
||||||
|
if: ${{ always() }}
|
||||||
|
name: Install successful
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
|
steps:
|
||||||
|
- name: Check install matrix status
|
||||||
|
if: ${{ needs.install.result != 'success' }}
|
||||||
|
run: exit 1
|
||||||
|
|||||||
2
.github/workflows/charts-release.yaml
vendored
2
.github/workflows/charts-release.yaml
vendored
@@ -1,6 +1,7 @@
|
|||||||
name: "Charts: Release"
|
name: "Charts: Release"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
@@ -54,6 +55,7 @@ jobs:
|
|||||||
- name: Run chart-releaser
|
- name: Run chart-releaser
|
||||||
uses: helm/chart-releaser-action@v1.2.0
|
uses: helm/chart-releaser-action@v1.2.0
|
||||||
with:
|
with:
|
||||||
|
charts_dir: charts/*
|
||||||
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 }}"
|
||||||
|
|||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -7,8 +7,8 @@
|
|||||||
.devcontainer/
|
.devcontainer/
|
||||||
|
|
||||||
# Helm resources
|
# Helm resources
|
||||||
charts/*/Chart.lock
|
charts/**/Chart.lock
|
||||||
charts/*/charts
|
charts/**/charts
|
||||||
|
|
||||||
# Other rsources
|
# Other rsources
|
||||||
.env
|
.env
|
||||||
|
|||||||
@@ -1,8 +1 @@
|
|||||||
charts/homebridge
|
|
||||||
charts/librespeed
|
|
||||||
charts/node-feature-discovery
|
|
||||||
charts/oauth2-proxy
|
|
||||||
charts/ser2sock
|
|
||||||
charts/speedtest
|
|
||||||
charts/unifi
|
|
||||||
charts/uptimerobot
|
charts/uptimerobot
|
||||||
|
|||||||
32
README.md
32
README.md
@@ -1,4 +1,7 @@
|
|||||||
# Helm charts
|
# Helm charts
|
||||||
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||||
|
[](#contributors-)
|
||||||
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||||
|
|
||||||
[](https://github.com/pre-commit/pre-commit)
|
[](https://github.com/pre-commit/pre-commit)
|
||||||
[](https://discord.gg/sTMX7Vh)
|
[](https://discord.gg/sTMX7Vh)
|
||||||
@@ -34,3 +37,32 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md)
|
|||||||
## License
|
## License
|
||||||
|
|
||||||
[Apache 2.0 License](./LICENSE)
|
[Apache 2.0 License](./LICENSE)
|
||||||
|
|
||||||
|
## Contributors ✨
|
||||||
|
|
||||||
|
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||||
|
|
||||||
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- markdownlint-disable -->
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<td align="center"><a href="https://github.com/devfaz"><img src="https://avatars.githubusercontent.com/u/4060372?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fabian Zimmermann</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=devfaz" title="Code">💻</a></td>
|
||||||
|
<td align="center"><a href="https://github.com/angelnu"><img src="https://avatars.githubusercontent.com/u/4406403?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vegetto</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=angelnu" title="Code">💻</a></td>
|
||||||
|
<td align="center"><a href="https://github.com/trly"><img src="https://avatars.githubusercontent.com/u/212733?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Travis Lyons</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=trly" title="Code">💻</a></td>
|
||||||
|
<td align="center"><a href="https://github.com/bjw-s"><img src="https://avatars.githubusercontent.com/u/6213398?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=bjw-s" title="Code">💻</a></td>
|
||||||
|
<td align="center"><a href="http://schouten-lebbing.nl"><img src="https://avatars.githubusercontent.com/u/7613738?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kjeld Schouten-Lebbing</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=Ornias1993" title="Code">💻</a></td>
|
||||||
|
<td align="center"><a href="https://www.meetup.com/nl-NL/I-I-Inspiratie-Innovatie/"><img src="https://avatars.githubusercontent.com/u/30292281?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rolf Berkenbosch</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=rolfberkenbosch" title="Code">💻</a></td>
|
||||||
|
<td align="center"><a href="https://github.com/auricom"><img src="https://avatars.githubusercontent.com/u/27022259?v=4?s=100" width="100px;" alt=""/><br /><sub><b>auricom</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=auricom" title="Code">💻</a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center"><a href="http://aaronjohnson.io"><img src="https://avatars.githubusercontent.com/u/1386238?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aaron Johnson</b></sub></a><br /><a href="https://github.com/k8s-at-home/charts/commits?author=acjohnson" title="Code">💻</a></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<!-- markdownlint-restore -->
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
|
||||||
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||||
|
|
||||||
|
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,147 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
This chart depends on the [cert-manager](https://cert-manager.io/docs/installation/kubernetes/).
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,100 +0,0 @@
|
|||||||
# Homebridge
|
|
||||||
|
|
||||||
This is a helm chart for [Homebridge](https://homebridge.io) based on [Docker Homebridge](https://github.com/oznu/docker-homebridge).
|
|
||||||
|
|
||||||
## TL;DR;
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
||||||
helm install k8s-at-home/homebridge
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm install --name my-release k8s-at-home/homebridge
|
|
||||||
```
|
|
||||||
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm delete my-release --purge
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
The following tables lists the configurable parameters of the Home Assistant chart and their default values.
|
|
||||||
|
|
||||||
| Parameter | Description | Default |
|
|
||||||
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
|
|
||||||
| `image.repository` | Image repository | `oznu/homebridge` |
|
|
||||||
| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/oznu/homebridge/tags). | `3.1.0` |
|
|
||||||
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
|
||||||
| `image.pullSecrets` | Secrets to use when pulling the image | `[]` |
|
|
||||||
| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` |
|
|
||||||
| `timezone` | Specify the container timezone | `UTC` |
|
|
||||||
| `puid` | process userID the instance should run as | `1000` |
|
|
||||||
| `pgid` | process groupID the instance should run as | `1000` |
|
|
||||||
| `config.enableUI` | Enable the Homebridge UI plugin | `true` |
|
|
||||||
| `config.plugins` | Additional Homebridge plugins to install at container startup | `[]` |
|
|
||||||
| `config.additionalPackages` | Additional Alpine packages to install at container statup | `[] ` |
|
|
||||||
| `probes.liveness.enabled` | Use the livenessProbe? | `true` |
|
|
||||||
| `probes.liveness.initialDelaySeconds` | Specify liveness `initialDelaySeconds` parameter for the deployment | `60` |
|
|
||||||
| `probes.liveness.failureThreshold` | Specify liveness `failureThreshold` parameter for the deployment | `5` |
|
|
||||||
| `probes.liveness.timeoutSeconds` | Specify liveness `timeoutSeconds` parameter for the deployment | `10` |
|
|
||||||
| `probes.readiness.enabled` | Use the readinessProbe? | `true` |
|
|
||||||
| `probes.readiness.initialDelaySeconds` | Specify readiness `initialDelaySeconds` parameter for the deployment | `60` |
|
|
||||||
| `probes.readiness.failureThreshold` | Specify readiness `failureThreshold` parameter for the deployment | `5` |
|
|
||||||
| `probes.readiness.timeoutSeconds` | Specify readiness `timeoutSeconds` parameter for the deployment | `10` |
|
|
||||||
| `probes.startup.enabled` | Use the startupProbe? (new in kubernetes 1.16) | `false` |
|
|
||||||
| `probes.startup.failureThreshold` | Specify startup `failureThreshold` parameter for the deployment | `5` |
|
|
||||||
| `probes.startup.periodSeconds` | Specify startup `periodSeconds` parameter for the deployment | `10` |
|
|
||||||
| `service.type` | Kubernetes service type for the homebridge GUI | `ClusterIP` |
|
|
||||||
| `service.httpPort` | Kubernetes port where the homebridge GUI is exposed | `8123` |
|
|
||||||
| `service.annotations` | Service annotations for the homebridge GUI | `{}` |
|
|
||||||
| `service.clusterIP` | Cluster IP for the homebridge GUI | `` |
|
|
||||||
| `service.externalIPs` | External IPs for the homebridge GUI | `[]` |
|
|
||||||
| `service.loadBalancerIP` | Loadbalancer IP for the homebridge GUI | `` |
|
|
||||||
| `service.loadBalancerSourceRanges` | Loadbalancer client IP restriction range for the homebridge GUI | `[]` |
|
|
||||||
| `service.externalTrafficPolicy` | Loadbalancer externalTrafficPolicy | `` |
|
|
||||||
| `hostNetwork` | Enable hostNetwork - needed for discovery to work | `false` |
|
|
||||||
| `service.nodePort` | nodePort to listen on for the homebridge GUI | `` |
|
|
||||||
| `ingress.enabled` | Enables Ingress | `false` |
|
|
||||||
| `ingress.annotations` | Ingress annotations | `{}` |
|
|
||||||
| `ingress.path` | Ingress path | `/` |
|
|
||||||
| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` |
|
|
||||||
| `ingress.tls` | Ingress TLS configuration | `[]` |
|
|
||||||
| `persistence.enabled` | Use persistent volume to store data | `true` |
|
|
||||||
| `persistence.size` | Size of persistent volume claim | `1Gi` |
|
|
||||||
| `persistence.existingClaim` | Use an existing PVC to persist data | `nil` |
|
|
||||||
| `persistence.storageClass` | Type of persistent volume claim | `-` |
|
|
||||||
| `persistence.accessMode` | Persistence access modes | `ReadWriteMany` |
|
|
||||||
| `persistence.skipuninstall` | Do not delete the pvc upon helm uninstall | `false` |
|
|
||||||
| `extraEnvs` | Extra ENV vars to pass to the homebridge container | `[]` |
|
|
||||||
| `resources` | CPU/Memory resource requests/limits or the homebridge GUI | `{}` |
|
|
||||||
| `nodeSelector` | Node labels for pod assignment or the homebridge GUI | `{}` |
|
|
||||||
| `tolerations` | Toleration labels for pod assignment or the homebridge GUI | `[]` |
|
|
||||||
| `affinity` | Affinity settings for pod assignment or the homebridge GUI | `{}` |
|
|
||||||
| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` |
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm install --name my-release \
|
|
||||||
--set timezone="UTC" \
|
|
||||||
k8s-at-home/homebridge
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm install --name my-release -f values.yaml k8s-at-home/homebridge
|
|
||||||
```
|
|
||||||
|
|
||||||
Read through the [values.yaml](values.yaml) file. It has several commented out suggested values.
|
|
||||||
@@ -1,124 +0,0 @@
|
|||||||
# Default values for homebridge.
|
|
||||||
|
|
||||||
replicaCount: 1
|
|
||||||
|
|
||||||
image:
|
|
||||||
repository: oznu/homebridge
|
|
||||||
pullPolicy: IfNotPresent
|
|
||||||
# Overrides the image tag whose default is the chart appVersion.
|
|
||||||
tag: "3.1.0"
|
|
||||||
|
|
||||||
imagePullSecrets: []
|
|
||||||
nameOverride: ""
|
|
||||||
fullnameOverride: ""
|
|
||||||
|
|
||||||
# upgrade strategy type (e.g. Recreate or RollingUpdate)
|
|
||||||
strategyType: Recreate
|
|
||||||
|
|
||||||
timezone: "UTC"
|
|
||||||
puid: 1000
|
|
||||||
pgid: 1000
|
|
||||||
|
|
||||||
config:
|
|
||||||
enableUI: true
|
|
||||||
plugins: []
|
|
||||||
# - homebridge-hue
|
|
||||||
additionalPackages: []
|
|
||||||
# - bash
|
|
||||||
|
|
||||||
extraEnvs: []
|
|
||||||
|
|
||||||
serviceAccount:
|
|
||||||
# Specifies whether a service account should be created
|
|
||||||
create: true
|
|
||||||
# Annotations to add to the service account
|
|
||||||
annotations: {}
|
|
||||||
# The name of the service account to use.
|
|
||||||
# If not set and create is true, a name is generated using the fullname template
|
|
||||||
name: ""
|
|
||||||
|
|
||||||
podAnnotations: {}
|
|
||||||
|
|
||||||
podSecurityContext: {}
|
|
||||||
# fsGroup: 2000
|
|
||||||
|
|
||||||
securityContext: {}
|
|
||||||
# capabilities:
|
|
||||||
# drop:
|
|
||||||
# - ALL
|
|
||||||
# readOnlyRootFilesystem: true
|
|
||||||
# runAsNonRoot: true
|
|
||||||
# runAsUser: 1000
|
|
||||||
|
|
||||||
service:
|
|
||||||
type: ClusterIP
|
|
||||||
homebridgePort: 51826
|
|
||||||
httpPort: 8080
|
|
||||||
|
|
||||||
ingress:
|
|
||||||
enabled: false
|
|
||||||
annotations: {}
|
|
||||||
# kubernetes.io/ingress.class: nginx
|
|
||||||
# kubernetes.io/tls-acme: "true"
|
|
||||||
path: /
|
|
||||||
hosts:
|
|
||||||
- chart-example.local
|
|
||||||
tls: []
|
|
||||||
# - secretName: chart-example-tls
|
|
||||||
# hosts:
|
|
||||||
# - chart-example.local
|
|
||||||
|
|
||||||
hostNetwork: false
|
|
||||||
|
|
||||||
persistence:
|
|
||||||
enabled: true
|
|
||||||
## homebridge data 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: "-"
|
|
||||||
##
|
|
||||||
## If you want to reuse an existing claim, you can pass the name of the PVC using
|
|
||||||
## the existingClaim variable
|
|
||||||
# existingClaim: your-claim
|
|
||||||
accessMode: ReadWriteOnce
|
|
||||||
size: 1Gi
|
|
||||||
## Do not delete the pvc upon helm uninstall
|
|
||||||
skipuninstall: false
|
|
||||||
|
|
||||||
probes:
|
|
||||||
liveness:
|
|
||||||
enabled: true
|
|
||||||
initialDelaySeconds: 60
|
|
||||||
failureThreshold: 5
|
|
||||||
timeoutSeconds: 10
|
|
||||||
readiness:
|
|
||||||
enabled: true
|
|
||||||
initialDelaySeconds: 60
|
|
||||||
failureThreshold: 5
|
|
||||||
timeoutSeconds: 10
|
|
||||||
startup:
|
|
||||||
enabled: false
|
|
||||||
failureThreshold: 30
|
|
||||||
periodSeconds: 10
|
|
||||||
|
|
||||||
resources: {}
|
|
||||||
# We usually recommend not to specify default resources and to leave this as a conscious
|
|
||||||
# choice for the user. This also increases chances charts run on environments with little
|
|
||||||
# resources, such as Minikube. If you do want to specify resources, uncomment the following
|
|
||||||
# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
|
|
||||||
# limits:
|
|
||||||
# cpu: 100m
|
|
||||||
# memory: 128Mi
|
|
||||||
# requests:
|
|
||||||
# cpu: 100m
|
|
||||||
# memory: 128Mi
|
|
||||||
|
|
||||||
nodeSelector: {}
|
|
||||||
|
|
||||||
tolerations: []
|
|
||||||
|
|
||||||
affinity: {}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,96 +0,0 @@
|
|||||||
# Librespeed
|
|
||||||
|
|
||||||
HTML5 based speedtest with password protected history
|
|
||||||
|
|
||||||
**This chart is not maintained by the Librespeed project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new)**
|
|
||||||
|
|
||||||
## TL;DR;
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
||||||
helm install k8s-at-home/librespeed
|
|
||||||
```
|
|
||||||
|
|
||||||
## Introduction
|
|
||||||
|
|
||||||
This code is adopted from the [Linuxserver Librespeed docker image](https://hub.docker.com/r/linuxserver/librespeed) which runs the [Librespeed application](https://github.com/librespeed/speedtest)
|
|
||||||
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm install --name my-release k8s-at-home/librespeed
|
|
||||||
```
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm delete my-release --purge
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
The following tables lists the configurable parameters of the Librespeed chart and their default values.
|
|
||||||
|
|
||||||
| Parameter | Description | Default |
|
|
||||||
|:---------------------------------- |:----------------------------------------------------------------------- |:------------------------- |
|
|
||||||
| `image.repository` | Librespeed image | `linuxserver/librespeed` |
|
|
||||||
| `image.tag` | Librespeed image tag | `5.2-ls25` |
|
|
||||||
| `image.pullPolicy` | Librespeed image pull policy | `IfNotPresent` |
|
|
||||||
| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` |
|
|
||||||
| `livenessProbePath` | Default livenessProbe path | `/` |
|
|
||||||
| `readinessProbePath` | Default readinessProbe path | `/` |
|
|
||||||
| `timezone` | Default timezone | `UTC` |
|
|
||||||
| `puid` | Default UID | `1000` |
|
|
||||||
| `pgid` | Default GID | `1000` |
|
|
||||||
| `telemetry` | Enable/Disable history | `false` |
|
|
||||||
| `title` | Title of your speedtest | `LibreSpeed` |
|
|
||||||
| `idObfuscation` | Test IDs are obfuscated, avoids exposing database internal sequential IDs| `false` |
|
|
||||||
| `redactIPAddresses` | IP addresses/hostnames are redacted from the collected telemetry | `false` |
|
|
||||||
| `email` | Email address for GDPR requests. Must be specified when telemetry=true | `fake@fake.com |
|
|
||||||
| `distance` | how the distance from the server is measured. Options `km`, `mi`, or `` | `km` |
|
|
||||||
| `service.type` | Kubernetes service type for the GUI | `ClusterIP` |
|
|
||||||
| `service.port` | Kubernetes port where the GUI is exposed | `1880` |
|
|
||||||
| `service.nodePort` | Kubernetes nodePort where the GUI is exposed | `` |
|
|
||||||
| `service.annotations` | Service annotations for the GUI | `{}` |
|
|
||||||
| `service.labels` | Custom labels | `{}` |
|
|
||||||
| `service.loadBalancerIP` | Loadbalance IP for the GUI | `{}` |
|
|
||||||
| `service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None |
|
|
||||||
| `service.externalTrafficPolicy` | Set the externalTrafficPolicy in the Service to either Cluster or Local | `Cluster` |
|
|
||||||
| `ingress.enabled` | Enables Ingress | `false` |
|
|
||||||
| `ingress.annotations` | Ingress annotations | `{}` |
|
|
||||||
| `ingress.path` | Ingress path | `/` |
|
|
||||||
| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` |
|
|
||||||
| `ingress.tls` | Ingress TLS configuration | `[]` |
|
|
||||||
| `persistence.enabled` | Use persistent volume to store data | `false` |
|
|
||||||
| `persistence.size` | Size of persistent volume claim | `5Gi` |
|
|
||||||
| `persistence.existingClaim` | Use an existing PVC to persist data | `nil` |
|
|
||||||
| `persistence.storageClass` | Type of persistent volume claim | `-` |
|
|
||||||
| `persistence.accessModes` | Persistence access modes | `ReadWriteOnce` |
|
|
||||||
| `persistence.subPath` | Mount a sub dir of the persistent volume | `nil` |
|
|
||||||
| `resources` | CPU/Memory resource requests/limits | `{}` |
|
|
||||||
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
|
||||||
| `tolerations` | Toleration labels for pod assignment | `[]` |
|
|
||||||
| `affinity` | Affinity settings for pod assignment | `{}` |
|
|
||||||
| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` |
|
|
||||||
| `deploymentAnnotations` | Key-value pairs to add as deployment annotations | `{}` |
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm install --name my-release \
|
|
||||||
--set config.timezone="America/New_York" \
|
|
||||||
k8s-at-home/librespeed
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm install --name my-release -f values.yaml k8s-at-home/librespeed
|
|
||||||
```
|
|
||||||
|
|
||||||
Read through the [values.yaml](values.yaml) file. It has several commented out suggested values.
|
|
||||||
@@ -1,113 +0,0 @@
|
|||||||
# Default values for librespeed
|
|
||||||
# This is a YAML-formatted file.
|
|
||||||
# Declare variables to be passed into your templates.
|
|
||||||
|
|
||||||
# upgrade strategy type (e.g. Recreate or RollingUpdate)
|
|
||||||
strategyType: Recreate
|
|
||||||
|
|
||||||
image:
|
|
||||||
repository: adolfintel/speedtest
|
|
||||||
tag: latest
|
|
||||||
pullPolicy: IfNotPresent
|
|
||||||
|
|
||||||
nameOverride: ""
|
|
||||||
fullnameOverride: ""
|
|
||||||
|
|
||||||
livenessProbePath: /
|
|
||||||
readinessProbePath: /
|
|
||||||
|
|
||||||
timezone: "UTC"
|
|
||||||
puid: "1000"
|
|
||||||
pgid: "1000"
|
|
||||||
|
|
||||||
## Store results? If enabled, password is required
|
|
||||||
telemetry: false
|
|
||||||
## The following are required when telemetry is enabled
|
|
||||||
## If telemetry is enabled, a stats page will be available at http://your.server/results/stats.php
|
|
||||||
# password: "ChangeMe"
|
|
||||||
# email: "fake@fake.com"
|
|
||||||
|
|
||||||
## The following are optional. The defaults are listed
|
|
||||||
# title: LibreSpeed
|
|
||||||
## Test IDs are obfuscated, to avoid exposing the database internal sequential IDs
|
|
||||||
# idObfuscation: false
|
|
||||||
## IP addresses and hostnames are redacted from the collected telemetry, for better privacy
|
|
||||||
# redactIPAddresses: false
|
|
||||||
## Specifies how the distance from the server is measured. Can be either km for kilometers, mi for miles, or an empty string to disable distance measurement.
|
|
||||||
# distance: "km"
|
|
||||||
|
|
||||||
|
|
||||||
service:
|
|
||||||
type: ClusterIP
|
|
||||||
port: 80
|
|
||||||
## Specify the nodePort value for the LoadBalancer and NodePort service types.
|
|
||||||
## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
|
|
||||||
##
|
|
||||||
# nodePort:
|
|
||||||
## Provide any additional annotations which may be required. This can be used to
|
|
||||||
## set the LoadBalancer service type to internal only.
|
|
||||||
## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer
|
|
||||||
##
|
|
||||||
annotations: {}
|
|
||||||
labels: {}
|
|
||||||
## Use loadBalancerIP to request a specific static IP,
|
|
||||||
## otherwise leave blank
|
|
||||||
##
|
|
||||||
loadBalancerIP:
|
|
||||||
# loadBalancerSourceRanges: []
|
|
||||||
## Set the externalTrafficPolicy in the Service to either Cluster or Local
|
|
||||||
# externalTrafficPolicy: Cluster
|
|
||||||
|
|
||||||
ingress:
|
|
||||||
enabled: false
|
|
||||||
annotations: {}
|
|
||||||
# kubernetes.io/ingress.class: nginx
|
|
||||||
# kubernetes.io/tls-acme: "true"
|
|
||||||
path: /
|
|
||||||
hosts:
|
|
||||||
- chart-example.local
|
|
||||||
tls: []
|
|
||||||
# - secretName: chart-example-tls
|
|
||||||
# hosts:
|
|
||||||
# - chart-example.local
|
|
||||||
|
|
||||||
persistence:
|
|
||||||
enabled: false
|
|
||||||
## node-red data 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: "-"
|
|
||||||
##
|
|
||||||
## If you want to reuse an existing claim, you can pass the name of the PVC using
|
|
||||||
## the existingClaim variable
|
|
||||||
# existingClaim: your-claim
|
|
||||||
accessMode: ReadWriteOnce
|
|
||||||
size: 1Gi
|
|
||||||
## When mounting the data volume you may specify a subPath
|
|
||||||
# subPath: /configs/node-red
|
|
||||||
|
|
||||||
resources: {}
|
|
||||||
# We usually recommend not to specify default resources and to leave this as a conscious
|
|
||||||
# choice for the user. This also increases chances charts run on environments with little
|
|
||||||
# resources, such as Minikube. If you do want to specify resources, uncomment the following
|
|
||||||
# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
|
|
||||||
# limits:
|
|
||||||
# cpu: 100m
|
|
||||||
# memory: 128Mi
|
|
||||||
# requests:
|
|
||||||
# cpu: 100m
|
|
||||||
# memory: 128Mi
|
|
||||||
|
|
||||||
nodeSelector: {}
|
|
||||||
|
|
||||||
tolerations: []
|
|
||||||
|
|
||||||
affinity: {}
|
|
||||||
|
|
||||||
podAnnotations: {}
|
|
||||||
|
|
||||||
deploymentAnnotations: {}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
#
|
|
||||||
# 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: eclipse-mosquitto
|
|
||||||
pullPolicy: IfNotPresent
|
|
||||||
tag: 2.0.7
|
|
||||||
|
|
||||||
strategy:
|
|
||||||
type: Recreate
|
|
||||||
|
|
||||||
service:
|
|
||||||
type: ClusterIP
|
|
||||||
# loadBalancerIP:
|
|
||||||
annotations: {}
|
|
||||||
port:
|
|
||||||
port: 1883
|
|
||||||
name: mqtt
|
|
||||||
|
|
||||||
persistence:
|
|
||||||
data:
|
|
||||||
enabled: false
|
|
||||||
emptyDir: false
|
|
||||||
mountPath: /mosquitto/data
|
|
||||||
## 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: 100Mi
|
|
||||||
## Do not delete the pvc upon helm uninstall
|
|
||||||
# skipuninstall: false
|
|
||||||
# existingClaim: ""
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
# node-feature-discovery helm chart
|
|
||||||
|
|
||||||
This is a helm chart for [node-feature-discovery](https://github.com/kubernetes-sigs/node-feature-discovery) using the master/worker pattern.
|
|
||||||
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
||||||
helm install k8s-at-home/node-feature-discovery
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm install my-release k8s-at-home/node-feature-discovery
|
|
||||||
```
|
|
||||||
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
helm delete my-release --purge
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
The following tables lists the configurable parameters of the Sentry chart and their default values.
|
|
||||||
Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/node-feature-discovery/values.yaml) file. It has several commented out suggested values.
|
|
||||||
|
|
||||||
| Parameter | Description | Default |
|
|
||||||
| ------------------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
||||||
| `image.repository` | Image repository | `quay.io/kubernetes_incubator/node-feature-discovery` |
|
|
||||||
| `image.tag` | Image tag. Possible values listed [here](https://github.com/kubernetes-sigs/node-feature-discovery/releases). | `v0.6.0` |
|
|
||||||
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
|
||||||
| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` |
|
|
||||||
| `sources` | List of sources to consider when labeling - see [documentation](https://github.com/kubernetes-sigs/node-feature-discovery#feature-sources) for info | `[]` |
|
|
||||||
| `config` | node-feature-discovery configuration - see [nfd-worker.conf.example](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/nfd-worker.conf.example) for example | `{}` |
|
|
||||||
| `service.type` | Kubernetes service type for the GUI | `ClusterIP` |
|
|
||||||
| `service.port` | Kubernetes port where the GUI is exposed | `8080` |
|
|
||||||
| `service.annotations` | Service annotations for the GUI | `{}` |
|
|
||||||
| `service.labels` | Custom labels | `{}` |
|
|
||||||
| `service.loadBalancerIP` | Loadbalancer IP for the GUI | `{}` |
|
|
||||||
| `service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | `nil` |
|
|
||||||
| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` |
|
|
||||||
| `master.replicaCount` | Number of replicas to scale the master component to | `1` |
|
|
||||||
| `master.resources` | CPU/Memory resource requests/limits for master component | `{}` |
|
|
||||||
| `master.nodeSelector` | Node labels for master component pod assignment | `{}` |
|
|
||||||
| `master.tolerations` | Toleration labels for master component pod assignment | See [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/node-feature-discovery/values.yaml) |
|
|
||||||
| `master.affinity` | Affinity settings for master component pod assignment | See [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/node-feature-discovery/values.yaml) |
|
|
||||||
| `worker.resources` | CPU/Memory resource requests/limits for worker component | `{}` |
|
|
||||||
| `worker.nodeSelector` | Node labels for worker component pod assignment | `{}` |
|
|
||||||
| `worker.tolerations` | Toleration labels for worker component pod assignment | `[]` |
|
|
||||||
| `worker.affinity` | Affinity settings for worker component pod assignment | `{}` |
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install my-release \
|
|
||||||
--set image.pullPolicy="Always" \
|
|
||||||
k8s-at-home/node-feature-discovery
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install my-release -f values.yaml k8s-at-home/node-feature-discovery
|
|
||||||
```
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,180 +0,0 @@
|
|||||||
# oauth2-proxy
|
|
||||||
|
|
||||||
[oauth2-proxy](https://github.com/pusher/oauth2_proxy) is a reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group.
|
|
||||||
|
|
||||||
## TL;DR;
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ helm install stable/oauth2-proxy
|
|
||||||
```
|
|
||||||
|
|
||||||
## Introduction
|
|
||||||
|
|
||||||
This chart bootstraps an oauth2-proxy deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
|
|
||||||
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ helm install stable/oauth2-proxy --name my-release
|
|
||||||
```
|
|
||||||
|
|
||||||
The command deploys oauth2-proxy on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
|
|
||||||
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall/delete the `my-release` deployment:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ helm delete my-release
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
|
||||||
|
|
||||||
## Upgrading an existing Release to a new major version
|
|
||||||
|
|
||||||
A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an
|
|
||||||
incompatible breaking change needing manual actions.
|
|
||||||
|
|
||||||
### To 1.0.0
|
|
||||||
|
|
||||||
This version upgrade oauth2-proxy to v4.0.0. Please see the [changelog](https://github.com/pusher/oauth2_proxy/blob/v4.0.0/CHANGELOG.md#v400) in order to upgrade.
|
|
||||||
|
|
||||||
### To 2.0.0
|
|
||||||
|
|
||||||
Version 2.0.0 of this chart introduces support for Kubernetes v1.16.x by way of addressing the deprecation of the Deployment object apiVersion `apps/v1beta2`. See [the v1.16 API deprecations page](https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/) for more information.
|
|
||||||
|
|
||||||
Due to [this issue](https://github.com/helm/helm/issues/6583) there may be errors performing a `helm upgrade`of this chart from versions earlier than 2.0.0.
|
|
||||||
|
|
||||||
### To 3.0.0
|
|
||||||
|
|
||||||
Version 3.0.0 introduces support for [EKS IAM roles for service accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) by adding a managed service account to the chart. This is a breaking change since the service account is enabled by default. To disable this behaviour set `serviceAccount.enabled` to `false`
|
|
||||||
|
|
||||||
### To 4.0.0
|
|
||||||
|
|
||||||
This is a breaking change as the chart was moved to k8s-at-home. No other change on top of the 3.x.x branch.
|
|
||||||
|
|
||||||
## To 5.0.0
|
|
||||||
|
|
||||||
Not many breaking changes. See the [changelog](https://github.com/oauth2-proxy/oauth2-proxy/releases/tag/v7.0.0) for oauth2-proxy, specifically the section "Breaking Changes" for a few configuration changes, particularly to do with the Azure provider.
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
The following table lists the configurable parameters of the oauth2-proxy chart and their default values.
|
|
||||||
|
|
||||||
Parameter | Description | Default
|
|
||||||
--- | --- | ---
|
|
||||||
`affinity` | node/pod affinities | None
|
|
||||||
`authenticatedEmailsFile.enabled` | Enables authorize individual email addresses | `false`
|
|
||||||
`authenticatedEmailsFile.template` | Name of the configmap that is handled outside of that chart | `""`
|
|
||||||
`authenticatedEmailsFile.restricted_access` | [email addresses](https://github.com/pusher/oauth2_proxy#email-authentication) list config | `""`
|
|
||||||
`config.clientID` | oauth client ID | `""`
|
|
||||||
`config.clientSecret` | oauth client secret | `""`
|
|
||||||
`config.cookieSecret` | server specific cookie for the secret; create a new one with `openssl rand -base64 32 | head -c 32 | base64` | `""`
|
|
||||||
`config.existingSecret` | existing Kubernetes secret to use for OAuth2 credentials. See [secret template](https://github.com/helm/charts/blob/master/stable/oauth2-proxy/templates/secret.yaml) for the required values | `nil`
|
|
||||||
`config.configFile` | custom [oauth2_proxy.cfg](https://github.com/pusher/oauth2_proxy/blob/master/contrib/oauth2_proxy.cfg.example) contents for settings not overridable via environment nor command line | `""`
|
|
||||||
`config.existingConfig` | existing Kubernetes configmap to use for the configuration file. See [config template](https://github.com/helm/charts/blob/master/stable/oauth2-proxy/templates/configmap.yaml) for the required values | `nil`
|
|
||||||
`config.google.adminEmail` | user impersonated by the google service account | `""`
|
|
||||||
`config.google.serviceAccountJson` | google service account json contents | `""`
|
|
||||||
`config.google.existingConfig` | existing Kubernetes configmap to use for the service account file. See [google secret template](https://github.com/helm/charts/blob/master/stable/oauth2-proxy/templates/google-secret.yaml) for the required values | `nil`
|
|
||||||
`extraArgs` | key:value list of extra arguments to give the binary | `{}`
|
|
||||||
`extraEnv` | key:value list of extra environment variables to give the binary | `[]`
|
|
||||||
`extraVolumes` | list of extra volumes | `[]`
|
|
||||||
`extraVolumeMounts` | list of extra volumeMounts | `[]`
|
|
||||||
`htpasswdFile.enabled` | enable htpasswd-file option | `false`
|
|
||||||
`htpasswdFile.entries` | list of [SHA encrypted user:passwords](https://pusher.github.io/oauth2_proxy/configuration#command-line-options) | `{}`
|
|
||||||
`htpasswdFile.existingSecret` | existing Kubernetes secret to use for OAuth2 htpasswd file | `""`
|
|
||||||
`httpScheme` | `http` or `https`. `name` used for port on the deployment. `httpGet` port `name` and `scheme` used for `liveness`- and `readinessProbes`. `name` and `targetPort` used for the service. | `http`
|
|
||||||
`image.pullPolicy` | Image pull policy | `IfNotPresent`
|
|
||||||
`image.repository` | Image repository | `quay.io/pusher/oauth2_proxy`
|
|
||||||
`image.tag` | Image tag | `v5.1.0`
|
|
||||||
`imagePullSecrets` | Specify image pull secrets | `nil` (does not add image pull secrets to deployed pods)
|
|
||||||
`ingress.enabled` | Enable Ingress | `false`
|
|
||||||
`ingress.ingressClassName` | Set ingressClassName | `nil`
|
|
||||||
`ingress.path` | Ingress accepted path | `/`
|
|
||||||
`ingress.extraPaths` | Ingress extra paths to prepend to every host configuration. Useful when configuring [custom actions with AWS ALB Ingress Controller](https://kubernetes-sigs.github.io/aws-alb-ingress-controller/guide/ingress/annotation/#actions). | `[]`
|
|
||||||
`ingress.annotations` | Ingress annotations | `nil`
|
|
||||||
`ingress.hosts` | Ingress accepted hostnames | `nil`
|
|
||||||
`ingress.tls` | Ingress TLS configuration | `nil`
|
|
||||||
`initContainers` | pod init containers | `[]`
|
|
||||||
`livenessProbe.enabled` | enable Kubernetes livenessProbe. Disable to use oauth2-proxy with Istio mTLS. See [Istio FAQ](https://istio.io/help/faq/security/#k8s-health-checks) | `true`
|
|
||||||
`livenessProbe.initialDelaySeconds` | number of seconds | 0
|
|
||||||
`livenessProbe.timeoutSeconds` | number of seconds | 1
|
|
||||||
`nodeSelector` | node labels for pod assignment | `{}`
|
|
||||||
`podAnnotations` | annotations to add to each pod | `{}`
|
|
||||||
`podLabels` | additional labesl to add to each pod | `{}`
|
|
||||||
`podDisruptionBudget.enabled`| Enabled creation of PodDisruptionBudget (only if replicaCount > 1) | true
|
|
||||||
`podDisruptionBudget.minAvailable`| minAvailable parameter for PodDisruptionBudget | 1
|
|
||||||
`podSecurityContext` | Kubernetes security context to apply to pod | `{}`
|
|
||||||
`priorityClassName` | priorityClassName | `nil`
|
|
||||||
`readinessProbe.enabled` | enable Kubernetes readinessProbe. Disable to use oauth2-proxy with Istio mTLS. See [Istio FAQ](https://istio.io/help/faq/security/#k8s-health-checks) | `true`
|
|
||||||
`readinessProbe.initialDelaySeconds` | number of seconds | 0
|
|
||||||
`readinessProbe.timeoutSeconds` | number of seconds | 1
|
|
||||||
`readinessProbe.periodSeconds` | number of seconds | 10
|
|
||||||
`readinessProbe.successThreshold` | number of successes | 1
|
|
||||||
`replicaCount` | desired number of pods | `1`
|
|
||||||
`resources` | pod resource requests & limits | `{}`
|
|
||||||
`service.port` | port for the service | `80`
|
|
||||||
`service.type` | type of service | `ClusterIP`
|
|
||||||
`service.clusterIP` | cluster ip address | `nil`
|
|
||||||
`service.loadBalancerIP` | ip of load balancer | `nil`
|
|
||||||
`service.loadBalancerSourceRanges` | allowed source ranges in load balancer | `nil`
|
|
||||||
`serviceAccount.enabled` | create a service account | `true`
|
|
||||||
`serviceAccount.name` | the service account name | ``
|
|
||||||
`serviceAccount.annotations` | (optional) annotations for the service account | `{}`
|
|
||||||
`tolerations` | list of node taints to tolerate | `[]`
|
|
||||||
`topologySpreadConstraints.enabled` | enable Kubernetes [topologySpreadConstraints](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/) | `false`
|
|
||||||
`topologySpreadConstraints.maxSkew` | the degree to which Pods may be unevenly distributed | `1`
|
|
||||||
`topologySpreadConstraints.topologyKey` | the key of node labels | `topology.kubernetes.io/zone`
|
|
||||||
`topologySpreadConstraints.whenUnsatisfiable` | how to deal with a Pod if it doesn't satisfy the spread constraint (`DoNotSchedule`, `ScheduleAnyway`) | `DoNotSchedule`
|
|
||||||
`securityContext.enabled` | enable Kubernetes security context on container | `false`
|
|
||||||
`securityContext.runAsNonRoot` | make sure that the container runs as a non-root user | `true`
|
|
||||||
`proxyVarsAsSecrets` | choose between environment values or secrets for setting up OAUTH2_PROXY variables. When set to false, remember to add the variables OAUTH2_PROXY_CLIENT_ID, OAUTH2_PROXY_CLIENT_SECRET, OAUTH2_PROXY_COOKIE_SECRET in extraEnv | `true`
|
|
||||||
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ helm install stable/oauth2-proxy --name my-release \
|
|
||||||
--set=image.tag=v0.0.2,resources.limits.cpu=200m
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ helm install stable/oauth2-proxy --name my-release -f values.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
> **Tip**: You can use the default [values.yaml](values.yaml)
|
|
||||||
|
|
||||||
## SSL Configuration
|
|
||||||
|
|
||||||
See: [SSL Configuration](https://pusher.github.io/oauth2_proxy/tls-configuration).
|
|
||||||
Use ```values.yaml``` like:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
...
|
|
||||||
extraArgs:
|
|
||||||
tls-cert: /path/to/cert.pem
|
|
||||||
tls-key: /path/to/cert.key
|
|
||||||
|
|
||||||
extraVolumes:
|
|
||||||
- name: ssl-cert
|
|
||||||
secret:
|
|
||||||
secretName: my-ssl-secret
|
|
||||||
|
|
||||||
extraVolumeMounts:
|
|
||||||
- mountPath: /path/to/
|
|
||||||
name: ssl-cert
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
With a secret called `my-ssl-secret`:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
...
|
|
||||||
data:
|
|
||||||
cert.pem: AB..==
|
|
||||||
cert.key: CD..==
|
|
||||||
```
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{{- define "custom.changelog.header" -}}
|
|
||||||
## Changelog
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.changelog" -}}
|
|
||||||
{{ template "custom.changelog.header" . }}
|
|
||||||
|
|
||||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/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 -}}
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
k8s-at-home
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/k8s-at-home/charts
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://k8s-at-home.com/charts/
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install.tldr" -}}
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstalling the Chart
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
|
|
||||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.valuesSection" -}}
|
|
||||||
## Values
|
|
||||||
|
|
||||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
|
||||||
|
|
||||||
{{ template "chart.valuesTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
||||||
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
||||||
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
||||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install.tldr" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
|
||||||
|
|
||||||
{{ template "custom.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.changelog" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
{{ template "helm-docs.versionFooter" . }}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user