Clarify comments in values file

RADAR-base · Oct 22, 2024 · afa1ef6 · afa1ef6
1 parent 5f465c9
commit afa1ef6
Show file tree

Hide file tree

Showing 30 changed files with 44 additions and 41 deletions.
diff --git a/charts/app-config-frontend/README.md b/charts/app-config-frontend/README.md
@@ -3,7 +3,7 @@
 # app-config-frontend
 [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/app-config-frontend)](https://artifacthub.io/packages/helm/radar-base/app-config-frontend)
 
-![Version: 2.0.3](https://img.shields.io/badge/Version-2.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.2](https://img.shields.io/badge/AppVersion-0.5.2-informational?style=flat-square)
+![Version: 2.1.0](https://img.shields.io/badge/Version-2.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.2](https://img.shields.io/badge/AppVersion-0.5.2-informational?style=flat-square)
 
 A Helm chart for the frontend application of RADAR-base application config (app-config).
 
@@ -43,6 +43,8 @@ A Helm chart for the frontend application of RADAR-base application config (app-
 | securityContext | object | `{}` | Configure Appconfig containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8080` | Appconfig frontend port |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
+| advertised_protocol | string | `"https"` | The protocol in advertised URIs (https, http) |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |
 | ingress.path | string | `"/appconfig"` | Path within the url structure |

diff --git a/charts/app-config-frontend/values.yaml b/charts/app-config-frontend/values.yaml
@@ -44,9 +44,9 @@ service:
   # -- Appconfig frontend port
   port: 8080
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
-# - The protocol in advertised (return) URIs (https, http)
+# -- The protocol in advertised URIs (https, http)
 advertised_protocol: https
 
 ingress:

diff --git a/charts/app-config/README.md b/charts/app-config/README.md
@@ -45,7 +45,7 @@ A Helm chart for RADAR-base application config (app-config) backend service whic
 | securityContext | object | `{}` | Configure Appconfig containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8090` | Appconfig port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |
 | ingress.path | string | `"/appconfig/api"` | Path within the url structure |

diff --git a/charts/app-config/values.yaml b/charts/app-config/values.yaml
@@ -51,7 +51,7 @@ service:
   # -- Appconfig port
   port: 8090
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
 
 ingress:

diff --git a/charts/cc-schema-registry-proxy/README.md b/charts/cc-schema-registry-proxy/README.md
@@ -34,7 +34,7 @@ A Helm chart for Confluent Cloud schema registry proxy. This proxy service is us
 | service.type | string | `"ExternalName"` | Kubernetes Service type, |
 | service.externalName | string | `"schema-registry-domain"` | Domain name used for pointing to actual schema registry instance |
 | service.port | int | `443` | Port number to connect to Confluent platform |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |
 | ingress.path | string | `"/schema/?(.*)"` | Path within the url structure |

diff --git a/charts/cc-schema-registry-proxy/values.yaml b/charts/cc-schema-registry-proxy/values.yaml
@@ -9,7 +9,7 @@ service:
   # -- Port number to connect to Confluent platform
   port: 443
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
 
 ingress:

diff --git a/charts/data-dashboard-backend/README.md b/charts/data-dashboard-backend/README.md
@@ -40,7 +40,7 @@ API for data in the data dashboard
 | securityContext | object | `{}` | Configure container's Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `9000` | data-dashboard-backend port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.ingressClassName | string | `"nginx"` | Ingress class name |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |

diff --git a/charts/data-dashboard-backend/values.yaml b/charts/data-dashboard-backend/values.yaml
@@ -40,7 +40,7 @@ service:
   # -- data-dashboard-backend port
   port: 9000
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
 
 ingress:

diff --git a/charts/kafka-manager/README.md b/charts/kafka-manager/README.md
@@ -66,7 +66,7 @@ The following table lists the configurable parameters of the Kafka Manager chart
 | image.tag | string | `nil` | Overrides the image tag whose default is the chart appVersion. |
 | image.pullPolicy | string | `"IfNotPresent"` |  |
 | imagePullSecrets | list | `[]` | Docker registry secret names as an array |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |
 | ingress.path | string | `"/kafkamanager/"` | Path within the url structure |

diff --git a/charts/kafka-manager/values.yaml b/charts/kafka-manager/values.yaml
@@ -147,7 +147,7 @@ image:
 # -- Docker registry secret names as an array
 imagePullSecrets: []
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
 
 ingress:

diff --git a/charts/management-portal/README.md b/charts/management-portal/README.md
@@ -42,8 +42,8 @@ A Helm chart for RADAR-Base Management Portal to manage projects and participant
 | securityContext | object | `{}` | Configure management-portal containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8080` | Management Portal port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
-| advertised_protocol | string | `"https"` |  |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
+| advertised_protocol | string | `"https"` | The protocol in advertised URIs (https, http) |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |
 | ingress.path | string | `"/managementportal"` | Path within the url structure |

diff --git a/charts/management-portal/values.yaml b/charts/management-portal/values.yaml
@@ -40,9 +40,9 @@ service:
   # -- Management Portal port
   port: 8080
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
-# - The protocol in advertised (return) URIs (https, http)
+# -- The protocol in advertised URIs (https, http)
 advertised_protocol: https
 
 ingress:

diff --git a/charts/radar-appserver/README.md b/charts/radar-appserver/README.md
@@ -41,8 +41,8 @@ A Helm chart for the backend application of RADAR-base Appserver
 | securityContext | object | `{}` | Configure radar-appserver containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8080` | radar-appserver port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
-| advertised_protocol | string | `"https"` |  |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
+| advertised_protocol | string | `"https"` | The protocol in advertised URIs (https, http) |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer and session configuration |
 | ingress.path | string | `"/appserver/?(.*)"` | Path within the url structure |

diff --git a/charts/radar-appserver/values.yaml b/charts/radar-appserver/values.yaml
@@ -41,9 +41,9 @@ service:
   # -- radar-appserver port
   port: 8080
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
-# - The protocol in advertised (return) URIs (https, http)
+# -- The protocol in advertised URIs (https, http)
 advertised_protocol: https
 
 ingress:

diff --git a/charts/radar-gateway/README.md b/charts/radar-gateway/README.md
@@ -41,7 +41,7 @@ A Helm chart for RADAR-base gateway. REST Gateway to Kafka, for incoming partici
 | securityContext | object | `{}` | Configure radar-gateway containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8080` | radar-gateway port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer and deny access to sensitive URLs |
 | ingress.path | string | `"/kafka/?(.*)"` | Path within the url structure |

diff --git a/charts/radar-gateway/values.yaml b/charts/radar-gateway/values.yaml
@@ -41,7 +41,7 @@ service:
   # -- radar-gateway port
   port: 8080
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
 
 ingress:

diff --git a/charts/radar-home/README.md b/charts/radar-home/README.md
@@ -40,7 +40,7 @@ RADAR-base home page.
 | namespace | string | `"default"` | Kubernetes namespace that Appconfig is going to be deployed on |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8080` | Port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |
 | ingress.path | string | `"/"` | Path within the url structure |

diff --git a/charts/radar-home/values.yaml b/charts/radar-home/values.yaml
@@ -30,7 +30,7 @@ service:
   # -- Port
   port: 8080
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
 
 ingress:

diff --git a/charts/radar-integration/README.md b/charts/radar-integration/README.md
@@ -41,7 +41,7 @@ A Helm chart for RADAR-Base REDCap survey integration application.
 | securityContext | object | `{}` | Configure radar-integration containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8080` | radar-integration port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer and deny access to sensitive URLs |
 | ingress.path | string | `"/redcapint/?(.*)"` | Path within the url structure |

diff --git a/charts/radar-integration/values.yaml b/charts/radar-integration/values.yaml
@@ -41,7 +41,7 @@ service:
   # -- radar-integration port
   port: 8080
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
 
 ingress:

diff --git a/charts/radar-push-endpoint/README.md b/charts/radar-push-endpoint/README.md
@@ -41,7 +41,7 @@ A Helm chart for RADAR-base Push Endpoint. REST Gateway to Kafka, for incoming d
 | securityContext | object | `{}` | Configure radar-push-endpoint containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8090` | radar-push-endpoint port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer and deny access to sensitive URLs |
 | ingress.path | string | `"/push-endpoint"` | Path within the url structure |

diff --git a/charts/radar-push-endpoint/values.yaml b/charts/radar-push-endpoint/values.yaml
@@ -41,7 +41,7 @@ service:
   # -- radar-push-endpoint port
   port: 8090
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
 
 ingress:

diff --git a/charts/radar-rest-sources-authorizer/README.md b/charts/radar-rest-sources-authorizer/README.md
@@ -3,7 +3,7 @@
 # radar-rest-sources-authorizer
 [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/radar-rest-sources-authorizer)](https://artifacthub.io/packages/helm/radar-base/radar-rest-sources-authorizer)
 
-![Version: 2.0.5](https://img.shields.io/badge/Version-2.0.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.4.4](https://img.shields.io/badge/AppVersion-4.4.4-informational?style=flat-square)
+![Version: 2.1.0](https://img.shields.io/badge/Version-2.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.4.4](https://img.shields.io/badge/AppVersion-4.4.4-informational?style=flat-square)
 
 A Helm chart for the front-end application of RADAR-base Rest Sources Authorizer which is a portal to authorize the Fitbit connector to read data from Fitbit accounts.
 
@@ -42,7 +42,8 @@ A Helm chart for the front-end application of RADAR-base Rest Sources Authorizer
 | securityContext | object | `{}` | Configure radar-rest-sources-authorizer containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8080` | radar-rest-sources-authorizer port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
+| advertised_protocol | string | `"https"` | The protocol in advertised URIs (https, http) |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |
 | ingress.path | string | `"/rest-sources/authorizer"` | Path within the url structure |

diff --git a/charts/radar-rest-sources-authorizer/values.yaml b/charts/radar-rest-sources-authorizer/values.yaml
@@ -41,9 +41,9 @@ service:
   # -- radar-rest-sources-authorizer port
   port: 8080
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
-# - The protocol in advertised (return) URIs (https, http)
+# -- The protocol in advertised URIs (https, http)
 advertised_protocol: https
 
 ingress:

diff --git a/charts/radar-rest-sources-backend/README.md b/charts/radar-rest-sources-backend/README.md
@@ -43,7 +43,7 @@ A Helm chart for the backend application of RADAR-base Rest Sources Authorizer
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8080` | radar-rest-sources-backend port |
 | disable_tls | bool | `false` | Disable TLS (reconfigures Ingress) |
-| advertised_protocol | string | `"https"` |  |
+| advertised_protocol | string | `"https"` | The protocol in advertised URIs (https, http) |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer and session configuration |
 | ingress.path | string | `"/rest-sources/backend"` | Path within the url structure |

diff --git a/charts/radar-rest-sources-backend/values.yaml b/charts/radar-rest-sources-backend/values.yaml
@@ -43,7 +43,7 @@ service:
 
 # -- Disable TLS (reconfigures Ingress)
 disable_tls: false
-# - The protocol in advertised (return) URIs (https, http)
+# -- The protocol in advertised URIs (https, http)
 advertised_protocol: https
 
 ingress:

diff --git a/charts/radar-upload-connect-backend/README.md b/charts/radar-upload-connect-backend/README.md
@@ -42,8 +42,8 @@ A Helm chart for RADAR-base upload connector backend application. This applicati
 | securityContext | object | `{}` | Configure radar-upload-connect-backend containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `8085` | radar-upload-connect-backend port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
-| advertised_protocol | string | `"https"` |  |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
+| advertised_protocol | string | `"https"` | The protocol in advertised URIs (https, http) |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer and proxy settings |
 | ingress.path | string | `"/upload/api/?(.*)"` | Path within the url structure |

diff --git a/charts/radar-upload-connect-backend/values.yaml b/charts/radar-upload-connect-backend/values.yaml
@@ -41,9 +41,9 @@ service:
   # -- radar-upload-connect-backend port
   port: 8085
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
-# - The protocol in advertised (return) URIs (https, http)
+# -- The protocol in advertised URIs (https, http)
 advertised_protocol: https
 
 ingress:

diff --git a/charts/radar-upload-connect-frontend/README.md b/charts/radar-upload-connect-frontend/README.md
@@ -42,8 +42,8 @@ A Helm chart for RADAR-base upload connector frontend application that provides
 | securityContext | object | `{}` | Configure radar-upload-connect-frontend containers' Security Context |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
 | service.port | int | `80` | radar-upload-connect-frontend port |
-| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
-| advertised_protocol | string | `"https"` |  |
+| disable_tls | bool | `false` | Reconfigure Ingress to not force TLS |
+| advertised_protocol | string | `"https"` | The protocol in advertised URIs (https, http) |
 | ingress.enabled | bool | `true` | Enable ingress controller resource |
 | ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |
 | ingress.path | string | `"/upload/?(.*)"` | Path within the url structure |

diff --git a/charts/radar-upload-connect-frontend/values.yaml b/charts/radar-upload-connect-frontend/values.yaml
@@ -41,9 +41,9 @@ service:
   # -- radar-upload-connect-frontend port
   port: 80
 
-# -- Disable TLS (reconfigures Ingress and sets URLs to use HTTP)
+# -- Reconfigure Ingress to not force TLS
 disable_tls: false
-# - The protocol in advertised (return) URIs (https, http)
+# -- The protocol in advertised URIs (https, http)
 advertised_protocol: https
 
 ingress: