356 lines
4.1 KiB
Text
356 lines
4.1 KiB
Text
|
|
|
|
= matrix-sliding-sync
|
|
|
|
image::https://img.shields.io/badge/Version-0.2.2-informational?style=flat-square[Version: 0.2.2]
|
|
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
|
|
image::https://img.shields.io/badge/AppVersion-0.99.19-informational?style=flat-square[AppVersion: 0.99.19]
|
|
== Maintainers
|
|
|
|
.Maintainers
|
|
|===
|
|
| Name | Email | Url
|
|
|
|
| WrenIX
|
|
|
|
|
| <https://wrenix.eu>
|
|
|===
|
|
|
|
== Usage
|
|
|
|
Helm must be installed and setup to your kubernetes cluster to use the charts.
|
|
Refer to Helm's https://helm.sh/docs[documentation] to get started.
|
|
Once Helm has been set up correctly, fetch the charts as follows:
|
|
|
|
[source,bash]
|
|
----
|
|
helm pull oci://codeberg.org/wrenix/helm-charts/matrix-sliding-sync
|
|
----
|
|
|
|
You can install a chart release using the following command:
|
|
|
|
[source,bash]
|
|
----
|
|
helm install matrix-sliding-sync-release oci://codeberg.org/wrenix/helm-charts/matrix-sliding-sync --values values.yaml
|
|
----
|
|
|
|
To uninstall a chart release use `helm`'s delete command:
|
|
|
|
[source,bash]
|
|
----
|
|
helm uninstall matrix-sliding-sync-release
|
|
----
|
|
|
|
== 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.opentelemetry.password
|
|
| string
|
|
| `nil`
|
|
|
|
|
|
|
| config.opentelemetry.url
|
|
| string
|
|
| `nil`
|
|
|
|
|
|
|
| config.opentelemetry.username
|
|
| string
|
|
| `nil`
|
|
|
|
|
|
|
| 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
|
|
|
|
| grafana.dashboards.annotations
|
|
| object
|
|
| `{}`
|
|
|
|
|
|
|
| grafana.dashboards.enabled
|
|
| bool
|
|
| `false`
|
|
|
|
|
|
|
| grafana.dashboards.labels.grafana_dashboard
|
|
| string
|
|
| `"1"`
|
|
|
|
|
|
|
| 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 https://github.com/norwoodj/helm-docs[helm-docs]
|