777 on new scripts (+2 squashed commit)
Squashed commit: [9ae7dd0f] add helm-docs to workflow [2206f5ba] fix small typo in workflows (+1 squashed commits) Squashed commits: [29c2ceb4] Documentation-Cleanup (#181) * work on readme generation * document windows setup * add simple pre-commit install script * more docs for git setup * Update pre-commit * pre-commit automatic fixes * Increase all patch versions * Auto Readme and Config doc * Auto app-readme.md generation * increase common and common-test versions accordingly (due to cleanup) * move contribution guidelines to /development in wiki * fix some end-of-line issues (again) * fix line 14 of workflows
This commit is contained in:
Kjeld Schouten-Lebbing
kjeld Schouten-Lebbing
parent
94a6d6f9e1
commit
1d51be0e3d
|
|
@ -5,8 +5,8 @@
|
|||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, sex characteristics, gender, level of experience,
|
||||
education, socio-economic status, nationality, personal appearance, race,
|
||||
size, disability, ethnicity, sex characteristics, gender, level of experience,
|
||||
education, socio-economic status, nationality, personal appearance, race,
|
||||
religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Contribution and Review Guidelines
|
||||
# Contribution Guidelines
|
||||
|
||||
This project welcomes any and all input, but we need to have a few quality guidelines. These guidelines will be examplained here, in this document.
|
||||
|
||||
|
|
@ -6,11 +6,11 @@ This project welcomes any and all input, but we need to have a few quality guide
|
|||
***
|
||||
#### New to GIT
|
||||
|
||||
If you have never used git before, you can look up our general reference on our wiki.
|
||||
If you have never used git before, you can look up our general reference on our wiki.
|
||||
|
||||
#### Git and You
|
||||
|
||||
GIT is a fantastic system, but while using it we have a few guidelines to keep it fantastic for everyone.
|
||||
GIT is a fantastic system, but while using it we have a few guidelines to keep it fantastic for everyone.
|
||||
|
||||
* Submit complete PR's.
|
||||
* Add [DNM] if you do not want your PR merged yet.
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ A: Please file an issue about it, after checking the wiki to make sure it hasn't
|
|||
https://github.com/truecharts/truecharts/wiki/k8s-at-home-to-SCALE-App-migration-list
|
||||
|
||||
- Q: Isn't there more documentation for app x<br>
|
||||
A: If it's not on our [wiki](https://wiki.truecharts.org), we do not. Currently during TrueNAS SCALE ALPHA/BETA we focus on the technical aspects.
|
||||
A: If it's not on our [wiki](https://wiki.truecharts.org), we do not. Currently during TrueNAS SCALE ALPHA/BETA we focus on the technical aspects.
|
||||
|
||||
- Q: Function x doesn't seem to be working, should it be working?<br>
|
||||
A: Maybe, please file an issue
|
||||
|
|
|
|||
|
|
@ -13,4 +13,3 @@ If you find any security issue, please email the project maintainer.
|
|||
|
||||
Currently the Project Maintainer is:
|
||||
[Ornias1993](https://github.com/Ornias1993)
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
# Setting up your dev environment
|
||||
|
||||
With TrueCharts we use some custom tools to make sure you have the least amount of work possible when working on the project.
|
||||
However, this means you need some custom tools before you can start working on TrueCharts:
|
||||
|
||||
- Git (git client optional)
|
||||
- Python (including Pip, added to path on windows)
|
||||
- Pre-Commit (prefered)
|
||||
|
||||
## Windows
|
||||
|
||||
### Terminal basics:
|
||||
When we talk about "In a terminal" we mean doing the following:
|
||||
- hit windows+r
|
||||
- enter "cmd"
|
||||
|
||||
### GIT
|
||||
|
||||
- Download and install GIT (https://git-scm.com/download/win)
|
||||
- Most default options would be fine
|
||||
|
||||
In a terminal window or GUI client:
|
||||
- Clone the repository in a specific directory of your choice (we will call this "Project-Root")
|
||||
|
||||
|
||||
### Python
|
||||
- Install Python3 with the installer (https://www.python.org/downloads/)
|
||||
- Right click "Run as administrator"
|
||||
- Check "Add to Path"
|
||||
- Click the big install button
|
||||
|
||||
### Pre-Commit
|
||||
Run .tools/pre-commit-install.bat
|
||||
(Advanced users: This is for beginner users and will also execute "git config --unset-all core.hooksPath")
|
||||
OR
|
||||
In a terminal window:
|
||||
- Enter "pip install pre-commit"
|
||||
- CD to Project-Root
|
||||
- Enter "pre-commit install"
|
||||
|
|
@ -43,7 +43,7 @@ jobs:
|
|||
run: ct lint --config .github/ct.yaml --charts 'library/common'
|
||||
- name: Create kind cluster
|
||||
uses: helm/kind-action@v1.1.0
|
||||
|
||||
|
||||
common-unittest:
|
||||
runs-on: ubuntu-latest
|
||||
needs: common-lint
|
||||
|
|
@ -72,7 +72,7 @@ jobs:
|
|||
bundle install
|
||||
- name: Run tests
|
||||
run: |
|
||||
bundle exec m -r .test/charts
|
||||
bundle exec m -r .tools/tests/charts
|
||||
|
||||
|
||||
chart-tests:
|
||||
|
|
@ -100,4 +100,4 @@ jobs:
|
|||
sudo pip3 install -U catalog_validation/.
|
||||
|
||||
- name: Validate changed charts
|
||||
run: /bin/bash -c "PWD=${pwd}; sudo /usr/local/bin/charts_validate deploy --path $PWD"
|
||||
run: /bin/bash -c "PWD=${pwd}; sudo /usr/local/bin/charts_validate deploy --path $PWD"
|
||||
|
|
|
|||
|
|
@ -3,56 +3,26 @@ name: "Charts: Release"
|
|||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- charts
|
||||
tags-ignore:
|
||||
- '**'
|
||||
paths:
|
||||
- 'charts/**'
|
||||
- '!charts/**/*.md'
|
||||
- '!charts/**/README.md'
|
||||
- '!charts/**/README.md.gotmpl'
|
||||
- '!charts/**/app-readme.md'
|
||||
- '!charts/**/app-readme.md.gotmpl'
|
||||
- '!charts/**/docs/*'
|
||||
- 'library/**'
|
||||
- '!library/**/*.md'
|
||||
- '!library/**/README.md'
|
||||
- '!library/**/README.md.gotmpl'
|
||||
- '!library/**/app-readme.md'
|
||||
- '!library/**/app-readme.md.gotmpl'
|
||||
- '!library/**/docs/*'
|
||||
|
||||
jobs:
|
||||
copy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout-Master
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
ref: 'master'
|
||||
path: 'master'
|
||||
- name: Checkout-Charts
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
ref: 'charts'
|
||||
path: 'charts'
|
||||
|
||||
- name: Generate Helm Structure
|
||||
run: |
|
||||
cd master
|
||||
rm -Rf ../charts/charts/*
|
||||
for chart in charts/*; do
|
||||
if [ -d "${chart}" ]; then
|
||||
maxversion=$(ls -l ${chart} | grep ^d | awk '{print $9}' | tail -n 1)
|
||||
chartname=$(basename ${chart})
|
||||
echo "Processing ${chart} version ${maxversion}"
|
||||
mv ${chart}/${maxversion} ../charts/charts/${chartname}
|
||||
rm ../charts/charts/${chartname}/Chart.lock || echo "chart.lock missing for ${chartname}, continuing..."
|
||||
fi
|
||||
done
|
||||
mv library/* ../charts/charts/
|
||||
ls ../charts/charts/
|
||||
cd ..
|
||||
|
||||
- name: Commit and push updated charts
|
||||
run: |
|
||||
cd charts
|
||||
git config user.name "$GITHUB_ACTOR"
|
||||
git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
|
||||
git add --all
|
||||
git commit -sm "Publish Chart updates" || exit 0
|
||||
git push
|
||||
|
||||
pre-release:
|
||||
needs: copy
|
||||
runs-on: ubuntu-latest
|
||||
|
|
@ -79,7 +49,6 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
ref: 'charts'
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Configure Git
|
||||
|
|
@ -97,7 +66,7 @@ jobs:
|
|||
charts_repo_url: https://charts.truecharts.org/
|
||||
env:
|
||||
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|
||||
|
||||
|
||||
# Update the generated timestamp in the index.yaml
|
||||
# needed until https://github.com/helm/chart-releaser/issues/90
|
||||
# or helm/chart-releaser-action supports this
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ jobs:
|
|||
uses: actions/checkout@v2
|
||||
with:
|
||||
token: ${{ secrets.RENOVPUSH }}
|
||||
|
||||
|
||||
- name: Configure Git
|
||||
run: |
|
||||
git config user.name "$GITHUB_ACTOR"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,64 @@
|
|||
name: "Charts: Release"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
tags-ignore:
|
||||
- '**'
|
||||
paths:
|
||||
- 'charts/**'
|
||||
- '!charts/**/*.md'
|
||||
- '!charts/**/README.md'
|
||||
- '!charts/**/README.md.gotmpl'
|
||||
- '!charts/**/app-readme.md'
|
||||
- '!charts/**/app-readme.md.gotmpl'
|
||||
- '!charts/**/docs/*'
|
||||
- 'library/**'
|
||||
- '!library/**/*.md'
|
||||
- '!library/**/README.md'
|
||||
- '!library/**/README.md.gotmpl'
|
||||
- '!library/**/app-readme.md'
|
||||
- '!library/**/app-readme.md.gotmpl'
|
||||
- '!library/**/docs/*'
|
||||
|
||||
jobs:
|
||||
copy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout-Master
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
ref: 'master'
|
||||
path: 'master'
|
||||
- name: Checkout-Charts
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
ref: 'charts'
|
||||
path: 'charts'
|
||||
|
||||
- name: Generate Helm Structure
|
||||
run: |
|
||||
cd master
|
||||
rm -Rf ../charts/charts/*
|
||||
for chart in charts/*; do
|
||||
if [ -d "${chart}" ]; then
|
||||
maxversion=$(ls -l ${chart} | grep ^d | awk '{print $9}' | tail -n 1)
|
||||
chartname=$(basename ${chart})
|
||||
echo "Processing ${chart} version ${maxversion}"
|
||||
mv ${chart}/${maxversion} ../charts/charts/${chartname}
|
||||
rm ../charts/charts/${chartname}/Chart.lock || echo "chart.lock missing for ${chartname}, continuing..."
|
||||
fi
|
||||
done
|
||||
mv library/* ../charts/charts/
|
||||
ls ../charts/charts/
|
||||
cd ..
|
||||
|
||||
- name: Commit and push updated charts
|
||||
run: |
|
||||
cd charts
|
||||
git config user.name "$GITHUB_ACTOR"
|
||||
git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
|
||||
git add --all
|
||||
git commit -sm "Publish Chart updates" || exit 0
|
||||
git push
|
||||
|
|
@ -28,24 +28,37 @@ jobs:
|
|||
repository: 'truecharts/wiki'
|
||||
path: 'wiki'
|
||||
token: ${{ secrets.RENOVPUSH }}
|
||||
|
||||
|
||||
- name: install helm-docs
|
||||
run: |
|
||||
brew install norwoodj/tap/helm-docs
|
||||
|
||||
- name: (re)generate docs
|
||||
run: |
|
||||
cd master
|
||||
.tools/gen-helm-docs.sh
|
||||
cd ..
|
||||
|
||||
- name: Clean-Wiki
|
||||
run: |
|
||||
rm -Rf wiki/content
|
||||
mkdir -p wiki/content
|
||||
mkdir -p wiki/content/development
|
||||
cp -f wiki/CNAME wiki/content/CNAME
|
||||
|
||||
|
||||
- name: Create general wiki
|
||||
run: |
|
||||
cd master
|
||||
# for doc in docs/*; do
|
||||
# if [ -d "${doc}" ]; then
|
||||
# docname=$(basename ${doc})
|
||||
# cp -Rf docs/${docname} ../wiki/content/
|
||||
# fi
|
||||
# done
|
||||
for doc in .github/docs/*; do
|
||||
if [ -d "${doc}" ]; then
|
||||
docname=$(basename ${doc})
|
||||
cp -Rf ${doc} ../wiki/content/
|
||||
fi
|
||||
done
|
||||
cp .github/README.md ../wiki/content/index.md || echo "readme copy failed, continuing..."
|
||||
cp .github/CODE_OF_CONDUCT ../wiki/content/code_of_conduct.md || echo "CODE_OF_CONDUCT copy failed, continuing..."
|
||||
cp .github/CONTRIBUTING ../wiki/content/contributing.md || echo "CONTRIBUTING copy failed, continuing..."
|
||||
cp .github/CONTRIBUTING ../wiki/content/development/contributing.md || echo "CONTRIBUTING copy failed, continuing..."
|
||||
ls ../wiki/content/
|
||||
cd ..
|
||||
|
||||
|
|
@ -65,7 +78,7 @@ jobs:
|
|||
ls ../wiki/content/apps/
|
||||
cd ..
|
||||
|
||||
- name: Commit and push updated charts
|
||||
- name: Commit and push updated wiki
|
||||
run: |
|
||||
cd wiki
|
||||
git config user.name "$GITHUB_ACTOR"
|
||||
|
|
@ -73,3 +86,13 @@ jobs:
|
|||
git add --all
|
||||
git commit -sm "Publish general wiki updates" || exit 0
|
||||
git push
|
||||
cd ..
|
||||
|
||||
- name: Commit and push updated charts
|
||||
run: |
|
||||
cd master
|
||||
git config user.name "$GITHUB_ACTOR"
|
||||
git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
|
||||
git add --all
|
||||
git commit -sm "Publish docs updates" || exit 0
|
||||
git push
|
||||
|
|
|
|||
|
|
@ -3,7 +3,9 @@ repos:
|
|||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v3.4.0
|
||||
hooks:
|
||||
- id: end-of-file-fixer
|
||||
exclude: '\.github(.+)'
|
||||
- id: trailing-whitespace
|
||||
exclude: '\.github(.+)'
|
||||
- id: end-of-file-fixer
|
||||
- id: fix-byte-order-marker
|
||||
- id: mixed-line-ending
|
||||
- id: check-merge-conflict
|
||||
- id: check-case-conflict
|
||||
|
|
|
|||
|
|
@ -0,0 +1,57 @@
|
|||
#!/usr/bin/env bash
|
||||
set -eu
|
||||
|
||||
# Generate helm-docs for Helm charts
|
||||
# Usage ./gen-helm-docs.sh [chart]
|
||||
|
||||
# require helm-docs
|
||||
command -v helm-docs >/dev/null 2>&1 || {
|
||||
echo >&2 "helm-docs is not installed. Aborting."
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Absolute path of repository
|
||||
repository=$(git rev-parse --show-toplevel)
|
||||
|
||||
# Templates to copy into each chart directory
|
||||
readme_template="${repository}/.tools/templates/chart/README.md.gotmpl"
|
||||
config_template="${repository}/.tools/templates/chart/docs/CONFIG.md.gotmpl"
|
||||
app_readme_template="${repository}/.tools/templates/chart/app-readme.md.gotmpl"
|
||||
|
||||
# Gather all charts using the common library, excluding common-test
|
||||
charts=$(find "${repository}" -name "Chart.yaml" -exec grep --exclude="*common-test*" -l "\- name\: common" {} \;)
|
||||
root="${repository}"
|
||||
|
||||
for chart in charts/*; do
|
||||
if [ -d "${chart}" ]; then
|
||||
maxfolderversion=$(ls -l ${chart} | grep ^d | awk '{print $9}' | tail -n 1)
|
||||
maxchartversion=$(cat ${chart}/${maxfolderversion}/Chart.yaml | grep "^version: " | awk -F" " '{ print $2 }')
|
||||
chartname=$(basename ${chart})
|
||||
mkdir -p ${chart}/${maxfolderversion}/docs || true
|
||||
echo "-] Copying templates to ${chart}/${maxfolderversion}"
|
||||
# Copy README template into each Chart directory, remove current if existing
|
||||
rm -f "${chart}/${maxfolderversion}/README.md.gotmpl" || true
|
||||
cp -f "${readme_template}" "${chart}/${maxfolderversion}/README.md.gotmpl" || true
|
||||
# Copy README template into each Chart directory, remove current if existing
|
||||
rm -f "${chart}/${maxfolderversion}/app-readme.md.gotmpl" || true
|
||||
cp -f "${app_readme_template}" "${chart}/${maxfolderversion}/app-readme.md.gotmpl" || true
|
||||
# Copy CONFIG template to each Chart directory, do not overwrite if exists
|
||||
cp -n "${config_template}" "${chart}/${maxfolderversion}/docs/CONFIG.md.gotmpl" || true
|
||||
helm-docs \
|
||||
--ignore-file="${repository}/.helmdocsignore" \
|
||||
--template-files="${chart}/${maxfolderversion}/README.md.gotmpl" \
|
||||
--chart-search-root="${chart}/${maxfolderversion}"
|
||||
helm-docs \
|
||||
--ignore-file="${repository}/.helmdocsignore" \
|
||||
--output-file="docs/CONFIG.md" \
|
||||
--template-files="${chart}/${maxfolderversion}/docs/CONFIG.md.gotmpl" \
|
||||
--chart-search-root="${chart}/${maxfolderversion}"
|
||||
helm-docs \
|
||||
--ignore-file="${repository}/.helmdocsignore" \
|
||||
--output-file="app-readme.md" \
|
||||
--template-files="${chart}/${maxfolderversion}/app-readme.md.gotmpl" \
|
||||
--chart-search-root="${chart}/${maxfolderversion}"
|
||||
|
||||
|
||||
fi
|
||||
done
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
pip install pre-commit
|
||||
git config --unset-all core.hooksPath
|
||||
cd ..
|
||||
pre-commit install
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# Patterns to ignore when building packages.
|
||||
# This supports shell glob matching, relative path matching, and
|
||||
# negation (prefixed with !). Only one pattern per line.
|
||||
.DS_Store
|
||||
# Common VCS dirs
|
||||
.git/
|
||||
.gitignore
|
||||
.bzr/
|
||||
.bzrignore
|
||||
.hg/
|
||||
.hgignore
|
||||
.svn/
|
||||
# Common backup files
|
||||
*.swp
|
||||
*.bak
|
||||
*.tmp
|
||||
*~
|
||||
# Various IDEs
|
||||
.project
|
||||
.idea/
|
||||
*.tmproj
|
||||
.vscode/
|
||||
# OWNERS file for Kubernetes
|
||||
OWNERS
|
||||
# helm-docs templates
|
||||
*.gotmpl
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
apiVersion: v2
|
||||
appVersion: 1.0.0
|
||||
description: ${CHARTNAME} helm package
|
||||
name: ${CHARTNAME}
|
||||
version: 1.0.0
|
||||
kubeVersion: ">=1.16.0-0"
|
||||
keywords:
|
||||
- ${CHARTNAME}
|
||||
home: https://github.com/k8s-at-home/charts/tree/master/charts/${CHARTNAME}
|
||||
icon: https://${CHARTNAME}.org/icon
|
||||
sources:
|
||||
- https://github.com/${CHARTNAME}/${CHARTNAME}-docker
|
||||
- https://github.com/k8s-at-home/charts/tree/master/charts/${CHARTNAME}
|
||||
maintainers:
|
||||
- name: ${CHARTNAME}
|
||||
email: ${CHARTNAME}@${CHARTNAME}.com
|
||||
dependencies:
|
||||
- name: common
|
||||
repository: https://k8s-at-home.com/charts/
|
||||
version: 3.0.1
|
||||
|
|
@ -0,0 +1,117 @@
|
|||
# ${CHARTNAME}
|
||||
|
||||
 
|
||||
|
||||
${CHARTNAME} helm package
|
||||
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
||||
|
||||
## Source Code
|
||||
|
||||
* <https://github.com/${CHARTNAME}/${CHARTNAME}-docker>
|
||||
* <https://github.com/k8s-at-home/charts/tree/master/charts/${CHARTNAME}>
|
||||
|
||||
## Requirements
|
||||
|
||||
Kubernetes: `>=1.16.0-0`
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://k8s-at-home.com/charts/ | common | 3.0.1 |
|
||||
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
||||
helm repo update
|
||||
helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}
|
||||
```
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `${CHARTNAME}`
|
||||
|
||||
```console
|
||||
helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}
|
||||
```
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `${CHARTNAME}` deployment
|
||||
|
||||
```console
|
||||
helm uninstall ${CHARTNAME}
|
||||
```
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
||||
|
||||
## Configuration
|
||||
|
||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
||||
Other values may be used from the [values.yaml](../common/values.yaml) from the [common library](../common).
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
||||
|
||||
```console
|
||||
helm install ${CHARTNAME} \
|
||||
--set env.TZ="America/New York" \
|
||||
k8s-at-home/${CHARTNAME}
|
||||
```
|
||||
|
||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||
|
||||
```console
|
||||
helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} -f values.yaml
|
||||
```
|
||||
|
||||
## Custom configuration
|
||||
|
||||
N/A
|
||||
|
||||
## Values
|
||||
|
||||
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| env | object | `{}` | |
|
||||
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||
| image.repository | string | `"${CHARTNAME}/${CHARTNAME}"` | |
|
||||
| image.tag | string | `"1.0.0"` | |
|
||||
| ingress.enabled | bool | `false` | |
|
||||
| service.port.port | int | `1880` | |
|
||||
| strategy.type | string | `"Recreate"` | |
|
||||
|
||||
## Changelog
|
||||
|
||||
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog).
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
### [1.0.0]
|
||||
|
||||
#### Added
|
||||
|
||||
- N/A
|
||||
|
||||
#### Changed
|
||||
|
||||
- N/A
|
||||
|
||||
#### Removed
|
||||
|
||||
- N/A
|
||||
|
||||
[1.0.0]: #1.0.0
|
||||
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://github.com/k8s-at-home/charts/wiki)
|
||||
- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/k8s-at-home/charts/discussions)
|
||||
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
{{- define "custom.introheader" -}}
|
||||
# Introduction
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.organization" -}}
|
||||
TrueCharts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.url" -}}
|
||||
https://github.com/truecharts/charts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.url" -}}
|
||||
https://charts.truecharts.org
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.path" -}}
|
||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.notes" -}}
|
||||
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.requirements" -}}
|
||||
## Requirements
|
||||
|
||||
{{ template "chart.kubeVersionLine" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.dependencies" -}}
|
||||
## Dependencies
|
||||
|
||||
{{ template "chart.requirementsTable" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.install" -}}
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.uninstall" -}}
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.configuration.header" -}}
|
||||
## Configuration
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.support" -}}
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.introheader" . }}
|
||||
|
||||
{{ 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" . }}
|
||||
|
||||
{{ template "custom.uninstall" . }}
|
||||
|
||||
{{ template "custom.support" . }}
|
||||
|
||||
{{ template "helm-docs.versionFooter" . }}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{{- define "custom.notes" -}}
|
||||
{{- end -}}
|
||||
|
||||
{{ template "chart.description" . }}
|
||||
{{ template "custom.notes" . }}
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{{- define "custom.custom.configuration.header" -}}
|
||||
# Configuration Options
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.custom.configuration" -}}
|
||||
{{ template "custom.custom.configuration.header" . }}
|
||||
|
||||
N/A
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.custom.configuration" . }}
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
#
|
||||
# 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: ${CHARTNAME}/${CHARTNAME}
|
||||
pullPolicy: IfNotPresent
|
||||
tag: 1.0.0
|
||||
|
||||
strategy:
|
||||
type: Recreate
|
||||
|
||||
# See more environment variables in the ${CHARTNAME} documentation
|
||||
# https://${CHARTNAME}.org/docs
|
||||
env: {}
|
||||
# TZ:
|
||||
|
||||
service:
|
||||
port:
|
||||
port: 1880
|
||||
|
||||
ingress:
|
||||
enabled: false
|
||||
|
||||
# persistence:
|
||||
# data:
|
||||
# enabled: false
|
||||
# emptyDir: false
|
||||
# mountPath: /data
|
||||
|
|
@ -3,7 +3,7 @@ require_relative '../test_helper'
|
|||
|
||||
class Test < ChartTest
|
||||
@@chart = Chart.new('library/common-test')
|
||||
|
||||
|
||||
describe @@chart.name do
|
||||
describe 'controller type' do
|
||||
it 'defaults to "Deployment"' do
|
||||
|
|
@ -11,14 +11,14 @@ class Test < ChartTest
|
|||
assert_nil(resource('DaemonSet'))
|
||||
refute_nil(resource('Deployment'))
|
||||
end
|
||||
|
||||
|
||||
it 'accepts "statefulset"' do
|
||||
chart.value controllerType: 'statefulset'
|
||||
assert_nil(resource('Deployment'))
|
||||
assert_nil(resource('DaemonSet'))
|
||||
refute_nil(resource('StatefulSet'))
|
||||
end
|
||||
|
||||
|
||||
it 'accepts "daemonset"' do
|
||||
chart.value controllerType: 'daemonset'
|
||||
assert_nil(resource('Deployment'))
|
||||
|
|
@ -26,12 +26,12 @@ class Test < ChartTest
|
|||
refute_nil(resource('DaemonSet'))
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
describe 'pod replicas' do
|
||||
it 'defaults to 1' do
|
||||
jq('.spec.replicas', resource('Deployment')).must_equal 1
|
||||
end
|
||||
|
||||
|
||||
it 'accepts integer as value' do
|
||||
chart.value replicas: 3
|
||||
jq('.spec.replicas', resource('Deployment')).must_equal 3
|
||||
|
|
@ -109,7 +109,7 @@ class Test < ChartTest
|
|||
jq('.spec.template.spec.containers[0].env[4].name', resource('Deployment')).must_equal values[:envTpl].keys[0].to_s
|
||||
jq('.spec.template.spec.containers[0].env[4].value', resource('Deployment')).must_equal 'common-test-admin'
|
||||
end
|
||||
|
||||
|
||||
it 'set "Dynamic/Tpl" environment variables' do
|
||||
values = {
|
||||
envTpl: {
|
||||
|
|
@ -139,7 +139,7 @@ class Test < ChartTest
|
|||
jq('.spec.template.spec.containers[0].ports[0].containerPort', resource('Deployment')).must_equal default_port
|
||||
jq('.spec.template.spec.containers[0].ports[0].name', resource('Deployment')).must_equal default_name
|
||||
end
|
||||
|
||||
|
||||
it 'port name can be overridden' do
|
||||
values = {
|
||||
service: {
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
# Bazarr helm chart
|
||||
|
||||
## Configuration
|
||||
|
||||
Please refer to questions.yaml for a detailed overview on supported configurable items.
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
# Bazarr
|
||||
|
||||
Bazarr chart is a chart designed to deploy Bazarr in a TrueNAS SCALE kubernetes cluster.
|
||||
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
|||
appVersion: v0.9.0.5
|
||||
description: Bazarr is a companion application to Bazarr and Radarr. It manages and downloads subtitles based on your requirements
|
||||
name: bazarr
|
||||
version: 1.3.0
|
||||
version: 1.3.1
|
||||
upstream_version: 5.2.1
|
||||
keywords:
|
||||
- bazarr
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
# Introduction
|
||||
|
||||
 
|
||||
|
||||
Bazarr is a companion application to Bazarr and Radarr. It manages and downloads subtitles based on your requirements
|
||||
|
||||
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||||
|
||||
## Source Code
|
||||
|
||||
* <https://github.com/Bazarr/Bazarr>
|
||||
* <https://hub.docker.com/r/linuxserver/bazarr>
|
||||
|
||||
## Requirements
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://charts.truecharts.org/ | common | 1.3.0 |
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `bazarr`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `bazarr` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
{{- define "custom.introheader" -}}
|
||||
# Introduction
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.organization" -}}
|
||||
TrueCharts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.url" -}}
|
||||
https://github.com/truecharts/charts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.url" -}}
|
||||
https://charts.truecharts.org
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.path" -}}
|
||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.notes" -}}
|
||||
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.requirements" -}}
|
||||
## Requirements
|
||||
|
||||
{{ template "chart.kubeVersionLine" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.dependencies" -}}
|
||||
## Dependencies
|
||||
|
||||
{{ template "chart.requirementsTable" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.install" -}}
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.uninstall" -}}
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.configuration.header" -}}
|
||||
## Configuration
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.support" -}}
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.introheader" . }}
|
||||
|
||||
{{ 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" . }}
|
||||
|
||||
{{ template "custom.uninstall" . }}
|
||||
|
||||
{{ template "custom.support" . }}
|
||||
|
||||
{{ template "helm-docs.versionFooter" . }}
|
||||
|
|
@ -0,0 +1 @@
|
|||
Bazarr is a companion application to Bazarr and Radarr. It manages and downloads subtitles based on your requirements
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{{- define "custom.notes" -}}
|
||||
{{- end -}}
|
||||
|
||||
{{ template "chart.description" . }}
|
||||
{{ template "custom.notes" . }}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Configuration Options
|
||||
|
||||
N/A
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{{- define "custom.custom.configuration.header" -}}
|
||||
# Configuration Options
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.custom.configuration" -}}
|
||||
{{ template "custom.custom.configuration.header" . }}
|
||||
|
||||
N/A
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.custom.configuration" . }}
|
||||
|
|
@ -111,7 +111,7 @@ questions:
|
|||
label: "Value"
|
||||
schema:
|
||||
type: string
|
||||
|
||||
|
||||
- variable: service
|
||||
group: "Networking"
|
||||
label: "Configure Service"
|
||||
|
|
@ -188,7 +188,7 @@ questions:
|
|||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
hidden: false
|
||||
hidden: false
|
||||
- variable: emptyDir
|
||||
label: "emptyDir"
|
||||
schema:
|
||||
|
|
@ -244,7 +244,7 @@ questions:
|
|||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
hidden: false
|
||||
hidden: false
|
||||
- variable: emptyDir
|
||||
label: "emptyDir"
|
||||
schema:
|
||||
|
|
@ -300,7 +300,7 @@ questions:
|
|||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
hidden: false
|
||||
hidden: false
|
||||
- variable: emptyDir
|
||||
label: "emptyDir"
|
||||
schema:
|
||||
|
|
@ -432,4 +432,4 @@ questions:
|
|||
label: "Forward Authentication URL"
|
||||
schema:
|
||||
type: string
|
||||
default: ""
|
||||
default: ""
|
||||
|
|
@ -57,5 +57,3 @@ appVolumeMounts:
|
|||
emptyDir: true
|
||||
setPermissions: true
|
||||
mountPath: "/downloads"
|
||||
|
||||
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
# Calibre-Web
|
||||
|
||||
This is a helm chart for [Calibre-Web](https://github.com/janeczku/calibre-web).
|
||||
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
||||
|
||||
## TL;DR;
|
||||
|
||||
```shell
|
||||
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
||||
$ helm install k8s-at-home/calibre-web
|
||||
```
|
||||
|
||||
## Storage
|
||||
|
||||
If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the
|
||||
Fast Access option in the Booksonic settings. This will help improve the perfomance of the application
|
||||
by not constantly monitoring media folders.
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `my-release`:
|
||||
|
||||
```console
|
||||
helm install --name my-release k8s-at-home/calibre-web
|
||||
```
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `my-release` deployment:
|
||||
|
||||
```console
|
||||
helm delete my-release --purge
|
||||
```
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
||||
|
||||
## Configuration
|
||||
Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/calibre-web/values.yaml)
|
||||
file. It has several commented out suggested values. Most notably, these include several environment variables used to
|
||||
customize the container.
|
||||
Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options.
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
||||
```console
|
||||
helm install calibre-web \
|
||||
--set env.TZ="America/New_York" \
|
||||
k8s-at-home/calibre-web
|
||||
```
|
||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
|
||||
chart. For example,
|
||||
```console
|
||||
helm install calibre-web k8s-at-home/calibre-web -f values.yaml
|
||||
```
|
||||
|
||||
```yaml
|
||||
image:
|
||||
tag: ...
|
||||
```
|
||||
|
||||
---
|
||||
**NOTE**
|
||||
|
||||
If you get
|
||||
```console
|
||||
Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...`
|
||||
```
|
||||
it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`.
|
||||
|
||||
---
|
||||
|
||||
## Upgrading an existing Release to a new major version
|
||||
|
||||
A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions.
|
||||
|
||||
### Upgrading from 2.x.x to 3.x.x
|
||||
|
||||
Due to migrating to a centralized common library some values in `values.yaml` have changed.
|
||||
|
||||
Examples:
|
||||
|
||||
* `service.port` has been moved to `service.port.port`.
|
||||
* `persistence.type` has been moved to `controllerType`.
|
||||
|
||||
Refer to the library values.yaml for more configuration options.
|
||||
|
|
@ -1 +0,0 @@
|
|||
The calibre App is designed to deploy calibre in a TrueNAS SCALE kubernetes cluster.
|
||||
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
|||
appVersion: 0.6.9
|
||||
description: Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
|
||||
name: calibre-web
|
||||
version: 1.3.0
|
||||
version: 1.3.1
|
||||
upstream_version: 4.3.1
|
||||
keywords:
|
||||
- calibre
|
||||
|
|
@ -18,4 +18,3 @@ dependencies:
|
|||
- name: common
|
||||
repository: https://charts.truecharts.org/
|
||||
version: 1.3.0
|
||||
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
# Introduction
|
||||
|
||||
 
|
||||
|
||||
Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
|
||||
|
||||
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||||
|
||||
## Source Code
|
||||
|
||||
* <https://hub.docker.com/r/linuxserver/calibre-web/>
|
||||
* <https://github.com/janeczku/calibre-web>
|
||||
|
||||
## Requirements
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://charts.truecharts.org/ | common | 1.3.0 |
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `calibre-web`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `calibre-web` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
{{- define "custom.introheader" -}}
|
||||
# Introduction
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.organization" -}}
|
||||
TrueCharts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.url" -}}
|
||||
https://github.com/truecharts/charts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.url" -}}
|
||||
https://charts.truecharts.org
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.path" -}}
|
||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.notes" -}}
|
||||
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.requirements" -}}
|
||||
## Requirements
|
||||
|
||||
{{ template "chart.kubeVersionLine" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.dependencies" -}}
|
||||
## Dependencies
|
||||
|
||||
{{ template "chart.requirementsTable" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.install" -}}
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.uninstall" -}}
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.configuration.header" -}}
|
||||
## Configuration
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.support" -}}
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.introheader" . }}
|
||||
|
||||
{{ 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" . }}
|
||||
|
||||
{{ template "custom.uninstall" . }}
|
||||
|
||||
{{ template "custom.support" . }}
|
||||
|
||||
{{ template "helm-docs.versionFooter" . }}
|
||||
|
|
@ -0,0 +1 @@
|
|||
Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{{- define "custom.notes" -}}
|
||||
{{- end -}}
|
||||
|
||||
{{ template "chart.description" . }}
|
||||
{{ template "custom.notes" . }}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Configuration Options
|
||||
|
||||
N/A
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{{- define "custom.custom.configuration.header" -}}
|
||||
# Configuration Options
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.custom.configuration" -}}
|
||||
{{ template "custom.custom.configuration.header" . }}
|
||||
|
||||
N/A
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.custom.configuration" . }}
|
||||
|
|
@ -111,7 +111,7 @@ questions:
|
|||
label: "Value"
|
||||
schema:
|
||||
type: string
|
||||
|
||||
|
||||
- variable: service
|
||||
group: "Networking"
|
||||
label: "Configure Service"
|
||||
|
|
@ -187,7 +187,7 @@ questions:
|
|||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
hidden: false
|
||||
hidden: false
|
||||
- variable: emptyDir
|
||||
label: "emptyDir"
|
||||
schema:
|
||||
|
|
@ -243,7 +243,7 @@ questions:
|
|||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
hidden: false
|
||||
hidden: false
|
||||
- variable: emptyDir
|
||||
label: "emptyDir"
|
||||
schema:
|
||||
|
|
@ -41,7 +41,7 @@ persistence:
|
|||
# existingClaim: ""
|
||||
|
||||
appIngressEnabled: false
|
||||
|
||||
|
||||
|
||||
appVolumeMounts:
|
||||
config:
|
||||
|
|
@ -54,4 +54,3 @@ appVolumeMounts:
|
|||
emptyDir: true
|
||||
setPermissions: true
|
||||
mountPath: "/media"
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ persistence:
|
|||
# existingClaim: ""
|
||||
|
||||
appIngressEnabled: false
|
||||
|
||||
|
||||
|
||||
#appVolumeMounts:
|
||||
# config:
|
||||
|
|
@ -50,4 +50,3 @@ appIngressEnabled: false
|
|||
# media:
|
||||
# enabled: false
|
||||
# emptyDir: false
|
||||
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
# Collabora Online (CODE)
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart installs a collabora online (code) server
|
||||
|
||||
## Configuration
|
||||
|
||||
| **Description** | **Parameter** | **Type** | **Values** | **Command Example (This is the defaults)** |
|
||||
|------------------------------------------------------------------------------------------------------------------------|-----------------------|----------|---------------------|--------------------------------------------|
|
||||
| Controls whether the welcome screen should be shown to the users on new install and updates. | welcome.enable | bool | true|false | -o:welcome.enable=true |
|
||||
| Controls whether the welcome screen should have an explanatory button instead of an X button to close the dialog. | welcome.enable_button | bool | true|false | -o:welcome.enable_button=false |
|
||||
| Controls whether the welcome screen should have an explanatory button instead of an X button to close the dialog. | user_interface.mode | string | classic|notebookbar | -o:user_interface.mode=notebookbar |
|
||||
| Opacity of on-screen watermark from 0.0 to 1.0 | watermark.opacity | double | 0.0 - 1.0 | -o:watermark.opacity=0.2 |
|
||||
| Watermark text to be displayed on the document if entered | watermark.text | string | Any text | -o:watermark.text="" |
|
||||
|
||||
|
||||
For more parameters and options, Bash in your container and `cat /etc/loolwsd/loolwsd.xml`
|
||||
|
|
@ -1,15 +1,15 @@
|
|||
apiVersion: v2
|
||||
name: collabora-online
|
||||
version: 1.3.0
|
||||
version: 1.3.1
|
||||
appVersion: 6.4.6.1
|
||||
description: Collabora Online Development Edition – an awesome, Online Office suite image suitable for home use.
|
||||
description: Collabora Online Development Edition – an awesome, Online Office suite image suitable for home use.
|
||||
keywords:
|
||||
- collabora
|
||||
- collaboration
|
||||
- documents
|
||||
home: https://www.collaboraoffice.com/
|
||||
icon: https://avatars.githubusercontent.com/u/22418908?s=200&v=4
|
||||
sources:
|
||||
sources:
|
||||
- https://hub.docker.com/r/collabora/code
|
||||
- https://www.collaboraoffice.com/code/docker/
|
||||
dependencies:
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
# Introduction
|
||||
|
||||
 
|
||||
|
||||
Collabora Online Development Edition – an awesome, Online Office suite image suitable for home use.
|
||||
|
||||
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||||
|
||||
## Source Code
|
||||
|
||||
* <https://hub.docker.com/r/collabora/code>
|
||||
* <https://www.collaboraoffice.com/code/docker/>
|
||||
|
||||
## Requirements
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://charts.truecharts.org/ | common | 1.3.0 |
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `collabora-online`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `collabora-online` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
{{- define "custom.introheader" -}}
|
||||
# Introduction
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.organization" -}}
|
||||
TrueCharts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.url" -}}
|
||||
https://github.com/truecharts/charts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.url" -}}
|
||||
https://charts.truecharts.org
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.path" -}}
|
||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.notes" -}}
|
||||
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.requirements" -}}
|
||||
## Requirements
|
||||
|
||||
{{ template "chart.kubeVersionLine" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.dependencies" -}}
|
||||
## Dependencies
|
||||
|
||||
{{ template "chart.requirementsTable" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.install" -}}
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.uninstall" -}}
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.configuration.header" -}}
|
||||
## Configuration
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.support" -}}
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.introheader" . }}
|
||||
|
||||
{{ 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" . }}
|
||||
|
||||
{{ template "custom.uninstall" . }}
|
||||
|
||||
{{ template "custom.support" . }}
|
||||
|
||||
{{ template "helm-docs.versionFooter" . }}
|
||||
|
|
@ -0,0 +1 @@
|
|||
Collabora Online Development Edition – an awesome, Online Office suite image suitable for home use.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{{- define "custom.notes" -}}
|
||||
{{- end -}}
|
||||
|
||||
{{ template "chart.description" . }}
|
||||
{{ template "custom.notes" . }}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Configuration Options
|
||||
|
||||
N/A
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{{- define "custom.custom.configuration.header" -}}
|
||||
# Configuration Options
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.custom.configuration" -}}
|
||||
{{ template "custom.custom.configuration.header" . }}
|
||||
|
||||
N/A
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.custom.configuration" . }}
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
groups:
|
||||
- name: "Container Image"
|
||||
description: "Configure Container Image"
|
||||
description: "Configure Container Image"
|
||||
- name: "Configuration"
|
||||
description: "additional container configuration"
|
||||
- name: "Networking"
|
||||
|
|
@ -17,7 +17,7 @@ portals:
|
|||
web_portal:
|
||||
protocols:
|
||||
- "https"
|
||||
host:
|
||||
host:
|
||||
- "$node_ip"
|
||||
ports:
|
||||
- "$variable-service.port.nodePort"
|
||||
|
|
@ -36,7 +36,7 @@ questions:
|
|||
- variable: repository
|
||||
label: "Image Repository"
|
||||
schema:
|
||||
type: string
|
||||
type: string
|
||||
default: "collabora/code"
|
||||
editable: false
|
||||
#Tag
|
||||
|
|
@ -71,7 +71,7 @@ questions:
|
|||
- value: "RollingUpdate"
|
||||
description: "Create new pods and then kill old ones"
|
||||
- value: "Recreate"
|
||||
description: "Kill existing pods before creating new ones"
|
||||
description: "Kill existing pods before creating new ones"
|
||||
|
||||
# Configure Time Zone
|
||||
- variable: timezone
|
||||
|
|
@ -145,7 +145,7 @@ questions:
|
|||
max: 65535
|
||||
default: 30980
|
||||
required: true
|
||||
|
||||
|
||||
# environmentVariables Configuraiton
|
||||
- variable: env
|
||||
group: "Environment Variables"
|
||||
|
|
@ -161,7 +161,7 @@ questions:
|
|||
type: string
|
||||
default: 'nextcloud\.domain\.tld|othernextcloud\.domain\.tld'
|
||||
required: true
|
||||
- variable: username
|
||||
- variable: username
|
||||
label: "Username for WebUI"
|
||||
schema:
|
||||
type: string
|
||||
|
|
@ -184,10 +184,10 @@ questions:
|
|||
description: 'e.g. "–o:welcome.enable=false", See more on /etc/loolwsd/loowsd.xml. Separate params with space'
|
||||
schema:
|
||||
type: string
|
||||
default: "-o:welcome.enable=false -o:user_interface.mode=notebookbar -o:ssl.termination=true -o:ssl.enable=false"
|
||||
default: "-o:welcome.enable=false -o:user_interface.mode=notebookbar -o:ssl.termination=true -o:ssl.enable=false"
|
||||
- variable: server_name
|
||||
label: "Server Name"
|
||||
description: "When this environment variable is set (is not “”), then its value will be used as server name in /etc/loolwsd/loolwsd.xml. Without this, CODE is not delivering a correct host for the websocket connection in case of a proxy in front of it."
|
||||
description: "When this environment variable is set (is not “”), then its value will be used as server name in /etc/loolwsd/loolwsd.xml. Without this, CODE is not delivering a correct host for the websocket connection in case of a proxy in front of it."
|
||||
schema:
|
||||
type: string
|
||||
default: 'collabora\.domain\.tld'
|
||||
|
|
@ -289,4 +289,4 @@ questions:
|
|||
label: "Forward Authentication URL"
|
||||
schema:
|
||||
type: string
|
||||
default: ""
|
||||
default: ""
|
||||
|
|
@ -12,9 +12,9 @@ service:
|
|||
port: 9980
|
||||
nodePort: 30980
|
||||
|
||||
env:
|
||||
domain: nextcloud\.domain\.tld
|
||||
dictionaries: de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru
|
||||
env:
|
||||
domain: nextcloud\.domain\.tld
|
||||
dictionaries: de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru
|
||||
username: admin
|
||||
password: changeme
|
||||
extra_params:
|
||||
|
|
@ -10,9 +10,9 @@ service:
|
|||
port:
|
||||
port: 9980
|
||||
|
||||
env:
|
||||
domain:
|
||||
dictionaries:
|
||||
env:
|
||||
domain:
|
||||
dictionaries:
|
||||
username: admin
|
||||
password: changeme
|
||||
extra_params:
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
# Deluge
|
||||
|
||||
This is a helm chart for [Deluge](https://deluge-torrent.org/).
|
||||
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
||||
|
||||
## TL;DR;
|
||||
|
||||
```shell
|
||||
$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
||||
$ helm install k8s-at-home/deluge
|
||||
```
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `my-release`:
|
||||
|
||||
```console
|
||||
helm install --name my-release k8s-at-home/deluge
|
||||
```
|
||||
|
||||
The default login details (change ASAP) are:
|
||||
|
||||
* password:deluge
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `my-release` deployment:
|
||||
|
||||
```console
|
||||
helm delete my-release --purge
|
||||
```
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
||||
|
||||
## Configuration
|
||||
Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/deluge/values.yaml)
|
||||
file. It has several commented out suggested values.
|
||||
Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options.
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
||||
```console
|
||||
helm install deluge \
|
||||
--set env.TZ="America/New_York" \
|
||||
k8s-at-home/deluge
|
||||
```
|
||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the
|
||||
chart. For example,
|
||||
```console
|
||||
helm install deluge k8s-at-home/deluge --values values.yaml
|
||||
```
|
||||
|
||||
These values will be nested as it is a dependency, for example
|
||||
```yaml
|
||||
image:
|
||||
tag: ...
|
||||
```
|
||||
|
|
@ -1 +0,0 @@
|
|||
The deluge App is designed to deploy deluge in a TrueNAS SCALE kubernetes cluster.
|
||||
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
|||
appVersion: v2.0.3-2201906121747
|
||||
description: Deluge is a torrent download client
|
||||
name: deluge
|
||||
version: 1.3.0
|
||||
version: 1.3.1
|
||||
upstream_version: 1.1.1
|
||||
keywords:
|
||||
- deluge
|
||||
|
|
@ -18,4 +18,3 @@ dependencies:
|
|||
- name: common
|
||||
repository: https://charts.truecharts.org/
|
||||
version: 1.3.0
|
||||
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
# Introduction
|
||||
|
||||
 
|
||||
|
||||
Deluge is a torrent download client
|
||||
|
||||
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||||
|
||||
## Source Code
|
||||
|
||||
* <https://hub.docker.com/r/linuxserver/deluge/>
|
||||
* <https://deluge-torrent.org/>
|
||||
|
||||
## Requirements
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://charts.truecharts.org/ | common | 1.3.0 |
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `deluge`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `deluge` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
{{- define "custom.introheader" -}}
|
||||
# Introduction
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.organization" -}}
|
||||
TrueCharts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.repository.url" -}}
|
||||
https://github.com/truecharts/charts
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.url" -}}
|
||||
https://charts.truecharts.org
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.helm.path" -}}
|
||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.notes" -}}
|
||||
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.requirements" -}}
|
||||
## Requirements
|
||||
|
||||
{{ template "chart.kubeVersionLine" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.dependencies" -}}
|
||||
## Dependencies
|
||||
|
||||
{{ template "chart.requirementsTable" . }}
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.install" -}}
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Click "Install" for this specific Apps
|
||||
- Fill out the configuration form
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.uninstall" -}}
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
||||
|
||||
- Open TrueNAS SCALE
|
||||
- Go to Apps
|
||||
- Go to "Installed Apps"
|
||||
- Expand the menu in the top-right corner of this App
|
||||
- Click "Remove" for this specific Apps
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.configuration.header" -}}
|
||||
## Configuration
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.support" -}}
|
||||
## Support
|
||||
|
||||
- See the [Wiki](https://wiki.truecharts.org)
|
||||
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
||||
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.introheader" . }}
|
||||
|
||||
{{ 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" . }}
|
||||
|
||||
{{ template "custom.uninstall" . }}
|
||||
|
||||
{{ template "custom.support" . }}
|
||||
|
||||
{{ template "helm-docs.versionFooter" . }}
|
||||
|
|
@ -0,0 +1 @@
|
|||
Deluge is a torrent download client
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{{- define "custom.notes" -}}
|
||||
{{- end -}}
|
||||
|
||||
{{ template "chart.description" . }}
|
||||
{{ template "custom.notes" . }}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Configuration Options
|
||||
|
||||
N/A
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{{- define "custom.custom.configuration.header" -}}
|
||||
# Configuration Options
|
||||
{{- end -}}
|
||||
|
||||
{{- define "custom.custom.configuration" -}}
|
||||
{{ template "custom.custom.configuration.header" . }}
|
||||
|
||||
N/A
|
||||
{{- end -}}
|
||||
|
||||
{{ template "custom.custom.configuration" . }}
|
||||
|
|
@ -111,7 +111,7 @@ questions:
|
|||
label: "Value"
|
||||
schema:
|
||||
type: string
|
||||
|
||||
|
||||
# Enable Host Network
|
||||
- variable: hostNetwork
|
||||
group: "Networking"
|
||||
|
|
@ -119,7 +119,7 @@ questions:
|
|||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
|
||||
|
||||
- variable: service
|
||||
group: "Networking"
|
||||
label: "Configure Service"
|
||||
|
|
@ -315,7 +315,7 @@ questions:
|
|||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
hidden: false
|
||||
hidden: false
|
||||
- variable: emptyDir
|
||||
label: "emptyDir"
|
||||
schema:
|
||||
|
|
@ -371,7 +371,7 @@ questions:
|
|||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
hidden: false
|
||||
hidden: false
|
||||
- variable: emptyDir
|
||||
label: "emptyDir"
|
||||
schema:
|
||||
|
|
@ -45,7 +45,7 @@ env: {}
|
|||
# DELUGE_LOGLEVEL: "error"
|
||||
|
||||
appIngressEnabled: false
|
||||
|
||||
|
||||
appVolumeMounts:
|
||||
config:
|
||||
enabled: true
|
||||
|
|
@ -57,7 +57,7 @@ appVolumeMounts:
|
|||
emptyDir: true
|
||||
setPermissions: true
|
||||
mountPath: "/downloads"
|
||||
|
||||
|
||||
appAdditionalServicesEnabled: true
|
||||
appAdditionalServices:
|
||||
tcp:
|
||||
|
|
@ -76,4 +76,3 @@ appAdditionalServices:
|
|||
name: bittorrent-udp
|
||||
protocol: UDP
|
||||
targetPort: 51413
|
||||
|
||||
|
|
@ -45,7 +45,7 @@ env: {}
|
|||
# DELUGE_LOGLEVEL: "error"
|
||||
|
||||
appIngressEnabled: false
|
||||
|
||||
|
||||
# appVolumeMounts:
|
||||
# config:
|
||||
# enabled: false
|
||||
|
|
@ -53,7 +53,7 @@ appIngressEnabled: false
|
|||
# downloads:
|
||||
# enabled: false
|
||||
# emptyDir: false
|
||||
|
||||
|
||||
appAdditionalServicesEnabled: true
|
||||
appAdditionalServices:
|
||||
tcp:
|
||||
|
|
@ -72,4 +72,3 @@ appAdditionalServices:
|
|||
name: bittorrent-udp
|
||||
protocol: UDP
|
||||
targetPort: 51413
|
||||
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
# ESPHome helm chart
|
||||
|
||||
## Configuration
|
||||
|
||||
Please refer to questions.yaml for a detailed overview on supported configurable items.
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
# ESPHome
|
||||
|
||||
ESPHome chart is a chart designed to deploy ESPHome in a TrueNAS SCALE kubernetes cluster.
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
apiVersion: v2
|
||||
appVersion: 1.15.3
|
||||
version: 1.3.0
|
||||
version: 1.3.1
|
||||
upstream_version: 4.3.1
|
||||
|
||||
name: esphome
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue