wrenix/helm-charts
1
0
Fork 0
Code Issues 8 Pull requests 8 Projects Packages Activity

chore(docs): support sections

Browse source
This commit is contained in:
WrenIX 2024-04-03 15:48:03 +02:00
parent 167acdfd97
commit e4eed9122d
Signed by: wrenix
GPG key ID: 7AFDB012974B1BB5
7 changed files with 18 additions and 1322 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.adoc.gotmpl
View file

@ -19,10 +19,25 @@ image::https://img.shields.io/badge/AppVersion-{{ .AppVersion }}-informational?s
|===
{{ end }}
{{ define "chart.valuesHeader" }}== Values{{ end }}
{{ define "chart.valuesTable" }}.Values
{{ 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 .Values }}
{{- range . }}
| {{ .Key }}
| {{ .Type }}
@ -30,7 +45,7 @@ image::https://img.shields.io/badge/AppVersion-{{ .AppVersion }}-informational?s
| {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}
{{- end }}
|===
{{ end }}
{{ end }}{{/* end chart.valuesOneTable */}}
{{- define "chart.prerequirements" -}}{{- end -}}

378
home-assistant/README.adoc
View file

@ -399,381 +399,3 @@ helm uninstall home-assistant-release
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]
= home-assistant
image::https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square[Version: 0.1.3]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
image::https://img.shields.io/badge/AppVersion-2024.3.3-informational?style=flat-square[AppVersion: 2024.3.3]
Home Assistant with tooling to run on an k3s pi
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.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.12-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: <storageClass> 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
| `{}`
|
| 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.36.1"`
|
| zigbee2mqtt.ingress.hosts
| list
| `[]`
|
| zigbee2mqtt.securityContext.privileged
| bool
| `true`
|
|===
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.2](https://github.com/norwoodj/helm-docs/releases/v1.11.2)

0
home-assistant/_docs.gotmpl Normal file
View file

638
matrix-authentication-service/README.adoc
View file

@ -659,641 +659,3 @@ helm uninstall matrix-authentication-service-release
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]
= matrix-authentication-service
image::https://img.shields.io/badge/Version-0.0.3-informational?style=flat-square[Version: 0.0.3]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
image::https://img.shields.io/badge/AppVersion-0.9.0-informational?style=flat-square[AppVersion: 0.9.0]
OAuth2.0 + OpenID Provider for Matrix Homeservers (per MSC3861)
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| affinity
| object
| `{}`
|
| autoscaling.enabled
| bool
| `false`
|
| autoscaling.maxReplicas
| int
| `100`
|
| autoscaling.minReplicas
| int
| `1`
|
| autoscaling.targetCPUUtilizationPercentage
| int
| `80`
|
| config.branding.imprint
| string
| `nil`
|
| config.branding.logo_uri
| string
| `nil`
|
| config.branding.policy_uri
| string
| `nil`
|
| config.branding.service_name
| string
| `nil`
|
| config.branding.tos_uri
| string
| `nil`
|
| config.clients
| list
| `[]`
|
| config.database.connect_timeout
| int
| `30`
|
| config.database.database
| string
| `"sliding_sync"`
|
| config.database.host
| string
| `"localhost"`
|
| config.database.idle_timeout
| int
| `600`
|
| config.database.max_connections
| int
| `10`
|
| config.database.max_lifetime
| int
| `1800`
|
| config.database.min_connections
| int
| `0`
|
| config.database.password
| string
| `"secret"`
|
| config.database.port
| int
| `5432`
|
| config.database.username
| string
| `"sliding_sync"`
|
| config.email.from
| string
| `"\"Authentication Service\" <root@localhost>"`
|
| config.email.reply_to
| string
| `"\"Authentication Service\" <root@localhost>"`
|
| config.email.transport
| string
| `"blackhole"`
|
| config.experimental.access_token_ttl
| int
| `300`
|
| config.experimental.compat_token_ttl
| int
| `300`
|
| config.http.issuer
| string
| `"http://[::]:8080/"`
|
| config.http.listeners[0].binds[0].address
| string
| `"[::]:8080"`
|
| config.http.listeners[0].name
| string
| `"http"`
|
| config.http.listeners[0].proxy_protocol
| bool
| `false`
|
| config.http.listeners[0].resources[0].name
| string
| `"discovery"`
|
| config.http.listeners[0].resources[1].name
| string
| `"human"`
|
| config.http.listeners[0].resources[2].name
| string
| `"oauth"`
|
| config.http.listeners[0].resources[3].name
| string
| `"compat"`
|
| config.http.listeners[0].resources[4].name
| string
| `"graphql"`
|
| config.http.listeners[0].resources[4].playground
| bool
| `true`
|
| config.http.listeners[0].resources[5].name
| string
| `"assets"`
|
| config.http.listeners[0].resources[5].path
| string
| `"/usr/local/share/mas-cli/assets/"`
|
| config.http.listeners[1].binds[0].address
| string
| `"[::]:8081"`
|
| config.http.listeners[1].name
| string
| `"internal"`
|
| config.http.listeners[1].resources[0].name
| string
| `"health"`
|
| config.http.listeners[2].binds[0].address
| string
| `"[::]:9100"`
|
| config.http.listeners[2].name
| string
| `"metrics"`
|
| config.http.listeners[2].resources[0].name
| string
| `"prometheus"`
|
| config.http.public_base
| string
| `"http://[::]:8080/"`
|
| config.http.trusted_proxies[0]
| string
| `"192.128.0.0/16"`
|
| config.http.trusted_proxies[1]
| string
| `"172.16.0.0/12"`
|
| config.http.trusted_proxies[2]
| string
| `"10.0.0.0/10"`
|
| config.http.trusted_proxies[3]
| string
| `"127.0.0.1/8"`
|
| config.http.trusted_proxies[4]
| string
| `"fd00::/8"`
|
| config.http.trusted_proxies[5]
| string
| `"::1/128"`
|
| config.matrix.endpoint
| string
| `"http://localhost:8008/"`
|
| config.matrix.homeserver
| string
| `"localhost:8008"`
|
| config.matrix.secret
| string
| `"kPnqGbK9hmSRK41DZTgVJxfKVAiLrY6G"`
|
| config.passwords.enabled
| bool
| `true`
|
| config.passwords.schemes[0].algorithm
| string
| `"argon2id"`
|
| config.passwords.schemes[0].version
| int
| `1`
|
| config.policy.authorization_grant_entrypoint
| string
| `"authorization_grant/violation"`
|
| config.policy.client_registration_entrypoint
| string
| `"client_registration/violation"`
|
| config.policy.data
| string
| `nil`
|
| config.policy.email_entrypoint
| string
| `"email/violation"`
|
| config.policy.password_entrypoint
| string
| `"password/violation"`
|
| config.policy.register_entrypoint
| string
| `"register/violation"`
|
| config.policy.wasm_module
| string
| `"/usr/local/share/mas-cli/policy.wasm"`
|
| config.secrets.encryption
| string
| `nil`
|
| config.secrets.keys
| list
| `[]`
|
| config.telemetry.metrics.exporter
| string
| `"prometheus"`
|
| config.telemetry.sentry.dsn
| string
| `nil`
|
| config.telemetry.tracing.exporter
| string
| `"none"`
|
| config.telemetry.tracing.propagators
| list
| `[]`
|
| config.templates.assets_manifest
| string
| `"/usr/local/share/mas-cli/manifest.json"`
|
| config.templates.path
| string
| `"/usr/local/share/mas-cli/templates/"`
|
| config.templates.translations_path
| string
| `"/usr/local/share/mas-cli/translations/"`
|
| config.upstream_oauth2.providers
| list
| `[]`
|
| 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
| `"matrix-org/matrix-authentication-service"`
|
| image.tag
| string
| `nil`
| Overrides the image tag whose default is the chart appVersion.
| imagePullSecrets
| list
| `[]`
|
| ingress.annotations
| object
| `{}`
|
| ingress.className
| string
| `""`
|
| ingress.enabled
| bool
| `false`
|
| ingress.hosts[0].host
| string
| `"auth.matrix.chart-example.local"`
|
| ingress.hosts[0].paths[0].path
| string
| `"/l"`
|
| ingress.hosts[0].paths[0].pathType
| string
| `"Prefix"`
|
| ingress.hosts[1].host
| string
| `"matrix.chart-example.local"`
|
| ingress.hosts[1].paths[0].path
| string
| `"/_matrix/client/v3/login"`
|
| ingress.hosts[1].paths[0].pathType
| string
| `"Exact"`
|
| ingress.hosts[1].paths[1].path
| string
| `"/_matrix/client/v3/logout"`
|
| ingress.hosts[1].paths[1].pathType
| string
| `"Exact"`
|
| ingress.hosts[1].paths[2].path
| string
| `"/_matrix/client/v3/refresh"`
|
| ingress.hosts[1].paths[2].pathType
| string
| `"Exact"`
|
| ingress.tls
| list
| `[]`
|
| livenessProbe.httpGet.path
| string
| `"/health"`
|
| livenessProbe.httpGet.port
| string
| `"internal"`
|
| nameOverride
| string
| `""`
|
| nodeSelector
| object
| `{}`
|
| podAnnotations
| object
| `{}`
|
| podLabels
| object
| `{}`
|
| podSecurityContext.fsGroup
| int
| `1000`
|
| prometheus.servicemonitor.enabled
| bool
| `false`
|
| prometheus.servicemonitor.labels
| object
| `{}`
|
| readinessProbe.httpGet.path
| string
| `"/health"`
|
| readinessProbe.httpGet.port
| string
| `"internal"`
|
| replicaCount
| int
| `1`
|
| resources
| object
| `{}`
|
| securityContext.capabilities.drop[0]
| string
| `"ALL"`
|
| securityContext.readOnlyRootFilesystem
| bool
| `true`
|
| securityContext.runAsNonRoot
| bool
| `true`
|
| securityContext.runAsUser
| int
| `1000`
|
| service.port
| int
| `80`
|
| service.type
| string
| `"ClusterIP"`
|
| serviceAccount.annotations
| object
| `{}`
|
| serviceAccount.automount
| bool
| `true`
|
| serviceAccount.create
| bool
| `true`
|
| serviceAccount.name
| string
| `""`
|
| tolerations
| list
| `[]`
|
| volumeMounts
| list
| `[]`
|
| volumes
| list
| `[]`
|
|===
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.2](https://github.com/norwoodj/helm-docs/releases/v1.11.2)

0
matrix-authentication-service/_docs.gotmpl Normal file
View file

303
matrix-sliding-sync/README.adoc
View file

@ -324,306 +324,3 @@ helm uninstall matrix-sliding-sync-release
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]
= matrix-sliding-sync
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]
image::https://img.shields.io/badge/AppVersion-0.99.15-informational?style=flat-square[AppVersion: 0.99.15]
Proxy implementation of MSC3575's sync protocol.
== Maintainers
.Maintainers
|===
| Name | Email | Url
| WrenIX
|
| <https://wrenix.eu>
|===
== Values
.Values
|===
| Key | Type | Default | Description
| affinity
| object
| `{}`
|
| autoscaling.enabled
| bool
| `false`
|
| autoscaling.maxReplicas
| int
| `100`
|
| autoscaling.minReplicas
| int
| `1`
|
| autoscaling.targetCPUUtilizationPercentage
| int
| `80`
|
| config.homeserver
| string
| `"http://localhost:8008"`
|
| config.logLevel
| string
| `"INFO"`
|
| config.metrics
| int
| `9100`
|
| config.postgresql.database
| string
| `"sliding_sync"`
|
| config.postgresql.host
| string
| `"localhost"`
|
| config.postgresql.maxConn
| int
| `0`
|
| config.postgresql.password
| string
| `"secret"`
|
| config.postgresql.port
| int
| `5432`
|
| config.postgresql.sslmode
| string
| `"disable"`
|
| config.postgresql.username
| string
| `"sliding_sync"`
|
| config.syncSecret
| string
| `nil`
|
| 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
| `"matrix-org/sliding-sync"`
|
| image.tag
| string
| `nil`
| Overrides the image tag whose default is the chart appVersion.
| 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.tcpSocket.port
| string
| `"http"`
|
| nameOverride
| string
| `""`
|
| nodeSelector
| object
| `{}`
|
| podAnnotations
| object
| `{}`
|
| podLabels
| object
| `{}`
|
| podSecurityContext.fsGroup
| int
| `2000`
|
| prometheus.servicemonitor.enabled
| bool
| `false`
|
| prometheus.servicemonitor.labels
| object
| `{}`
|
| readinessProbe.tcpSocket.port
| string
| `"http"`
|
| replicaCount
| int
| `1`
|
| resources
| object
| `{}`
|
| securityContext.capabilities.drop[0]
| string
| `"ALL"`
|
| securityContext.readOnlyRootFilesystem
| bool
| `true`
|
| securityContext.runAsNonRoot
| bool
| `true`
|
| securityContext.runAsUser
| int
| `1000`
|
| service.port
| int
| `8008`
|
| service.type
| string
| `"ClusterIP"`
|
| serviceAccount.annotations
| object
| `{}`
|
| serviceAccount.automount
| bool
| `true`
|
| serviceAccount.create
| bool
| `true`
|
| serviceAccount.name
| string
| `""`
|
| tolerations
| list
| `[]`
|
| volumeMounts
| list
| `[]`
|
| volumes
| list
| `[]`
|
|===
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.2](https://github.com/norwoodj/helm-docs/releases/v1.11.2)

0
matrix-sliding-sync/_docs.gotmpl Normal file
View file