fix: README with oci

solve #3

README.md

@@ -1,26 +1,23 @@
-= helm-charts
+# helm-charts
 
-== Usage
+## Usage
 
 Helm must be installed and setup to your kubernetes cluster to use the charts.
-Refer to Helm's https://helm.sh/docs[documentation] to get started.
+Refer to Helm's [documentation](https://helm.sh/docs) to get started.
 Once Helm has been set up correctly, fetch the charts as follows:
 
-[source,bash]
-----
-helm pull oci://codeberg.org/wrenix/helm-charts/<chart>
-----
+```bash
+helm pull oci://codeberg.org/wrenix/helm-charts/<chart.name>
+```
 
 You can install a chart release using the following command:
 
-[source,bash]
-----
-helm install <release> oci://codeberg.org/wrenix/helm-charts/<chart> --values values.yaml
-----
+```bash
+helm install <release> oci://codeberg.org/wrenix/helm-charts/<chart.name> --values values.yaml
+```
 
 To uninstall a chart release use `helm`'s delete command:
 
-[source,bash]
-----
+```bash
 helm uninstall <release>
-----
+```

README.md.gotmpl

@@ -1,3 +1,4 @@
+{{- define "chart.prerequirements" -}}{{- end -}}
 {{ template "chart.header" . }}
 {{ template "chart.deprecationWarning" . }}
 
@@ -9,8 +10,35 @@
 
 {{ template "chart.maintainersSection" . }}
 
+{{ template "chart.prerequirements" . }}
+
+## 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/{{ template "chart.name" . }}
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install {{ template "chart.name" . }}-release oci://codeberg.org/wrenix/helm-charts/{{ template "chart.name" . }} --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall {{ template "chart.name" . }}-release
+```
+
 {{ template "chart.sourcesSection" . }}
 
 {{ template "chart.requirementsSection" . }}
 
 {{ template "chart.valuesSection" . }}
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

alertmanager-matrix/README.md

@@ -4,6 +4,28 @@
 
 Service for managing and receiving Alertmanager alerts on Matrix
 
+## 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/alertmanager-matrix
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install alertmanager-matrix-release oci://codeberg.org/wrenix/helm-charts/alertmanager-matrix --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall alertmanager-matrix-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -66,3 +88,6 @@ Service for managing and receiving Alertmanager alerts on Matrix
 | serviceAccount.create | bool | `true` |  |
 | serviceAccount.name | string | `""` |  |
 | tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

alertmanager-ntfy/README.md

@@ -4,6 +4,28 @@
 
 Receiver for alertmanager to forward to ntfy.sh
 
+## 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/alertmanager-ntfy
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install alertmanager-ntfy-release oci://codeberg.org/wrenix/helm-charts/alertmanager-ntfy --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall alertmanager-ntfy-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -57,3 +79,6 @@ Receiver for alertmanager to forward to ntfy.sh
 | serviceAccount.create | bool | `true` |  |
 | serviceAccount.name | string | `""` |  |
 | tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

authentik-application/Chart.yaml

@@ -3,65 +3,4 @@ name: authentik-application
 type: application
 
 version: 0.3.4
-description: |-
-  A Chart to deploy a secret for the authentik blueprint-sidecar.
-
-  for usage, deploy:
-  https://github.com/goauthentik/helm/pull/146
-
-  or use:
-  ```yaml
-  serviceAccount:
-    create: true
-
-  additionalContainers:
-    - name: sidecar-blueprints
-      image: "ghcr.io/kiwigrid/k8s-sidecar:1.25.1"
-      env:
-        - name: "FOLDER"
-          value: "/blueprints/sidecar"
-        - name: "LABEL"
-          value: "goauthentik_blueprint"
-        - name: "LABEL_VALUE"
-          value: "1"
-        # - name: "NAMESPACE"
-        #   value: "ALL"
-        - name: "RESOURCE"
-          value: "both"
-        - name: "UNIQUE_FILENAMES"
-          value: "true"
-      volumeMounts:
-        - name: sidecar-blueprints
-          mountPath: /blueprints/sidecar
-
-  volumeMounts:
-    - name: sidecar-blueprints
-      mountPath: /blueprints/sidecar
-
-  volumes:
-    - name: sidecar-blueprints
-      emptyDir: {}
-  ```
-  and create an serviceaccount to read secrets:
-  ```yaml
-  apiVersion: rbac.authorization.k8s.io/v1
-  kind: RoleBinding
-  metadata:
-    name: authentik-blueprint-sidecar
-  roleRef:
-    apiGroup: rbac.authorization.k8s.io
-    kind: Role
-    name: authentik-blueprint-sidecar
-  subjects:
-    - kind: ServiceAccount
-      name: authentik
-  ---
-  apiVersion: rbac.authorization.k8s.io/v1
-  kind: Role
-  metadata:
-    name: authentik-blueprint-sidecar
-  rules:
-    - apiGroups: [""]
-      resources: ["configmaps", "secrets"]
-      verbs: ["get", "watch", "list"]
-  ```
+description: "A Chart to deploy a secret for the authentik blueprint-sidecar."

authentik-application/README.adoc

@@ -1,51 +0,0 @@
-= Authentik Application
-
-setup configmap with blueprint for goauthentik and store values in secrets
-
-
-Usage with FluxCD:
-[source,yaml]
-----
-apiVersion: helm.toolkit.fluxcd.io/v2beta1
-kind: HelmRelease
-metadata:
-  name: app-oauth2
-spec:
-  interval: 5m
-  chart:
-    spec:
-      sourceRef:
-        kind: GitRepository
-        name: "wrenix-helm-charts"
-        namespace: "infra"
-      chart: './charts/authentik-application'
-      reconcileStrategy: 'Revision'
-      interval: 1m
-  install:
-    crds: CreateReplace
-    remediation:
-      retries: -1
-    disableWait: true
-  upgrade:
-    crds: CreateReplace
-    remediation:
-      retries: -1
-    disableWait: true
-    force: true
-  values:
-    secret:
-      name: "oidc-auth"
-    blueprint:
-      provider:
-        name: "GitOps"
-        redirectURL: "https://application.domain/oauth2/callback"
-        signingKey: "authentik Self-signed Certificate"
-        scopes:
-          - "email"
-      application:
-        name: "The Application"
-        slug: "app"
-        group: "Infrastructure"
-        launchURL: "https://application.domain/"
-        openInNewTab: True
-----

authentik-application/README.md

@@ -4,10 +4,11 @@
 
 A Chart to deploy a secret for the authentik blueprint-sidecar.
 
-for usage, deploy:
-https://github.com/goauthentik/helm/pull/146
+## Pre-Requirement
+Usage of https://github.com/goauthentik/helm/pull/146
 
-or use:
+## or manual:
+Install authentik with this `values.yaml`:
 ```yaml
 serviceAccount:
   create: true
@@ -40,8 +41,19 @@ volumes:
   - name: sidecar-blueprints
     emptyDir: {}
 ```
-and create an serviceaccount to read secrets:
+
+And create an Role and bind them on to the ServiceAccount to read secrets:
 ```yaml
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: Role
+metadata:
+  name: authentik-blueprint-sidecar
+rules:
+  - apiGroups: [""]
+    resources: ["configmaps", "secrets"]
+    verbs: ["get", "watch", "list"]
+---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: RoleBinding
 metadata:
@@ -53,15 +65,28 @@ roleRef:
 subjects:
   - kind: ServiceAccount
     name: authentik
----
-apiVersion: rbac.authorization.k8s.io/v1
-kind: Role
-metadata:
-  name: authentik-blueprint-sidecar
-rules:
-  - apiGroups: [""]
-    resources: ["configmaps", "secrets"]
-    verbs: ["get", "watch", "list"]
+```
+
+## 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/authentik-application
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install authentik-application-release oci://codeberg.org/wrenix/helm-charts/authentik-application --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall authentik-application-release
 ```
 
 ## Values
@@ -99,3 +124,7 @@ rules:
 | blueprint.provider.type | string | `"oidc"` | type of application connection, current support: oidc and proxy |
 | secret.labels | object | `{}` | label of secret to store generated secret |
 | secret.name | string | `""` | name of secret to store generated secret (like clientI) |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
+

authentik-application/_docs.gotmpl

@@ -0,0 +1,64 @@
+{{ define "chart.prerequirements" -}}
+## Pre-Requirement
+Usage of https://github.com/goauthentik/helm/pull/146
+
+## or manual:
+Install authentik with this `values.yaml`:
+```yaml
+serviceAccount:
+  create: true
+
+additionalContainers:
+  - name: sidecar-blueprints
+    image: "ghcr.io/kiwigrid/k8s-sidecar:1.25.1"
+    env:
+      - name: "FOLDER"
+        value: "/blueprints/sidecar"
+      - name: "LABEL"
+        value: "goauthentik_blueprint"
+      - name: "LABEL_VALUE"
+        value: "1"
+      # - name: "NAMESPACE"
+      #   value: "ALL"
+      - name: "RESOURCE"
+        value: "both"
+      - name: "UNIQUE_FILENAMES"
+        value: "true"
+    volumeMounts:
+      - name: sidecar-blueprints
+        mountPath: /blueprints/sidecar
+
+volumeMounts:
+  - name: sidecar-blueprints
+    mountPath: /blueprints/sidecar
+
+volumes:
+  - name: sidecar-blueprints
+    emptyDir: {}
+```
+
+And create an Role and bind them on to the ServiceAccount to read secrets:
+```yaml
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: Role
+metadata:
+  name: authentik-blueprint-sidecar
+rules:
+  - apiGroups: [""]
+    resources: ["configmaps", "secrets"]
+    verbs: ["get", "watch", "list"]
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: RoleBinding
+metadata:
+  name: authentik-blueprint-sidecar
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: Role
+  name: authentik-blueprint-sidecar
+subjects:
+  - kind: ServiceAccount
+    name: authentik
+```
+{{- end }}

conduit/README.md

@@ -4,6 +4,28 @@
 
 Conduit is a simple, fast and reliable chat server powered by Matrix.
 
+## 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/conduit
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install conduit-release oci://codeberg.org/wrenix/helm-charts/conduit --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall conduit-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -76,3 +98,6 @@ Conduit is a simple, fast and reliable chat server powered by Matrix.
 | wellknown.service.port | int | `8080` |  |
 | wellknown.service.type | string | `"ClusterIP"` |  |
 | wellknown.tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

forgejo-runner/README.md

@@ -4,6 +4,28 @@
 
 Deploy runner for an forgejo instance (default codeberg.org)
 
+## 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/forgejo-runner
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install forgejo-runner-release oci://codeberg.org/wrenix/helm-charts/forgejo-runner --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall forgejo-runner-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -47,3 +69,6 @@ Deploy runner for an forgejo instance (default codeberg.org)
 | tolerations | list | `[]` |  |
 | volumeMounts | list | `[]` |  |
 | volumes | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

headscale-ui/README.md

@@ -4,6 +4,28 @@
 
 A simple Headscale web UI for small-scale deployments.
 
+## 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/headscale-ui
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install headscale-ui-release oci://codeberg.org/wrenix/helm-charts/headscale-ui --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall headscale-ui-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -39,3 +61,6 @@ A simple Headscale web UI for small-scale deployments.
 | serviceAccount.create | bool | `true` |  |
 | serviceAccount.name | string | `""` |  |
 | tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

headscale/README.md

@@ -4,6 +4,28 @@
 
 An open source, self-hosted implementation of the Tailscale control server.
 
+## 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/headscale
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install headscale-release oci://codeberg.org/wrenix/helm-charts/headscale --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall headscale-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -80,3 +102,6 @@ An open source, self-hosted implementation of the Tailscale control server.
 | serviceAccount.create | bool | `true` |  |
 | serviceAccount.name | string | `""` |  |
 | tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

hydrogen-web/README.md

@@ -4,6 +4,28 @@
 
 A Helm Chart to install hydrogen-web (a nextgen Matrix Webclient)
 
+## 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/hydrogen-web
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install hydrogen-web-release oci://codeberg.org/wrenix/helm-charts/hydrogen-web --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall hydrogen-web-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -47,3 +69,6 @@ A Helm Chart to install hydrogen-web (a nextgen Matrix Webclient)
 | serviceAccount.create | bool | `true` |  |
 | serviceAccount.name | string | `""` |  |
 | tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

jellyfin/README.md

@@ -4,6 +4,28 @@
 
 The Free Software Media System
 
+## 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/jellyfin
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install jellyfin-release oci://codeberg.org/wrenix/helm-charts/jellyfin --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall jellyfin-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -48,3 +70,6 @@ The Free Software Media System
 | serviceAccount.create | bool | `true` |  |
 | serviceAccount.name | string | `""` |  |
 | tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

miniserve/README.md

@@ -4,6 +4,28 @@
 
 A Helm chart for Kubernetes
 
+## 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/miniserve
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install miniserve-release oci://codeberg.org/wrenix/helm-charts/miniserve --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall miniserve-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -73,3 +95,6 @@ A Helm chart for Kubernetes
 | serviceAccount.create | bool | `true` |  |
 | serviceAccount.name | string | `""` |  |
 | tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

monitoring/README.md

@@ -4,6 +4,28 @@
 
 Deploy helper for probes and scrapeconfig of prometheus-operator
 
+## 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/monitoring
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install monitoring-release oci://codeberg.org/wrenix/helm-charts/monitoring --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall monitoring-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -32,3 +54,6 @@ Deploy helper for probes and scrapeconfig of prometheus-operator
 | scrapes[1].metricsPath | string | `"/minio/v2/metrics/node"` | metric path on scrape |
 | scrapes[1].name | string | `"minio"` | name of scrape |
 | scrapes[1].scheme | string | `"http"` | schema on scrape |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

ntfy/README.md

@@ -4,6 +4,28 @@
 
 A Helm chart for Kubernetes
 
+## 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/ntfy
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install ntfy-release oci://codeberg.org/wrenix/helm-charts/ntfy --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall ntfy-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -100,3 +122,6 @@ A Helm chart for Kubernetes
 | serviceAccount.create | bool | `true` |  |
 | serviceAccount.name | string | `""` |  |
 | tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

postgresql/README.md

@@ -4,6 +4,28 @@
 
 A Helm chart for running PostgreSQL (Postgres) database
 
+## 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/postgresql
+```
+
+You can install a chart release using the following command:
+
+```bash
+helm install postgresql-release oci://codeberg.org/wrenix/helm-charts/postgresql --values values.yaml
+```
+
+To uninstall a chart release use `helm`'s delete command:
+
+```bash
+helm uninstall postgresql-release
+```
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -39,3 +61,6 @@ A Helm chart for running PostgreSQL (Postgres) database
 | serviceAccount.create | bool | `false` |  |
 | serviceAccount.name | string | `""` |  |
 | tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

publish.sh

@@ -2,7 +2,7 @@
 
 HELM_REPO=${HELM_REPO:-oci://codeberg.org/wrenix/helm-charts}
 
-helm-docs -t ./README.md.gotmpl
+helm-docs -t ./README.md.gotmpl -t _docs.gotmpl
 
 for p in * ; do
   if [ ! -d $p ]; then