Upgrade [helm-docs](https://github.com/norwoodj/helm-docs) to 1.13.1 …

…& re-generate docs
magda-io · May 24, 2024 · 028509e · 028509e
1 parent 562124a
commit 028509e
Show file tree

Hide file tree

Showing 32 changed files with 45 additions and 43 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -595,7 +595,7 @@ buildtest:helm-docs-check:
     - docker:dind
   script:
     - code=0
-    - docker run --rm -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.5.0 || code=$?;
+    - docker run --rm -v "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.13.1 || code=$?;
       if [ "$code" != "0" ]; then 
         echo "Failed to run helm-docs!";
         exit 1;
@@ -605,7 +605,7 @@ buildtest:helm-docs-check:
     - git ls-files -m | grep -i readme.md || code=$?;
       if [ "$code" == "0" ]; then
         echo -e "Some of helm chart docs are required to be updated using the [helm-docs](https://github.com/norwoodj/helm-docs) tool. \n
-        Please run helm-docs (v1.5.0) at project root, review & commit docs changes and push a new commit.";
+        Please run helm-docs (v1.13.1) at project root, review & commit docs changes and push a new commit.";
         exit 1;
       else 
         echo -e "helm docs check passed. helm docs update is not required.";

diff --git a/CHANGES.md b/CHANGES.md
@@ -6,6 +6,7 @@
 - Allow supply extra K8s manifests to deploy via `magda-core` `.Values.extraObjects`
 - #3337 Stop releasing helm charts to charts.magda.io. Since v2, we started to release charts to Github container OCI registry
 - #3337 Make all helm charts use github container registry `ghcr.io/magda-io`
+- Upgrade [helm-docs](https://github.com/norwoodj/helm-docs) to 1.13.1
 
 ## v3.0.4
 

diff --git a/deploy/helm/internal-charts/admin-api/README.md b/deploy/helm/internal-charts/admin-api/README.md
@@ -26,4 +26,4 @@ Kubernetes: `>= 1.14.0-0`
 | skipAuth | bool | `false` | when set to true, API will not query policy engine for auth decision but assume it's always permitted.  It's for debugging only. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/apidocs-server/README.md b/deploy/helm/internal-charts/apidocs-server/README.md
@@ -21,4 +21,4 @@ Kubernetes: `>= 1.14.0-0`
 | resources.requests.memory | string | `"10Mi"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/authorization-api/README.md b/deploy/helm/internal-charts/authorization-api/README.md
@@ -38,4 +38,4 @@ Kubernetes: `>= 1.14.0-0`
 | skipAuth | bool | `false` | when set to true, API will not query policy engine for auth decision but assume it's always permitted.  It's for debugging only. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/authorization-db/README.md b/deploy/helm/internal-charts/authorization-db/README.md
@@ -29,4 +29,4 @@ Kubernetes: `>= 1.14.0-0`
 | migratorBackoffLimit | int | `6` | No. of retries before the migrator job is considered as failed. Failed Pods associated with the Job are recreated by the Job controller with an exponential back-off delay (10s, 20s, 40s ...) capped at six minutes. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/cloud-sql-proxy/README.md b/deploy/helm/internal-charts/cloud-sql-proxy/README.md
@@ -63,7 +63,7 @@ kubectl -n [Magda Deploy Namespace] create secret generic cloudsql-instance-cred
 | image.pullSecrets | bool | `false` |  |
 | image.repository | string | `"gcr.io/cloudsql-docker"` |  |
 | image.tag | string | `"1.33.2-alpine"` |  |
-| ipAddressTypes | string | `nil` | A comma-delimited list of preferred IP types for connecting to an instance.  For example, setting this to PRIVATE will force the proxy to connect to instances using an instance's associated private IP. Available from docker image 1.23.0 Options: a list of strings separated by ',', e.g. 'PUBLIC,PRIVATE' Default to 'PUBLIC,PRIVATE' |
+| ipAddressTypes | string | PUBLIC,PRIVATE | A comma-delimited list of preferred IP types for connecting to an instance.  For example, setting this to PRIVATE will force the proxy to connect to instances using an instance's associated private IP. Available from docker image 1.23.0 Options: a list of strings separated by ',', e.g. 'PUBLIC,PRIVATE' Default to 'PUBLIC,PRIVATE' |
 | logDebugStdout | bool | true | This is to log non-error output to standard out instead of standard error.  For example, if you don't want connection related messages to log as errors, set this flag to true. Available from docker image 1.23.0 |
 | maxConnections | int | 0 (no limit). | If provided, the maximum number of connections to establish before refusing new connections.  Available from docker image 1.23.0 |
 | replicas | string | `nil` | no. of replicas required for the deployment. If not set, k8s will assume `1` but allows HPA (autoscaler) alters it. @default 1 |

diff --git a/deploy/helm/internal-charts/combined-db/README.md b/deploy/helm/internal-charts/combined-db/README.md
@@ -26,4 +26,4 @@ Kubernetes: `>= 1.14.0-0`
 | magda-postgres.postgresql.resources.requests.memory | string | `"500Mi"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/content-api/README.md b/deploy/helm/internal-charts/content-api/README.md
@@ -31,4 +31,4 @@ Kubernetes: `>= 1.14.0-0`
 | skipAuth | bool | `false` | when set to true, API will not query policy engine for auth decision but assume it's always permitted.  It's for debugging only. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/content-db/README.md b/deploy/helm/internal-charts/content-db/README.md
@@ -29,4 +29,4 @@ Kubernetes: `>= 1.14.0-0`
 | migratorBackoffLimit | int | `6` | No. of retries before the migrator job is considered as failed. Failed Pods associated with the Job are recreated by the Job controller with an exponential back-off delay (10s, 20s, 40s ...) capped at six minutes. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/correspondence-api/README.md b/deploy/helm/internal-charts/correspondence-api/README.md
@@ -25,4 +25,4 @@ Kubernetes: `>= 1.14.0-0`
 | smtpPort | int | `587` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/elasticsearch/README.md b/deploy/helm/internal-charts/elasticsearch/README.md
@@ -46,4 +46,4 @@ Kubernetes: `>= 1.14.0-0`
 | production | bool | `false` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/indexer/README.md b/deploy/helm/internal-charts/indexer/README.md
@@ -14,7 +14,7 @@ Kubernetes: `>= 1.21.0`
 |-----|------|---------|-------------|
 | appConfig | object | `{"akka":{"http":{"server":{"idle-timeout":"120s","request-timeout":"90s"}}},"authApi":{"baseUrl":"http://authorization-api"},"elasticSearch":{"replicas":0,"serverUrl":"http://opensearch:9200","shards":1},"http":{"port":6103},"indexer":{"makeSnapshots":false,"readSnapshots":false},"printFullConfig":false,"registry":{"baseUrl":"http://registry-api","readOnlyBaseUrl":"http://registry-api-read-only","webhookUrl":"http://indexer/v0/registry-hook"}}` | application config. Allow to configure any application config fields. For all available configuration fields and their default values, please refer to [application.conf](https://github.com/magda-io/magda/blob/main/magda-indexer/src/main/resources/application.conf) This config field is available since v2.2.5 Previous versions' obsolete are still supported for backward compatible reason |
 | appConfig.akka.http.server.idle-timeout | string | `"120s"` | The time after which an idle connection will be automatically closed. Set to `infinite` to completely disable idle connection timeouts. |
-| appConfig.akka.http.server.request-timeout | string | `"90s"` | Defines the default time period within which the application has to produce an HttpResponse for any given HttpRequest it received. The timeout begins to run when the *end* of the request has been received, so even potentially long uploads can have a short timeout. Set to `infinite` to completely disable request timeout checking. Make sure this timeout is smaller than the idle-timeout, otherwise, the idle-timeout will kick in first and reset the TCP connection without a response. If this setting is not `infinite` the HTTP server layer attaches a `Timeout-Access` header to the request, which enables programmatic customization of the timeout period and timeout response for each request individually. |
+| appConfig.akka.http.server.request-timeout | string | `"90s"` | Defines the default time period within which the application has to produce an HttpResponse for any given HttpRequest it received. The timeout begins to run when the *end* of the request has been received, so even potentially long uploads can have a short timeout. Set to `infinite` to completely disable request timeout checking.  Make sure this timeout is smaller than the idle-timeout, otherwise, the idle-timeout will kick in first and reset the TCP connection without a response.  If this setting is not `infinite` the HTTP server layer attaches a `Timeout-Access` header to the request, which enables programmatic customization of the timeout period and timeout response for each request individually. |
 | appConfig.printFullConfig | bool | `false` | whether print out full config data at application starting up for debug purpose only |
 | autoReIndex.enable | bool | `true` | Whether turn on the cronjob to trigger reindex. `publisher` & `format` indices might contains obsolete records which require the triming / reindex process to be removed. |
 | autoReIndex.schedule | string | "0 15 * * 0": 15:00PM UTC timezone (1:00AM in AEST Sydney timezone) on every Sunday | auto reindex cronjob schedule string. specified using unix-cron format (in UTC timezone by default). |
@@ -33,4 +33,4 @@ Kubernetes: `>= 1.21.0`
 | resources.requests.memory | string | `"250Mi"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/ingress/README.md b/deploy/helm/internal-charts/ingress/README.md
@@ -18,4 +18,4 @@ Kubernetes: `>= 1.19.0-0`
 | useDefaultCertificate | bool | `false` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/magda-postgres/README.md b/deploy/helm/internal-charts/magda-postgres/README.md
@@ -59,7 +59,7 @@ More config postgreSQL related options, please refer to: https://github.com/bitn
 | postgresql.persistence.size | string | `"50Gi"` | set the persistence volume size of the postgresql statefulset |
 | postgresql.primary.extraVolumeMounts | list | `[]` | extra volume mount can be set here.  e.g. mount backup storage config secret and map as files in /etc/wal-g.d/env |
 | postgresql.primary.extraVolumes | list | `[]` | extra volumes can be set here.  e.g. map backup storage config secret as files in /etc/wal-g.d/env |
-| postgresql.primary.priorityClassName | string | `""` |  |
+| postgresql.primary.priorityClassName | string | `""` | - Set priority class of the primary database instance. When `global.enablePriorityClass` is `true`. We should set this config to "magda-9" to make sure db instance get appropriate schedule priority. By default, Magda will create priorityClassName from "magda-10" to "magda-0" where "magda-10" indicates the highest priority.  |
 | postgresql.readinessProbe.enabled | bool | `false` | `customReadinessProbe` will only be used when `enabled`=`false` Otherwise, default livenessProbe will be used. |
 | postgresql.resources | object | `{"requests":{"cpu":"200m","memory":"500Mi"}}` | Set the resource config for the postgresql container |
 
diff --git a/deploy/helm/internal-charts/opensearch-dashboards/README.md b/deploy/helm/internal-charts/opensearch-dashboards/README.md
@@ -89,4 +89,4 @@ Kubernetes: `>= 1.23.0-0`
 | topologySpreadConstraints | list | `[]` | This is the pod topology spread constraints https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/opensearch/README.md b/deploy/helm/internal-charts/opensearch/README.md
@@ -107,4 +107,4 @@ Kubernetes: `>= 1.23.0-0`
 | updateStrategy | string | `"RollingUpdate"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/rds-dev-proxy/README.md b/deploy/helm/internal-charts/rds-dev-proxy/README.md
@@ -29,4 +29,4 @@ Kubernetes: `>= 1.14.0-0`
 | resources.requests.memory | string | `"30Mi"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/registry-api/README.md b/deploy/helm/internal-charts/registry-api/README.md
@@ -42,4 +42,4 @@ Kubernetes: `>= 1.14.0-0`
 | resources.requests.memory | string | `"500Mi"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/registry-db/README.md b/deploy/helm/internal-charts/registry-db/README.md
@@ -32,4 +32,4 @@ Kubernetes: `>= 1.21.0`
 | vacuumJobImage.name | string | `"magda-postgres"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/search-api-node/README.md b/deploy/helm/internal-charts/search-api-node/README.md
@@ -25,4 +25,4 @@ Kubernetes: `>= 1.14.0-0`
 | resources.requests.memory | string | `"60Mi"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/search-api/README.md b/deploy/helm/internal-charts/search-api/README.md
@@ -32,4 +32,4 @@ Kubernetes: `>= 1.14.0-0`
 | resources.requests.memory | string | `"300Mi"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/session-db/README.md b/deploy/helm/internal-charts/session-db/README.md
@@ -29,4 +29,4 @@ Kubernetes: `>= 1.14.0-0`
 | migratorBackoffLimit | int | `6` | No. of retries before the migrator job is considered as failed. Failed Pods associated with the Job are recreated by the Job controller with an exponential back-off delay (10s, 20s, 40s ...) capped at six minutes. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/tenant-api/README.md b/deploy/helm/internal-charts/tenant-api/README.md
@@ -23,4 +23,4 @@ Kubernetes: `>= 1.14.0-0`
 | skipAuth | bool | `false` | when set to true, API will not query policy engine for auth decision but assume it's always permitted.  It's for debugging only. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/tenant-db/README.md b/deploy/helm/internal-charts/tenant-db/README.md
@@ -29,4 +29,4 @@ Kubernetes: `>= 1.14.0-0`
 | migratorBackoffLimit | int | `6` | No. of retries before the migrator job is considered as failed. Failed Pods associated with the Job are recreated by the Job controller with an exponential back-off delay (10s, 20s, 40s ...) capped at six minutes. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/internal-charts/web-server/README.md b/deploy/helm/internal-charts/web-server/README.md
@@ -115,4 +115,4 @@ Kubernetes: `>= 1.14.0-0`
 | vocabularyApiEndpoints | list | `[]` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
diff --git a/deploy/helm/local-auth-test-deployment/readme.md b/deploy/helm/local-auth-test-deployment/readme.md
@@ -1,14 +1,14 @@
 # magda-local-auth-test-deployment
 
-![Version: 3.0.1-alpha.0](https://img.shields.io/badge/Version-3.0.1--alpha.0-informational?style=flat-square)
+![Version: 3.0.4](https://img.shields.io/badge/Version-3.0.4-informational?style=flat-square)
 
 ## Requirements
 
 Kubernetes: `>= 1.14.0-0`
 
 | Repository | Name | Version |
 |------------|------|---------|
-| file://../magda-core | magda-core | 3.0.1-alpha.0 |
+| file://../magda-core | magda-core | 3.0.4 |
 
 ## Values
 
@@ -37,4 +37,4 @@ Kubernetes: `>= 1.14.0-0`
 | tags.registry-db | bool | `true` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)