From d068e85edcc6cb2d03190628629a1834f4ad6873 Mon Sep 17 00:00:00 2001 From: "k8s-at-home[bot]" Date: Mon, 4 Jul 2022 06:37:50 +0000 Subject: [PATCH] chore: Auto-update chart README [skip ci] --- charts/stable/deemix/README.md | 91 +++++++++++++++++++++++++++++++--- 1 file changed, 84 insertions(+), 7 deletions(-) diff --git a/charts/stable/deemix/README.md b/charts/stable/deemix/README.md index 5fae5b88..ebf4958c 100644 --- a/charts/stable/deemix/README.md +++ b/charts/stable/deemix/README.md @@ -4,13 +4,7 @@ Deemix is a Deezer Download Manager -**Homepage:** - -## Maintainers - -| Name | Email | Url | -| ---- | ------ | --- | -| preisschild | | | +**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 @@ -21,12 +15,65 @@ Deemix is a Deezer Download Manager Kubernetes: `>=1.16.0-0` +## Dependencies + | Repository | Name | Version | |------------|------|---------| | https://library-charts.k8s-at-home.com | common | 4.4.2 | +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install deemix k8s-at-home/deemix +``` + +## Installing the Chart + +To install the chart with the release name `deemix` + +```console +helm install deemix k8s-at-home/deemix +``` + +## Uninstalling the Chart + +To uninstall the `deemix` deployment + +```console +helm uninstall deemix +``` + +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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install deemix \ + --set env.TZ="America/New York" \ + k8s-at-home/deemix +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install deemix k8s-at-home/deemix -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/library-charts/tree/main/charts/stable/common) + | Key | Type | Default | Description | |-----|------|---------|-------------| | env | object | See below | environment variables. See more environment variables in the [deemix-docker documentation](https://gitlab.com/Bockiii/deemix-docker). | @@ -40,3 +87,33 @@ Kubernetes: `>=1.16.0-0` | ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | | persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | | service | object | See values.yaml | Configures service settings for the chart. | + +## Changelog + +### Version 1.0.0 + +#### Added + +* Initial version + +#### Changed + +N/A + +#### Fixed + +N/A + +### Older versions + +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/deemix?modal=changelog) + +## 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 + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)