From 86755ddff632bf128c3b852a5dc9b0993dd53411 Mon Sep 17 00:00:00 2001 From: WrenIX Date: Tue, 12 Nov 2024 12:15:09 +0100 Subject: [PATCH] fix(matrix-sliding-sync): add README in markdown --- matrix-sliding-sync/Chart.yaml | 2 +- matrix-sliding-sync/README.adoc | 2 +- matrix-sliding-sync/README.md | 108 ++++++++++++++++++++++++++++++++ 3 files changed, 110 insertions(+), 2 deletions(-) create mode 100644 matrix-sliding-sync/README.md diff --git a/matrix-sliding-sync/Chart.yaml b/matrix-sliding-sync/Chart.yaml index c9f2534..06c81bd 100644 --- a/matrix-sliding-sync/Chart.yaml +++ b/matrix-sliding-sync/Chart.yaml @@ -4,7 +4,7 @@ name: matrix-sliding-sync description: Proxy implementation of MSC3575's sync protocol. icon: https://matrix.org/images/matrix-logo.svg type: application -version: 0.2.1 +version: "0.2.2" # renovate: image=ghcr.io/matrix-org/sliding-sync appVersion: "0.99.19" maintainers: diff --git a/matrix-sliding-sync/README.adoc b/matrix-sliding-sync/README.adoc index 6ee9361..37179ba 100644 --- a/matrix-sliding-sync/README.adoc +++ b/matrix-sliding-sync/README.adoc @@ -2,7 +2,7 @@ = matrix-sliding-sync -image::https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square[Version: 0.2.1] +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 diff --git a/matrix-sliding-sync/README.md b/matrix-sliding-sync/README.md new file mode 100644 index 0000000..422c3f3 --- /dev/null +++ b/matrix-sliding-sync/README.md @@ -0,0 +1,108 @@ +--- +title: "matrix-sliding-sync" + +description: "Proxy implementation of MSC3575's sync protocol." + +--- + +# matrix-sliding-sync + +![Version: 0.2.2](https://img.shields.io/badge/Version-0.2.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.99.19](https://img.shields.io/badge/AppVersion-0.99.19-informational?style=flat-square) + +Proxy implementation of MSC3575's sync protocol. + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| WrenIX | | | + +## Usage + +Helm must be installed and setup to your kubernetes cluster to use the charts. +Refer to Helm's [documentation](https://helm.sh/docs) to get started. +Once Helm has been set up correctly, fetch the charts as follows: + +```bash +helm pull oci://codeberg.org/wrenix/helm-charts/matrix-sliding-sync +``` + +You can install a chart release using the following command: + +```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: + +```bash +helm uninstall matrix-sliding-sync-release +``` + +## 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 [helm-docs](https://github.com/norwoodj/helm-docs)