From fdd4e6dcdadd4223ddadebbc584ef9e01dae96c0 Mon Sep 17 00:00:00 2001 From: nivethika Date: Mon, 9 Aug 2021 15:40:16 +0200 Subject: [PATCH 1/3] Add readme for radar-gateway --- .helmdocsignore | 1 - charts/radar-gateway/Chart.yaml | 8 +++- charts/radar-gateway/DOCS.md.gotmpl | 0 charts/radar-gateway/README.md | 66 +++++++++++++++++++++++++++ charts/radar-gateway/README.md.gotmpl | 16 +++++++ charts/radar-gateway/values.yaml | 16 +++++-- 6 files changed, 102 insertions(+), 5 deletions(-) create mode 100644 charts/radar-gateway/DOCS.md.gotmpl create mode 100644 charts/radar-gateway/README.md create mode 100644 charts/radar-gateway/README.md.gotmpl diff --git a/.helmdocsignore b/.helmdocsignore index de77e5a5..7016ee5b 100644 --- a/.helmdocsignore +++ b/.helmdocsignore @@ -3,7 +3,6 @@ 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/ diff --git a/charts/radar-gateway/Chart.yaml b/charts/radar-gateway/Chart.yaml index 137e45d7..4d38a213 100644 --- a/charts/radar-gateway/Chart.yaml +++ b/charts/radar-gateway/Chart.yaml @@ -1,10 +1,16 @@ apiVersion: v1 appVersion: "0.5.6" -description: A Helm chart for Kubernetes +description: A Helm chart for RADAR-base gateway. For more details of the configurations, see https://github.com/RADAR-base/RADAR-Gateway/blob/master/gateway.yml. name: radar-gateway version: 0.1.3 +sources: ["https://github.com/RADAR-base/RADAR-Gateway"] +deprecated: false +type: application +home: "https://radar-base.org" maintainers: - email: keyvan@thehyve.nl name: Keyvan Hedayati - email: joris@thehyve.nl name: Joris Borgdorff + - email: nivethika@thehyve.nl + name: Nivethika Mahasivam \ No newline at end of file diff --git a/charts/radar-gateway/DOCS.md.gotmpl b/charts/radar-gateway/DOCS.md.gotmpl new file mode 100644 index 00000000..e69de29b diff --git a/charts/radar-gateway/README.md b/charts/radar-gateway/README.md new file mode 100644 index 00000000..948cef2f --- /dev/null +++ b/charts/radar-gateway/README.md @@ -0,0 +1,66 @@ + + +# radar-gateway + +![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.6](https://img.shields.io/badge/AppVersion-0.5.6-informational?style=flat-square) + +A Helm chart for RADAR-base gateway. + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| Keyvan Hedayati | keyvan@thehyve.nl | | +| Joris Borgdorff | joris@thehyve.nl | | +| Nivethika Mahasivam | nivethika@thehyve.nl | | + +## Source Code + +* + +## Prerequisites +* Kubernetes 1.17+ +* Kubectl 1.17+ +* Helm 3.1.0+ + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| replicaCount | int | `2` | | +| image.repository | string | `"radarbase/radar-gateway"` | | +| image.tag | string | `"0.5.6"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| nameOverride | string | `""` | | +| fullnameOverride | string | `""` | | +| service.type | string | `"ClusterIP"` | | +| service.port | int | `8080` | | +| ingress.enabled | bool | `true` | | +| ingress.annotations."kubernetes.io/ingress.class" | string | `"nginx"` | | +| ingress.annotations."cert-manager.io/cluster-issuer" | string | `"letsencrypt-prod"` | | +| ingress.annotations."nginx.ingress.kubernetes.io/rewrite-target" | string | `"/kafka/$1"` | | +| ingress.annotations."nginx.ingress.kubernetes.io/server-snippet" | string | `"location ^~ /kafka/consumers {\n deny all;\n}\nlocation ^~ /kafka/brokers {\n deny all;\n}\nlocation ~* /kafka/topics/.+/partitions {\n deny all;\n}\n"` | | +| ingress.path | string | `"/kafka/?(.*)"` | | +| ingress.hosts[0] | string | `"localhost"` | | +| ingress.tls.secretName | string | `"radar-base-tls"` | | +| resources.requests.cpu | string | `"100m"` | | +| resources.requests.memory | string | `"128Mi"` | | +| nodeSelector | object | `{}` | | +| tolerations | list | `[]` | | +| affinity | object | `{}` | | +| serviceMonitor.enabled | bool | `true` | | +| managementportalHost | string | `"management-portal"` | | +| schemaRegistry | string | `"http://cp-schema-registry:8081"` | | +| max_requests | int | `1000` | | +| bootstrapServers | string | `"cp-kafka-headless:9092"` | | +| checkSourceId | bool | `true` | | +| adminProperties | object | `{}` | | +| producerProperties."compression.type" | string | `"lz4"` | | +| serializationProperties | object | `{}` | | +| cc.enabled | bool | `false` | | +| cc.apiKey | string | `"ccApikey"` | | +| cc.apiSecret | string | `"ccApiSecret"` | | +| cc.schemaRegistryApiKey | string | `"srApiKey"` | | +| cc.schemaRegistryApiSecret | string | `"srApiSecret"` | | diff --git a/charts/radar-gateway/README.md.gotmpl b/charts/radar-gateway/README.md.gotmpl new file mode 100644 index 00000000..228e1710 --- /dev/null +++ b/charts/radar-gateway/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/radar-gateway/values.yaml b/charts/radar-gateway/values.yaml index 50f2991b..b828292c 100644 --- a/charts/radar-gateway/values.yaml +++ b/charts/radar-gateway/values.yaml @@ -59,22 +59,32 @@ affinity: {} serviceMonitor: enabled: true +# -- Host name of the management portal application managementportalHost: management-portal +# -- Schema Registry URL schemaRegistry: http://cp-schema-registry:8081 +# -- Not used. To be confirmed max_requests: 1000 +# -- Kafka broker URLs bootstrapServers: cp-kafka-headless:9092 +# -- set to true, if sources in access token should be validated checkSourceId: true - +# -- Additional Kafka Admin Client settings as key value pairs. Read from https://kafka.apache.org/documentation/#adminclientconfigs. adminProperties: {} - +# -- Kafka producer properties as key value pairs. Read from https://kafka.apache.org/documentation/#producerconfigs. producerProperties: compression.type: lz4 - +# -- Additional Kafka serialization settings, used in KafkaAvroSerializer. Read from [io.confluent.kafka.serializers.AbstractKafkaSchemaSerDeConfig]. serializationProperties: {} cc: + # set to true, if requests should be forwarded to Confluent Cloud based brokers. enabled: false + # Confluent Cloud cluster API key apiKey: ccApikey + # Confluent Cloud cluster API secret apiSecret: ccApiSecret + # Confluent Cloud schema registry API key schemaRegistryApiKey: srApiKey + # Confluent Cloud schema registry API secret schemaRegistryApiSecret: srApiSecret From 1f6e320c7e1a9398d69a28362c2d71ea737ad76b Mon Sep 17 00:00:00 2001 From: nivethika Date: Mon, 9 Aug 2021 21:42:36 +0200 Subject: [PATCH 2/3] fix values and description --- charts/radar-gateway/README.md | 28 ++++++++++++++-------------- charts/radar-gateway/values.yaml | 10 +++++----- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/charts/radar-gateway/README.md b/charts/radar-gateway/README.md index 948cef2f..10c582fe 100644 --- a/charts/radar-gateway/README.md +++ b/charts/radar-gateway/README.md @@ -4,7 +4,7 @@ ![Version: 0.1.3](https://img.shields.io/badge/Version-0.1.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.6](https://img.shields.io/badge/AppVersion-0.5.6-informational?style=flat-square) -A Helm chart for RADAR-base gateway. +A Helm chart for RADAR-base gateway. For more details of the configurations, see https://github.com/RADAR-base/RADAR-Gateway/blob/master/gateway.yml. **Homepage:** @@ -51,16 +51,16 @@ A Helm chart for RADAR-base gateway. | tolerations | list | `[]` | | | affinity | object | `{}` | | | serviceMonitor.enabled | bool | `true` | | -| managementportalHost | string | `"management-portal"` | | -| schemaRegistry | string | `"http://cp-schema-registry:8081"` | | -| max_requests | int | `1000` | | -| bootstrapServers | string | `"cp-kafka-headless:9092"` | | -| checkSourceId | bool | `true` | | -| adminProperties | object | `{}` | | -| producerProperties."compression.type" | string | `"lz4"` | | -| serializationProperties | object | `{}` | | -| cc.enabled | bool | `false` | | -| cc.apiKey | string | `"ccApikey"` | | -| cc.apiSecret | string | `"ccApiSecret"` | | -| cc.schemaRegistryApiKey | string | `"srApiKey"` | | -| cc.schemaRegistryApiSecret | string | `"srApiSecret"` | | +| managementportalHost | string | `"management-portal"` | Host name of the management portal application | +| schemaRegistry | string | `"http://cp-schema-registry:8081"` | Schema Registry URL | +| max_requests | int | `1000` | Not used. To be confirmed | +| bootstrapServers | string | `"cp-kafka-headless:9092"` | Kafka broker URLs | +| checkSourceId | bool | `true` | set to true, if sources in access token should be validated | +| adminProperties | object | `{}` | Additional Kafka Admin Client settings as key value pairs. Read from https://kafka.apache.org/documentation/#adminclientconfigs. | +| producerProperties | object | `{"compression.type":"lz4"}` | Kafka producer properties as key value pairs. Read from https://kafka.apache.org/documentation/#producerconfigs. | +| serializationProperties | object | `{}` | Additional Kafka serialization settings, used in KafkaAvroSerializer. Read from [io.confluent.kafka.serializers.AbstractKafkaSchemaSerDeConfig]. | +| cc.enabled | bool | `false` | set to true, if requests should be forwarded to Confluent Cloud based brokers. | +| cc.apiKey | string | `"ccApikey"` | Confluent Cloud cluster API key | +| cc.apiSecret | string | `"ccApiSecret"` | Confluent Cloud cluster API secret | +| cc.schemaRegistryApiKey | string | `"srApiKey"` | Confluent Cloud schema registry API key | +| cc.schemaRegistryApiSecret | string | `"srApiSecret"` | Confluent Cloud schema registry API secret | diff --git a/charts/radar-gateway/values.yaml b/charts/radar-gateway/values.yaml index b828292c..811c0e02 100644 --- a/charts/radar-gateway/values.yaml +++ b/charts/radar-gateway/values.yaml @@ -78,13 +78,13 @@ producerProperties: serializationProperties: {} cc: - # set to true, if requests should be forwarded to Confluent Cloud based brokers. + # -- set to true, if requests should be forwarded to Confluent Cloud based brokers. enabled: false - # Confluent Cloud cluster API key + # -- Confluent Cloud cluster API key apiKey: ccApikey - # Confluent Cloud cluster API secret + # -- Confluent Cloud cluster API secret apiSecret: ccApiSecret - # Confluent Cloud schema registry API key + # -- Confluent Cloud schema registry API key schemaRegistryApiKey: srApiKey - # Confluent Cloud schema registry API secret + # -- Confluent Cloud schema registry API secret schemaRegistryApiSecret: srApiSecret From 1034a9fce85c242670bec242566ef0b6552989eb Mon Sep 17 00:00:00 2001 From: Keyvan Date: Tue, 10 Aug 2021 14:11:43 +0200 Subject: [PATCH 3/3] Completed values docs for radar-gateway Signed-off-by: Keyvan --- charts/radar-gateway/README.md | 40 ++++++++++++++------------------ charts/radar-gateway/values.yaml | 21 +++++++++++++++++ 2 files changed, 39 insertions(+), 22 deletions(-) diff --git a/charts/radar-gateway/README.md b/charts/radar-gateway/README.md index 10c582fe..af9a9cda 100644 --- a/charts/radar-gateway/README.md +++ b/charts/radar-gateway/README.md @@ -29,28 +29,24 @@ A Helm chart for RADAR-base gateway. For more details of the configurations, see | Key | Type | Default | Description | |-----|------|---------|-------------| -| replicaCount | int | `2` | | -| image.repository | string | `"radarbase/radar-gateway"` | | -| image.tag | string | `"0.5.6"` | | -| image.pullPolicy | string | `"IfNotPresent"` | | -| nameOverride | string | `""` | | -| fullnameOverride | string | `""` | | -| service.type | string | `"ClusterIP"` | | -| service.port | int | `8080` | | -| ingress.enabled | bool | `true` | | -| ingress.annotations."kubernetes.io/ingress.class" | string | `"nginx"` | | -| ingress.annotations."cert-manager.io/cluster-issuer" | string | `"letsencrypt-prod"` | | -| ingress.annotations."nginx.ingress.kubernetes.io/rewrite-target" | string | `"/kafka/$1"` | | -| ingress.annotations."nginx.ingress.kubernetes.io/server-snippet" | string | `"location ^~ /kafka/consumers {\n deny all;\n}\nlocation ^~ /kafka/brokers {\n deny all;\n}\nlocation ~* /kafka/topics/.+/partitions {\n deny all;\n}\n"` | | -| ingress.path | string | `"/kafka/?(.*)"` | | -| ingress.hosts[0] | string | `"localhost"` | | -| ingress.tls.secretName | string | `"radar-base-tls"` | | -| resources.requests.cpu | string | `"100m"` | | -| resources.requests.memory | string | `"128Mi"` | | -| nodeSelector | object | `{}` | | -| tolerations | list | `[]` | | -| affinity | object | `{}` | | -| serviceMonitor.enabled | bool | `true` | | +| replicaCount | int | `2` | Number of radar-gateway replicas to deploy | +| image.repository | string | `"radarbase/radar-gateway"` | radar-gateway image repository | +| image.tag | string | `"0.5.6"` | radar-gateway image tag (immutable tags are recommended) Overrides the image tag whose default is the chart appVersion. | +| image.pullPolicy | string | `"IfNotPresent"` | radar-gateway image pull policy | +| nameOverride | string | `""` | String to partially override radar-gateway.fullname template with a string (will prepend the release name) | +| fullnameOverride | string | `""` | String to fully override radar-gateway.fullname template with a string | +| service.type | string | `"ClusterIP"` | Kubernetes Service type | +| service.port | int | `8080` | radar-gateway port | +| 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 | +| ingress.hosts | list | `["localhost"]` | Hosts to accept requests from | +| ingress.tls.secretName | string | `"radar-base-tls"` | Name of the secret that contains TLS certificates | +| 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 | +| serviceMonitor.enabled | bool | `true` | Enable metrics to be collected via Prometheus-operator | | managementportalHost | string | `"management-portal"` | Host name of the management portal application | | schemaRegistry | string | `"http://cp-schema-registry:8081"` | Schema Registry URL | | max_requests | int | `1000` | Not used. To be confirmed | diff --git a/charts/radar-gateway/values.yaml b/charts/radar-gateway/values.yaml index 811c0e02..3bf57fc9 100644 --- a/charts/radar-gateway/values.yaml +++ b/charts/radar-gateway/values.yaml @@ -2,22 +2,34 @@ # This is a YAML-formatted file. # Declare variables to be passed into your templates. +# -- Number of radar-gateway replicas to deploy replicaCount: 2 image: + # -- radar-gateway image repository repository: radarbase/radar-gateway + # -- radar-gateway image tag (immutable tags are recommended) + # Overrides the image tag whose default is the chart appVersion. tag: 0.5.6 + # -- radar-gateway image pull policy pullPolicy: IfNotPresent +# -- String to partially override radar-gateway.fullname template with a string (will prepend the release name) nameOverride: "" +# -- String to fully override radar-gateway.fullname template with a string fullnameOverride: "" service: + # -- Kubernetes Service type type: ClusterIP + # -- radar-gateway port port: 8080 ingress: + # -- Enable ingress controller resource enabled: true + # -- Annotations that define default ingress class, certificate issuer and deny access to sensitive URLs + # @default -- check values.yaml annotations: kubernetes.io/ingress.class: nginx cert-manager.io/cluster-issuer: letsencrypt-prod @@ -32,10 +44,13 @@ ingress: location ~* /kafka/topics/.+/partitions { deny all; } + # -- Path within the url structure path: "/kafka/?(.*)" + # -- Hosts to accept requests from hosts: - localhost tls: + # -- Name of the secret that contains TLS certificates secretName: radar-base-tls resources: @@ -46,17 +61,23 @@ 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: {} serviceMonitor: + # -- Enable metrics to be collected via Prometheus-operator enabled: true # -- Host name of the management portal application