charts/templates/chart
2021-02-13 18:46:58 -05:00
..
templates [template] Move template chart to outer folder (#518) 2021-01-26 20:31:43 +01:00
Chart.yaml bump charts to common v3 (#582) 2021-02-13 18:46:58 -05:00
OWNERS [template] Move template chart to outer folder (#518) 2021-01-26 20:31:43 +01:00
README.md [template] Move template chart to outer folder (#518) 2021-01-26 20:31:43 +01:00
values.yaml bump charts to common v3 (#582) 2021-02-13 18:46:58 -05:00

${CHARTNAME}

This is a helm chart for ${CHARTNAME}.

This chart is not maintained by the upstream project and any issues with the chart should be raised here

TL;DR;

$ helm repo add k8s-at-home https://k8s-at-home.com/charts/
$ helm install k8s-at-home/${CHARTNAME}

Installing the Chart

To install the chart with the release name my-release:

helm install --name my-release k8s-at-home/${CHARTNAME}

Uninstalling the Chart

To uninstall/delete the my-release deployment:

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 file. It has several commented out suggested values. Additionally you can take a look at the common library values.yaml for more (advanced) configuration options.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

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. For example,

helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} --values values.yaml

These values will be nested as it is a dependency, for example

image:
  tag: ...

NOTE

If you get

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.