chore(docs): support sections

This commit is contained in:
WrenIX 2024-04-03 14:49:18 +02:00
parent 8906c4e57f
commit 5797fb1824
Signed by: wrenix
GPG key ID: 7AFDB012974B1BB5
27 changed files with 1343 additions and 556 deletions

View file

@ -2,7 +2,7 @@
= base = 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-0.2.0-informational?style=flat-square[Version: 0.2.0]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application] image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
== Maintainers == Maintainers
@ -17,45 +17,95 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Base
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
| commons.helm.release.driftDetection | base.helm.release.driftDetection
| object | object
| `{}` | `{}`
| | driftDetection of FluxCD HelmRelease
| commons.helm.release.install | base.helm.release.install
| object | object
| `{}` | `{}`
| | install of FluxCD HelmRelease
| commons.helm.release.test | base.helm.release.interval
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.namespace.labels
| object
| `{}`
| labels for every new created namespace (together or overwritten by components.<component-release-name.namespace.labels)
| componentCommons.helm.release.interval
| string | string
| `"10m"` | `"10m"`
| | interval of FluxCD HelmRelease
| componentCommons.helm.release.valuesFrom | base.helm.release.test
| object
| `{}`
| test of FluxCD HelmRelease
| base.helm.release.upgrade
| object
| `{}`
| upgrade of FluxCD HelmRelease
| base.helm.release.valuesFrom
| list | list
| `[]` | `[]`
| valuesFrom for every components (for use values from ConfigMap or Secret) | valuesFrom for every components (for use values from ConfigMap or Secret)
| base.helm.repo.interval
| string
| `"10m"`
| interval of FluxCD Repository
| base.helm.repo.namespace
| string
| `nil`
| namespace, where the GitRepo resource is installed (maybe needed together with secretRef)
| base.helm.repo.ref
| object
| `{"branch":"main"}`
| default ref (if no branch is set - maybe overwritten by semver or so)
| base.helm.repo.secretRef
| string
| `nil`
| secret to get access to the git-repo
| base.helm.repo.url
| string
| `"https://codeberg.org/wrenix/flux-charts.git"`
| git repo where all components are stored
| base.helm.repo.verify
| string
| `nil`
| secret to get access to the git-repo
| base.namespace.labels
| object
| `{}`
| labels for every new created namespace (together or overwritten by components.<component-release-name.namespace.labels)
|===
.Values Shared Values - between all components
|===
| Key | Type | Default | Description
| commons
| object
| `{}`
| commons are values which are additional
| global
| object
| `{}`
| global are values which overwrite values global
|===
.Values A Component
|===
| Key | Type | Default | Description
| components.<component-release-name>.enabled | components.<component-release-name>.enabled
| bool | bool
| `false` | `false`
@ -90,11 +140,6 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| list | list
| `[]` | `[]`
| valuesFrom just for this component (for use values from ConfigMap or Secret) | valuesFrom just for this component (for use values from ConfigMap or Secret)
| global
| object
| `{}`
|
|=== |===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs] Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]

View file

@ -5,36 +5,59 @@
base: base:
namespace: namespace:
# -- labels for every new created namespace (together or overwritten by components.<component-release-name.namespace.labels) # -- labels for every new created namespace (together or overwritten by components.<component-release-name.namespace.labels)
# @section -- Base
labels: {} labels: {}
helm: helm:
repo: repo:
# -- git repo where all components are stored # -- git repo where all components are stored
# @section -- Base
url: https://codeberg.org/wrenix/flux-charts.git url: https://codeberg.org/wrenix/flux-charts.git
# -- namespace, where the GitRepo resource is installed (maybe needed together with secretRef) # -- namespace, where the GitRepo resource is installed (maybe needed together with secretRef)
# @section -- Base
namespace: namespace:
# -- default ref (if no branch is set - maybe overwritten by semver or so) # -- default ref (if no branch is set - maybe overwritten by semver or so)
# @section -- Base
ref: ref:
branch: main branch: main
# -- secret to get access to the git-repo # -- secret to get access to the git-repo
# @section -- Base
secretRef: secretRef:
# -- secret to get access to the git-repo # -- secret to get access to the git-repo
# @section -- Base
verify: verify:
# -- interval of FluxCD Repository
# @section -- Base
interval: 10m interval: 10m
release: release:
# -- interval of FluxCD HelmRelease
# @section -- Base
interval: 10m interval: 10m
# -- install of FluxCD HelmRelease
# @section -- Base
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Base
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Base
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Base
driftDetection: {} driftDetection: {}
# -- valuesFrom for every components (for use values from ConfigMap or Secret) # -- valuesFrom for every components (for use values from ConfigMap or Secret)
# @section -- Base
valuesFrom: [] valuesFrom: []
## ##
# Shared Values # Shared Values
# between all components # between all components
## ##
# -- global are values which overwrite values global
# @section -- Shared Values - between all components
global: {} global: {}
# -- commons are values which are additional
# @section -- Shared Values - between all components
commons: {} commons: {}
@ -44,17 +67,24 @@ commons: {}
components: components:
<component-release-name>: <component-release-name>:
# -- enable component-release to install # -- enable component-release to install
# @section -- A Component
enabled: false enabled: false
# -- optional component-name (if not set component-release-name is used as component-name) # -- optional component-name (if not set component-release-name is used as component-name)
# @section -- A Component
name: name:
namespace: namespace:
# -- if not set, it reuse namespace where this base-chart is deployed # -- if not set, it reuse namespace where this base-chart is deployed
# @section -- A Component
name: name:
# -- if create a new namespace use labels (and the common namespace.labels) # -- if create a new namespace use labels (and the common namespace.labels)
# @section -- A Component
labels: {} labels: {}
# -- use the named namespace but does not create it # -- use the named namespace but does not create it
# @section -- A Component
skip_create: false skip_create: false
# -- valuesFrom just for this component (for use values from ConfigMap or Secret) # -- valuesFrom just for this component (for use values from ConfigMap or Secret)
# @section -- A Component
valuesFrom: [] valuesFrom: []
# -- set values on component-release # -- set values on component-release
# @section -- A Component
values: {} values: {}

View file

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

View file

@ -17,34 +17,58 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons Monitoring
|===
| Key | Type | Default | Description
| commons.grafana.dashboards.labels
| object
| `{"grafana_dashboard":"1"}`
| labels of grafana dashboard configmap
| commons.grafana.datasource.labels
| object
| `{"grafana_datasource":"1"}`
| labels of grafana datasource configmap and secret
| commons.prometheus.monitor.labels
| object
| `{}`
| labels on Pod- and Service-Monitor
|===
.Values Commons helm release
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
| commons.helm.release.driftDetection | commons.helm.release.driftDetection
| object | object
| `{}` | `{}`
| | driftDetection of FluxCD HelmRelease
| commons.helm.release.install | commons.helm.release.install
| object | object
| `{}` | `{}`
| | install of FluxCD HelmRelease
| commons.helm.release.test | commons.helm.release.test
| object | object
| `{}` | `{}`
| | test of FluxCD HelmRelease
| commons.helm.release.upgrade | commons.helm.release.upgrade
| object | object
| `{}` | `{}`
| | upgrade of FluxCD HelmRelease
|===
.Values Other Values
|===
| Key | Type | Default | Description
| commons.prometheus.monitor.labels | commons.prometheus.rules.labels
| object | object
| `{}` | `{}`
| | labels on PrometheusRules
| email | email
| string | string

View file

@ -5,22 +5,37 @@ init:
commons: commons:
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
rules: rules:
# -- labels on PrometheusRules
labels: {} labels: {}
grafana: grafana:
datasource: datasource:
# -- labels of grafana datasource configmap and secret
# @section -- Commons Monitoring
labels: labels:
grafana_datasource: "1" grafana_datasource: "1"
dashboards: dashboards:
# -- labels of grafana dashboard configmap
# @section -- Commons Monitoring
labels: labels:
grafana_dashboard: "1" grafana_dashboard: "1"

View file

@ -17,29 +17,33 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons Monitoring
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
| commons.grafana.dashboards.labels.grafana_dashboard | commons.grafana.dashboards.labels
| string | object
| `"1"` | `{"grafana_dashboard":"1"}`
| | labels of grafana dashboard configmap
| commons.prometheus.monitor.labels | commons.prometheus.monitor.labels
| object | object
| `{}` | `{}`
| | labels on Pod- and Service-Monitor
| commons.prometheus.rules.labels | commons.prometheus.rules.labels
| object | object
| `{}` | `{}`
| | labels on PrometheusRules
|===
.Values Other Values
|===
| Key | Type | Default | Description
| grafana.dashboards.annotations | grafana.dashboards.annotations
| object | object
| `{}` | `{}`
| | annotations of grafana dashboard configmap
| init.namespace | init.namespace
| string | string

View file

@ -3,20 +3,28 @@ init:
namespace: "bases" namespace: "bases"
commons: commons:
grafana:
dashboards:
labels:
grafana_dashboard: "1"
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
rules: rules:
# -- labels on PrometheusRules
# @section -- Commons Monitoring
labels: {} labels: {}
grafana:
dashboards:
# -- labels of grafana dashboard configmap
# @section -- Commons Monitoring
labels:
grafana_dashboard: "1"
prometheus: prometheus:
kubeStateMetricsConfig: kubeStateMetricsConfig:
namespace: namespace:
grafana: grafana:
dashboards: dashboards:
# -- annotations of grafana dashboard configmap
annotations: {} annotations: {}

View file

@ -17,39 +17,53 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons helm release
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
| commons.helm.release.driftDetection | commons.helm.release.driftDetection
| object | object
| `{}` | `{}`
| | driftDetection of FluxCD HelmRelease
| commons.helm.release.install | commons.helm.release.install
| object | object
| `{}` | `{}`
| | install of FluxCD HelmRelease
| commons.helm.release.test | commons.helm.release.test
| object | object
| `{}` | `{}`
| | test of FluxCD HelmRelease
| commons.helm.release.upgrade | commons.helm.release.upgrade
| object | object
| `{}` | `{}`
| | upgrade of FluxCD HelmRelease
|===
.Values Commons Ingress
|===
| Key | Type | Default | Description
| commons.ingress.domain | commons.ingress.domain
| string | string
| `"wrenix.eu"` | `"wrenix.eu"`
| | top domain for all services
|===
.Values Commons Monitoring
|===
| Key | Type | Default | Description
| commons.prometheus.monitor.labels | commons.prometheus.monitor.labels
| object | object
| `{}` | `{}`
| | labels on Pod- and Service-Monitor
|===
.Values Other Values
|===
| Key | Type | Default | Description
| controller | controller
| string | string

View file

@ -5,16 +5,28 @@ init:
commons: commons:
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
ingress: ingress:
# -- top domain for all services
# @section -- Commons Ingress
domain: "wrenix.eu" domain: "wrenix.eu"
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
controller: "traefik" controller: "traefik"

View file

@ -17,49 +17,58 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons Monitoring
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
| commons.grafana.dashboards.labels.grafana_dashboard | commons.grafana.dashboards.labels
| string
| `"1"`
|
| commons.grafana.datasource.labels.grafana_datasource
| string
| `"1"`
|
| commons.helm.release.driftDetection
| object | object
| `{}` | `{"grafana_dashboard":"1"}`
| | labels of grafana dashboard configmap
| commons.helm.release.install | commons.grafana.datasource.labels
| object | object
| `{}` | `{"grafana_datasource":"1"}`
| | labels of grafana datasource configmap and secret
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.prometheus.monitor.labels | commons.prometheus.monitor.labels
| object | object
| `{}` | `{}`
| | labels on Pod- and Service-Monitor
| commons.prometheus.rules.labels | commons.prometheus.rules.labels
| object | object
| `{}` | `{}`
| | labels on PrometheusRules
|===
.Values Commons helm release
|===
| Key | Type | Default | Description
| commons.helm.release.driftDetection
| object
| `{}`
| driftDetection of FluxCD HelmRelease
| commons.helm.release.install
| object
| `{}`
| install of FluxCD HelmRelease
| commons.helm.release.test
| object
| `{}`
| test of FluxCD HelmRelease
| commons.helm.release.upgrade
| object
| `{}`
| upgrade of FluxCD HelmRelease
|===
.Values Other Values
|===
| Key | Type | Default | Description
| fluentd.replicas | fluentd.replicas
| int | int
@ -69,7 +78,7 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| grafana.dashboards.annotations | grafana.dashboards.annotations
| object | object
| `{}` | `{}`
| | annotations of grafana dashboard configmap
| init.namespace | init.namespace
| string | string

View file

@ -5,27 +5,44 @@ init:
commons: commons:
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
grafana:
datasource:
labels:
grafana_datasource: "1"
dashboards:
labels:
grafana_dashboard: "1"
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
rules: rules:
# -- labels on PrometheusRules
# @section -- Commons Monitoring
labels: {} labels: {}
grafana: grafana:
datasource:
# -- labels of grafana datasource configmap and secret
# @section -- Commons Monitoring
labels:
grafana_datasource: "1"
dashboards: dashboards:
# -- labels of grafana dashboard configmap
# @section -- Commons Monitoring
labels:
grafana_dashboard: "1"
grafana:
dashboards:
# -- annotations of grafana dashboard configmap
annotations: {} annotations: {}
fluentd: fluentd:

View file

@ -17,7 +17,76 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons helm release
|===
| Key | Type | Default | Description
| commons.helm.release.driftDetection
| object
| `{}`
| driftDetection of FluxCD HelmRelease
| commons.helm.release.install
| object
| `{}`
| install of FluxCD HelmRelease
| commons.helm.release.test
| object
| `{}`
| test of FluxCD HelmRelease
| commons.helm.release.upgrade
| object
| `{}`
| upgrade of FluxCD HelmRelease
|===
.Values Commons Ingress
|===
| Key | Type | Default | Description
| commons.ingress.annotations
| object
| `{"cert-manager.io/cluster-issuer":"letsencrypt-prod"}`
| annotations for all ingress objects
| commons.ingress.domain
| string
| `"wrenix.eu"`
| top domain for all services
| 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)
|===
.Values Commons
|===
| Key | Type | Default | Description
| commons.masterPassword
| string
| `"CHANGEME"`
| masterPassword to generate secrets
|===
.Values Commons Monitoring
|===
| Key | Type | Default | Description
| commons.prometheus.monitor.labels
| object
| `{}`
| labels on Pod- and Service-Monitor
|===
.Values Other Values
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
@ -128,7 +197,7 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| commons.auth.authentik.backend | commons.auth.authentik.backend
| string | string
| `"authentik"` | `"authentik-server"`
| |
| commons.auth.authentik.domain | commons.auth.authentik.domain
@ -151,56 +220,6 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `"authentik"` | `"authentik"`
| |
| commons.helm.release.driftDetection
| object
| `{}`
|
| 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 | grafana.adminPassword
| string | string
| `nil` | `nil`

View file

@ -3,6 +3,8 @@ init:
namespace: "bases" namespace: "bases"
commons: commons:
# -- masterPassword to generate secrets
# @section -- Commons
masterPassword: "CHANGEME" masterPassword: "CHANGEME"
auth: auth:
@ -15,23 +17,39 @@ commons:
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
ingress: ingress:
# -- top domain for all services
# @section -- Commons Ingress
domain: "wrenix.eu" domain: "wrenix.eu"
# -- annotations for all ingress objects
# @section -- Commons Ingress
annotations: annotations:
cert-manager.io/cluster-issuer: letsencrypt-prod cert-manager.io/cluster-issuer: letsencrypt-prod
tls: tls:
# -- tls on every ingress # -- tls on every ingress
# @section -- Commons Ingress
enabled: false enabled: false
# -- use own definition of tls (e.g. for own or wildcard certificate) # -- use own definition of tls (e.g. for own or wildcard certificate)
# @section -- Commons Ingress
override: override:
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
alertmanager: alertmanager:

View file

@ -17,54 +17,63 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons Monitoring
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
| commons.grafana.dashboards.labels.grafana_dashboard | commons.grafana.dashboards.labels
| string
| `"1"`
|
| commons.helm.release.driftDetection
| object | object
| `{}` | `{"grafana_dashboard":"1"}`
| | labels of grafana dashboard configmap
| commons.helm.release.install
| object
| `{}`
|
| commons.helm.release.test
| object
| `{}`
|
| commons.helm.release.upgrade
| object
| `{}`
|
| commons.prometheus.alertmanager.labels | commons.prometheus.alertmanager.labels
| object | object
| `{}` | `{}`
| | labels on AlertmanagerConf
| commons.prometheus.monitor.labels | commons.prometheus.monitor.labels
| object | object
| `{}` | `{}`
| | labels on Pod- and Service-Monitor
| commons.prometheus.rules.labels | commons.prometheus.rules.labels
| object | object
| `{}` | `{}`
| | labels on PrometheusRules
|===
.Values Commons helm release
|===
| Key | Type | Default | Description
| commons.helm.release.driftDetection
| object
| `{}`
| driftDetection of FluxCD HelmRelease
| commons.helm.release.install
| object
| `{}`
| install of FluxCD HelmRelease
| commons.helm.release.test
| object
| `{}`
| test of FluxCD HelmRelease
| commons.helm.release.upgrade
| object
| `{}`
| upgrade of FluxCD HelmRelease
|===
.Values Other Values
|===
| Key | Type | Default | Description
| grafana.dashboards.annotations | grafana.dashboards.annotations
| object | object
| `{}` | `{}`
| | annotations of grafana dashboard configmap
| init.namespace | init.namespace
| string | string

View file

@ -5,26 +5,43 @@ init:
commons: commons:
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
prometheus: prometheus:
alertmanager: alertmanager:
# -- labels on AlertmanagerConf
# @section -- Commons Monitoring
labels: {} labels: {}
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
rules: rules:
# -- labels on PrometheusRules
# @section -- Commons Monitoring
labels: {} labels: {}
grafana: grafana:
dashboards: dashboards:
# -- labels of grafana dashboard configmap
# @section -- Commons Monitoring
labels: labels:
grafana_dashboard: "1" grafana_dashboard: "1"
grafana: grafana:
dashboards: dashboards:
# -- annotations of grafana dashboard configmap
annotations: {} annotations: {}

View file

@ -17,39 +17,44 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons helm release
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
| commons.helm.release.driftDetection | commons.helm.release.driftDetection
| object | object
| `{}` | `{}`
| | driftDetection of FluxCD HelmRelease
| commons.helm.release.install | commons.helm.release.install
| object | object
| `{}` | `{}`
| | install of FluxCD HelmRelease
| commons.helm.release.test | commons.helm.release.test
| object | object
| `{}` | `{}`
| | test of FluxCD HelmRelease
| commons.helm.release.upgrade | commons.helm.release.upgrade
| object | object
| `{}` | `{}`
| | upgrade of FluxCD HelmRelease
|===
| commons.ingress.annotations."cert-manager.io/cluster-issuer" .Values Commons Ingress
| string |===
| `"letsencrypt-prod"` | Key | Type | Default | Description
|
| commons.ingress.annotations
| object
| `{"cert-manager.io/cluster-issuer":"letsencrypt-prod"}`
| annotations for all ingress objects
| commons.ingress.domain | commons.ingress.domain
| string | string
| `"wrenix.eu"` | `"wrenix.eu"`
| | top domain for all services
| commons.ingress.tls.enabled | commons.ingress.tls.enabled
| bool | bool
@ -60,66 +65,100 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| string | string
| `nil` | `nil`
| use own definition of tls (e.g. for own or wildcard certificate) | use own definition of tls (e.g. for own or wildcard certificate)
|===
.Values Commons mail
|===
| Key | Type | Default | Description
| commons.mail.from | commons.mail.from
| string | string
| `nil` | `nil`
| | send from address
| commons.mail.host | commons.mail.host
| string | string
| `nil` | `nil`
| | smtp server
| commons.mail.password | commons.mail.password
| string | string
| `nil` | `nil`
| | smtp password
| commons.mail.use_ssl | commons.mail.use_ssl
| bool | bool
| `false` | `false`
| | smtp server use ssl
| commons.mail.use_tls | commons.mail.use_tls
| bool | bool
| `false` | `false`
| | smtp server use start tls
| commons.mail.username | commons.mail.username
| string | string
| `nil` | `nil`
| | smtp username
|===
.Values Commons
|===
| Key | Type | Default | Description
| commons.masterPassword | commons.masterPassword
| string | string
| `"CHANGEME"` | `"CHANGEME"`
| | masterPassword to generate secrets
|===
.Values Commons Monitoring
|===
| Key | Type | Default | Description
| commons.prometheus.monitor.labels | commons.prometheus.monitor.labels
| object | object
| `{}` | `{}`
| | labels on Pod- and Service-Monitor
| commons.prometheus.rules.labels | commons.prometheus.rules.labels
| object | object
| `{}` | `{}`
| | labels on PrometheusRules
|===
.Values Commons Redis
|===
| Key | Type | Default | Description
| commons.redis.replicas
| int
| `0`
| replicas
|===
.Values Commons theme
|===
| Key | Type | Default | Description
| commons.theme.favicon | commons.theme.favicon
| string | string
| `"/static/dist/assets/icons/icon.png"` | `"/static/dist/assets/icons/icon.png"`
| | favicon everywhere
| commons.theme.logo | commons.theme.logo
| string | string
| `"/static/dist/assets/icons/icon_left_brand.svg"` | `"/static/dist/assets/icons/icon_left_brand.svg"`
| | logo everywhere
| commons.theme.title | commons.theme.title
| string | string
| `"myCloud"` | `"myCloud"`
| | title everywhere
|===
.Values Other Values
|===
| Key | Type | Default | Description
| database.host | database.host
| string | string

View file

@ -3,44 +3,84 @@ init:
namespace: "bases" namespace: "bases"
commons: commons:
# -- masterPassword to generate secrets
# @section -- Commons
masterPassword: "CHANGEME" masterPassword: "CHANGEME"
theme: theme:
# -- title everywhere
# @section -- Commons theme
title: myCloud title: myCloud
# -- logo everywhere
# @section -- Commons theme
logo: /static/dist/assets/icons/icon_left_brand.svg logo: /static/dist/assets/icons/icon_left_brand.svg
# -- favicon everywhere
# @section -- Commons theme
favicon: /static/dist/assets/icons/icon.png favicon: /static/dist/assets/icons/icon.png
mail: mail:
# -- smtp server
# @section -- Commons mail
host: host:
# -- smtp username
# @section -- Commons mail
username: username:
# -- smtp password
# @section -- Commons mail
password: password:
# -- send from address
# @section -- Commons mail
from: from:
# -- smtp server use start tls
# @section -- Commons mail
use_tls: false use_tls: false
# -- smtp server use ssl
# @section -- Commons mail
use_ssl: false use_ssl: false
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
ingress: ingress:
# -- top domain for all services
# @section -- Commons Ingress
domain: "wrenix.eu" domain: "wrenix.eu"
# -- annotations for all ingress objects
# @section -- Commons Ingress
annotations: annotations:
cert-manager.io/cluster-issuer: letsencrypt-prod cert-manager.io/cluster-issuer: letsencrypt-prod
tls: tls:
# -- tls on every ingress # -- tls on every ingress
# @section -- Commons Ingress
enabled: true enabled: true
# -- use own definition of tls (e.g. for own or wildcard certificate) # -- use own definition of tls (e.g. for own or wildcard certificate)
# @section -- Commons Ingress
override: override:
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
rules: rules:
# -- labels on PrometheusRules
# @section -- Commons Monitoring
labels: {} labels: {}
redis: redis:
# -- replicas
# @section -- Commons Redis
replicas: 0 replicas: 0
# -- generated by .Values.commons.masterPassword # -- generated by .Values.commons.masterPassword

View file

@ -17,7 +17,91 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons Monitoring
|===
| Key | Type | Default | Description
| commons.grafana.dashboards.annotations
| object
| `{}`
| annotations of grafana dashboard configmap
| commons.grafana.dashboards.labels
| object
| `{}`
| labels of grafana dashboard configmap
| commons.prometheus.monitor.labels
| object
| `{}`
| labels on Pod- and Service-Monitor
| commons.prometheus.rules.labels
| object
| `{}`
| labels on PrometheusRules
|===
.Values Commons helm release
|===
| Key | Type | Default | Description
| commons.helm.release.driftDetection
| object
| `{}`
| driftDetection of FluxCD HelmRelease
| commons.helm.release.install
| object
| `{}`
| install of FluxCD HelmRelease
| commons.helm.release.test
| object
| `{}`
| test of FluxCD HelmRelease
| commons.helm.release.upgrade
| object
| `{}`
| upgrade of FluxCD HelmRelease
|===
.Values Commons Ingress
|===
| Key | Type | Default | Description
| commons.ingress.annotations
| object
| `{"cert-manager.io/cluster-issuer":"letsencrypt-prod"}`
| annotations for all ingress objects
| commons.ingress.domain
| string
| `"wrenix.eu"`
| top domain for all services
| 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)
|===
.Values Commons
|===
| Key | Type | Default | Description
| commons.masterPassword
| string
| `"CHANGEME"`
| masterPassword to generate secrets
|===
.Values Other Values
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
@ -31,71 +115,6 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `{}` | `{}`
| allowed host to use this collabora instance if not set we allow defaults (like nextcloud) example: main.host.de: [ "alias1.host.de", "alias2.host.de" ] | allowed host to use this collabora instance if not set we allow defaults (like nextcloud) example: main.host.de: [ "alias1.host.de", "alias2.host.de" ]
| commons.grafana.dashboards.annotations
| object
| `{}`
|
| commons.grafana.dashboards.labels
| object
| `{}`
|
| commons.helm.release.driftDetection
| object
| `{}`
|
| 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.masterPassword
| string
| `"CHANGEME"`
|
| commons.prometheus.monitor.labels
| object
| `{}`
|
| commons.prometheus.rules.labels
| object
| `{}`
|
| ingress.annotations | ingress.annotations
| object | object
| `{"haproxy-ingress.github.io/assign-backend-server-id":"true","haproxy-ingress.github.io/balance-algorithm":"url_param WOPISrc","haproxy-ingress.github.io/config-backend":"hash-type consistent acl admin_url path_beg /cool/getMetrics acl admin_url path_beg /cool/adminws/ acl admin_url path_beg /browser/dist/admin/admin.html http-request deny if admin_url","haproxy-ingress.github.io/timeout-tunnel":"3600s","nginx.ingress.kubernetes.io/server-snippet":"location /cool/getMetrics { deny all; return 403; }\nlocation /cool/adminws/ { deny all; return 403; }\nlocation /browser/dist/admin/admin.html { deny all; return 403; }\n","nginx.ingress.kubernetes.io/upstream-hash-by":"$arg_WOPISrc"}` | `{"haproxy-ingress.github.io/assign-backend-server-id":"true","haproxy-ingress.github.io/balance-algorithm":"url_param WOPISrc","haproxy-ingress.github.io/config-backend":"hash-type consistent acl admin_url path_beg /cool/getMetrics acl admin_url path_beg /cool/adminws/ acl admin_url path_beg /browser/dist/admin/admin.html http-request deny if admin_url","haproxy-ingress.github.io/timeout-tunnel":"3600s","nginx.ingress.kubernetes.io/server-snippet":"location /cool/getMetrics { deny all; return 403; }\nlocation /cool/adminws/ { deny all; return 403; }\nlocation /browser/dist/admin/admin.html { deny all; return 403; }\n","nginx.ingress.kubernetes.io/upstream-hash-by":"$arg_WOPISrc"}`

View file

@ -3,33 +3,58 @@ init:
namespace: "bases" namespace: "bases"
commons: commons:
# -- masterPassword to generate secrets
# @section -- Commons
masterPassword: "CHANGEME" masterPassword: "CHANGEME"
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
ingress: ingress:
# -- top domain for all services
# @section -- Commons Ingress
domain: "wrenix.eu" domain: "wrenix.eu"
# -- annotations for all ingress objects
# @section -- Commons Ingress
annotations: annotations:
cert-manager.io/cluster-issuer: letsencrypt-prod cert-manager.io/cluster-issuer: letsencrypt-prod
tls: tls:
# -- tls on every ingress # -- tls on every ingress
# @section -- Commons Ingress
enabled: true enabled: true
# -- use own definition of tls (e.g. for own or wildcard certificate) # -- use own definition of tls (e.g. for own or wildcard certificate)
# @section -- Commons Ingress
override: override:
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
rules: rules:
# -- labels on PrometheusRules
# @section -- Commons Monitoring
labels: {} labels: {}
grafana: grafana:
dashboards: dashboards:
# -- labels of grafana dashboard configmap
# @section -- Commons Monitoring
labels: {} labels: {}
# -- annotations of grafana dashboard configmap
# @section -- Commons Monitoring
annotations: {} annotations: {}

View file

@ -17,7 +17,161 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons
|===
| Key | Type | Default | Description
| commons.auth.host
| string
| `nil`
| default auth.(.Values.commons.ingress.domain)
| commons.masterPassword
| string
| `"CHANGEME"`
| masterPassword to generate secrets
|===
.Values Commons helm release
|===
| Key | Type | Default | Description
| commons.helm.release.driftDetection
| object
| `{}`
| driftDetection of FluxCD HelmRelease
| commons.helm.release.install
| object
| `{}`
| install of FluxCD HelmRelease
| commons.helm.release.test
| object
| `{}`
| test of FluxCD HelmRelease
| commons.helm.release.upgrade
| object
| `{}`
| upgrade of FluxCD HelmRelease
|===
.Values Commons Ingress
|===
| Key | Type | Default | Description
| commons.ingress.annotations
| object
| `{"cert-manager.io/cluster-issuer":"letsencrypt-prod"}`
| annotations for all ingress objects
| commons.ingress.domain
| string
| `"wrenix.eu"`
| top domain for all services
| 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)
|===
.Values Commons mail
|===
| Key | Type | Default | Description
| commons.mail.from
| string
| `nil`
| send from address
| commons.mail.host
| string
| `nil`
| smtp server
| commons.mail.password
| string
| `nil`
| smtp password
| commons.mail.use_ssl
| bool
| `false`
| smtp server use ssl
| commons.mail.use_tls
| bool
| `false`
| smtp server use start tls
| commons.mail.username
| string
| `nil`
| smtp username
|===
.Values Commons Persistence
|===
| Key | Type | Default | Description
| commons.persistence.hostPath.enabled
| bool
| `false`
| use hostPath instatt of PVC
| commons.persistence.hostPath.prefix
| string
| `"/var/lib/mycloud"`
| use hostPath under the following path
| commons.persistence.storageClass
| string
| `nil`
| storageClass of PVC
|===
.Values Commons Monitoring
|===
| Key | Type | Default | Description
| commons.prometheus.monitor.labels
| object
| `{}`
| labels on Pod- and Service-Monitor
| commons.prometheus.rules.labels
| object
| `{}`
| labels on PrometheusRules
|===
.Values Commons theme
|===
| Key | Type | Default | Description
| commons.theme.favicon
| string
| `"/static/dist/assets/icons/icon.png"`
| favicon everywhere
| commons.theme.logo
| string
| `"/static/dist/assets/icons/icon_left_brand.svg"`
| logo everywhere
| commons.theme.title
| string
| `"myCloud"`
| title everywhere
|===
.Values Other Values
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
@ -31,126 +185,6 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `nil` | `nil`
| generated by .Values.commons.masterPassword | generated by .Values.commons.masterPassword
| commons.auth.host
| string
| `nil`
| default auth.(.Values.commons.ingress.domain)
| commons.helm.release.driftDetection
| object
| `{}`
|
| 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.persistence.hostPath.enabled
| bool
| `false`
|
| commons.persistence.hostPath.prefix
| string
| `"/var/lib/mycloud"`
|
| commons.persistence.storageClass
| string
| `nil`
|
| 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 | database.host
| string | string
| `"mycloud-services-postgresql"` | `"mycloud-services-postgresql"`

View file

@ -3,52 +3,97 @@ init:
namespace: "bases" namespace: "bases"
commons: commons:
# -- masterPassword to generate secrets
# @section -- Commons
masterPassword: "CHANGEME" masterPassword: "CHANGEME"
auth: auth:
# -- default auth.(.Values.commons.ingress.domain) # -- default auth.(.Values.commons.ingress.domain)
# @section -- Commons
host: host:
theme: theme:
# -- title everywhere
# @section -- Commons theme
title: myCloud title: myCloud
# -- logo everywhere
# @section -- Commons theme
logo: /static/dist/assets/icons/icon_left_brand.svg logo: /static/dist/assets/icons/icon_left_brand.svg
# -- favicon everywhere
# @section -- Commons theme
favicon: /static/dist/assets/icons/icon.png favicon: /static/dist/assets/icons/icon.png
mail: mail:
# -- smtp server
# @section -- Commons mail
host: host:
# -- smtp username
# @section -- Commons mail
username: username:
# -- smtp password
# @section -- Commons mail
password: password:
# -- send from address
# @section -- Commons mail
from: from:
# -- smtp server use start tls
# @section -- Commons mail
use_tls: false use_tls: false
# -- smtp server use ssl
# @section -- Commons mail
use_ssl: false use_ssl: false
persistence: persistence:
# -- storageClass of PVC
# @section -- Commons Persistence
storageClass: storageClass:
hostPath: hostPath:
# -- use hostPath instatt of PVC
# @section -- Commons Persistence
enabled: false enabled: false
# -- use hostPath under the following path
# @section -- Commons Persistence
prefix: "/var/lib/mycloud" prefix: "/var/lib/mycloud"
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
ingress: ingress:
# -- top domain for all services
# @section -- Commons Ingress
domain: "wrenix.eu" domain: "wrenix.eu"
# -- annotations for all ingress objects
# @section -- Commons Ingress
annotations: annotations:
cert-manager.io/cluster-issuer: letsencrypt-prod cert-manager.io/cluster-issuer: letsencrypt-prod
tls: tls:
# -- tls on every ingress # -- tls on every ingress
# @section -- Commons Ingress
enabled: true enabled: true
# -- use own definition of tls (e.g. for own or wildcard certificate) # -- use own definition of tls (e.g. for own or wildcard certificate)
# @section -- Commons Ingress
override: override:
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
rules: rules:
# -- labels on PrometheusRules
# @section -- Commons Monitoring
labels: {} labels: {}
auth: auth:

View file

@ -17,7 +17,7 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
@ -26,35 +26,75 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `nil` | `nil`
| default auth.(.Values.commons.ingress.domain) | default auth.(.Values.commons.ingress.domain)
| commons.masterPassword
| string
| `"CHANGEME"`
| masterPassword to generate secrets
|===
.Values Commons Monitoring
|===
| Key | Type | Default | Description
| commons.grafana.dashboards.annotations
| string
| `nil`
| annotations of grafana dashboard configmap
| commons.grafana.dashboards.labels
| object
| `{"grafana_dashboard":"1"}`
| labels of grafana dashboard configmap
| commons.prometheus.monitor.labels
| object
| `{}`
| labels on Pod- and Service-Monitor
| commons.prometheus.rules.labels
| object
| `{}`
| labels on PrometheusRules
|===
.Values Commons helm release
|===
| Key | Type | Default | Description
| commons.helm.release.driftDetection | commons.helm.release.driftDetection
| object | object
| `{}` | `{}`
| | driftDetection of FluxCD HelmRelease
| commons.helm.release.install | commons.helm.release.install
| object | object
| `{}` | `{}`
| | install of FluxCD HelmRelease
| commons.helm.release.test | commons.helm.release.test
| object | object
| `{}` | `{}`
| | test of FluxCD HelmRelease
| commons.helm.release.upgrade | commons.helm.release.upgrade
| object | object
| `{}` | `{}`
| | upgrade of FluxCD HelmRelease
|===
| commons.ingress.annotations."cert-manager.io/cluster-issuer" .Values Commons Ingress
| string |===
| `"letsencrypt-prod"` | Key | Type | Default | Description
|
| commons.ingress.annotations
| object
| `{"cert-manager.io/cluster-issuer":"letsencrypt-prod"}`
| annotations for all ingress objects
| commons.ingress.domain | commons.ingress.domain
| string | string
| `"wrenix.eu"` | `"wrenix.eu"`
| | top domain for all services
| commons.ingress.tls.enabled | commons.ingress.tls.enabled
| bool | bool
@ -65,86 +105,140 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| string | string
| `nil` | `nil`
| use own definition of tls (e.g. for own or wildcard certificate) | use own definition of tls (e.g. for own or wildcard certificate)
|===
.Values Commons mail
|===
| Key | Type | Default | Description
| commons.mail.from | commons.mail.from
| string | string
| `nil` | `nil`
| | send from address
| commons.mail.host | commons.mail.host
| string | string
| `nil` | `nil`
| | smtp server
| commons.mail.password | commons.mail.password
| string | string
| `nil` | `nil`
| | smtp password
| commons.mail.use_ssl | commons.mail.use_ssl
| bool | bool
| `false` | `false`
| | smtp server use ssl
| commons.mail.use_tls | commons.mail.use_tls
| bool | bool
| `false` | `false`
| | smtp server use start tls
| commons.mail.username | commons.mail.username
| string | string
| `nil` | `nil`
| | smtp username
|===
| commons.masterPassword .Values Commons Persistence
| string |===
| `"CHANGEME"` | Key | Type | Default | Description
|
| commons.persistence.hostPath.enabled | commons.persistence.hostPath.enabled
| bool | bool
| `false` | `false`
| | use hostPath instatt of PVC
| commons.persistence.hostPath.prefix | commons.persistence.hostPath.prefix
| string | string
| `"/var/lib/mycloud"` | `"/var/lib/mycloud"`
| | use hostPath under the following path
| commons.persistence.storageClass | commons.persistence.storageClass
| string | string
| `nil` | `nil`
| | storageClass of PVC
|===
| commons.prometheus.monitor.labels .Values Commons theme
| object |===
| `{}` | Key | Type | Default | Description
|
| commons.prometheus.rules.labels
| object
| `{}`
|
| commons.theme.favicon | commons.theme.favicon
| string | string
| `"/static/dist/assets/icons/icon.png"` | `"/static/dist/assets/icons/icon.png"`
| | favicon everywhere
| commons.theme.logo | commons.theme.logo
| string | string
| `"/static/dist/assets/icons/icon_left_brand.svg"` | `"/static/dist/assets/icons/icon_left_brand.svg"`
| | logo everywhere
| commons.theme.title | commons.theme.title
| string | string
| `"myCloud"` | `"myCloud"`
| title everywhere
|===
.Values Other Values
|===
| Key | Type | Default | Description
| bridge.signal.admins
| list
| `[]`
|
| bridge.signal.enabled
| bool
| `false`
|
| databases.authenticationService.host
| string
| `"mycloud-services-postgresql"`
| default is from mycloud-services
| databases.authenticationService.name
| string
| `"matrix-authentication-service"`
|
| databases.authenticationService.password
| string
| `nil`
| generated by .commons.masterPassword (equal to mycloud-services)
| databases.authenticationService.username
| string
| `"matrix-authentication-service"`
|
| databases.bridge.signal.host
| string
| `"mycloud-services-postgresql"`
| default is from mycloud-services
| databases.bridge.signal.name
| string
| `"matrix-bridge-signal"`
|
| databases.bridge.signal.password
| string
| `nil`
| generated by .commons.masterPassword (equal to mycloud-services)
| databases.bridge.signal.username
| string
| `"matrix-bridge-signal"`
| |
| databases.server.host | databases.server.host
| string | string
| `"mycloud-services-postgresql"` | `"mycloud-services-postgresql"`
| default is from mysql-services | default is from mycloud-services
| databases.server.name | databases.server.name
| string | string
@ -161,6 +255,36 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `"matrix-synapse"` | `"matrix-synapse"`
| |
| databases.slidingSync.host
| string
| `"mycloud-services-postgresql"`
| default is from mycloud-services
| databases.slidingSync.name
| string
| `"matrix-sliding-sync"`
|
| databases.slidingSync.password
| string
| `nil`
| generated by .commons.masterPassword (equal to mycloud-services)
| databases.slidingSync.username
| string
| `"matrix-sliding-sync"`
|
| ingress.authenticationService.annotations
| string
| `nil`
|
| ingress.authenticationService.host
| string
| `nil`
| default: auth.matrix.(.commons.ingress.domain)
| ingress.element.annotations | ingress.element.annotations
| string | string
| `nil` | `nil`
@ -201,6 +325,16 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `nil` | `nil`
| default: matrix.(.commons.ingress.domain) | default: matrix.(.commons.ingress.domain)
| ingress.slidingSync.annotations
| string
| `nil`
|
| ingress.slidingSync.host
| string
| `nil`
| default: sliding.matrix.(.commons.ingress.domain)
| init.namespace | init.namespace
| string | string
| `"bases"` | `"bases"`
@ -231,6 +365,21 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `nil` | `nil`
| generated by .commons.masterPassword | generated by .commons.masterPassword
| server.auth.webClient
| string
| `nil`
| default: element.(.commons.ingress.domain)
| server.authenticationService.admins
| list
| `[]`
|
| server.authenticationService.enabled
| bool
| `false`
|
| server.host | server.host
| string | string
| `nil` | `nil`
@ -246,6 +395,16 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `nil` | `nil`
| default .commons.mail.host | default .commons.mail.host
| server.scaling
| bool
| `false`
|
| server.slidingSync.enabled
| bool
| `false`
|
| server.software | server.software
| string | string
| `"synapse"` | `"synapse"`

View file

@ -3,58 +3,107 @@ init:
namespace: "bases" namespace: "bases"
commons: commons:
# -- masterPassword to generate secrets
# @section -- Commons
masterPassword: "CHANGEME" masterPassword: "CHANGEME"
auth: auth:
# -- default auth.(.Values.commons.ingress.domain) # -- default auth.(.Values.commons.ingress.domain)
# @section -- Commons
host: host:
theme: theme:
# -- title everywhere
# @section -- Commons theme
title: myCloud title: myCloud
# -- logo everywhere
# @section -- Commons theme
logo: /static/dist/assets/icons/icon_left_brand.svg logo: /static/dist/assets/icons/icon_left_brand.svg
# -- favicon everywhere
# @section -- Commons theme
favicon: /static/dist/assets/icons/icon.png favicon: /static/dist/assets/icons/icon.png
mail: mail:
# -- smtp server
# @section -- Commons mail
host: host:
# -- smtp username
# @section -- Commons mail
username: username:
# -- smtp password
# @section -- Commons mail
password: password:
# -- send from address
# @section -- Commons mail
from: from:
# -- smtp server use start tls
# @section -- Commons mail
use_tls: false use_tls: false
# -- smtp server use ssl
# @section -- Commons mail
use_ssl: false use_ssl: false
persistence: persistence:
# -- storageClass of PVC
# @section -- Commons Persistence
storageClass: storageClass:
hostPath: hostPath:
# -- use hostPath instatt of PVC
# @section -- Commons Persistence
enabled: false enabled: false
# -- use hostPath under the following path
# @section -- Commons Persistence
prefix: "/var/lib/mycloud" prefix: "/var/lib/mycloud"
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
ingress: ingress:
# -- top domain for all services
# @section -- Commons Ingress
domain: "wrenix.eu" domain: "wrenix.eu"
# -- annotations for all ingress objects
# @section -- Commons Ingress
annotations: annotations:
cert-manager.io/cluster-issuer: letsencrypt-prod cert-manager.io/cluster-issuer: letsencrypt-prod
tls: tls:
# -- tls on every ingress # -- tls on every ingress
# @section -- Commons Ingress
enabled: true enabled: true
# -- use own definition of tls (e.g. for own or wildcard certificate) # -- use own definition of tls (e.g. for own or wildcard certificate)
# @section -- Commons Ingress
override: override:
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
rules: rules:
# -- labels on PrometheusRules
# @section -- Commons Monitoring
labels: {} labels: {}
grafana: grafana:
dashboards: dashboards:
# -- labels of grafana dashboard configmap
# @section -- Commons Monitoring
labels: labels:
grafana_dashboard: "1" grafana_dashboard: "1"
# -- annotations of grafana dashboard configmap
# @section -- Commons Monitoring
annotations: annotations:
server: server:

View file

@ -17,7 +17,171 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons
|===
| Key | Type | Default | Description
| commons.auth.host
| string
| `nil`
| default auth.(.Values.commons.ingress.domain)
| commons.masterPassword
| string
| `"CHANGEME"`
| masterPassword to generate secrets
|===
.Values Commons helm release
|===
| Key | Type | Default | Description
| commons.helm.release.driftDetection
| object
| `{}`
| driftDetection of FluxCD HelmRelease
| commons.helm.release.install
| object
| `{}`
| install of FluxCD HelmRelease
| commons.helm.release.test
| object
| `{}`
| test of FluxCD HelmRelease
| commons.helm.release.upgrade
| object
| `{}`
| upgrade of FluxCD HelmRelease
|===
.Values Commons Ingress
|===
| Key | Type | Default | Description
| commons.ingress.annotations
| object
| `{"cert-manager.io/cluster-issuer":"letsencrypt-prod"}`
| annotations for all ingress objects
| commons.ingress.domain
| string
| `"wrenix.eu"`
| top domain for all services
| 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)
|===
.Values Commons mail
|===
| Key | Type | Default | Description
| commons.mail.from
| string
| `nil`
| send from address
| commons.mail.host
| string
| `nil`
| smtp server
| commons.mail.password
| string
| `nil`
| smtp password
| commons.mail.use_ssl
| bool
| `false`
| smtp server use ssl
| commons.mail.use_tls
| bool
| `false`
| smtp server use start tls
| commons.mail.username
| string
| `nil`
| smtp username
|===
.Values Commons Persistence
|===
| Key | Type | Default | Description
| commons.persistence.hostPath.enabled
| bool
| `false`
| use hostPath instatt of PVC
| commons.persistence.hostPath.prefix
| string
| `"/var/lib/mycloud"`
| use hostPath under the following path
| commons.persistence.storageClass
| string
| `nil`
| storageClass of PVC
|===
.Values Commons Monitoring
|===
| Key | Type | Default | Description
| commons.prometheus.monitor.labels
| object
| `{}`
| labels on Pod- and Service-Monitor
| commons.prometheus.rules.labels
| object
| `{}`
| labels on PrometheusRules
|===
.Values Commons Redis
|===
| Key | Type | Default | Description
| commons.redis.replicas
| int
| `0`
| replicas
|===
.Values Commons theme
|===
| Key | Type | Default | Description
| commons.theme.favicon
| string
| `"/static/dist/assets/icons/icon.png"`
| favicon everywhere
| commons.theme.logo
| string
| `"/static/dist/assets/icons/icon_left_brand.svg"`
| logo everywhere
| commons.theme.title
| string
| `"myCloud"`
| title everywhere
|===
.Values Other Values
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
@ -91,126 +255,6 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `"sub"` | `"sub"`
| oidc field which us used as id in nextcloud for username (for security reason it is sub, but could be overwritten by username) https://goauthentik.io/integrations/services/nextcloud/#provider-and-application | oidc field which us used as id in nextcloud for username (for security reason it is sub, but could be overwritten by username) https://goauthentik.io/integrations/services/nextcloud/#provider-and-application
| commons.auth.host
| string
| `nil`
| default auth.(.Values.commons.ingress.domain)
| commons.helm.release.driftDetection
| object
| `{}`
|
| 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.persistence.hostPath.enabled
| bool
| `false`
|
| commons.persistence.hostPath.prefix
| string
| `"/var/lib/mycloud"`
|
| commons.persistence.storageClass
| string
| `nil`
|
| 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 | database.host
| string | string
| `"mycloud-services-postgresql"` | `"mycloud-services-postgresql"`
@ -231,11 +275,6 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
| `"nextcloud"` | `"nextcloud"`
| |
| helm.nextcloud.chart
| string
| `"6378227fe4a3b36c9d968e6ece377036b6c2df1a"`
| version of the helm chart (current on git)
| ingress.annotations | ingress.annotations
| string | string
| `nil` | `nil`

View file

@ -3,55 +3,102 @@ init:
namespace: "bases" namespace: "bases"
commons: commons:
# -- masterPassword to generate secrets
# @section -- Commons
masterPassword: "CHANGEME" masterPassword: "CHANGEME"
auth: auth:
# -- default auth.(.Values.commons.ingress.domain) # -- default auth.(.Values.commons.ingress.domain)
# @section -- Commons
host: host:
theme: theme:
# -- title everywhere
# @section -- Commons theme
title: myCloud title: myCloud
# -- logo everywhere
# @section -- Commons theme
logo: /static/dist/assets/icons/icon_left_brand.svg logo: /static/dist/assets/icons/icon_left_brand.svg
# -- favicon everywhere
# @section -- Commons theme
favicon: /static/dist/assets/icons/icon.png favicon: /static/dist/assets/icons/icon.png
mail: mail:
# -- smtp server
# @section -- Commons mail
host: host:
# -- smtp username
# @section -- Commons mail
username: username:
# -- smtp password
# @section -- Commons mail
password: password:
# -- send from address
# @section -- Commons mail
from: from:
# -- smtp server use start tls
# @section -- Commons mail
use_tls: false use_tls: false
# -- smtp server use ssl
# @section -- Commons mail
use_ssl: false use_ssl: false
persistence: persistence:
# -- storageClass of PVC
# @section -- Commons Persistence
storageClass: storageClass:
hostPath: hostPath:
# -- use hostPath instatt of PVC
# @section -- Commons Persistence
enabled: false enabled: false
# -- use hostPath under the following path
# @section -- Commons Persistence
prefix: "/var/lib/mycloud" prefix: "/var/lib/mycloud"
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
ingress: ingress:
# -- top domain for all services
# @section -- Commons Ingress
domain: "wrenix.eu" domain: "wrenix.eu"
# -- annotations for all ingress objects
# @section -- Commons Ingress
annotations: annotations:
cert-manager.io/cluster-issuer: letsencrypt-prod cert-manager.io/cluster-issuer: letsencrypt-prod
tls: tls:
# -- tls on every ingress # -- tls on every ingress
# @section -- Commons Ingress
enabled: true enabled: true
# -- use own definition of tls (e.g. for own or wildcard certificate) # -- use own definition of tls (e.g. for own or wildcard certificate)
# @section -- Commons Ingress
override: override:
prometheus: prometheus:
monitor: monitor:
# -- labels on Pod- and Service-Monitor
# @section -- Commons Monitoring
labels: {} labels: {}
rules: rules:
# -- labels on PrometheusRules
# @section -- Commons Monitoring
labels: {} labels: {}
redis: redis:
# -- replicas
# @section -- Commons Redis
replicas: 0 replicas: 0
# -- generated by .Values.commons.masterPassword # -- generated by .Values.commons.masterPassword

View file

@ -17,55 +17,74 @@ image::https://img.shields.io/badge/Version-application-informational?style=flat
== Values == Values
.Values .Values Commons helm release
|=== |===
| Key | Type | Default | Description | Key | Type | Default | Description
| commons.helm.release.driftDetection | commons.helm.release.driftDetection
| object | object
| `{}` | `{}`
| | driftDetection of FluxCD HelmRelease
| commons.helm.release.install | commons.helm.release.install
| object | object
| `{}` | `{}`
| | install of FluxCD HelmRelease
| commons.helm.release.test | commons.helm.release.test
| object | object
| `{}` | `{}`
| | test of FluxCD HelmRelease
| commons.helm.release.upgrade | commons.helm.release.upgrade
| object | object
| `{}` | `{}`
| | upgrade of FluxCD HelmRelease
|===
.Values Commons
|===
| Key | Type | Default | Description
| commons.masterPassword | commons.masterPassword
| string | string
| `"CHANGEME"` | `"CHANGEME"`
| | masterPassword to generate secrets
|===
.Values Commons Persistence
|===
| Key | Type | Default | Description
| commons.persistence.hostPath.enabled | commons.persistence.hostPath.enabled
| bool | bool
| `false` | `false`
| | use hostPath instatt of PVC
| commons.persistence.hostPath.prefix | commons.persistence.hostPath.prefix
| string | string
| `"/var/lib/mycloud"` | `"/var/lib/mycloud"`
| | use hostPath under the following path
| commons.persistence.storageClass | commons.persistence.storageClass
| string | string
| `nil` | `nil`
| | storageClass of PVC
|===
.Values Other Values
|===
| Key | Type | Default | Description
| databases | databases
| object | object
| `{"example":{"password":null,"type":"none","username":"example-password"}}` | `{"example":{"additionalParams":null,"password":null,"type":"none","username":"example-password"}}`
| create databases | create databases
| databases.example.additionalParams
| string
| `nil`
| additional params for databases
| databases.example.password | databases.example.password
| string | string
| `nil` | `nil`

View file

@ -1,17 +1,33 @@
commons: commons:
# -- masterPassword to generate secrets
# @section -- Commons
masterPassword: "CHANGEME" masterPassword: "CHANGEME"
persistence: persistence:
# -- storageClass of PVC
# @section -- Commons Persistence
storageClass: storageClass:
hostPath: hostPath:
# -- use hostPath instatt of PVC
# @section -- Commons Persistence
enabled: false enabled: false
# -- use hostPath under the following path
# @section -- Commons Persistence
prefix: "/var/lib/mycloud" prefix: "/var/lib/mycloud"
helm: helm:
release: release:
# -- install of FluxCD HelmRelease
# @section -- Commons helm release
install: {} install: {}
# -- test of FluxCD HelmRelease
# @section -- Commons helm release
test: {} test: {}
# -- upgrade of FluxCD HelmRelease
# @section -- Commons helm release
upgrade: {} upgrade: {}
# -- driftDetection of FluxCD HelmRelease
# @section -- Commons helm release
driftDetection: {} driftDetection: {}
postgresql: postgresql: