chore(docs): generate

This commit is contained in:
WrenIX 2023-12-20 10:17:35 +01:00
parent 9d457ef630
commit b8e670f333
Signed by: wrenix
GPG key ID: 7AFDB012974B1BB5
22 changed files with 1250 additions and 0 deletions

65
base/README.adoc Normal file
View file

@ -0,0 +1,65 @@
= base
image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| commons.helm.release.install
| object
| `{}`
|
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.namespace.labels
| object
| `{}`
|
| componentCommons.helm.release.interval
| string
| `"10m"`
|
| componentCommons.helm.release.valuesFrom
| list
| `[]`
|
| components
| object
| `{}`
|
| global
| object
| `{}`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

View file

@ -4,3 +4,6 @@ version:
v(?<version>+({0..9}).+({0..9}).+({0..9})).*: $<version> v(?<version>+({0..9}).+({0..9}).+({0..9})).*: $<version>
main: latest main: latest
nav:
- modules/ROOT/nav.adoc
- modules/components/nav.adoc

View file

@ -0,0 +1 @@
* xref:index.adoc[Home]

View file

@ -0,0 +1,43 @@
{{ 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" }}.Values
|===
| Key | Type | Default | Description
{{- range .Values }}
| {{ .Key }}
| {{ .Type }}
| {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }}
| {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}
{{- end }}
|===
{{ end }}
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}
{{ template "chart.badgesSection" . }}
{{ template "chart.maintainersSection" . }}
{{ template "chart.valuesSection" . }}
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

View file

@ -0,0 +1,11 @@
#!/bin/sh
ROOT_DIR="../../.."
echo "* components" > nav.adoc
for c in $ROOT_DIR/{infra,mycloud}-* ; do
name=$(basename $c)
ln -sf "../${c}/README.adoc" "pages/${name}.adoc";
echo "** xref:${name}.adoc[${name}]" >> nav.adoc
done
helm-docs --chart-search-root "${ROOT_DIR}/" -t ./docs/modules/components/README.adoc.gotmpl -o README.adoc

View file

@ -0,0 +1,9 @@
* components
** xref:infra-certificates.adoc[infra-certificates]
** xref:infra-fluxcd.adoc[infra-fluxcd]
** xref:infra-ingress.adoc[infra-ingress]
** xref:infra-logging.adoc[infra-logging]
** xref:infra-monitoring.adoc[infra-monitoring]
** xref:infra-trivy.adoc[infra-trivy]
** xref:mycloud-authentik.adoc[mycloud-authentik]
** xref:mycloud-services.adoc[mycloud-services]

View file

@ -0,0 +1 @@
../../../../infra-certificates/README.adoc

View file

@ -0,0 +1 @@
../../../../infra-fluxcd/README.adoc

View file

@ -0,0 +1 @@
../../../../infra-ingress/README.adoc

View file

@ -0,0 +1 @@
../../../../infra-logging/README.adoc

View file

@ -0,0 +1 @@
../../../../infra-monitoring/README.adoc

View file

@ -0,0 +1 @@
../../../../infra-trivy/README.adoc

View file

@ -0,0 +1 @@
../../../../mycloud-authentik/README.adoc

View file

@ -0,0 +1 @@
../../../../mycloud-services/README.adoc

View file

@ -0,0 +1,60 @@
= infra-certificates
image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| commons.helm.release.install
| object
| `{}`
|
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.prometheus.monitor.labels
| object
| `{}`
|
| email
| string
| `"an@example.org"`
|
| init.namespace
| string
| `"bases"`
|
| init.version
| int
| `0`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

55
infra-fluxcd/README.adoc Normal file
View file

@ -0,0 +1,55 @@
= infra-fluxcd
image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| commons.grafana.dashboards.labels.grafana_dashboard
| string
| `"1"`
|
| commons.prometheus.monitor.labels
| object
| `{}`
|
| commons.prometheus.rules.labels
| object
| `{}`
|
| grafana.dashboards.annotations
| object
| `{}`
|
| init.namespace
| string
| `"bases"`
|
| init.version
| int
| `0`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

75
infra-ingress/README.adoc Normal file
View file

@ -0,0 +1,75 @@
= infra-ingress
image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| commons.helm.release.install
| object
| `{}`
|
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.ingress.domain
| string
| `"wrenix.eu"`
|
| commons.prometheus.monitor.labels
| object
| `{}`
|
| controller
| string
| `"traefik"`
|
| external
| bool
| `true`
|
| init.namespace
| string
| `"bases"`
|
| init.version
| int
| `0`
|
| traefik.hostPath
| string
| `"/srv/k8s/pv/pvc-traefik-certs"`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

85
infra-logging/README.adoc Normal file
View file

@ -0,0 +1,85 @@
= infra-logging
image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| commons.grafana.dashboards.labels.grafana_dashboard
| string
| `"1"`
|
| commons.grafana.datasource.labels.grafana_datasource
| string
| `"1"`
|
| commons.helm.release.install
| object
| `{}`
|
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.prometheus.monitor.labels
| object
| `{}`
|
| commons.prometheus.rules.labels
| object
| `{}`
|
| fluentd.replicas
| int
| `1`
|
| grafana.dashboards.annotations
| object
| `{}`
|
| init.namespace
| string
| `"bases"`
|
| init.version
| int
| `0`
|
| loki.enabled
| bool
| `true`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

View file

@ -0,0 +1,380 @@
= infra-monitoring
image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| alertmanager.auth.anonymous.enabled
| bool
| `false`
|
| alertmanager.ingress.annotations
| object
| `{}`
| annotations on ingress object (beside of .Values.commons.ingress.annotations )
| alertmanager.ingress.enabled
| bool
| `true`
|
| alertmanager.ingress.host
| string
| `""`
|
| alertmanager.receiver.matrix.default
| string
| `"!example-room:matrix.org"`
|
| alertmanager.receiver.matrix.enabled
| bool
| `false`
|
| alertmanager.receiver.matrix.homeserver
| string
| `"https://matrix.org"`
|
| alertmanager.receiver.matrix.rooms
| object
| `{}`
|
| alertmanager.receiver.matrix.sendResolved
| bool
| `false`
|
| alertmanager.receiver.matrix.userID
| string
| `"@alert:matrix.org"`
|
| alertmanager.receiver.ntfy.config.labels.entries[0].label
| string
| `"severity"`
|
| alertmanager.receiver.ntfy.config.labels.entries[0].priority
| int
| `4`
|
| alertmanager.receiver.ntfy.config.labels.entries[0].tags[0]
| string
| `"rotating_light"`
|
| alertmanager.receiver.ntfy.config.labels.entries[0].value
| string
| `"critical"`
|
| alertmanager.receiver.ntfy.config.labels.entries[1].label
| string
| `"severity"`
|
| alertmanager.receiver.ntfy.config.labels.entries[1].priority
| int
| `3`
|
| alertmanager.receiver.ntfy.config.labels.entries[1].tags[0]
| string
| `"warning"`
|
| alertmanager.receiver.ntfy.config.labels.entries[1].value
| string
| `"warning"`
|
| alertmanager.receiver.ntfy.config.labels.entries[2].label
| string
| `"severity"`
|
| alertmanager.receiver.ntfy.config.labels.entries[2].priority
| int
| `1`
|
| alertmanager.receiver.ntfy.config.labels.entries[2].tags[0]
| string
| `"information_source"`
|
| alertmanager.receiver.ntfy.config.labels.entries[2].value
| string
| `"info"`
|
| alertmanager.receiver.ntfy.config.labels.order[0]
| string
| `"severity"`
|
| alertmanager.receiver.ntfy.config.ntfy.topic
| string
| `"https://ntfy.wrenix.eu/alertmanager-example"`
|
| alertmanager.receiver.ntfy.config.password
| string
| `nil`
| password used between alertmanager and ntfy reciever generated from commons.masterPassword
| alertmanager.receiver.ntfy.config.user
| string
| `"alertmanager-to-ntfy"`
| user used between alertmanager and ntfy receiver
| alertmanager.receiver.ntfy.enabled
| bool
| `true`
|
| alertmanager.receiver.ntfy.ingress.annotations
| object
| `{}`
| annotations on ingress object (beside of .Values.commons.ingress.annotations )
| alertmanager.receiver.ntfy.ingress.enabled
| bool
| `false`
|
| alertmanager.receiver.ntfy.ingress.host
| string
| `nil`
|
| alertmanager.receiver.ntfy.sendResolved
| bool
| `false`
|
| alertmanager.receiver.repeatInterval
| string
| `"24h"`
| repeat Interval
| alertmanager.receiver.routes
| string
| `nil`
| would overwrite defaults (like ntfy or matrix)
| commons.auth.authentik.domain
| string
| `""`
|
| commons.auth.enabled
| bool
| `false`
|
| commons.auth.namespace
| string
| `""`
|
| commons.auth.type
| string
| `"authentik"`
|
| commons.helm.release.install
| object
| `{}`
|
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.ingress.annotations."cert-manager.io/cluster-issuer"
| string
| `"letsencrypt-prod"`
|
| commons.ingress.domain
| string
| `"wrenix.eu"`
|
| commons.ingress.tls.enabled
| bool
| `false`
| tls on every ingress
| commons.ingress.tls.override
| string
| `nil`
| use own definition of tls (e.g. for own or wildcard certificate)
| commons.masterPassword
| string
| `"CHANGEME"`
|
| commons.prometheus.monitor.labels
| object
| `{}`
|
| grafana.adminPassword
| string
| `nil`
| generated from commons.masterPassword
| grafana.auth.anonymous.enabled
| bool
| `true`
|
| grafana.auth.authentik.clientID
| string
| `nil`
| generated from commons.masterPassword
| grafana.auth.authentik.clientSecret
| string
| `nil`
| generated from commons.masterPassword
| grafana.dashboards.annotations."grafana.mon.local/dashboard-folder"
| string
| `"Kubernetes"`
|
| grafana.dashboards.folderAnnotation
| string
| `"grafana.mon.local/dashboard-folder"`
|
| grafana.ingress.annotations
| object
| `{}`
| annotations on ingress object (beside of .Values.commons.ingress.annotations )
| grafana.ingress.enabled
| bool
| `true`
|
| grafana.ingress.host
| string
| `""`
|
| init.namespace
| string
| `"bases"`
|
| init.version
| int
| `0`
|
| karma.additionalAlertmanager
| string
| `nil`
|
| karma.auth.anonymous.enabled
| bool
| `false`
|
| karma.enabled
| bool
| `true`
|
| karma.ingress.annotations
| object
| `{}`
| annotations on ingress object (beside of .Values.commons.ingress.annotations )
| karma.ingress.enabled
| bool
| `true`
|
| karma.ingress.host
| string
| `""`
|
| prometheus.auth.anonymous.enabled
| bool
| `false`
|
| prometheus.exporter.blackbox.enabled
| bool
| `true`
|
| prometheus.exporter.blackbox.ingress.annotations
| object
| `{}`
| annotations on ingress object (beside of .Values.commons.ingress.annotations )
| prometheus.exporter.blackbox.ingress.enabled
| bool
| `false`
| enable ingress for blackbox-exporter
| prometheus.exporter.blackbox.ingress.host
| string
| `""`
| default use .Values.commons.ingress.host with prefix: `blackbox.exporter`
| prometheus.ingress.annotations
| object
| `{}`
| annotations on ingress object (beside of .Values.commons.ingress.annotations )
| prometheus.ingress.enabled
| bool
| `true`
|
| prometheus.ingress.host
| string
| `""`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

185
infra-trivy/README.adoc Normal file
View file

@ -0,0 +1,185 @@
= infra-trivy
image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| commons.grafana.dashboards.labels.grafana_dashboard
| string
| `"1"`
|
| commons.helm.release.install
| object
| `{}`
|
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.prometheus.alertmanager.labels
| object
| `{}`
|
| commons.prometheus.monitor.labels
| object
| `{}`
|
| commons.prometheus.rules.labels
| object
| `{}`
|
| grafana.dashboards.annotations
| object
| `{}`
|
| init.namespace
| string
| `"bases"`
|
| init.version
| int
| `0`
|
| prometheus.rules.clusterCompliance.enabled
| bool
| `false`
|
| prometheus.rules.clusterRBACAssessments.enabled
| bool
| `false`
|
| prometheus.rules.clusterRBACAssessments.info.enabled
| bool
| `false`
|
| prometheus.rules.clusterRBACAssessments.warning.enabled
| bool
| `false`
|
| prometheus.rules.enabled
| bool
| `true`
|
| prometheus.rules.imageExposedSecrets.enabled
| bool
| `true`
|
| prometheus.rules.imageExposedSecrets.info.enabled
| bool
| `false`
|
| prometheus.rules.imageExposedSecrets.warning.enabled
| bool
| `false`
|
| prometheus.rules.imageVulnerabilities.enabled
| bool
| `false`
|
| prometheus.rules.imageVulnerabilities.info.enabled
| bool
| `false`
|
| prometheus.rules.imageVulnerabilities.warning.enabled
| bool
| `false`
|
| prometheus.rules.infraAssessments.enabled
| bool
| `true`
|
| prometheus.rules.infraAssessments.info.enabled
| bool
| `true`
|
| prometheus.rules.infraAssessments.warning.enabled
| bool
| `true`
|
| prometheus.rules.resourceConfigAudits.enabled
| bool
| `true`
|
| prometheus.rules.resourceConfigAudits.info.enabled
| bool
| `false`
|
| prometheus.rules.resourceConfigAudits.warning.enabled
| bool
| `false`
|
| prometheus.rules.roleRBACAssessments.enabled
| bool
| `false`
|
| prometheus.rules.roleRBACAssessments.info.enabled
| bool
| `false`
|
| prometheus.rules.roleRBACAssessments.warning.enabled
| bool
| `false`
|
| scans.concurrent
| int
| `2`
|
| scans.ttl
| string
| `"168h"`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

View file

@ -0,0 +1,175 @@
= mycloud-authentik
image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| commons.helm.release.install
| object
| `{}`
|
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.ingress.annotations."cert-manager.io/cluster-issuer"
| string
| `"letsencrypt-prod"`
|
| commons.ingress.domain
| string
| `"wrenix.eu"`
|
| commons.ingress.tls.enabled
| bool
| `true`
| tls on every ingress
| commons.ingress.tls.override
| string
| `nil`
| use own definition of tls (e.g. for own or wildcard certificate)
| commons.mail.from
| string
| `nil`
|
| commons.mail.host
| string
| `nil`
|
| commons.mail.password
| string
| `nil`
|
| commons.mail.use_ssl
| bool
| `false`
|
| commons.mail.use_tls
| bool
| `false`
|
| commons.mail.username
| string
| `nil`
|
| commons.masterPassword
| string
| `"CHANGEME"`
|
| commons.prometheus.monitor.labels
| object
| `{}`
|
| commons.prometheus.rules.labels
| object
| `{}`
|
| commons.theme.favicon
| string
| `"/static/dist/assets/icons/icon.png"`
|
| commons.theme.logo
| string
| `"/static/dist/assets/icons/icon_left_brand.svg"`
|
| commons.theme.title
| string
| `"myCloud"`
|
| database.host
| string
| `"mycloud-services-postgresql"`
| default is from mysql-services
| database.name
| string
| `"authentik"`
|
| database.password
| string
| `nil`
| generated by .Values.commons.masterPassword (equal to mycloud-services)
| database.username
| string
| `"authentik"`
|
| ingress.annotations
| string
| `nil`
|
| ingress.host
| string
| `nil`
| default: auth.(Values.commons.ingress.domain)
| init.namespace
| string
| `"bases"`
|
| init.version
| int
| `0`
|
| mail.from
| string
| `nil`
| generade by Values.commons.mail.from
| secret_key
| string
| `nil`
| generated by .Values.commons.masterPassword
| theme.background
| string
| `nil`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

View file

@ -0,0 +1,95 @@
= mycloud-services
image::https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square[Version: 0.1.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| commons.helm.release.install
| object
| `{}`
|
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.masterPassword
| string
| `"CHANGEME"`
|
| commons.persistence.hostPath.enabled
| bool
| `false`
|
| commons.persistence.hostPath.prefix
| string
| `"/var/lib/mycloud"`
|
| commons.persistence.storageClass
| string
| `nil`
|
| databases
| object
| `{"example":{"password":null,"type":"none","username":"example-password"}}`
| create databases
| databases.example.password
| string
| `nil`
| if not set generated by .Values.commons.masterPassword and databasename
| databases.example.type
| string
| `"none"`
| database type (current only "postgresql" is supported)
| databases.example.username
| string
| `"example-password"`
| username default like database
| postgresql.password
| string
| `nil`
| root
| postgresql.persistence.size
| string
| `"10G"`
|
| postgresql.persistence.storageClass
| string
| `nil`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]