update docs

colearendt · Jul 29, 2023 · 7fb27a9 · 7fb27a9
1 parent 203098b
commit 7fb27a9
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 8 deletions.
diff --git a/charts/postgrest/Chart.yaml b/charts/postgrest/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: postgrest
 description: A Helm chart for deploying Postgrest to Kubernetes
 type: application
-version: 0.3.4
+version: 0.3.5
 appVersion: v11.1.0
 icon: https://avatars.githubusercontent.com/u/15115011?s=200&v=4
 maintainers:

diff --git a/charts/postgrest/NEWS.md b/charts/postgrest/NEWS.md
@@ -1,3 +1,7 @@
+# 0.3.5
+
+- Make values `postgrest.dbUri` and `postgrest.jwtSecret` required
+
 # 0.3.4
 
 - Add configuration for the `pod.adminPort` and `service.adminPort`

diff --git a/charts/postgrest/README.md b/charts/postgrest/README.md
@@ -1,14 +1,14 @@
 # postgrest
 
-![Version: 0.3.4](https://img.shields.io/badge/Version-0.3.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v11.1.0](https://img.shields.io/badge/AppVersion-v11.1.0-informational?style=flat-square)
+![Version: 0.3.5](https://img.shields.io/badge/Version-0.3.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v11.1.0](https://img.shields.io/badge/AppVersion-v11.1.0-informational?style=flat-square)
 
 ## Installing the Chart
 
-To install the chart with the release name `my-release` at version 0.3.4:
+To install the chart with the release name `my-release` at version 0.3.5:
 
 ```bash
 helm repo add colearendt https://colearendt.github.io/helm
-helm install my-release colearendt/postgrest --version=0.3.4
+helm install my-release colearendt/postgrest --version=0.3.5
 ```
 
 #### _A Helm chart for deploying Postgrest to Kubernetes_
@@ -57,9 +57,9 @@ helm install my-release colearendt/postgrest --version=0.3.4
 | postgrest.dbPool | string | `""` |  |
 | postgrest.dbPoolTimeout | string | `""` |  |
 | postgrest.dbSchema | string | `""` |  |
-| postgrest.dbUri | string | `""` |  |
+| postgrest.dbUri | string | `""` | The dbUri for connecting to the database. Required |
 | postgrest.jwtAud | string | `""` |  |
-| postgrest.jwtSecret | string | `""` |  |
+| postgrest.jwtSecret | string | `""` | The JWT Secret used for constructing JWTs. Required |
 | postgrest.maxRows | string | `""` |  |
 | postgrest.openApiServerProxyUri | string | `""` |  |
 | postgrest.preRequest | string | `""` |  |

diff --git a/charts/postgrest/templates/secret.yaml b/charts/postgrest/templates/secret.yaml
@@ -5,9 +5,9 @@ metadata:
   namespace: {{ $.Release.Namespace }}
 stringData:
   db-uri.txt: |-
-    {{- required "Missing postgrest.dbUri" .Values.postgrest.dbUri | nindent 4 }}
+    {{- required "Missing required value postgrest.dbUri" .Values.postgrest.dbUri | nindent 4 }}
   jwt-secret.txt: |-
-    {{- required "postgrest.jwtSecret" .Values.postgrest.jwtSecret | nindent 4 }}
+    {{- required "Missing required value postgrest.jwtSecret" .Values.postgrest.jwtSecret | nindent 4 }}
   {{- if .Values.secret }}
     {{- toYaml .Values.secret | nindent 2 }}
   {{- end }}
diff --git a/charts/postgrest/values.yaml b/charts/postgrest/values.yaml
@@ -41,6 +41,7 @@ command: []
 args: []
 
 postgrest:
+  # -- The dbUri for connecting to the database. Required
   dbUri: ""
   dbSchema: ""
   dbAnonRole: ""
@@ -52,6 +53,7 @@ postgrest:
   serverHost: ""
   serverPort: "9000"
   openApiServerProxyUri: ""
+  # -- The JWT Secret used for constructing JWTs. Required
   jwtSecret: ""
   secretIsBase64: ""
   jwtAud: ""