From eab19f90778a0943930d2a2411e921e4e119823a Mon Sep 17 00:00:00 2001 From: Jeremy Shimko Date: Thu, 26 Sep 2024 09:33:55 -0400 Subject: [PATCH] update readme in each chart with latest details --- charts/stack-auth/README.md | 28 ++++++---- charts/svix/README.md | 106 ++++++++++++++++++++++++++++++++++++ 2 files changed, 123 insertions(+), 11 deletions(-) create mode 100644 charts/svix/README.md diff --git a/charts/stack-auth/README.md b/charts/stack-auth/README.md index 7f46917..969aa33 100644 --- a/charts/stack-auth/README.md +++ b/charts/stack-auth/README.md @@ -1,6 +1,6 @@ # Stack Auth -![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) +![Version: 0.8.1](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) A Helm chart to deploy the Stack Auth platform. @@ -34,8 +34,8 @@ helm delete stack --namespace stack | Repository | Name | Version | | --------------------------------------- | ---------- | ------- | -| `https://charts.bitnami.com/bitnami` | [postgresql](https://github.com/bitnami/charts/tree/main/bitnami/postgresql) | 15.5.32 | -| `https://jshimko.github.io/helm-charts` | [svix](../svix/) | 0.1.0 | +| `https://jshimko.github.io/helm-charts` | [postgrescluster](../postgrescluster/) | 5.6.1 | +| `https://jshimko.github.io/helm-charts` | [svix](../svix/) | 0.6.0 | ## Values @@ -48,7 +48,7 @@ helm delete stack --namespace stack | backend.autoscaling.minReplicas | int | `1` | | | backend.autoscaling.targetCPUUtilizationPercentage | int | `80` | | | backend.autoscaling.targetMemoryUtilizationPercentage | int | `95` | | -| backend.dbUrlOptions | string | `"schema=public"` | | +| backend.dbUrlOptions | string | `"schema=stack&sslmode=require&application_name=stack-auth"` | PostgresCluster connection string options. e.g. schema=stack,connection_limit=10,connect_timeout=10,pool_timeout=10 | | backend.env | list | `[]` | Backend environment variables - see available [.env](https://github.com/stack-auth/stack/blob/dev/apps/backend/.env) options | | backend.envFrom | list | `[]` | Backend environment variables from secrets or configmaps | | backend.image.pullPolicy | string | `"IfNotPresent"` | | @@ -56,7 +56,7 @@ helm delete stack --namespace stack | backend.image.tag | string | `"dev"` | | | backend.imagePullSecrets | list | `[]` | | | backend.ingress.annotations | object | `{}` | | -| backend.ingress.className | string | `""` | | +| backend.ingress.className | string | `"nginx"` | | | backend.ingress.enabled | bool | `false` | | | backend.ingress.hosts[0].host | string | `"example.com"` | | | backend.ingress.hosts[0].paths[0].path | string | `"/"` | | @@ -67,6 +67,7 @@ helm delete stack --namespace stack | backend.podAnnotations | object | `{}` | | | backend.podLabels | object | `{}` | | | backend.podSecurityContext | object | `{}` | | +| backend.postgresClusterSecret | string | `""` | optional Postgres Operator cluster secret name. This is useful if you deploy a PostgresCluster instance outside of this chart. | | backend.readinessProbe | string | `nil` | | | backend.replicaCount | int | `1` | | | backend.resources | object | `{}` | | @@ -95,7 +96,7 @@ helm delete stack --namespace stack | dashboard.image.tag | string | `"dev"` | | | dashboard.imagePullSecrets | list | `[]` | | | dashboard.ingress.annotations | object | `{}` | | -| dashboard.ingress.className | string | `""` | | +| dashboard.ingress.className | string | `"nginx"` | | | dashboard.ingress.enabled | bool | `false` | | | dashboard.ingress.hosts[0].host | string | `"example.com"` | | | dashboard.ingress.hosts[0].paths[0].path | string | `"/"` | | @@ -122,13 +123,18 @@ helm delete stack --namespace stack | dashboard.volumes | list | `[]` | | | extraTemplates | list | `[]` | Any misc extra K8s manifests you'd like to create | | fullnameOverride | string | `""` | | -| global.postgresql.auth.database | string | `"stack"` | | -| global.postgresql.auth.password | string | `"stack123"` | | -| global.postgresql.auth.username | string | `"stack"` | | | manageNamespace.enabled | bool | `false` | | | nameOverride | string | `""` | | -| postgresql.enabled | bool | `true` | | -| postgresql.fullnameOverride | string | `"stack-postgresql"` | | +| postgrescluster.annotations | object | `{}` | PostgresCluster annotations | +| postgrescluster.enabled | bool | `false` | disabled by default in case PostgresOperator is not installed in the cluster | +| postgrescluster.instances | list | `[{"dataVolumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"10Gi"}}},"name":"stack","replicas":1,"resources":{}}]` | Postgres instances | +| postgrescluster.instances[0].resources | object | `{}` | Postgres instance resources | +| postgrescluster.name | string | `"postgres-stack"` | PostgresCluster name | +| postgrescluster.pgBackRestConfig | object | `{"global":{"repo1-retention-full":"7","repo1-retention-full-type":"time"},"manual":{"options":["--type=full"],"repoName":"repo1"},"repos":[{"name":"repo1","schedules":{"differential":"0 12 * * 1-6","full":"0 12 * * 0"},"volume":{"volumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"10Gi"}}}}}]}` | | +| postgrescluster.pgBouncerReplicas | int | `1` | | +| postgrescluster.users | list | `[{"name":"postgres"},{"databases":["stack"],"name":"stack"}]` | Postgres users to create and assign access to databases | +| postgrescluster.users[0] | object | `{"name":"postgres"}` | db admin | +| postgrescluster.users[1] | object | `{"databases":["stack"],"name":"stack"}` | app user | | svix.enabled | bool | `true` | | | svix.fullnameOverride | string | `"svix"` | | | svix.postgresql.architecture | string | `"standalone"` | `standalone` or `replication` | diff --git a/charts/svix/README.md b/charts/svix/README.md new file mode 100644 index 0000000..4a498f1 --- /dev/null +++ b/charts/svix/README.md @@ -0,0 +1,106 @@ +# Svix Webhooks + +![Version: 0.6.0](https://img.shields.io/badge/Version-0.6.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) + +A Helm chart to deploy the Svix open source webhooks service. + +## Usage + +[Helm](https://helm.sh) must be installed to use this chart. Please refer to +Helm's [documentation](https://helm.sh/docs) to get started. + +Add this repo as follows: + +```sh +helm repo add jshimko https://jshimko.github.io/helm-charts +``` + +If you had already added this repo earlier, run `helm repo update` to retrieve +the latest versions. + +To install: + +```sh +helm install svix --namespace svix jshimko/svix +``` + +To uninstall: + +```sh +helm delete svix --namespace svix +``` + +## Included Dependencies + +| Repository | Name | Version | +| --------------------------------------- | ---------- | ------- | +| `https://jshimko.github.io/helm-charts` | [postgrescluster](../postgrescluster/) | 5.6.1 | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| extraTemplates | list | `[]` | | +| fullnameOverride | string | `""` | | +| nameOverride | string | `""` | | +| postgrescluster.annotations | object | `{}` | PostgresCluster annotations | +| postgrescluster.enabled | bool | `false` | disabled by default in case PostgresOperator is not installed in the cluster | +| postgrescluster.instances | list | `[{"dataVolumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"2Gi"}}},"name":"svix","replicas":1,"resources":{}}]` | Postgres instances | +| postgrescluster.instances[0].resources | object | `{}` | Postgres instance resources | +| postgrescluster.name | string | `"postgres-svix"` | PostgresCluster name | +| postgrescluster.pgBackRestConfig | object | `{"global":{"repo1-retention-full":"7","repo1-retention-full-type":"time"},"manual":{"options":["--type=full"],"repoName":"repo1"},"repos":[{"name":"repo1","schedules":{"differential":"0 12 * * 1-6","full":"0 12 * * 0"},"volume":{"volumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"10Gi"}}}}}]}` | | +| postgrescluster.pgBouncerReplicas | int | `1` | | +| postgrescluster.users | list | `[{"name":"postgres"},{"databases":["svix"],"name":"svix"}]` | Postgres users to create and assign access to databases | +| postgrescluster.users[0] | object | `{"name":"postgres"}` | db admin | +| postgrescluster.users[1] | object | `{"databases":["svix"],"name":"svix"}` | app user | +| redis.architecture | string | `"standalone"` | | +| redis.auth.enabled | bool | `false` | | +| redis.enabled | bool | `true` | | +| redis.fullnameOverride | string | `"svix-redis"` | | +| redis.master.extraFlags[0] | string | `"--save 60 500"` | | +| redis.master.extraFlags[1] | string | `"--appendonly yes"` | | +| redis.master.extraFlags[2] | string | `"--appendfsync everysec"` | | +| svix.affinity | object | `{}` | | +| svix.autoscaling.enabled | bool | `false` | | +| svix.autoscaling.maxReplicas | int | `10` | | +| svix.autoscaling.minReplicas | int | `1` | | +| svix.autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| svix.autoscaling.targetMemoryUtilizationPercentage | int | `95` | | +| svix.createJwtSecret.annotations | object | `{}` | | +| svix.createJwtSecret.enabled | bool | `false` | | +| svix.createJwtSecret.secretKey | string | `"SVIX_API_KEY"` | | +| svix.createJwtSecret.secretName | string | `"svix-jwt"` | | +| svix.dbUrlOptions | string | `"schema=svix&sslmode=require&application_name=svix"` | PostgresCluster connection string options. e.g. schema=stack,connection_limit=10,connect_timeout=10,pool_timeout=10 | +| svix.env | list | `[]` | | +| svix.envFrom | list | `[]` | | +| svix.image.pullPolicy | string | `"Always"` | | +| svix.image.repository | string | `"svix/svix-server"` | | +| svix.image.tag | string | `"latest"` | | +| svix.imagePullSecrets | list | `[]` | | +| svix.ingress.annotations | object | `{}` | | +| svix.ingress.className | string | `""` | | +| svix.ingress.enabled | bool | `false` | | +| svix.ingress.hosts[0].host | string | `"example.com"` | | +| svix.ingress.hosts[0].paths[0].path | string | `"/"` | | +| svix.ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| svix.ingress.tls | list | `[]` | | +| svix.livenessProbe | string | `nil` | | +| svix.nodeSelector | object | `{}` | | +| svix.podAnnotations | object | `{}` | | +| svix.podLabels | object | `{}` | | +| svix.podSecurityContext | object | `{}` | | +| svix.postgresClusterSecret | string | `""` | optional Postgres Operator cluster secret name. This is useful if you deploy a PostgresCluster instance outside of this chart. | +| svix.readinessProbe | string | `nil` | | +| svix.replicaCount | int | `1` | | +| svix.resources | object | `{}` | | +| svix.securityContext | object | `{}` | | +| svix.service.port | int | `8071` | | +| svix.service.type | string | `"ClusterIP"` | | +| svix.serviceAccount.annotations | object | `{}` | | +| svix.serviceAccount.automount | bool | `true` | | +| svix.serviceAccount.create | bool | `true` | | +| svix.serviceAccount.name | string | `""` | | +| svix.startupProbe | string | `nil` | | +| svix.tolerations | list | `[]` | | +| svix.volumeMounts | list | `[]` | | +| svix.volumes | list | `[]` | |