From 3b7a10478e5cdb31d07434760758dd31d2a7c022 Mon Sep 17 00:00:00 2001 From: WrenIX Date: Fri, 3 Nov 2023 15:59:10 +0100 Subject: [PATCH] fix: README with oci solve #3 --- README.adoc => README.md | 25 +++++------- README.md.gotmpl | 28 +++++++++++++ alertmanager-matrix/README.md | 25 ++++++++++++ alertmanager-matrix/_docs.gotmpl | 0 alertmanager-ntfy/README.md | 25 ++++++++++++ alertmanager-ntfy/_docs.gotmpl | 0 authentik-application/Chart.yaml | 63 +---------------------------- authentik-application/README.adoc | 51 ------------------------ authentik-application/README.md | 55 +++++++++++++++++++------ authentik-application/_docs.gotmpl | 64 ++++++++++++++++++++++++++++++ conduit/README.md | 25 ++++++++++++ conduit/_docs.gotmpl | 0 forgejo-runner/README.md | 25 ++++++++++++ forgejo-runner/_docs.gotmpl | 0 headscale-ui/README.md | 25 ++++++++++++ headscale-ui/_docs.gotmpl | 0 headscale/README.md | 25 ++++++++++++ headscale/_docs.gotmpl | 0 hydrogen-web/README.md | 25 ++++++++++++ hydrogen-web/_docs.gotmpl | 0 jellyfin/README.md | 25 ++++++++++++ jellyfin/_docs.gotmpl | 0 miniserve/README.md | 25 ++++++++++++ miniserve/_docs.gotmpl | 0 monitoring/README.md | 25 ++++++++++++ monitoring/_docs.gotmpl | 0 ntfy/README.md | 25 ++++++++++++ ntfy/_docs.gotmpl | 0 postgresql/README.md | 25 ++++++++++++ postgresql/_docs.gotmpl | 0 publish.sh | 2 +- 31 files changed, 447 insertions(+), 141 deletions(-) rename README.adoc => README.md (59%) create mode 100644 alertmanager-matrix/_docs.gotmpl create mode 100644 alertmanager-ntfy/_docs.gotmpl delete mode 100644 authentik-application/README.adoc create mode 100644 authentik-application/_docs.gotmpl create mode 100644 conduit/_docs.gotmpl create mode 100644 forgejo-runner/_docs.gotmpl create mode 100644 headscale-ui/_docs.gotmpl create mode 100644 headscale/_docs.gotmpl create mode 100644 hydrogen-web/_docs.gotmpl create mode 100644 jellyfin/_docs.gotmpl create mode 100644 miniserve/_docs.gotmpl create mode 100644 monitoring/_docs.gotmpl create mode 100644 ntfy/_docs.gotmpl create mode 100644 postgresql/_docs.gotmpl diff --git a/README.adoc b/README.md similarity index 59% rename from README.adoc rename to README.md index 8dc32bb..50992f3 100644 --- a/README.adoc +++ b/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/ ----- +```bash +helm pull oci://codeberg.org/wrenix/helm-charts/ +``` You can install a chart release using the following command: -[source,bash] ----- -helm install oci://codeberg.org/wrenix/helm-charts/ --values values.yaml ----- +```bash +helm install oci://codeberg.org/wrenix/helm-charts/ --values values.yaml +``` To uninstall a chart release use `helm`'s delete command: -[source,bash] ----- +```bash helm uninstall ----- +``` diff --git a/README.md.gotmpl b/README.md.gotmpl index 9174c35..102f585 100644 --- a/README.md.gotmpl +++ b/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) diff --git a/alertmanager-matrix/README.md b/alertmanager-matrix/README.md index ee37636..c90fc31 100644 --- a/alertmanager-matrix/README.md +++ b/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) diff --git a/alertmanager-matrix/_docs.gotmpl b/alertmanager-matrix/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/alertmanager-ntfy/README.md b/alertmanager-ntfy/README.md index b1bebcb..fb039b4 100644 --- a/alertmanager-ntfy/README.md +++ b/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) diff --git a/alertmanager-ntfy/_docs.gotmpl b/alertmanager-ntfy/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/authentik-application/Chart.yaml b/authentik-application/Chart.yaml index 7760812..67f1755 100644 --- a/authentik-application/Chart.yaml +++ b/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." diff --git a/authentik-application/README.adoc b/authentik-application/README.adoc deleted file mode 100644 index 885d803..0000000 --- a/authentik-application/README.adoc +++ /dev/null @@ -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 ----- diff --git a/authentik-application/README.md b/authentik-application/README.md index 3ae5dcc..7218441 100644 --- a/authentik-application/README.md +++ b/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) + diff --git a/authentik-application/_docs.gotmpl b/authentik-application/_docs.gotmpl new file mode 100644 index 0000000..9f16b41 --- /dev/null +++ b/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 }} diff --git a/conduit/README.md b/conduit/README.md index 2b3e6f6..abd01c2 100644 --- a/conduit/README.md +++ b/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) diff --git a/conduit/_docs.gotmpl b/conduit/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/forgejo-runner/README.md b/forgejo-runner/README.md index 1f93957..d32f5dd 100644 --- a/forgejo-runner/README.md +++ b/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) diff --git a/forgejo-runner/_docs.gotmpl b/forgejo-runner/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/headscale-ui/README.md b/headscale-ui/README.md index 8125175..51b5ac1 100644 --- a/headscale-ui/README.md +++ b/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) diff --git a/headscale-ui/_docs.gotmpl b/headscale-ui/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/headscale/README.md b/headscale/README.md index ef4554b..b769df3 100644 --- a/headscale/README.md +++ b/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) diff --git a/headscale/_docs.gotmpl b/headscale/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/hydrogen-web/README.md b/hydrogen-web/README.md index bca1f9a..94f201b 100644 --- a/hydrogen-web/README.md +++ b/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) diff --git a/hydrogen-web/_docs.gotmpl b/hydrogen-web/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/jellyfin/README.md b/jellyfin/README.md index 0b4de67..ce733fe 100644 --- a/jellyfin/README.md +++ b/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) diff --git a/jellyfin/_docs.gotmpl b/jellyfin/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/miniserve/README.md b/miniserve/README.md index 7f8d810..7e97c2a 100644 --- a/miniserve/README.md +++ b/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) diff --git a/miniserve/_docs.gotmpl b/miniserve/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/monitoring/README.md b/monitoring/README.md index fe0b754..83faa3b 100644 --- a/monitoring/README.md +++ b/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) diff --git a/monitoring/_docs.gotmpl b/monitoring/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/ntfy/README.md b/ntfy/README.md index 8d6a39b..da9caf2 100644 --- a/ntfy/README.md +++ b/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) diff --git a/ntfy/_docs.gotmpl b/ntfy/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/postgresql/README.md b/postgresql/README.md index 50762ba..63ae68e 100644 --- a/postgresql/README.md +++ b/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) diff --git a/postgresql/_docs.gotmpl b/postgresql/_docs.gotmpl new file mode 100644 index 0000000..e69de29 diff --git a/publish.sh b/publish.sh index 1a03740..abd6758 100755 --- a/publish.sh +++ b/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