RADAR-base · nivemaham · Aug 9, 2021 · Jul 28, 2021 · Aug 3, 2021 · Aug 3, 2021
diff --git a/.helmdocsignore b/.helmdocsignore
@@ -0,0 +1,16 @@
+charts/cc-schema-registry-proxy/
+charts/cert-manager/
+charts/kafka-manager/
+charts/kube-prometheus-stack/
+charts/radar-backend/
+charts/radar-gateway/
+charts/radar-integration/
+charts/radar-jdbc-connector/
+charts/radar-output/
+charts/radar-s3-connector/
+charts/radar-upload-connect-backend/
+charts/radar-upload-connect-frontend/
+charts/radar-upload-source-connector/
+charts/s3-proxy/
+charts/smtp/
+charts/velero/
diff --git a/Makefile b/Makefile
@@ -0,0 +1,7 @@
+.PHONY: gen
+gen: gen-chart-doc
+
+.PHONY: gen-chart-doc
+gen-chart-doc:
+	@echo "Generate chart docs"
+	@helm-docs -s file --template-files=charts/_templates.gotmpl --template-files=DOCS.md.gotmpl --template-files=README.md.gotmpl
diff --git a/charts/_templates.gotmpl b/charts/_templates.gotmpl
@@ -0,0 +1,14 @@
+{{ define "common.prerequisites" -}}
+## Prerequisites
+* Kubernetes 1.17+
+* Kubectl 1.17+
+* Helm 3.1.0+
+{{- end }}
+
+{{ define "common.prerequisiteswithpv" -}}
+## Prerequisites
+* Kubernetes 1.17+
+* Kubectl 1.17+
+* Helm 3.1.0+
+* PV provisioner support in the underlying infrastructure
+{{- end }}
diff --git a/charts/app-config-frontend/Chart.yaml b/charts/app-config-frontend/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: app-config-frontend
-description: A Helm chart for Kubernetes
+description: A Helm chart for the frontend application of RADAR-base application config
 
 # A chart can be either an 'application' or a 'library' chart.
 #
@@ -21,8 +21,12 @@ version: 0.1.1
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 appVersion: 0.3.2
+sources: ["https://github.com/RADAR-base/radar-app-config"]
+home: "https://radar-base.org"
 maintainers:
   - email: [email protected]
     name: Keyvan Hedayati
   - email: [email protected]
     name: Joris Borgdorff
+  - email: [email protected]
+    name: Nivethika Mahasivam
diff --git a/charts/app-config-frontend/DOCS.md.gotmpl b/charts/app-config-frontend/DOCS.md.gotmpl
diff --git a/charts/app-config-frontend/README.md b/charts/app-config-frontend/README.md
@@ -0,0 +1,55 @@
+
+
+# app-config-frontend
+
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.2](https://img.shields.io/badge/AppVersion-0.3.2-informational?style=flat-square)
+
+A Helm chart for the frontend application of RADAR-base application config
+
+**Homepage:** <https://radar-base.org>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Keyvan Hedayati | [email protected] |  |
+| Joris Borgdorff | [email protected] |  |
+| Nivethika Mahasivam | [email protected] |  |
+
+## Source Code
+
+* <https://github.com/RADAR-base/radar-app-config>
+
+## Prerequisites
+* Kubernetes 1.17+
+* Kubectl 1.17+
+* Helm 3.1.0+
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| replicaCount | int | `2` | Number of Appconfig frontend replicas to deploy |
+| image.repository | string | `"radarbase/radar-app-config-frontend"` | Appconfig frontend image repository |
+| image.tag | string | `"0.3.2"` | Appconfig frontend image tag (immutable tags are recommended) Overrides the image tag whose default is the chart appVersion. |
+| image.pullPolicy | string | `"IfNotPresent"` | Appconfig frontend image pull policy |
+| imagePullSecrets | list | `[]` | Docker registry secret names as an array |
+| nameOverride | string | `""` | String to partially override app-config-frontend.fullname template with a string (will prepend the release name) |
+| fullnameOverride | string | `""` | String to fully override app-config-frontend.fullname template with a string |
+| podAnnotations | object | `{}` | Annotations for Appconfig frontend pods |
+| podSecurityContext | object | `{}` | Configure Appconfig pods' Security Context |
+| securityContext | object | `{}` | Configure Appconfig containers' Security Context |
+| service.type | string | `"ClusterIP"` | Kubernetes Service type |
+| service.port | int | `8080` | Appconfig frontend port |
+| ingress.enabled | bool | `true` | Enable ingress controller resource |
+| ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer |
+| ingress.hosts[0] | object | `{"paths":["/appconfig($|/)(.*)"]}` | Path within the url structure |
+| ingress.tls | list | `[]` | Utilize TLS backend in ingress |
+| resources.limits | object | `{"cpu":"200m","memory":"512Mi"}` | CPU/Memory resource limits |
+| resources.requests | object | `{"cpu":"100m","memory":"128Mi"}` | CPU/Memory resource requests |
+| nodeSelector | object | `{}` | Node labels for pod assignment |
+| tolerations | list | `[]` | Toleration labels for pod assignment |
+| affinity | object | `{}` | Affinity labels for pod assignment |
+| authUrl | string | `"http://localhost/managementportal/oauth"` | Authorization URL of the IDP |
+| authCallbackUrl | string | `"http://localhost/appconfig/login"` | Callback URL to where authorization-code should be returned |
+| backendUrl | string | `"/appconfig/api"` | Base-URL of the App Config backend service |
diff --git a/charts/app-config-frontend/README.md.gotmpl b/charts/app-config-frontend/README.md.gotmpl
@@ -0,0 +1,16 @@
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "common.prerequisites" . }}
+
+{{ template "chart.valuesSection" . }}
diff --git a/charts/app-config-frontend/values.yaml b/charts/app-config-frontend/values.yaml
@@ -2,23 +2,34 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
-replicaCount: 1
+# -- Number of Appconfig frontend replicas to deploy
+replicaCount: 2
 
 image:
+  # -- Appconfig frontend image repository
   repository: radarbase/radar-app-config-frontend
-  pullPolicy: IfNotPresent
+  # -- Appconfig frontend image tag (immutable tags are recommended)
   # Overrides the image tag whose default is the chart appVersion.
   tag: 0.3.2
+  # -- Appconfig frontend image pull policy
+  pullPolicy: IfNotPresent
 
+# -- Docker registry secret names as an array
 imagePullSecrets: []
+
+# -- String to partially override app-config-frontend.fullname template with a string (will prepend the release name)
 nameOverride: ""
+# -- String to fully override app-config-frontend.fullname template with a string
 fullnameOverride: ""
 
+# -- Annotations for Appconfig frontend pods
 podAnnotations: {}
 
+# -- Configure Appconfig pods' Security Context
 podSecurityContext: {}
   # fsGroup: 2000
 
+# -- Configure Appconfig containers' Security Context
 securityContext: {}
   # capabilities:
   #   drop:
@@ -28,40 +39,57 @@ securityContext: {}
   # runAsUser: 1000
 
 service:
+  # -- Kubernetes Service type
   type: ClusterIP
+  # -- Appconfig frontend port
   port: 8080
 
 ingress:
+  # -- Enable ingress controller resource
   enabled: true
+  # -- Annotations that define default ingress class, certificate issuer
+  # @default -- check values.yaml
   annotations:
     kubernetes.io/ingress.class: nginx
     cert-manager.io/cluster-issuer: letsencrypt-prod
   hosts:
+    # -- Path within the url structure
     - paths:
-        - "/appconfig($|/)(.*)"
+        - '/appconfig($|/)(.*)'
+
+  # -- Utilize TLS backend in ingress
   tls: []
   #  - secretName: chart-example-tls
   #    hosts:
   #      - chart-example.local
 
-resources: {}
+resources:
   # We usually recommend not to specify default resources and to leave this as a conscious
   # choice for the user. This also increases chances charts run on environments with little
   # resources, such as Minikube. If you do want to specify resources, uncomment the following
   # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
-  # limits:
-  #   cpu: 100m
-  #   memory: 128Mi
-  # requests:
-  #   cpu: 100m
-  #   memory: 128Mi
 
+  # -- CPU/Memory resource limits
+  limits:
+    cpu: 200m
+    memory: 512Mi
+  # -- CPU/Memory resource requests
+  requests:
+    cpu: 100m
+    memory: 128Mi
+
+# -- Node labels for pod assignment
 nodeSelector: {}
 
+# -- Toleration labels for pod assignment
 tolerations: []
 
+# -- Affinity labels for pod assignment
 affinity: {}
 
+# -- Authorization URL of the IDP
 authUrl: http://localhost/managementportal/oauth
+# -- Callback URL to where authorization-code should be returned
 authCallbackUrl: http://localhost/appconfig/login
+# -- Base-URL of the App Config backend service
 backendUrl: /appconfig/api
diff --git a/charts/app-config/Chart.yaml b/charts/app-config/Chart.yaml
@@ -1,10 +1,15 @@
 apiVersion: v1
 appVersion: "0.3.2"
-description: A Helm chart for Kubernetes
+description: A Helm chart for RADAR-base application config (app-config) backend service
 name: app-config
 version: 0.1.1
+sources: ["https://github.com/RADAR-base/radar-app-config"]
+type: application
+home: "https://radar-base.org"
 maintainers:
   - email: [email protected]
     name: Keyvan Hedayati
   - email: [email protected]
     name: Joris Borgdorff
+  - email: [email protected]
+    name: Nivethika Mahasivam
diff --git a/charts/app-config/DOCS.md.gotmpl b/charts/app-config/DOCS.md.gotmpl
diff --git a/charts/app-config/README.md b/charts/app-config/README.md
@@ -0,0 +1,63 @@
+
+
+# app-config
+
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.2](https://img.shields.io/badge/AppVersion-0.3.2-informational?style=flat-square)
+
+A Helm chart for RADAR-base application config (app-config) backend service
+
+**Homepage:** <https://radar-base.org>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Keyvan Hedayati | [email protected] |  |
+| Joris Borgdorff | [email protected] |  |
+| Nivethika Mahasivam | [email protected] |  |
+
+## Source Code
+
+* <https://github.com/RADAR-base/radar-app-config>
+
+## Prerequisites
+* Kubernetes 1.17+
+* Kubectl 1.17+
+* Helm 3.1.0+
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| replicaCount | int | `2` | Number of Appconfig replicas to deploy |
+| image.repository | string | `"radarbase/radar-app-config"` | Appconfig image repository |
+| image.tag | string | `"0.3.2"` | Appconfig image tag (immutable tags are recommended) |
+| image.pullPolicy | string | `"IfNotPresent"` | Appconfig image pull policy |
+| imagePullSecrets | list | `[]` | Docker registry secret names as an array |
+| nameOverride | string | `""` | String to partially override management-portal.fullname template with a string (will prepend the release name) |
+| fullnameOverride | string | `""` | String to fully override management-portal.fullname template with a string |
+| namespace | string | `"default"` | Kubernetes namespace that Appconfig is going to be deployed on |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| serviceAccount.name | string | `nil` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+| podSecurityContext | object | `{}` | Configure Appconfig pods' Security Context |
+| securityContext | object | `{}` | Configure Appconfig containers' Security Context |
+| service.type | string | `"ClusterIP"` | Kubernetes Service type |
+| service.port | int | `8090` | Appconfig port |
+| 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 |
+| ingress.hosts | list | `["localhost"]` | Hosts to accept requests from |
+| ingress.tls.secretName | string | `"radar-base-tls"` | TLS Secret Name |
+| resources.limits | object | `{"cpu":2}` | CPU/Memory resource limits |
+| resources.requests | object | `{"cpu":"100m","memory":"768Mi"}` | CPU/Memory resource requests |
+| nodeSelector | object | `{}` | Node labels for pod assignment |
+| tolerations | list | `[]` | Toleration labels for pod assignment |
+| affinity | object | `{}` | Affinity labels for pod assignment |
+| javaOpts | string | `"-Xmx550m"` | Standard JAVA_OPTS that should be passed to this service |
+| clientId | string | `"radar_appconfig"` | OAuth2 client id |
+| clientSecret | string | `"secret"` | OAuth2 client secret |
+| jdbc.driver | string | `"org.postgresql.Driver"` | JDBC Driver to connect to the database. |
+| jdbc.url | string | `"jdbc:postgresql://postgresql:5432/appconfig"` | JDBC Connection url of the database. |
+| jdbc.user | string | `"postgres"` | Username of the database |
+| jdbc.password | string | `"password"` | Password of the user |
+| jdbc.dialect | string | `"org.hibernate.dialect.PostgreSQLDialect"` | JDBC dialect to use for JDBC Connection |
diff --git a/charts/app-config/README.md.gotmpl b/charts/app-config/README.md.gotmpl
@@ -0,0 +1,16 @@
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "common.prerequisites" . }}
+
+{{ template "chart.valuesSection" . }}