Add documentation for Fitbit connector and rest-sources-authorizer

.helmdocsignore

@@ -3,13 +3,10 @@ charts/cert-manager/
 charts/kafka-manager/
 charts/kube-prometheus-stack/
 charts/radar-backend/
-charts/radar-fitbit-connector/
 charts/radar-gateway/
 charts/radar-integration/
 charts/radar-jdbc-connector/
 charts/radar-output/
-charts/radar-rest-sources-authorizer/
-charts/radar-rest-sources-backend/
 charts/radar-s3-connector/
 charts/radar-upload-connect-backend/
 charts/radar-upload-connect-frontend/

charts/radar-fitbit-connector/Chart.yaml

@@ -1,10 +1,16 @@
 apiVersion: v1
 appVersion: "1.0"
-description: A Helm chart for Kubernetes
+description: A Helm chart for RADAR-base fitbit connector
 name: radar-fitbit-connector
 version: 0.1.1
+sources: ["https://github.com/RADAR-base/RADAR-REST-Connector"]
+deprecated: false
+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

charts/radar-fitbit-connector/README.md

@@ -0,0 +1,63 @@
+
+
+# radar-fitbit-connector
+
+![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: 1.0](https://img.shields.io/badge/AppVersion-1.0-informational?style=flat-square)
+
+A Helm chart for RADAR-base fitbit connector
+
+**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-REST-Connector>
+
+## Prerequisites
+* Kubernetes 1.17+
+* Kubectl 1.17+
+* Helm 3.1.0+
+* PV provisioner support in the underlying infrastructure
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| replicaCount | int | `1` | Number of radar-fitbit-connector replicas to deploy |
+| image.repository | string | `"radarbase/kafka-connect-rest-fitbit-source"` | radar-fitbit-connector image repository |
+| image.tag | string | `"0.3.3"` | radar-fitbit-connector image tag (immutable tags are recommended) Overrides the image tag whose default is the chart appVersion. |
+| image.pullPolicy | string | `"IfNotPresent"` | radar-fitbit-connector image pull policy |
+| nameOverride | string | `""` | String to partially override radar-fitbit-connector.fullname template with a string (will prepend the release name) |
+| fullnameOverride | string | `""` | String to fully override radar-fitbit-connector.fullname template with a string |
+| service.type | string | `"ClusterIP"` | Kubernetes Service type |
+| service.port | int | `8083` | radar-fitbit-connector port |
+| ingress.enabled | bool | `false` | Enable ingress controller resource |
+| ingress.annotations | object | `{}` | Annotations to define default ingress class, certificate issuer |
+| ingress.hosts | list | check values.yaml | Hosts to listen to incoming requests |
+| ingress.tls | list | `[]` | TLS secrets for certificates |
+| resources.requests | object | `{"cpu":"100m","memory":"1Gi"}` | CPU/Memory resource requests |
+| persistence.enabled | bool | `true` | Enable persistence using PVC |
+| persistence.accessMode | string | `"ReadWriteOnce"` | PVC Access Mode for radar-fitbit-connector volume |
+| persistence.size | string | `"5Gi"` | PVC Storage Request for radar-fitbit-connector volume |
+| nodeSelector | object | `{}` | Node labels for pod assignment |
+| tolerations | list | `[]` | Toleration labels for pod assignment |
+| affinity | object | `{}` | Affinity labels for pod assignment |
+| zookeeper | string | `"cp-zookeeper-headless:2181"` | URI of Zookeeper instances of the cluster |
+| kafka | string | `"PLAINTEXT://cp-kafka-headless:9092"` | URI of Kafka brokers of the cluster |
+| kafka_num_brokers | string | `"3"` | Number of Kafka brokers. This is used to validate the cluster availability at connector init. |
+| schema_registry | string | `"http://cp-schema-registry:8081"` | URL of the Kafka schema registry |
+| radar_rest_sources_backend_url | string | `"http://radar-rest-sources-backend:8080/rest-sources/backend/"` | Base URL of the rest-sources-authorizer-backend service |
+| connector_num_tasks | string | `"5"` | Number of connector tasks to be used in connector.properties |
+| fitbit_api_client | string | `""` | Fitbit API client id. |
+| fitbit_api_secret | string | `""` | Fitbit API client secret. |
+| oauthClientId | string | `"radar_fitbit_connector"` | OAuth2 client id from Management Portal |
+| oauthClientSecret | string | `"secret"` | OAuth2 client secret from Management Portal |
+| managementportal_host | string | `"management-portal"` | Hostname of Management Portal. This will be used to create URLs to access Management Portal |
+| includeIntradayData | bool | `true` | Set to true, if intraday access data should be collected by the connector. This will be set in connector.properties. |

charts/radar-fitbit-connector/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.prerequisiteswithpv" . }}
+
+{{ template "chart.valuesSection" . }}

charts/radar-fitbit-connector/values.yaml

@@ -1,29 +1,44 @@
 # Default values for radar-fitbit-connector.
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
+
+# -- Number of radar-fitbit-connector replicas to deploy
 replicaCount: 1
 
 image:
+  # -- radar-fitbit-connector image repository
   repository: radarbase/kafka-connect-rest-fitbit-source
+  # -- radar-fitbit-connector image tag (immutable tags are recommended)
+  # Overrides the image tag whose default is the chart appVersion.
   tag: 0.3.3
+  # -- radar-fitbit-connector image pull policy
   pullPolicy: IfNotPresent
 
+# -- String to partially override radar-fitbit-connector.fullname template with a string (will prepend the release name)
 nameOverride: ""
+# -- String to fully override radar-fitbit-connector.fullname template with a string
 fullnameOverride: ""
 
 service:
+  # -- Kubernetes Service type
   type: ClusterIP
+  # -- radar-fitbit-connector port
   port: 8083
 
 ingress:
+  # -- Enable ingress controller resource
   enabled: false
+  # -- Annotations to define default ingress class, certificate issuer
   annotations: {}
     # kubernetes.io/ingress.class: nginx
     # kubernetes.io/tls-acme: "true"
+
+  # -- Hosts to listen to incoming requests
+  # @default -- check values.yaml
   hosts:
     - host: chart-example.local
       paths: []
-
+  # -- TLS secrets for certificates
   tls: []
   #  - secretName: chart-example-tls
   #    hosts:
@@ -37,11 +52,14 @@ resources:
   # limits:
   #   cpu: 100m
   #   memory: 128Mi
+
+  # -- CPU/Memory resource requests
   requests:
     cpu: 100m
     memory: 1Gi
 
 persistence:
+  # -- Enable persistence using PVC
   enabled: true
   ## If defined, storageClassName: <storageClass>
   ## If set to "-", storageClassName: "", which disables dynamic provisioning
@@ -54,27 +72,44 @@ persistence:
   ## If you want to reuse an existing claim, you can pass the name of the PVC using
   ## the existingClaim variable
   # existingClaim: your-claim
+
+  # -- PVC Access Mode for radar-fitbit-connector volume
   accessMode: ReadWriteOnce
+  # -- PVC Storage Request for radar-fitbit-connector volume
   size: 5Gi
 
+# -- Node labels for pod assignment
 nodeSelector: {}
 
+# -- Toleration labels for pod assignment
 tolerations: []
 
+# -- Affinity labels for pod assignment
 affinity: {}
 
+# -- URI of Zookeeper instances of the cluster
 zookeeper: cp-zookeeper-headless:2181
+# -- URI of Kafka brokers of the cluster
 kafka: PLAINTEXT://cp-kafka-headless:9092
+# -- Number of Kafka brokers. This is used to validate the cluster availability at connector init.
 kafka_num_brokers: "3"
+# -- URL of the Kafka schema registry
 schema_registry: http://cp-schema-registry:8081
 
+# -- Base URL of the rest-sources-authorizer-backend service
 radar_rest_sources_backend_url: http://radar-rest-sources-backend:8080/rest-sources/backend/
+# -- Number of connector tasks to be used in connector.properties
 connector_num_tasks: "5"
-
+# -- Fitbit API client id.
 fitbit_api_client: ""
+# -- Fitbit API client secret.
 fitbit_api_secret: ""
 
+# -- OAuth2 client id from Management Portal
 oauthClientId: radar_fitbit_connector
+# -- OAuth2 client secret from Management Portal
 oauthClientSecret: secret
+# -- Hostname of Management Portal. This will be used to create URLs to access Management Portal
 managementportal_host: management-portal
+# -- Set to true, if intraday access data should be collected by the connector. This will be set in connector.properties.
 includeIntradayData: true

charts/radar-rest-sources-authorizer/Chart.yaml

@@ -1,10 +1,16 @@
 apiVersion: v1
 appVersion: "3.2.0"
-description: A Helm chart for Kubernetes
+description: A Helm chart for the front-end application of RADAR-base Rest Sources Authorizer
 name: radar-rest-sources-authorizer
 version: 0.2.0
+sources: ["https://github.com/RADAR-base/RADAR-Rest-Source-Auth"]
+deprecated: false
+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

charts/radar-rest-sources-authorizer/README.md

@@ -0,0 +1,50 @@
+
+
+# radar-rest-sources-authorizer
+
+![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.2.0](https://img.shields.io/badge/AppVersion-3.2.0-informational?style=flat-square)
+
+A Helm chart for the front-end application of RADAR-base Rest Sources Authorizer
+
+**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-Rest-Source-Auth>
+
+## Prerequisites
+* Kubernetes 1.17+
+* Kubectl 1.17+
+* Helm 3.1.0+
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| replicaCount | int | `2` | Number of radar-fitbit-connector replicas to deploy |
+| image.repository | string | `"radarbase/radar-rest-source-authorizer"` | radar-rest-sources-authorizer image repository |
+| image.tag | string | `"3.2.0"` | radar-rest-sources-authorizer image tag (immutable tags are recommended) Overrides the image tag whose default is the chart appVersion. |
+| image.pullPolicy | string | `"IfNotPresent"` | radar-rest-sources-authorizer image pull policy |
+| nameOverride | string | `""` | String to partially override radar-rest-sources-authorizer.fullname template with a string (will prepend the release name) |
+| fullnameOverride | string | `""` | String to fully override radar-rest-sources-authorizer.fullname template with a string |
+| service.type | string | `"ClusterIP"` | Kubernetes Service type |
+| service.port | int | `80` | radar-rest-sources-authorizer 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 | `"/rest-sources/authorizer/?(.*)"` | 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.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 |
+| clientId | string | `"radar_rest_sources_authorizer"` | OAuth2 client id of the application registered in Management Portal. It is assumed that this is a public client with empty client secret. |
+| serverName | string | `"localhost"` | Domain name of the server |

charts/radar-rest-sources-authorizer/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" . }}

charts/radar-rest-sources-authorizer/values.yaml

@@ -2,30 +2,45 @@
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
+# -- Number of radar-fitbit-connector replicas to deploy
 replicaCount: 2
 
 image:
+  # -- radar-rest-sources-authorizer image repository
   repository: radarbase/radar-rest-source-authorizer
+  # -- radar-rest-sources-authorizer image tag (immutable tags are recommended)
+  # Overrides the image tag whose default is the chart appVersion.
   tag: 3.2.0
+  # -- radar-rest-sources-authorizer image pull policy
   pullPolicy: IfNotPresent
 
+# -- String to partially override radar-rest-sources-authorizer.fullname template with a string (will prepend the release name)
 nameOverride: ""
+# -- String to fully override radar-rest-sources-authorizer.fullname template with a string
 fullnameOverride: ""
 
 service:
+  # -- Kubernetes Service type
   type: ClusterIP
+  # -- radar-rest-sources-authorizer port
   port: 80
 
 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
     nginx.ingress.kubernetes.io/rewrite-target: /$1
+  # -- Path within the url structure
   path: "/rest-sources/authorizer/?(.*)"
+  # -- Hosts to accept requests from
   hosts:
     - localhost
   tls:
+    # -- TLS Secret Name
     secretName: radar-base-tls
 
 
@@ -37,15 +52,22 @@ resources:
   # limits:
   #   cpu: 100m
   #   memory: 128Mi
+
+  # -- 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: {}
 
+# -- OAuth2 client id of the application registered in Management Portal. It is assumed that this is a public client with empty client secret.
 clientId: radar_rest_sources_authorizer
+# -- Domain name of the server
 serverName: localhost

charts/radar-rest-sources-backend/Chart.yaml

@@ -1,10 +1,16 @@
 apiVersion: v1
 appVersion: "3.2.0"
-description: A Helm chart for Kubernetes
+description: A Helm chart for the backend application of RADAR-base Rest Sources Authorizer
 name: radar-rest-sources-backend
 version: 0.2.0
+sources: ["https://github.com/RADAR-base/RADAR-Rest-Source-Auth"]
+deprecated: false
+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