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
3.4 KiB
${CHARTNAME}
${CHARTNAME} helm package
This chart is not maintained by the upstream project and any issues with the chart should be raised here
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
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}
helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}
Uninstalling the Chart
To uninstall the ${CHARTNAME} deployment
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 file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.
Specify each parameter using the --set key=value[,key=value] argument to helm install.
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.
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
| 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.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
1.0.0
Added
- N/A
Changed
- N/A
Removed
- N/A
Support
Autogenerated from chart metadata using helm-docs v1.5.0