Skip to content

Commit

Permalink
update readme in each chart with latest details
Browse files Browse the repository at this point in the history
  • Loading branch information
jshimko committed Sep 26, 2024
1 parent a906d0a commit eab19f9
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 11 deletions.
28 changes: 17 additions & 11 deletions charts/stack-auth/README.md
Original file line number Diff line number Diff line change
@@ -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. <https://stack-auth.com>

Expand Down Expand Up @@ -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

Expand All @@ -48,15 +48,15 @@ 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"` | |
| backend.image.repository | string | `"jshimko/stack-backend"` | |
| 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 | `"/"` | |
Expand All @@ -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 | `{}` | <https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/> |
Expand Down Expand Up @@ -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 | `"/"` | |
Expand All @@ -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"}}}}}]}` | <https://access.crunchydata.com/documentation/postgres-operator/latest/tutorials/backups-disaster-recovery/backups> |
| 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` |
Expand Down
106 changes: 106 additions & 0 deletions charts/svix/README.md
Original file line number Diff line number Diff line change
@@ -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. <https://www.svix.com>

## 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"}}}}}]}` | <https://access.crunchydata.com/documentation/postgres-operator/latest/tutorials/backups-disaster-recovery/backups> |
| 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 | `[]` | |

0 comments on commit eab19f9

Please sign in to comment.