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
committed by
kjeld Schouten-Lebbing
kjeld Schouten-Lebbing
parent
94a6d6f9e1
commit
1d51be0e3d
@@ -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 @@
|
||||
{{- include "common.notes.defaultNotes" . -}}
|
||||
@@ -0,0 +1 @@
|
||||
{{ include "common.all" . }}
|
||||
@@ -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
|
||||
Reference in New Issue
Block a user