Merge pull request #104 from RADAR-base/oura-connector

[radar-oura-connector] Add new radar-oura-connector chart

charts/radar-oura-connector/.helmignore

@@ -0,0 +1,22 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

charts/radar-oura-connector/Chart.yaml

@@ -0,0 +1,27 @@
+apiVersion: v2
+appVersion: "0.5.0"
+description: A Helm chart for RADAR-base oura connector. This application collects data from participants via the Oura Web API.
+name: radar-oura-connector
+version: 0.0.1
+icon: "http://radar-base.org/wp-content/uploads/2022/09/Logo_RADAR-Base-RGB.png"
+sources:
+- https://github.com/RADAR-base/radar-helm-charts/tree/main/charts/radar-oura-connector
+- https://github.com/RADAR-base/RADAR-REST-Connector
+keywords:
+  - radar-base
+  - remote-trial
+annotations:
+  artifacthub.io/license: Apache-2.0
+deprecated: false
+type: application
+home: "https://radar-base.org"
+maintainers:
+  - email: keyvan@thehyve.nl
+    name: Keyvan Hedayati
+    url: https://www.thehyve.nl
+  - email: pauline.conde@kcl.ac.uk
+    name: Pauline Conde
+    url: https://www.kcl.ac.uk/people/pauline-conde
+  - email: yatharth.ranjan@kcl.ac.uk
+    name: Yatharth Ranjan
+    url: https://www.kcl.ac.uk/people/yatharth-ranjan

charts/radar-oura-connector/README.md

@@ -0,0 +1,84 @@
+
+
+# radar-oura-connector
+[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/radar-oura-connector)](https://artifacthub.io/packages/helm/radar-base/radar-oura-connector)
+
+![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.0](https://img.shields.io/badge/AppVersion-0.5.0-informational?style=flat-square)
+
+A Helm chart for RADAR-base oura connector. This application collects data from participants via the Oura Web API.
+
+**Homepage:** <https://radar-base.org>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Keyvan Hedayati | <keyvan@thehyve.nl> | <https://www.thehyve.nl> |
+| Pauline Conde | <pauline.conde@kcl.ac.uk> | <https://www.kcl.ac.uk/people/pauline-conde> |
+| Yatharth Ranjan | <yatharth.ranjan@kcl.ac.uk> | <https://www.kcl.ac.uk/people/yatharth-ranjan> |
+
+## Source Code
+
+* <https://github.com/RADAR-base/radar-helm-charts/tree/main/charts/radar-oura-connector>
+* <https://github.com/RADAR-base/RADAR-REST-Connector>
+
+## Prerequisites
+* Kubernetes 1.22+
+* Kubectl 1.22+
+* Helm 3.1.0+
+* PV provisioner support in the underlying infrastructure
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| replicaCount | int | `1` | Number of radar-oura-connector replicas to deploy |
+| image.repository | string | `"radarbase/kafka-connect-rest-oura-source"` | radar-oura-connector image repository |
+| image.tag | string | `"0.5.0"` | radar-oura-connector image tag (immutable tags are recommended) Overrides the image tag whose default is the chart appVersion. |
+| image.pullPolicy | string | `"IfNotPresent"` | radar-oura-connector image pull policy |
+| imagePullSecrets | list | `[]` | Docker registry secret names as an array |
+| nameOverride | string | `""` | String to partially override radar-oura-connector.fullname template with a string (will prepend the release name) |
+| fullnameOverride | string | `""` | String to fully override radar-oura-connector.fullname template with a string |
+| podSecurityContext | object | `{}` | Configure radar-oura-connector pods' Security Context |
+| securityContext | object | `{}` | Configure radar-oura-connector containers' Security Context |
+| service.type | string | `"ClusterIP"` | Kubernetes Service type |
+| service.port | int | `8083` | radar-oura-connector port |
+| 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-oura-connector volume |
+| persistence.size | string | `"5Gi"` | PVC Storage Request for radar-oura-connector volume |
+| persistence.fsUserOverride | string | `nil` | Overrides the user of the oura connector logs, for example, `"1000:1000"`. |
+| nodeSelector | object | `{}` | Node labels for pod assignment |
+| tolerations | list | `[]` | Toleration labels for pod assignment |
+| affinity | object | `{}` | Affinity labels for pod assignment |
+| extraEnvVars | list | `[{"name":"CONNECT_SECURITY_PROTOCOL","value":"PLAINTEXT"}]` | Extra environment variables |
+| extraEnvVars[0] | object | `{"name":"CONNECT_SECURITY_PROTOCOL","value":"PLAINTEXT"}` | Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. |
+| customLivenessProbe | object | `{}` | Custom livenessProbe that overrides the default one |
+| livenessProbe.enabled | bool | `true` | Enable livenessProbe |
+| livenessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for livenessProbe |
+| livenessProbe.periodSeconds | int | `60` | Period seconds for livenessProbe |
+| livenessProbe.timeoutSeconds | int | `5` | Timeout seconds for livenessProbe |
+| livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe |
+| livenessProbe.failureThreshold | int | `3` | Failure threshold for livenessProbe |
+| customReadinessProbe | object | `{}` | Custom readinessProbe that overrides the default one |
+| readinessProbe.enabled | bool | `true` | Enable readinessProbe |
+| readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe |
+| readinessProbe.periodSeconds | int | `60` | Period seconds for readinessProbe |
+| readinessProbe.timeoutSeconds | int | `5` | Timeout seconds for readinessProbe |
+| readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe |
+| readinessProbe.failureThreshold | int | `3` | Failure threshold for readinessProbe |
+| networkpolicy | object | check `values.yaml` | Network policy defines who can access this application and who this applications has access to |
+| 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 |
+| kafka_wait.enabled | bool | `true` | Whether to wait before the specified number of brokers are available. |
+| kafka_wait.properties | string | `""` | Kafka connection properties file contents during wait. If empty, all environment variables starting with `CONNECT_` will be used. |
+| 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 |
+| oura_api_client | string | `""` | Oura API client id. |
+| oura_api_secret | string | `""` | Oura API client secret. |
+| oauthClientId | string | `"radar_oura_connector"` | OAuth2 client id from Management Portal |
+| oauthClientSecret | string | `"secret"` | OAuth2 client secret from Management Portal |
+| managementportal_url | string | `"http://management-portal:8080/managementportal"` | URL 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-oura-connector/README.md.gotmpl

@@ -0,0 +1,18 @@
+{{ template "common.header" . }}
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "common.prerequisiteswithpv" . }}
+
+{{ template "chart.requirementsSection" . }}
+
+{{ template "chart.valuesSection" . }}

charts/radar-oura-connector/templates/_helpers.tpl

@@ -0,0 +1,52 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "radar-oura-connector.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "radar-oura-connector.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "radar-oura-connector.labels" -}}
+helm.sh/chart: {{ include "radar-oura-connector.chart" . }}
+{{ include "radar-oura-connector.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "radar-oura-connector.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "radar-oura-connector.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "radar-oura-connector.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}

charts/radar-oura-connector/templates/configmap-properties.yaml

@@ -0,0 +1,25 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ template "radar-oura-connector.fullname" . }}-properties
+  labels:
+{{ include "radar-oura-connector.labels" . | indent 4 }}
+data:
+  source-oura.properties: |
+    name=radar-oura-source
+    connector.class=org.radarbase.connect.rest.oura.OuraSourceConnector
+    tasks.max={{ .Values.connector_num_tasks }}
+    rest.source.base.url=https://api.ouraring.com
+    rest.source.poll.interval.ms=5000
+    oura.api.client={{ .Values.oura_api_client }}
+    oura.api.secret={{ .Values.oura_api_secret }}
+    oura.api.intraday={{ .Values.includeIntradayData }}
+    oura.user.repository.class=org.radarbase.connect.rest.oura.user.OuraServiceUserRepository
+    oura.user.repository.url={{ .Values.radar_rest_sources_backend_url }}
+    oura.user.repository.client.id={{ .Values.oauthClientId }}
+    oura.user.repository.client.secret={{ .Values.oauthClientSecret }}
+    oura.user.repository.oauth2.token.url={{ .Values.managementportal_url }}/oauth/token
+  {{- if and .Values.kafka_wait.enabled .Values.kafka_wait.properties }}
+  kafka-wait.properties: |
+    {{ .Values.kafka_wait.properties | indent 4 }}
+  {{- end }}