chore(global): drop asciidoc support
This commit is contained in:
parent
8dc748c9d1
commit
f1c3954586
GPG key ID:
7AFDB012974B1BB5
31 changed files with 2 additions and 188 deletions
26
README.adoc
26
README.adoc
|
|
@ -1,26 +0,0 @@
|
||||||
= helm-charts
|
|
||||||
|
|
||||||
== 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.
|
|
||||||
Once Helm has been set up correctly, fetch the charts as follows:
|
|
||||||
|
|
||||||
[source,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.name> --values values.yaml
|
|
||||||
----
|
|
||||||
|
|
||||||
To uninstall a chart release use `helm`'s delete command:
|
|
||||||
|
|
||||||
[source,bash]
|
|
||||||
----
|
|
||||||
helm uninstall <release>
|
|
||||||
----
|
|
||||||
|
|
@ -1,87 +0,0 @@
|
||||||
{{ define "chart.header" }}= {{ .Name }}
|
|
||||||
{{ end }}
|
|
||||||
{{ define "chart.versionBadge" }}
|
|
||||||
image::https://img.shields.io/badge/Version-{{ .Version | replace "-" "--" }}-informational?style=flat-square[Version: {{ .Version }}]{{end}}
|
|
||||||
{{ define "chart.typeBadge" }}
|
|
||||||
image::https://img.shields.io/badge/Version-{{ .Type }}-informational?style=flat-square[Type: {{ .Type }}]{{end}}
|
|
||||||
{{ define "chart.appVersionBadge" }}{{- if (ne .AppVersion "") }}
|
|
||||||
image::https://img.shields.io/badge/AppVersion-{{ .AppVersion }}-informational?style=flat-square[AppVersion: {{ .AppVersion }}]{{ end }}{{end}}
|
|
||||||
{{ define "chart.maintainersHeader" }}== Maintainers{{ end }}
|
|
||||||
{{ define "chart.maintainersTable" }}.Maintainers
|
|
||||||
|===
|
|
||||||
| Name | Email | Url
|
|
||||||
{{- range .Maintainers }}
|
|
||||||
|
|
||||||
| {{ .Name }}
|
|
||||||
| {{ if .Email }}<{{ .Email }}>{{ end }}
|
|
||||||
| {{ if .Url }}<{{ .Url }}>{{ end }}
|
|
||||||
{{- end }}
|
|
||||||
|===
|
|
||||||
{{ end }}
|
|
||||||
{{ define "chart.valuesHeader" }}== Values{{ end }}
|
|
||||||
{{ define "chart.valuesTable" -}}
|
|
||||||
{{- if .Sections.Sections -}}
|
|
||||||
{{- range .Sections.Sections }}
|
|
||||||
.Values {{.SectionName }}
|
|
||||||
{{ template "chart.valuesOneTable" .SectionItems }}
|
|
||||||
{{- end }}{{/* range sections*/}}
|
|
||||||
{{- if .Sections.DefaultSection.SectionItems -}}
|
|
||||||
.Values {{.Sections.DefaultSection.SectionName }}
|
|
||||||
{{ template "chart.valuesOneTable" .Sections.DefaultSection.SectionItems }}
|
|
||||||
{{- end }}{{/* end default section */}}
|
|
||||||
{{- else }}{{/* if no sections */}}
|
|
||||||
.Values
|
|
||||||
{{ template "chart.valuesOneTable" .Values }}
|
|
||||||
{{- end }}
|
|
||||||
{{ end }}{{/* end chart.valuesTable */}}
|
|
||||||
{{ define "chart.valuesOneTable" -}}
|
|
||||||
|===
|
|
||||||
| Key | Type | Default | Description
|
|
||||||
{{- range . }}
|
|
||||||
|
|
||||||
| {{ .Key }}
|
|
||||||
| {{ .Type }}
|
|
||||||
| {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }}
|
|
||||||
| {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}
|
|
||||||
{{- end }}
|
|
||||||
|===
|
|
||||||
{{ end }}{{/* end chart.valuesOneTable */}}
|
|
||||||
|
|
||||||
{{- define "chart.prerequirements" -}}{{- end -}}
|
|
||||||
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
{{ template "chart.deprecationWarning" . }}
|
|
||||||
|
|
||||||
{{ template "chart.badgesSection" . }}
|
|
||||||
{{ 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 https://helm.sh/docs[documentation] 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/{{ template "chart.name" . }}
|
|
||||||
----
|
|
||||||
|
|
||||||
You can install a chart release using the following command:
|
|
||||||
|
|
||||||
[source,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:
|
|
||||||
|
|
||||||
[source,bash]
|
|
||||||
----
|
|
||||||
helm uninstall {{ template "chart.name" . }}-release
|
|
||||||
----
|
|
||||||
|
|
||||||
{{ template "chart.valuesSection" . }}
|
|
||||||
|
|
||||||
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]
|
|
||||||
|
|
@ -1,8 +0,0 @@
|
||||||
name: wrenix-helm
|
|
||||||
title: "WrenIX's Helm charts"
|
|
||||||
version:
|
|
||||||
main: latest
|
|
||||||
|
|
||||||
nav:
|
|
||||||
- modules/ROOT/nav.adoc
|
|
||||||
- modules/charts/nav.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
* xref:index.adoc[Home]
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../README.adoc
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
#!/bin/sh
|
|
||||||
ROOT_DIR="./docs/modules/charts/"
|
|
||||||
|
|
||||||
rm "${ROOT_DIR}/pages/"*".adoc"
|
|
||||||
|
|
||||||
echo "* charts" > "${ROOT_DIR}/nav.adoc"
|
|
||||||
for name in * ; do
|
|
||||||
if \
|
|
||||||
[ ! -d $name ] || \
|
|
||||||
[ ! -f $name/Chart.yaml ] \
|
|
||||||
; then
|
|
||||||
continue;
|
|
||||||
fi
|
|
||||||
ln -sf "../../../../${name}/README.adoc" "${ROOT_DIR}/pages/${name}.adoc";
|
|
||||||
echo "** xref:${name}.adoc[${name}]" >> "${ROOT_DIR}/nav.adoc"
|
|
||||||
done
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
* charts
|
|
||||||
** xref:alertmanager-matrix.adoc[alertmanager-matrix]
|
|
||||||
** xref:alertmanager-ntfy.adoc[alertmanager-ntfy]
|
|
||||||
** xref:authentik-application.adoc[authentik-application]
|
|
||||||
** xref:conduit.adoc[conduit]
|
|
||||||
** xref:element-call.adoc[element-call]
|
|
||||||
** xref:forgejo-runner.adoc[forgejo-runner]
|
|
||||||
** xref:gotosocial.adoc[gotosocial]
|
|
||||||
** xref:grampsweb.adoc[grampsweb]
|
|
||||||
** xref:headscale.adoc[headscale]
|
|
||||||
** xref:headscale-ui.adoc[headscale-ui]
|
|
||||||
** xref:home-assistant.adoc[home-assistant]
|
|
||||||
** xref:hydrogen-web.adoc[hydrogen-web]
|
|
||||||
** xref:jellyfin.adoc[jellyfin]
|
|
||||||
** xref:matrix-authentication-service.adoc[matrix-authentication-service]
|
|
||||||
** xref:matrix-sliding-sync.adoc[matrix-sliding-sync]
|
|
||||||
** xref:matrix-synapse.adoc[matrix-synapse]
|
|
||||||
** xref:mautrix-signal.adoc[mautrix-signal]
|
|
||||||
** xref:miniserve.adoc[miniserve]
|
|
||||||
** xref:monitoring.adoc[monitoring]
|
|
||||||
** xref:ntfy.adoc[ntfy]
|
|
||||||
** xref:postgresql.adoc[postgresql]
|
|
||||||
** xref:speedtest-exporter.adoc[speedtest-exporter]
|
|
||||||
** xref:stalwart-mail.adoc[stalwart-mail]
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../alertmanager-matrix/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../alertmanager-ntfy/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../authentik-application/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../conduit/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../element-call/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../forgejo-runner/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../gotosocial/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../grampsweb/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../headscale-ui/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../headscale/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../home-assistant/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../hydrogen-web/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../jellyfin/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../matrix-authentication-service/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../matrix-sliding-sync/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../matrix-synapse/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../mautrix-signal/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../miniserve/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../monitoring/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../ntfy/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../postgresql/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../speedtest-exporter/README.adoc
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
../../../../stalwart-mail/README.adoc
|
|
||||||
|
|
@ -53,7 +53,7 @@ for p in * ; do
|
||||||
set -e
|
set -e
|
||||||
echo "update docs"
|
echo "update docs"
|
||||||
helm-docs -t ./README.md.gotmpl -t _docs.gotmpl -o README.md -g "${p}"
|
helm-docs -t ./README.md.gotmpl -t _docs.gotmpl -o README.md -g "${p}"
|
||||||
helm-docs -t ./README.adoc.gotmpl -t _docs.gotmpl -o README.adoc -g "${p}"
|
rm "${p}/README.adoc"
|
||||||
|
|
||||||
echo "package and push helm-chart"
|
echo "package and push helm-chart"
|
||||||
helm package "${p}"
|
helm package "${p}"
|
||||||
|
|
@ -67,7 +67,7 @@ for p in * ; do
|
||||||
|
|
||||||
echo "push to git"
|
echo "push to git"
|
||||||
set -e
|
set -e
|
||||||
git add "${p}/" "docs/modules/charts/nav.adoc" "docs/modules/charts/pages/${p}.adoc"
|
git add "${p}/"
|
||||||
git commit -m "${COMMIT_SCOPE}(${p}): ${COMMIT_MESSAGE}"
|
git commit -m "${COMMIT_SCOPE}(${p}): ${COMMIT_MESSAGE}"
|
||||||
git tag "${tag}" --no-sign;
|
git tag "${tag}" --no-sign;
|
||||||
git push --tags origin main;
|
git push --tags origin main;
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue