flux-charts/template/README.adoc

244 lines
3.7 KiB
Text

= <template>
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 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
| list
| `[]`
| 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 Commons Tracing
|===
| Key | Type | Default | Description
| commons.tracing.enabled
| bool
| `false`
| enable tracing on all components
| commons.tracing.grpc.enabled
| bool
| `true`
| prefer grpc over http
| commons.tracing.grpc.endpoint
| string
| `"tempo.monitoring.svc:4317"`
| grpc endpoint
| commons.tracing.grpc.insecure
| bool
| `true`
| allow insecure connection per grpc
| commons.tracing.http.endpoint
| string
| `"http://tempo.monitoring.svc:4318/v1/traces"`
| http endpoint
|===
.Values Other Values
|===
| Key | Type | Default | Description
| commons.auth.authentik.backend
| string
| `"authentik-server"`
|
| commons.auth.authentik.domain
| string
| `""`
|
| commons.auth.enabled
| bool
| `false`
|
| commons.auth.namespace
| string
| `""`
|
| commons.auth.type
| string
| `"authentik"`
|
| init.namespace
| string
| `"bases"`
|
| init.version
| int
| `0`
|
|===
Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]