diff --git a/README.md b/README.md index 44274ac..bf954b6 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ -+++ -title = "Helm Chart" -template = "docs/section.html" -sort_by = "weight" -weight = 5 -+++ +--- +title: "Helm-Charts" +weight: 1 +cascade: + - url: /:sections/:title/ +url: /:sections +--- -# Usage +## Usage Helm must be installed and setup to your kubernetes cluster to use the charts. Refer to Helm's [documentation](https://helm.sh/docs) to get started. diff --git a/README.md.gotmpl b/README.md.gotmpl index dd93d2c..ffed287 100644 --- a/README.md.gotmpl +++ b/README.md.gotmpl @@ -1,16 +1,9 @@ -+++ -title = {{ .Name | quote }} +--- +title: {{ .Name | quote }} {{ if .Description }} -description = {{.Description | quote }} +description: {{.Description | quote }} {{ end }} - -weight = 30 -sort_by = "weight" -template = "docs/page.html" - -[extra] -toc = true -+++ +--- {{- define "chart.prerequirements" }} {{- end }} diff --git a/home-assistant/Chart.yaml b/home-assistant/Chart.yaml index de4ae1b..31ba2ae 100644 --- a/home-assistant/Chart.yaml +++ b/home-assistant/Chart.yaml @@ -1,10 +1,11 @@ apiVersion: v2 name: home-assistant description: Home Assistant with tooling to run on an k3s pi +icon: https://www.home-assistant.io/images/favicon-192x192.png type: application -version: 0.2.3 +version: 0.2.4 # renovate: image=ghcr.io/home-assistant/home-assistant -appVersion: "2024.10.4" +appVersion: "2024.11.0" maintainers: - name: WrenIX url: https://wrenix.eu diff --git a/home-assistant/README.adoc b/home-assistant/README.adoc index 0792440..07cca64 100644 --- a/home-assistant/README.adoc +++ b/home-assistant/README.adoc @@ -2,9 +2,9 @@ = home-assistant -image::https://img.shields.io/badge/Version-0.2.3-informational?style=flat-square[Version: 0.2.3] +image::https://img.shields.io/badge/Version-0.2.4-informational?style=flat-square[Version: 0.2.4] image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application] -image::https://img.shields.io/badge/AppVersion-2024.10.4-informational?style=flat-square[AppVersion: 2024.10.4] +image::https://img.shields.io/badge/AppVersion-2024.11.0-informational?style=flat-square[AppVersion: 2024.11.0] == Maintainers .Maintainers diff --git a/home-assistant/README.md b/home-assistant/README.md new file mode 100644 index 0000000..37246e0 --- /dev/null +++ b/home-assistant/README.md @@ -0,0 +1,120 @@ +--- +title: "home-assistant" + +description: "Home Assistant with tooling to run on an k3s pi" + +--- + +# home-assistant + +![Version: 0.2.4](https://img.shields.io/badge/Version-0.2.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2024.11.0](https://img.shields.io/badge/AppVersion-2024.11.0-informational?style=flat-square) + +Home Assistant with tooling to run on an k3s pi + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| WrenIX | | | + +## Usage + +Helm must be installed and setup to your kubernetes cluster to use the charts. +Refer to Helm's [documentation](https://helm.sh/docs) to get started. +Once Helm has been set up correctly, fetch the charts as follows: + +```bash +helm pull oci://codeberg.org/wrenix/helm-charts/home-assistant +``` + +You can install a chart release using the following command: + +```bash +helm install home-assistant-release oci://codeberg.org/wrenix/helm-charts/home-assistant --values values.yaml +``` + +To uninstall a chart release use `helm`'s delete command: + +```bash +helm uninstall home-assistant-release +``` + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| fullnameOverride | string | `""` | | +| global.image.pullPolicy | string | `nil` | if set it will overwrite all pullPolicy | +| global.image.registry | string | `nil` | if set it will overwrite all registry entries | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.registry | string | `"ghcr.io"` | | +| image.repository | string | `"home-assistant/home-assistant"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| livenessProbe.httpGet.path | string | `"/"` | | +| livenessProbe.httpGet.port | string | `"http"` | | +| nameOverride | string | `""` | | +| nats.enabled | bool | `true` | | +| nats.image.pullPolicy | string | `"IfNotPresent"` | | +| nats.image.registry | string | `"docker.io"` | | +| nats.image.repository | string | `"library/nats"` | | +| nats.image.tag | string | `"2.10.22-scratch"` | | +| nats.livenessProbe.tcpSocket.port | string | `"nats"` | | +| nats.readinessProbe.tcpSocket.port | string | `"nats"` | | +| nats.resources.limits.cpu | string | `"100m"` | | +| nats.resources.limits.memory | string | `"128Mi"` | | +| nats.resources.requests.cpu | string | `"100m"` | | +| nats.resources.requests.memory | string | `"128Mi"` | | +| nats.service.port.mqtt | int | `1883` | | +| nats.service.port.nats | int | `4222` | | +| nodeSelector | object | `{}` | | +| persistence.accessMode | string | `"ReadWriteOnce"` | | +| persistence.annotations | object | `{}` | | +| persistence.enabled | bool | `false` | | +| persistence.existingClaim | string | `nil` | A manually managed Persistent Volume and Claim Requires persistence.enabled: true If defined, PVC must be created manually before volume will be bound | +| persistence.hostPath | string | `nil` | | +| persistence.size | string | `"1Gi"` | | +| persistence.storageClass | string | `nil` | data Persistent Volume Storage Class If defined, storageClassName: If set to "-", storageClassName: "", which disables dynamic provisioning If undefined (the default) or set to null, no storageClassName spec is set, choosing the default provisioner. (gp2 on AWS, standard on GKE, AWS & OpenStack) | +| podAnnotations | object | `{}` | | +| podLabels | object | `{}` | | +| podSecurityContext | object | `{}` | | +| prometheus.podmonitor.bearerTokenSecret | object | `{}` | | +| prometheus.podmonitor.enabled | bool | `false` | | +| prometheus.podmonitor.labels | object | `{}` | | +| readinessProbe.httpGet.path | string | `"/"` | | +| readinessProbe.httpGet.port | string | `"http"` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| service.port | int | `80` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | If not set and create is true, a name is generated using the fullname template | +| tolerations | list | `[]` | | +| volumeMounts | list | `[]` | | +| volumes | list | `[]` | | +| zigbee2mqtt.config.homeassistant | bool | `true` | | +| zigbee2mqtt.config.serial.port | string | `"/dev/ttyACM0"` | | +| zigbee2mqtt.device | string | `"/dev/ttyACM0"` | | +| zigbee2mqtt.enabled | bool | `true` | | +| zigbee2mqtt.image.pullPolicy | string | `"IfNotPresent"` | | +| zigbee2mqtt.image.registry | string | `"docker.io"` | | +| zigbee2mqtt.image.repository | string | `"koenkk/zigbee2mqtt"` | | +| zigbee2mqtt.image.tag | string | `"1.41.0"` | | +| zigbee2mqtt.ingress.hosts | list | `[]` | | +| zigbee2mqtt.securityContext.privileged | bool | `true` | | + +Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs) diff --git a/home-assistant/artifacthub-repo.yml b/home-assistant/artifacthub-repo.yml new file mode 100644 index 0000000..c801df4 --- /dev/null +++ b/home-assistant/artifacthub-repo.yml @@ -0,0 +1 @@ +repositoryID: a2209d76-d5e9-4809-ac29-536b59035c65 diff --git a/publish.sh b/publish.sh index b676584..a0644cf 100755 --- a/publish.sh +++ b/publish.sh @@ -1,6 +1,7 @@ #/bin/sh -HELM_REPO=${HELM_REPO:-oci://codeberg.org/wrenix/helm-charts} +HELM_REPO=${HELM_REPO:-codeberg.org/wrenix/helm-charts} +HELM_REPO_URL="oci://${HELM_REPO}" COMMIT_SCOPE=${2:-fix} COMMIT_MESSAGE=${1:-"update appVersion"} @@ -52,7 +53,11 @@ for p in * ; do helm-docs -t ./README.adoc.gotmpl -t _docs.gotmpl -o README.adoc -g "${p}" helm package "${p}" - helm push "${p}-${v}.tgz" "${HELM_REPO}"; + helm push "${p}-${v}.tgz" "${HELM_REPO_URL}"; + + oras push "${HELM_REPO}/${p}:artifacthub.io" \ + --config /dev/null:application/vnd.cncf.artifacthub.config.v1+yaml \ + "${p}/artifacthub-repo.yml":application/vnd.cncf.artifacthub.repository-metadata.layer.v1.yaml git add "${p}/" "docs/modules/charts/nav.adoc" "docs/modules/charts/pages/${p}.adoc" git commit -m "${COMMIT_SCOPE}(${p}): ${COMMIT_MESSAGE}"