From 0fa2fdc65c55dfa81287d44662f6f1271e0b8359 Mon Sep 17 00:00:00 2001 From: Tom Skawinski Date: Thu, 17 Oct 2024 07:50:18 -0400 Subject: [PATCH 1/8] Modify Connector ENV names --- charts/ndc-connector-oracle/README.md | 18 +++++++-------- .../templates/secret.yaml | 4 ++-- charts/ndc-connector-oracle/values.yaml | 8 +++---- charts/ndc-connector-phoenix/README.md | 16 ++++++------- .../templates/secret.yaml | 4 ++-- charts/ndc-connector-phoenix/values.yaml | 4 ++-- charts/ndc-graphql/README.md | 16 ++++++------- charts/ndc-graphql/templates/secret.yaml | 4 ++-- charts/ndc-graphql/values.yaml | 2 +- charts/ndc-mongodb/README.md | 18 +++++++-------- charts/ndc-mongodb/templates/secret.yaml | 4 ++-- charts/ndc-mongodb/values.yaml | 4 ++-- charts/ndc-nodejs-lambda/README.md | 8 +++---- .../ndc-nodejs-lambda/templates/secret.yaml | 2 +- charts/ndc-nodejs-lambda/values.yaml | 2 +- charts/ndc-postgres/README.md | 22 +++++++++--------- charts/ndc-postgres/templates/secret.yaml | 7 ++++-- charts/ndc-postgres/values.yaml | 23 +++++++++++++------ 18 files changed, 89 insertions(+), 77 deletions(-) diff --git a/charts/ndc-connector-oracle/README.md b/charts/ndc-connector-oracle/README.md index 6424bab..b86e885 100644 --- a/charts/ndc-connector-oracle/README.md +++ b/charts/ndc-connector-oracle/README.md @@ -13,24 +13,24 @@ See all [configuration](#parameters) below. helm template \ --set image.repository="my_repo/ndc-jvm-oracle" \ --set image.tag="my_custom_image_tag" \ - --set connector.JDBC_URL="jdbc_url" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-connector-oracle | kubectl apply -f- # helm upgrade --install (pass configuration via command line) helm upgrade --install \ --set image.repository="my_repo/ndc-jvm-oracle" \ --set image.tag="my_custom_image_tag" \ - --set connector.JDBC_URL="jdbc_url" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-connector-oracle # helm upgrade --install (with OTEL variabes) helm upgrade --install \ --set image.repository="my_repo/ndc-jvm-oracle" \ --set image.tag="my_custom_image_tag" \ - --set connector.JDBC_URL="jdbc_url" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set otel.deployOtelCollector="true" \ --set otel.dataPlaneID= \ --set otel.dataPlaneKey= \ @@ -71,6 +71,6 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connector.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connector.JDBC_URL` | The JDBC URL to connect to the database (Required) | `""` | -| `connector.JDBC_SCHEMAS` | A comma-separated list of schemas to include in the metadata (Optional) | `""` | \ No newline at end of file +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.JDBC_URL` | The JDBC URL to connect to the database (Required) | `""` | +| `connectorEnvVars.JDBC_SCHEMAS` | A comma-separated list of schemas to include in the metadata (Optional) | `""` | \ No newline at end of file diff --git a/charts/ndc-connector-oracle/templates/secret.yaml b/charts/ndc-connector-oracle/templates/secret.yaml index 8c17ef2..9ea41ae 100644 --- a/charts/ndc-connector-oracle/templates/secret.yaml +++ b/charts/ndc-connector-oracle/templates/secret.yaml @@ -4,8 +4,8 @@ metadata: name: {{ printf "%s-secret" (include "common.name" .) }} namespace: {{ template "common.namespace" $ }} data: - HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connector.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} - MONGODB_DATABASE_URI: {{ .Values.connector.MONGODB_DATABASE_URI | b64enc | quote }} + HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} + MONGODB_DATABASE_URI: {{ .Values.connectorEnvVars.MONGODB_DATABASE_URI | b64enc | quote }} {{- if .Values.otel.deployOtelCollector }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} \ No newline at end of file diff --git a/charts/ndc-connector-oracle/values.yaml b/charts/ndc-connector-oracle/values.yaml index 6af5b24..bd62264 100644 --- a/charts/ndc-connector-oracle/values.yaml +++ b/charts/ndc-connector-oracle/values.yaml @@ -129,7 +129,7 @@ resources: | cpu: "1" memory: "1Gi" -connector: +connectorEnvVars: HASURA_SERVICE_TOKEN_SECRET: "" JDBC_URL: "" JDBC_SCHEMAS: "" @@ -148,11 +148,11 @@ env: | secretKeyRef: key: JDBC_URL name: {{ printf "%s-secret" (include "common.name" .) }} - {{- if .Values.connector.JDBC_SCHEMAS }} + {{- if .Values.connectorEnvVars.JDBC_SCHEMAS }} - name: JDBC_SCHEMAS - value: {{ .Values.connector.JDBC_SCHEMAS | quote }} + value: {{ .Values.connectorEnvVars.JDBC_SCHEMAS | quote }} {{- end }} - name: OTEL_EXPORTER_OTLP_ENDPOINT value: http://localhost:4317 - name: HASURA_CONFIGURATION_DIRECTORY - value: {{ .Values.connector.configDirectory }} \ No newline at end of file + value: {{ .Values.connectorEnvVars.configDirectory }} \ No newline at end of file diff --git a/charts/ndc-connector-phoenix/README.md b/charts/ndc-connector-phoenix/README.md index eb35286..fee122c 100644 --- a/charts/ndc-connector-phoenix/README.md +++ b/charts/ndc-connector-phoenix/README.md @@ -13,24 +13,24 @@ See all [configuration](#parameters) below. helm template \ --set image.repository="my_repo/ndc-jvm-phoenix" \ --set image.tag="my_custom_image_tag" \ - --set connector.JDBC_URL="jdbc_url" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-connector-phoenix | kubectl apply -f- # helm upgrade --install (pass configuration via command line) helm upgrade --install \ --set image.repository="my_repo/ndc-jvm-phoenix" \ --set image.tag="my_custom_image_tag" \ - --set connector.JDBC_URL="jdbc_url" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-connector-phoenix # helm upgrade --install (with OTEL variabes) helm upgrade --install \ --set image.repository="my_repo/ndc-jvm-phoenix" \ --set image.tag="my_custom_image_tag" \ - --set connector.JDBC_URL="jdbc_url" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set otel.deployOtelCollector="true" \ --set otel.dataPlaneID= \ --set otel.dataPlaneKey= \ @@ -71,5 +71,5 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connector.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connector.JDBC_URL` | The JDBC URL to connect to the database (Required) | `""` | \ No newline at end of file +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.JDBC_URL` | The JDBC URL to connect to the database (Required) | `""` | \ No newline at end of file diff --git a/charts/ndc-connector-phoenix/templates/secret.yaml b/charts/ndc-connector-phoenix/templates/secret.yaml index 8c17ef2..9ea41ae 100644 --- a/charts/ndc-connector-phoenix/templates/secret.yaml +++ b/charts/ndc-connector-phoenix/templates/secret.yaml @@ -4,8 +4,8 @@ metadata: name: {{ printf "%s-secret" (include "common.name" .) }} namespace: {{ template "common.namespace" $ }} data: - HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connector.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} - MONGODB_DATABASE_URI: {{ .Values.connector.MONGODB_DATABASE_URI | b64enc | quote }} + HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} + MONGODB_DATABASE_URI: {{ .Values.connectorEnvVars.MONGODB_DATABASE_URI | b64enc | quote }} {{- if .Values.otel.deployOtelCollector }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} \ No newline at end of file diff --git a/charts/ndc-connector-phoenix/values.yaml b/charts/ndc-connector-phoenix/values.yaml index 405760e..05d6709 100644 --- a/charts/ndc-connector-phoenix/values.yaml +++ b/charts/ndc-connector-phoenix/values.yaml @@ -127,7 +127,7 @@ resources: | cpu: "1" memory: "1Gi" -connector: +connectorEnvVars: HASURA_SERVICE_TOKEN_SECRET: "" JDBC_URL: "" configDirectory: /etc/connector @@ -148,4 +148,4 @@ env: | - name: OTEL_EXPORTER_OTLP_ENDPOINT value: http://localhost:4317 - name: HASURA_CONFIGURATION_DIRECTORY - value: {{ .Values.connector.configDirectory }} + value: {{ .Values.connectorEnvVars.configDirectory }} diff --git a/charts/ndc-graphql/README.md b/charts/ndc-graphql/README.md index 4e0361b..39c4d17 100644 --- a/charts/ndc-graphql/README.md +++ b/charts/ndc-graphql/README.md @@ -13,24 +13,24 @@ See all [configuration](#parameters) below. helm template \ --set image.repository="my_repo/ndc-graphql" \ --set image.tag="my_custom_image_tag" \ - --set connector.GRAPHQL_ENDPOINT="graphql_endpoint" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-graphql | kubectl apply -f- # helm upgrade --install (pass configuration via command line) helm upgrade --install \ --set image.repository="my_repo/ndc-graphql" \ --set image.tag="my_custom_image_tag" \ - --set connector.GRAPHQL_ENDPOINT="graphql_endpoint" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-graphql # helm upgrade --install (with OTEL variabes) helm upgrade --install \ --set image.repository="my_repo/ndc-graphql" \ --set image.tag="my_custom_image_tag" \ - --set connector.GRAPHQL_ENDPOINT="graphql_endpoint" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set otel.deployOtelCollector="true" \ --set otel.dataPlaneID= \ --set otel.dataPlaneKey= \ @@ -71,5 +71,5 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connector.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connector.GRAPHQL_ENDPOINT` | The GraphQL Endpoint (Required) | `""` | \ No newline at end of file +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.GRAPHQL_ENDPOINT` | The GraphQL Endpoint (Required) | `""` | \ No newline at end of file diff --git a/charts/ndc-graphql/templates/secret.yaml b/charts/ndc-graphql/templates/secret.yaml index d472f05..79e4376 100644 --- a/charts/ndc-graphql/templates/secret.yaml +++ b/charts/ndc-graphql/templates/secret.yaml @@ -4,8 +4,8 @@ metadata: name: {{ printf "%s-secret" (include "common.name" .) }} namespace: {{ template "common.namespace" $ }} data: - HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connector.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} - CONNECTION_URI: {{ .Values.connector.CONNECTION_URI | b64enc | quote }} + HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} + GRAPHQL_ENDPOINT: {{ .Values.connectorEnvVars.GRAPHQL_ENDPOINT | b64enc | quote }} {{- if .Values.otel.deployOtelCollector }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} diff --git a/charts/ndc-graphql/values.yaml b/charts/ndc-graphql/values.yaml index 7c622bc..19ff6dc 100644 --- a/charts/ndc-graphql/values.yaml +++ b/charts/ndc-graphql/values.yaml @@ -129,7 +129,7 @@ resources: | cpu: "1" memory: "1Gi" -connector: +connectorEnvVars: HASURA_SERVICE_TOKEN_SECRET: "" GRAPHQL_ENDPOINT: "" diff --git a/charts/ndc-mongodb/README.md b/charts/ndc-mongodb/README.md index 3e1e2e7..7557eaf 100644 --- a/charts/ndc-mongodb/README.md +++ b/charts/ndc-mongodb/README.md @@ -13,24 +13,24 @@ See all [configuration](#parameters) below. helm template \ --set image.repository="my_repo/ndc-mongodb" \ --set image.tag="my_custom_image_tag" \ - --set connector.MONGODB_DATABASE_URI="db_connection_string" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.MONGODB_DATABASE_URI="db_connection_string" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-mongodb | kubectl apply -f- # helm upgrade --install (pass configuration via command line) helm upgrade --install \ --set image.repository="my_repo/ndc-mongodb" \ --set image.tag="my_custom_image_tag" \ - --set connector.MONGODB_DATABASE_URI="db_connection_string" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.MONGODB_DATABASE_URI="db_connection_string" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-mongodb # helm upgrade --install (with OTEL variabes) helm upgrade --install \ --set image.repository="my_repo/ndc-mongodb" \ --set image.tag="my_custom_image_tag" \ - --set connector.MONGODB_DATABASE_URI="db_connection_string" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.MONGODB_DATABASE_URI="db_connection_string" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set otel.deployOtelCollector="true" \ --set otel.dataPlaneID= \ --set otel.dataPlaneKey= \ @@ -51,7 +51,7 @@ helm upgrade --install \ | `securityContext` | Define privilege and access control settings for a Pod or Container | `{}` | | `healthChecks.enabled` | Enable health check for ndc-mongodb container | `false` | | `healthChecks.livenessProbePath` | Health check liveness Probe path ndc-mongodb container | `"/healthz"` | -| `healthChecks.readinessProbePath` | Health check readiness Probe path mongo-connector container | `"/healthz"` | +| `healthChecks.readinessProbePath` | Health check readiness Probe path ndc-mongodb container | `"/healthz"` | | `hpa.enabled` | Enable HPA for ndc-mongodb. Ensure metrics cluster is configured when enabling | `false` | | `hpa.minReplicas` | minReplicas setting for HPA | `2` | | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | @@ -71,5 +71,5 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connector.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connector.MONGODB_DATABASE_URI` | Database Connection URI (Required) | `""` | \ No newline at end of file +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.MONGODB_DATABASE_URI` | Database Connection URI (Required) | `""` | \ No newline at end of file diff --git a/charts/ndc-mongodb/templates/secret.yaml b/charts/ndc-mongodb/templates/secret.yaml index 8c17ef2..9ea41ae 100644 --- a/charts/ndc-mongodb/templates/secret.yaml +++ b/charts/ndc-mongodb/templates/secret.yaml @@ -4,8 +4,8 @@ metadata: name: {{ printf "%s-secret" (include "common.name" .) }} namespace: {{ template "common.namespace" $ }} data: - HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connector.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} - MONGODB_DATABASE_URI: {{ .Values.connector.MONGODB_DATABASE_URI | b64enc | quote }} + HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} + MONGODB_DATABASE_URI: {{ .Values.connectorEnvVars.MONGODB_DATABASE_URI | b64enc | quote }} {{- if .Values.otel.deployOtelCollector }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} \ No newline at end of file diff --git a/charts/ndc-mongodb/values.yaml b/charts/ndc-mongodb/values.yaml index aa72342..5118c2b 100644 --- a/charts/ndc-mongodb/values.yaml +++ b/charts/ndc-mongodb/values.yaml @@ -129,7 +129,7 @@ resources: | cpu: "1" memory: "1Gi" -connector: +connectorEnvVars: HASURA_SERVICE_TOKEN_SECRET: "" MONGODB_DATABASE_URI: "" configDirectory: /etc/connector @@ -150,4 +150,4 @@ env: | - name: OTEL_EXPORTER_OTLP_ENDPOINT value: http://localhost:4317 - name: HASURA_CONFIGURATION_DIRECTORY - value: {{ .Values.connector.configDirectory }} + value: {{ .Values.connectorEnvVars.configDirectory }} diff --git a/charts/ndc-nodejs-lambda/README.md b/charts/ndc-nodejs-lambda/README.md index dffebf0..7e7d937 100644 --- a/charts/ndc-nodejs-lambda/README.md +++ b/charts/ndc-nodejs-lambda/README.md @@ -13,21 +13,21 @@ See all [configuration](#parameters) below. helm template \ --set image.repository="my_repo/ndc-nodejs-lambda" \ --set image.tag="my_custom_image_tag" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/nodejs-lambda | kubectl apply -f- # helm upgrade --install (pass configuration via command line) helm upgrade --install \ --set image.repository="my_repo/ndc-nodejs-lambda" \ --set image.tag="my_custom_image_tag" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/nodejs-lambda # helm upgrade --install (with OTEL variabes) helm upgrade --install \ --set image.repository="my_repo/ndc-nodejs-lambda" \ --set image.tag="my_custom_image_tag" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set otel.deployOtelCollector="true" \ --set otel.dataPlaneID= \ --set otel.dataPlaneKey= \ @@ -68,4 +68,4 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connector.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | \ No newline at end of file +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | \ No newline at end of file diff --git a/charts/ndc-nodejs-lambda/templates/secret.yaml b/charts/ndc-nodejs-lambda/templates/secret.yaml index 576bed8..090af2f 100644 --- a/charts/ndc-nodejs-lambda/templates/secret.yaml +++ b/charts/ndc-nodejs-lambda/templates/secret.yaml @@ -4,7 +4,7 @@ metadata: name: {{ printf "%s-secret" (include "common.name" .) }} namespace: {{ template "common.namespace" $ }} data: - HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connector.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} + HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} {{- if .Values.otel.deployOtelCollector }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} \ No newline at end of file diff --git a/charts/ndc-nodejs-lambda/values.yaml b/charts/ndc-nodejs-lambda/values.yaml index 8c16e64..f736412 100644 --- a/charts/ndc-nodejs-lambda/values.yaml +++ b/charts/ndc-nodejs-lambda/values.yaml @@ -137,7 +137,7 @@ resources: | cpu: "1" memory: "1Gi" -connector: +connectorEnvVars: HASURA_SERVICE_TOKEN_SECRET: "" env: | diff --git a/charts/ndc-postgres/README.md b/charts/ndc-postgres/README.md index c9b513c..fcf27a8 100644 --- a/charts/ndc-postgres/README.md +++ b/charts/ndc-postgres/README.md @@ -13,24 +13,24 @@ See all [configuration](#parameters) below. helm template \ --set image.repository="my_repo/ndc-postgres" \ --set image.tag="my_custom_image_tag" \ - --set connector.CONNECTION_URI="db_connection_string" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.CONNECTION_URI="db_connection_string" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-postgres | kubectl apply -f- # helm upgrade --install (pass configuration via command line) helm upgrade --install \ --set image.repository="my_repo/ndc-postgres" \ --set image.tag="my_custom_image_tag" \ - --set connector.CONNECTION_URI="db_connection_string" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.CONNECTION_URI="db_connection_string" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ hasura-ddn/ndc-postgres # helm upgrade --install (with OTEL variabes) helm upgrade --install \ --set image.repository="my_repo/ndc-postgres" \ --set image.tag="my_custom_image_tag" \ - --set connector.CONNECTION_URI="db_connection_string" \ - --set connector.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set connectorEnvVars.CONNECTION_URI="db_connection_string" \ + --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set otel.deployOtelCollector="true" \ --set otel.dataPlaneID= \ --set otel.dataPlaneKey= \ @@ -71,8 +71,8 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connector.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connector.CONNECTION_URI` | Database Connection URI (Required) | `""` | -| `connector.CLIENT_CERT` | Database Client cert (Optional) | `""` | -| `connector.CLIENT_KEY` | Database Client key (Optional) | `""` | -| `connector.ROOT_CERT` | Database Root cert (Optional) | `""` | \ No newline at end of file +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.CONNECTION_URI` | Database Connection URI (Required) | `""` | +| `connectorEnvVars.CLIENT_CERT` | Database Client cert (Optional) | `""` | +| `connectorEnvVars.CLIENT_KEY` | Database Client key (Optional) | `""` | +| `connectorEnvVars.ROOT_CERT` | Database Root cert (Optional) | `""` | \ No newline at end of file diff --git a/charts/ndc-postgres/templates/secret.yaml b/charts/ndc-postgres/templates/secret.yaml index d472f05..6cf6dff 100644 --- a/charts/ndc-postgres/templates/secret.yaml +++ b/charts/ndc-postgres/templates/secret.yaml @@ -4,8 +4,11 @@ metadata: name: {{ printf "%s-secret" (include "common.name" .) }} namespace: {{ template "common.namespace" $ }} data: - HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connector.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} - CONNECTION_URI: {{ .Values.connector.CONNECTION_URI | b64enc | quote }} + HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} + CONNECTION_URI: {{ .Values.connectorEnvVars.CONNECTION_URI | b64enc | quote }} + CLIENT_CERT: {{ .Values.connectorEnvVars.CLIENT_CERT | b64enc | quote }} + CLIENT_KEY: {{ .Values.connectorEnvVars.CLIENT_KEY | b64enc | quote }} + ROOT_CERT: {{ .Values.connectorEnvVars.ROOT_CERT | b64enc | quote }} {{- if .Values.otel.deployOtelCollector }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} diff --git a/charts/ndc-postgres/values.yaml b/charts/ndc-postgres/values.yaml index a12c321..5b70625 100644 --- a/charts/ndc-postgres/values.yaml +++ b/charts/ndc-postgres/values.yaml @@ -129,7 +129,7 @@ resources: | cpu: "1" memory: "1Gi" -connector: +connectorEnvVars: HASURA_SERVICE_TOKEN_SECRET: "" CONNECTION_URI: "" CLIENT_CERT: "" @@ -147,17 +147,26 @@ env: | secretKeyRef: key: CONNECTION_URI name: {{ printf "%s-secret" (include "common.name" .) }} - {{- if .Values.connector.CLIENT_CERT }} + {{- if .Values.connectorEnvVars.CLIENT_CERT }} - name: CLIENT_CERT - value: {{ .Values.connector.CLIENT_CERT | quote }} + valueFrom: + secretKeyRef: + key: CLIENT_CERT + name: {{ printf "%s-secret" (include "common.name" .) }} {{- end }} - {{- if .Values.connector.CLIENT_KEY }} + {{- if .Values.connectorEnvVars.CLIENT_KEY }} - name: CLIENT_KEY - value: {{ .Values.connector.CLIENT_KEY | quote }} + valueFrom: + secretKeyRef: + key: CLIENT_KEY + name: {{ printf "%s-secret" (include "common.name" .) }} {{- end }} - {{- if .Values.connector.ROOT_CERT }} + {{- if .Values.connectorEnvVars.ROOT_CERT }} - name: ROOT_CERT - value: {{ .Values.connector.ROOT_CERT | quote }} + valueFrom: + secretKeyRef: + key: ROOT_CERT + name: {{ printf "%s-secret" (include "common.name" .) }} {{- end }} - name: OTEL_EXPORTER_OTLP_ENDPOINT value: http://localhost:4317 From 16d0e8846f1841ff6353999c3af67029982e91b4 Mon Sep 17 00:00:00 2001 From: Tom Skawinski Date: Thu, 17 Oct 2024 08:48:11 -0400 Subject: [PATCH 2/8] Add namespace to all Charts --- charts/ndc-connector-oracle/README.md | 1 + charts/ndc-connector-oracle/values.yaml | 1 + charts/ndc-connector-phoenix/README.md | 1 + charts/ndc-connector-phoenix/values.yaml | 3 +++ charts/ndc-graphql/README.md | 1 + charts/ndc-graphql/values.yaml | 1 + charts/ndc-mongodb/README.md | 1 + charts/ndc-mongodb/values.yaml | 1 + charts/ndc-nodejs-lambda/README.md | 1 + charts/ndc-nodejs-lambda/values.yaml | 1 + charts/ndc-postgres/README.md | 1 + charts/ndc-postgres/values.yaml | 1 + charts/v3-engine/README.md | 1 + charts/v3-engine/values.yaml | 2 ++ 14 files changed, 17 insertions(+) diff --git a/charts/ndc-connector-oracle/README.md b/charts/ndc-connector-oracle/README.md index b86e885..c97e8ae 100644 --- a/charts/ndc-connector-oracle/README.md +++ b/charts/ndc-connector-oracle/README.md @@ -41,6 +41,7 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------| +| `namespace` | Namespace to deploy to | `"default"` | | `image.repository` | Image repository containing custom created ndc-connector-oracle | `""` | | `image.tag` | Image tag to use for custom created ndc-connector-oracle | `""` | | `image.pullPolicy` | Image pull policy | `Always` | diff --git a/charts/ndc-connector-oracle/values.yaml b/charts/ndc-connector-oracle/values.yaml index bd62264..6c2d2b8 100644 --- a/charts/ndc-connector-oracle/values.yaml +++ b/charts/ndc-connector-oracle/values.yaml @@ -1,3 +1,4 @@ +namespace: "default" useReleaseName: true additionalAnnotations: | diff --git a/charts/ndc-connector-phoenix/README.md b/charts/ndc-connector-phoenix/README.md index fee122c..1154fb1 100644 --- a/charts/ndc-connector-phoenix/README.md +++ b/charts/ndc-connector-phoenix/README.md @@ -41,6 +41,7 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------| +| `namespace` | Namespace to deploy to | `"default"` | | `image.repository` | Image repository containing custom created ndc-connector-phoenix | `""` | | `image.tag` | Image tag to use for custom created ndc-connector-phoenix | `""` | | `image.pullPolicy` | Image pull policy | `Always` | diff --git a/charts/ndc-connector-phoenix/values.yaml b/charts/ndc-connector-phoenix/values.yaml index 05d6709..416f7d5 100644 --- a/charts/ndc-connector-phoenix/values.yaml +++ b/charts/ndc-connector-phoenix/values.yaml @@ -1,3 +1,6 @@ +namespace: "default" +useReleaseName: true + additionalAnnotations: | checksum/config: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }} diff --git a/charts/ndc-graphql/README.md b/charts/ndc-graphql/README.md index 39c4d17..5b4f2ca 100644 --- a/charts/ndc-graphql/README.md +++ b/charts/ndc-graphql/README.md @@ -41,6 +41,7 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `namespace` | Namespace to deploy to | `"default"` | | `image.repository` | Image repository containing custom created ndc-graphql | `""` | | `image.tag` | Image tag to use for custom created ndc-graphql | `""` | | `image.pullPolicy` | Image pull policy | `Always` | diff --git a/charts/ndc-graphql/values.yaml b/charts/ndc-graphql/values.yaml index 19ff6dc..fcfe293 100644 --- a/charts/ndc-graphql/values.yaml +++ b/charts/ndc-graphql/values.yaml @@ -1,3 +1,4 @@ +namespace: "default" useReleaseName: true additionalAnnotations: | diff --git a/charts/ndc-mongodb/README.md b/charts/ndc-mongodb/README.md index 7557eaf..39b7b76 100644 --- a/charts/ndc-mongodb/README.md +++ b/charts/ndc-mongodb/README.md @@ -41,6 +41,7 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------| +| `namespace` | Namespace to deploy to | `"default"` | | `image.repository` | Image repository containing custom created ndc-mongodb | `""` | | `image.tag` | Image tag to use for custom created ndc-mongodb | `""` | | `image.pullPolicy` | Image pull policy | `Always` | diff --git a/charts/ndc-mongodb/values.yaml b/charts/ndc-mongodb/values.yaml index 5118c2b..6e03f53 100644 --- a/charts/ndc-mongodb/values.yaml +++ b/charts/ndc-mongodb/values.yaml @@ -1,3 +1,4 @@ +namespace: "default" useReleaseName: true additionalAnnotations: | diff --git a/charts/ndc-nodejs-lambda/README.md b/charts/ndc-nodejs-lambda/README.md index 7e7d937..c5e82a9 100644 --- a/charts/ndc-nodejs-lambda/README.md +++ b/charts/ndc-nodejs-lambda/README.md @@ -38,6 +38,7 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `namespace` | Namespace to deploy to | `"default"` | | `image.repository` | Image repository containing custom created ndc-nodejs-lambda | `""` | | `image.tag` | Image tag to use for custom created ndc-nodejs-lambda | `""` | | `image.pullPolicy` | Image pull policy | `Always` | diff --git a/charts/ndc-nodejs-lambda/values.yaml b/charts/ndc-nodejs-lambda/values.yaml index f736412..2ecfd13 100644 --- a/charts/ndc-nodejs-lambda/values.yaml +++ b/charts/ndc-nodejs-lambda/values.yaml @@ -1,3 +1,4 @@ +namespace: "default" useReleaseName: true additionalAnnotations: | diff --git a/charts/ndc-postgres/README.md b/charts/ndc-postgres/README.md index fcf27a8..a005f9b 100644 --- a/charts/ndc-postgres/README.md +++ b/charts/ndc-postgres/README.md @@ -41,6 +41,7 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `namespace` | Namespace to deploy to | `"default"` | | `image.repository` | Image repository containing custom created ndc-postgres | `""` | | `image.tag` | Image tag to use for custom created ndc-postgres | `""` | | `image.pullPolicy` | Image pull policy | `Always` | diff --git a/charts/ndc-postgres/values.yaml b/charts/ndc-postgres/values.yaml index 5b70625..26ea4e0 100644 --- a/charts/ndc-postgres/values.yaml +++ b/charts/ndc-postgres/values.yaml @@ -1,3 +1,4 @@ +namespace: "default" useReleaseName: true additionalAnnotations: | diff --git a/charts/v3-engine/README.md b/charts/v3-engine/README.md index a30bfb9..f0be329 100644 --- a/charts/v3-engine/README.md +++ b/charts/v3-engine/README.md @@ -51,6 +51,7 @@ helm upgrade --install \ | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `namespace` | Namespace to deploy to | `"default"` | | `image.repository` | Image repository + image name containing custom created v3-engine | `""` | | `image.pullPolicy` | Image pull policy | `Always` | | `image.tag` | Image tag to use for custom created v3-engine | `""` | diff --git a/charts/v3-engine/values.yaml b/charts/v3-engine/values.yaml index 2cf865e..0baeba5 100644 --- a/charts/v3-engine/values.yaml +++ b/charts/v3-engine/values.yaml @@ -1,4 +1,6 @@ +namespace: "default" useReleaseName: true + additionalAnnotations: | checksum/config: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }} From 0b4e29cb246ad2f469b3c2eb7d51a1ca0e49d651 Mon Sep 17 00:00:00 2001 From: Tom Skawinski Date: Thu, 17 Oct 2024 09:43:52 -0400 Subject: [PATCH 3/8] OTEL changes across all Helm charts. Set version in Chart.yaml to semver. Set appVersion to 3.0.0 --- charts/ndc-connector-oracle/Chart.yaml | 4 +-- charts/ndc-connector-oracle/README.md | 27 ++++++---------- charts/ndc-connector-oracle/values.yaml | 35 +++++++++++++-------- charts/ndc-connector-phoenix/Chart.yaml | 4 +-- charts/ndc-connector-phoenix/README.md | 27 ++++++---------- charts/ndc-connector-phoenix/values.yaml | 35 +++++++++++++-------- charts/ndc-graphql/Chart.yaml | 4 +-- charts/ndc-graphql/README.md | 27 ++++++---------- charts/ndc-graphql/values.yaml | 33 +++++++++++++------- charts/ndc-mongodb/Chart.yaml | 4 +-- charts/ndc-mongodb/README.md | 27 ++++++---------- charts/ndc-mongodb/values.yaml | 35 +++++++++++++-------- charts/ndc-nodejs-lambda/Chart.yaml | 4 +-- charts/ndc-nodejs-lambda/README.md | 26 ++++++---------- charts/ndc-nodejs-lambda/values.yaml | 37 +++++++++++++--------- charts/ndc-postgres/Chart.yaml | 4 +-- charts/ndc-postgres/README.md | 27 ++++++---------- charts/ndc-postgres/templates/secret.yaml | 9 ++++-- charts/ndc-postgres/values.yaml | 35 +++++++++++++-------- charts/v3-engine/Chart.yaml | 4 +-- charts/v3-engine/README.md | 12 +++---- charts/v3-engine/templates/secret.yaml | 2 +- charts/v3-engine/values.yaml | 38 ++++++++++++++--------- 23 files changed, 243 insertions(+), 217 deletions(-) diff --git a/charts/ndc-connector-oracle/Chart.yaml b/charts/ndc-connector-oracle/Chart.yaml index 187850a..f251e72 100644 --- a/charts/ndc-connector-oracle/Chart.yaml +++ b/charts/ndc-connector-oracle/Chart.yaml @@ -15,13 +15,13 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.3.0 +version: v2024.10.18 # This is the version number of the application being deployed. This version number should be # 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. # It is recommended to use it with quotes. -appVersion: "1.16.0" +appVersion: "3.0.0" dependencies: - name: common diff --git a/charts/ndc-connector-oracle/README.md b/charts/ndc-connector-oracle/README.md index c97e8ae..284ceb5 100644 --- a/charts/ndc-connector-oracle/README.md +++ b/charts/ndc-connector-oracle/README.md @@ -10,11 +10,13 @@ See all [configuration](#parameters) below. # EXAMPLES: # helm template and apply manifests via kubectl (example) -helm template \ +helm template \ --set image.repository="my_repo/ndc-jvm-oracle" \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.JDBC_URL="jdbc_url" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-connector-oracle | kubectl apply -f- # helm upgrade --install (pass configuration via command line) @@ -23,17 +25,8 @@ helm upgrade --install \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.JDBC_URL="jdbc_url" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - hasura-ddn/ndc-connector-oracle - -# helm upgrade --install (with OTEL variabes) -helm upgrade --install \ - --set image.repository="my_repo/ndc-jvm-oracle" \ - --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.JDBC_URL="jdbc_url" \ - --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - --set otel.deployOtelCollector="true" \ - --set otel.dataPlaneID= \ - --set otel.dataPlaneKey= \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-connector-oracle ``` @@ -58,11 +51,11 @@ helm upgrade --install \ | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | | `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `otel.deployOtelCollector` | Deploy OTEL collector as sidecar to ndc-connector-oracle container | `true` | -| `otel.endpoint` | OTEL endpoint under Hasura | `https://gateway.otlp.hasura.io:443` | -| `otel.dataPlaneID` | Oauth Client ID for pushing telemetry data to endpoint | `""` | -| `otel.dataPlaneKey` | Oauth Client Secret for pushing telemetry data to endpoint | `""` | -| `otel.oauthTokenEndpoint` | Oauth Token URL | `""` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-connector-oracle pod | `[]` | | `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-oracle pod | `[]` | | `resources` | Resource requests and limits of ndc-connector-oracle container | `{}` | diff --git a/charts/ndc-connector-oracle/values.yaml b/charts/ndc-connector-oracle/values.yaml index 6c2d2b8..3b3541b 100644 --- a/charts/ndc-connector-oracle/values.yaml +++ b/charts/ndc-connector-oracle/values.yaml @@ -42,24 +42,33 @@ hpa: type: Utilization averageUtilization: 80 # Target 80% memory utilization per pod -otel: - deployOtelCollector: false - endpoint: https://gateway.otlp.hasura.io:443 - dataPlaneID: "" - dataPlaneKey: "" +# Observability defaults are tuned for Hasura hosted Control Plane +# Enable observability +observability: + enabled: true + +# Required (when observability.enabled is set to true) +dataPlane: + id: "" + key: "" + +controlPlane: + otlpEndpoint: https://gateway.otlp.hasura.io:443 oauthTokenEndpoint: https://ddn-oauth.pro.hasura.io/oauth2/token + +otel: config: | extensions: oauth2client: - client_id: {{ .Values.otel.dataPlaneID }} - client_secret: {{ .Values.otel.dataPlaneKey }} - token_url: {{ .Values.otel.oauthTokenEndpoint }} + client_id: {{ .Values.dataPlane.id }} + client_secret: {{ .Values.dataPlane.key }} + token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: audience: https://ddn.hasura.io exporters: otlp/oauth: - endpoint: {{ .Values.otel.endpoint }} + endpoint: {{ .Values.controlPlane.otlpEndpoint }} auth: authenticator: oauth2client processors: @@ -94,10 +103,10 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: otel-config secret: secretName: {{ printf "%s-secret" (include "common.name" .) }} @@ -107,7 +116,7 @@ extraVolumes: | {{- end }} extraContainers: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: "otel-collector" command: - --config=/etc/otel-collector-config.yaml @@ -115,7 +124,7 @@ extraContainers: | image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.otel.endpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config mountPath: "/etc/otelcol-contrib/config.yaml" diff --git a/charts/ndc-connector-phoenix/Chart.yaml b/charts/ndc-connector-phoenix/Chart.yaml index 9f4468a..faee69b 100644 --- a/charts/ndc-connector-phoenix/Chart.yaml +++ b/charts/ndc-connector-phoenix/Chart.yaml @@ -15,13 +15,13 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.3.0 +version: v2024.10.18 # This is the version number of the application being deployed. This version number should be # 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. # It is recommended to use it with quotes. -appVersion: "1.16.0" +appVersion: "3.0.0" dependencies: - name: common diff --git a/charts/ndc-connector-phoenix/README.md b/charts/ndc-connector-phoenix/README.md index 1154fb1..4714501 100644 --- a/charts/ndc-connector-phoenix/README.md +++ b/charts/ndc-connector-phoenix/README.md @@ -10,11 +10,13 @@ See all [configuration](#parameters) below. # EXAMPLES: # helm template and apply manifests via kubectl (example) -helm template \ +helm template \ --set image.repository="my_repo/ndc-jvm-phoenix" \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.JDBC_URL="jdbc_url" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-connector-phoenix | kubectl apply -f- # helm upgrade --install (pass configuration via command line) @@ -23,17 +25,8 @@ helm upgrade --install \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.JDBC_URL="jdbc_url" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - hasura-ddn/ndc-connector-phoenix - -# helm upgrade --install (with OTEL variabes) -helm upgrade --install \ - --set image.repository="my_repo/ndc-jvm-phoenix" \ - --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.JDBC_URL="jdbc_url" \ - --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - --set otel.deployOtelCollector="true" \ - --set otel.dataPlaneID= \ - --set otel.dataPlaneKey= \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-connector-phoenix ``` @@ -58,11 +51,11 @@ helm upgrade --install \ | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | | `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `otel.deployOtelCollector` | Deploy OTEL collector as sidecar to ndc-connector-phoenix container | `true` | -| `otel.endpoint` | OTEL endpoint under Hasura | `https://gateway.otlp.hasura.io:443` | -| `otel.dataPlaneID` | Oauth Client ID for pushing telemetry data to endpoint | `""` | -| `otel.dataPlaneKey` | Oauth Client Secret for pushing telemetry data to endpoint | `""` | -| `otel.oauthTokenEndpoint` | Oauth Token URL | `""` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-connector-phoenix pod | `[]` | | `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-phoenix pod | `[]` | | `resources` | Resource requests and limits of ndc-connector-phoenix container | `{}` | diff --git a/charts/ndc-connector-phoenix/values.yaml b/charts/ndc-connector-phoenix/values.yaml index 416f7d5..bb27cf2 100644 --- a/charts/ndc-connector-phoenix/values.yaml +++ b/charts/ndc-connector-phoenix/values.yaml @@ -42,24 +42,33 @@ hpa: type: Utilization averageUtilization: 80 # Target 80% memory utilization per pod -otel: - deployOtelCollector: true - endpoint: https://gateway.otlp.hasura.io:443 - dataPlaneID: "" - dataPlaneKey: "" +# Observability defaults are tuned for Hasura hosted Control Plane +# Enable observability +observability: + enabled: true + +# Required (when observability.enabled is set to true) +dataPlane: + id: "" + key: "" + +controlPlane: + otlpEndpoint: https://gateway.otlp.hasura.io:443 oauthTokenEndpoint: https://ddn-oauth.pro.hasura.io/oauth2/token + +otel: config: | extensions: oauth2client: - client_id: {{ .Values.otel.dataPlaneID }} - client_secret: {{ .Values.otel.dataPlaneKey }} - token_url: {{ .Values.otel.oauthTokenEndpoint }} + client_id: {{ .Values.dataPlane.id }} + client_secret: {{ .Values.dataPlane.key }} + token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: audience: https://ddn.hasura.io exporters: otlp/oauth: - endpoint: {{ .Values.otel.endpoint }} + endpoint: {{ .Values.controlPlane.otlpEndpoint }} auth: authenticator: oauth2client processors: @@ -94,10 +103,10 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: otel-config secret: secretName: {{ printf "%s-secret" (include "common.name" .) }} @@ -107,7 +116,7 @@ extraVolumes: | {{- end }} extraContainers: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: "otel-collector" command: - --config=/etc/otel-collector-config.yaml @@ -115,7 +124,7 @@ extraContainers: | image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.otel.endpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config mountPath: "/etc/otelcol-contrib/config.yaml" diff --git a/charts/ndc-graphql/Chart.yaml b/charts/ndc-graphql/Chart.yaml index 07307af..50c4877 100644 --- a/charts/ndc-graphql/Chart.yaml +++ b/charts/ndc-graphql/Chart.yaml @@ -15,13 +15,13 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.3.0 +version: v2024.10.18 # This is the version number of the application being deployed. This version number should be # 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. # It is recommended to use it with quotes. -appVersion: "1.16.0" +appVersion: "3.0.0" dependencies: - name: common diff --git a/charts/ndc-graphql/README.md b/charts/ndc-graphql/README.md index 5b4f2ca..f34ac34 100644 --- a/charts/ndc-graphql/README.md +++ b/charts/ndc-graphql/README.md @@ -10,11 +10,13 @@ See all [configuration](#parameters) below. # EXAMPLES: # helm template and apply manifests via kubectl (example) -helm template \ +helm template \ --set image.repository="my_repo/ndc-graphql" \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-graphql | kubectl apply -f- # helm upgrade --install (pass configuration via command line) @@ -23,17 +25,8 @@ helm upgrade --install \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - hasura-ddn/ndc-graphql - -# helm upgrade --install (with OTEL variabes) -helm upgrade --install \ - --set image.repository="my_repo/ndc-graphql" \ - --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ - --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - --set otel.deployOtelCollector="true" \ - --set otel.dataPlaneID= \ - --set otel.dataPlaneKey= \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-graphql ``` @@ -58,11 +51,11 @@ helm upgrade --install \ | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | | `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `otel.deployOtelCollector` | Deploy OTEL collector as sidecar to ndc-graphql container | `true` | -| `otel.endpoint` | OTEL endpoint under Hasura | `https://gateway.otlp.hasura.io:443` | -| `otel.dataPlaneID` | Oauth Client ID for pushing telemetry data to endpoint | `""` | -| `otel.dataPlaneKey` | Oauth Client Secret for pushing telemetry data to endpoint | `""` | -| `otel.oauthTokenEndpoint` | Oauth Token URL | `""` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-graphql pod | `[]` | | `extraContainers` | Optionally specify extra list of additional containers for the ndc-graphql pod | `[]` | | | `resources` | Resource requests and limits of ndc-graphql container | `{}` | diff --git a/charts/ndc-graphql/values.yaml b/charts/ndc-graphql/values.yaml index fcfe293..acd463f 100644 --- a/charts/ndc-graphql/values.yaml +++ b/charts/ndc-graphql/values.yaml @@ -42,24 +42,33 @@ hpa: type: Utilization averageUtilization: 80 # Target 80% memory utilization per pod -otel: - deployOtelCollector: true - endpoint: https://gateway.otlp.hasura.io:443 - dataPlaneID: "" - dataPlaneKey: "" +# Observability defaults are tuned for Hasura hosted Control Plane +# Enable observability +observability: + enabled: true + +# Required (when observability.enabled is set to true) +dataPlane: + id: "" + key: "" + +controlPlane: + otlpEndpoint: https://gateway.otlp.hasura.io:443 oauthTokenEndpoint: https://ddn-oauth.pro.hasura.io/oauth2/token + +otel: config: | extensions: oauth2client: - client_id: {{ .Values.otel.dataPlaneID }} - client_secret: {{ .Values.otel.dataPlaneKey }} - token_url: {{ .Values.otel.oauthTokenEndpoint }} + client_id: {{ .Values.dataPlane.id }} + client_secret: {{ .Values.dataPlane.key }} + token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: audience: https://ddn.hasura.io exporters: otlp/oauth: - endpoint: {{ .Values.otel.endpoint }} + endpoint: {{ .Values.controlPlane.otlpEndpoint }} auth: authenticator: oauth2client processors: @@ -97,7 +106,7 @@ otel: - otlp extraVolumes: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: otel-config secret: secretName: {{ printf "%s-secret" (include "common.name" .) }} @@ -107,7 +116,7 @@ extraVolumes: | {{- end }} extraContainers: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: "otel-collector" command: - --config=/etc/otel-collector-config.yaml @@ -115,7 +124,7 @@ extraContainers: | image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.otel.endpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config mountPath: "/etc/otelcol-contrib/config.yaml" diff --git a/charts/ndc-mongodb/Chart.yaml b/charts/ndc-mongodb/Chart.yaml index 1222090..e12dc1d 100644 --- a/charts/ndc-mongodb/Chart.yaml +++ b/charts/ndc-mongodb/Chart.yaml @@ -15,13 +15,13 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.3.0 +version: v2024.10.18 # This is the version number of the application being deployed. This version number should be # 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. # It is recommended to use it with quotes. -appVersion: "1.16.0" +appVersion: "3.0.0" dependencies: - name: common diff --git a/charts/ndc-mongodb/README.md b/charts/ndc-mongodb/README.md index 39b7b76..e185d5b 100644 --- a/charts/ndc-mongodb/README.md +++ b/charts/ndc-mongodb/README.md @@ -10,11 +10,13 @@ See all [configuration](#parameters) below. # EXAMPLES: # helm template and apply manifests via kubectl (example) -helm template \ +helm template \ --set image.repository="my_repo/ndc-mongodb" \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.MONGODB_DATABASE_URI="db_connection_string" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-mongodb | kubectl apply -f- # helm upgrade --install (pass configuration via command line) @@ -23,17 +25,8 @@ helm upgrade --install \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.MONGODB_DATABASE_URI="db_connection_string" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - hasura-ddn/ndc-mongodb - -# helm upgrade --install (with OTEL variabes) -helm upgrade --install \ - --set image.repository="my_repo/ndc-mongodb" \ - --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.MONGODB_DATABASE_URI="db_connection_string" \ - --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - --set otel.deployOtelCollector="true" \ - --set otel.dataPlaneID= \ - --set otel.dataPlaneKey= \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-mongodb ``` @@ -58,11 +51,11 @@ helm upgrade --install \ | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | | `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `otel.deployOtelCollector` | Deploy OTEL collector as sidecar to ndc-mongodb container | `true` | -| `otel.endpoint` | OTEL endpoint under Hasura | `https://gateway.otlp.hasura.io:443` | -| `otel.dataPlaneID` | Oauth Client ID for pushing telemetry data to endpoint | `""` | -| `otel.dataPlaneKey` | Oauth Client Secret for pushing telemetry data to endpoint | `""` | -| `otel.oauthTokenEndpoint` | Oauth Token URL | `""` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-mongodb pod | `[]` | | `extraContainers` | Optionally specify extra list of additional containers for the ndc-mongodb pod | `[]` | | `resources` | Resource requests and limits of ndc-mongodb container | `{}` | diff --git a/charts/ndc-mongodb/values.yaml b/charts/ndc-mongodb/values.yaml index 6e03f53..686cb73 100644 --- a/charts/ndc-mongodb/values.yaml +++ b/charts/ndc-mongodb/values.yaml @@ -42,24 +42,33 @@ hpa: type: Utilization averageUtilization: 80 # Target 80% memory utilization per pod -otel: - deployOtelCollector: false - endpoint: https://gateway.otlp.hasura.io:443 - dataPlaneID: "" - dataPlaneKey: "" +# Observability defaults are tuned for Hasura hosted Control Plane +# Enable observability +observability: + enabled: true + +# Required (when observability.enabled is set to true) +dataPlane: + id: "" + key: "" + +controlPlane: + otlpEndpoint: https://gateway.otlp.hasura.io:443 oauthTokenEndpoint: https://ddn-oauth.pro.hasura.io/oauth2/token + +otel: config: | extensions: oauth2client: - client_id: {{ .Values.otel.dataPlaneID }} - client_secret: {{ .Values.otel.dataPlaneKey }} - token_url: {{ .Values.otel.oauthTokenEndpoint }} + client_id: {{ .Values.dataPlane.id }} + client_secret: {{ .Values.dataPlane.key }} + token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: audience: https://ddn.hasura.io exporters: otlp/oauth: - endpoint: {{ .Values.otel.endpoint }} + endpoint: {{ .Values.controlPlane.otlpEndpoint }} auth: authenticator: oauth2client processors: @@ -94,10 +103,10 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: otel-config secret: secretName: {{ printf "%s-secret" (include "common.name" .) }} @@ -107,7 +116,7 @@ extraVolumes: | {{- end }} extraContainers: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: "otel-collector" command: - --config=/etc/otel-collector-config.yaml @@ -115,7 +124,7 @@ extraContainers: | image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.otel.endpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config mountPath: "/etc/otelcol-contrib/config.yaml" diff --git a/charts/ndc-nodejs-lambda/Chart.yaml b/charts/ndc-nodejs-lambda/Chart.yaml index d73f366..e7ab4c8 100644 --- a/charts/ndc-nodejs-lambda/Chart.yaml +++ b/charts/ndc-nodejs-lambda/Chart.yaml @@ -15,13 +15,13 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.3.0 +version: v2024.10.18 # This is the version number of the application being deployed. This version number should be # 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. # It is recommended to use it with quotes. -appVersion: "1.16.0" +appVersion: "3.0.0" dependencies: - name: common diff --git a/charts/ndc-nodejs-lambda/README.md b/charts/ndc-nodejs-lambda/README.md index c5e82a9..08a388a 100644 --- a/charts/ndc-nodejs-lambda/README.md +++ b/charts/ndc-nodejs-lambda/README.md @@ -10,10 +10,12 @@ See all [configuration](#parameters) below. # EXAMPLES: # helm template and apply manifests via kubectl (example) -helm template \ +helm template \ --set image.repository="my_repo/ndc-nodejs-lambda" \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/nodejs-lambda | kubectl apply -f- # helm upgrade --install (pass configuration via command line) @@ -21,16 +23,8 @@ helm upgrade --install \ --set image.repository="my_repo/ndc-nodejs-lambda" \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - hasura-ddn/nodejs-lambda - -# helm upgrade --install (with OTEL variabes) -helm upgrade --install \ - --set image.repository="my_repo/ndc-nodejs-lambda" \ - --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - --set otel.deployOtelCollector="true" \ - --set otel.dataPlaneID= \ - --set otel.dataPlaneKey= \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/nodejs-lambda ``` @@ -55,11 +49,11 @@ helm upgrade --install \ | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | | `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `otel.deployOtelCollector` | Deploy OTEL collector as sidecar to ndc-nodejs-lambda container | `true` | -| `otel.endpoint` | OTEL endpoint under Hasura | `https://gateway.otlp.hasura.io:443` | -| `otel.dataPlaneID` | Oauth Client ID for pushing telemetry data to endpoint | `""` | -| `otel.dataPlaneKey` | Oauth Client Secret for pushing telemetry data to endpoint | `""` | -| `otel.oauthTokenEndpoint` | Oauth Token URL | `""` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-nodejs-lambda pod | `[]` | | `extraContainers` | Optionally specify extra list of additional containers for the ndc-nodejs-lambda pod | `[]` | | | `resources` | Resource requests and limits of ndc-nodejs-lambda container | `{}` | diff --git a/charts/ndc-nodejs-lambda/values.yaml b/charts/ndc-nodejs-lambda/values.yaml index 2ecfd13..4170d1a 100644 --- a/charts/ndc-nodejs-lambda/values.yaml +++ b/charts/ndc-nodejs-lambda/values.yaml @@ -48,24 +48,33 @@ hpa: type: Utilization averageUtilization: 80 # Target 80% memory utilization per pod -otel: - deployOtelCollector: true - endpoint: https://gateway.otlp.hasura.io:443 - dataPlaneID: "" - dataPlaneKey: "" +# Observability defaults are tuned for Hasura hosted Control Plane +# Enable observability +observability: + enabled: true + +# Required (when observability.enabled is set to true) +dataPlane: + id: "" + key: "" + +controlPlane: + otlpEndpoint: https://gateway.otlp.hasura.io:443 oauthTokenEndpoint: https://ddn-oauth.pro.hasura.io/oauth2/token + +otel: config: | extensions: oauth2client: - client_id: {{ .Values.otel.dataPlaneID }} - client_secret: {{ .Values.otel.dataPlaneKey }} - token_url: {{ .Values.otel.oauthTokenEndpoint }} + client_id: {{ .Values.dataPlane.id }} + client_secret: {{ .Values.dataPlane.key }} + token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: audience: https://ddn.hasura.io exporters: otlp/oauth: - endpoint: {{ .Values.otel.endpoint }} + endpoint: {{ .Values.controlPlane.otlpEndpoint }} auth: authenticator: oauth2client processors: @@ -100,10 +109,10 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: otel-config secret: secretName: {{ printf "%s-secret" (include "common.name" .) }} @@ -113,17 +122,15 @@ extraVolumes: | {{- end }} extraContainers: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: "otel-collector" command: - --config=/etc/otel-collector-config.yaml command: image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - - name: "HASURA_DDN_PAT" - value: "" - name: "OTEL_ENDPOINT" - value: "{{ .Values.otel.endpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config mountPath: "/etc/otelcol-contrib/config.yaml" diff --git a/charts/ndc-postgres/Chart.yaml b/charts/ndc-postgres/Chart.yaml index cfb2622..fc46e50 100644 --- a/charts/ndc-postgres/Chart.yaml +++ b/charts/ndc-postgres/Chart.yaml @@ -15,13 +15,13 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.3.0 +version: v2024.10.18 # This is the version number of the application being deployed. This version number should be # 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. # It is recommended to use it with quotes. -appVersion: "1.16.0" +appVersion: "3.0.0" dependencies: - name: common diff --git a/charts/ndc-postgres/README.md b/charts/ndc-postgres/README.md index a005f9b..7b5b0f6 100644 --- a/charts/ndc-postgres/README.md +++ b/charts/ndc-postgres/README.md @@ -10,11 +10,13 @@ See all [configuration](#parameters) below. # EXAMPLES: # helm template and apply manifests via kubectl (example) -helm template \ +helm template \ --set image.repository="my_repo/ndc-postgres" \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.CONNECTION_URI="db_connection_string" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-postgres | kubectl apply -f- # helm upgrade --install (pass configuration via command line) @@ -23,17 +25,8 @@ helm upgrade --install \ --set image.tag="my_custom_image_tag" \ --set connectorEnvVars.CONNECTION_URI="db_connection_string" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - hasura-ddn/ndc-postgres - -# helm upgrade --install (with OTEL variabes) -helm upgrade --install \ - --set image.repository="my_repo/ndc-postgres" \ - --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.CONNECTION_URI="db_connection_string" \ - --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ - --set otel.deployOtelCollector="true" \ - --set otel.dataPlaneID= \ - --set otel.dataPlaneKey= \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/ndc-postgres ``` @@ -58,11 +51,11 @@ helm upgrade --install \ | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | | `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `otel.deployOtelCollector` | Deploy OTEL collector as sidecar to ndc-postgres container | `true` | -| `otel.endpoint` | OTEL endpoint under Hasura | `https://gateway.otlp.hasura.io:443` | -| `otel.dataPlaneID` | Oauth Client ID for pushing telemetry data to endpoint | `""` | -| `otel.dataPlaneKey` | Oauth Client Secret for pushing telemetry data to endpoint | `""` | -| `otel.oauthTokenEndpoint` | Oauth Token URL | `""` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-postgres pod | `[]` | | `extraContainers` | Optionally specify extra list of additional containers for the ndc-postgres pod | `[]` | | | `resources` | Resource requests and limits of ndc-postgres container | `{}` | diff --git a/charts/ndc-postgres/templates/secret.yaml b/charts/ndc-postgres/templates/secret.yaml index 6cf6dff..a1f974d 100644 --- a/charts/ndc-postgres/templates/secret.yaml +++ b/charts/ndc-postgres/templates/secret.yaml @@ -6,10 +6,15 @@ metadata: data: HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} CONNECTION_URI: {{ .Values.connectorEnvVars.CONNECTION_URI | b64enc | quote }} + {{- if .Values.connectorEnvVars.CLIENT_CERT }} CLIENT_CERT: {{ .Values.connectorEnvVars.CLIENT_CERT | b64enc | quote }} + {{- end }} + {{- if .Values.connectorEnvVars.CLIENT_KEY }} CLIENT_KEY: {{ .Values.connectorEnvVars.CLIENT_KEY | b64enc | quote }} + {{- end }} + {{- if .Values.connectorEnvVars.ROOT_CERT }} ROOT_CERT: {{ .Values.connectorEnvVars.ROOT_CERT | b64enc | quote }} -{{- if .Values.otel.deployOtelCollector }} + {{- end }} +{{- if .Values.observability.enabled }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} - diff --git a/charts/ndc-postgres/values.yaml b/charts/ndc-postgres/values.yaml index 26ea4e0..2cb6993 100644 --- a/charts/ndc-postgres/values.yaml +++ b/charts/ndc-postgres/values.yaml @@ -40,26 +40,35 @@ hpa: name: memory target: type: Utilization - averageUtilization: 80 # Target 80% memory utilization per pod + averageUtilization: 80 # Target 80% memory utilization per pod -otel: - deployOtelCollector: false - endpoint: https://gateway.otlp.hasura.io:443 - dataPlaneID: "" - dataPlaneKey: "" +# Observability defaults are tuned for Hasura hosted Control Plane +# Enable observability +observability: + enabled: true + +# Required (when observability.enabled is set to true) +dataPlane: + id: "" + key: "" + +controlPlane: + otlpEndpoint: https://gateway.otlp.hasura.io:443 oauthTokenEndpoint: https://ddn-oauth.pro.hasura.io/oauth2/token + +otel: config: | extensions: oauth2client: - client_id: {{ .Values.otel.dataPlaneID }} - client_secret: {{ .Values.otel.dataPlaneKey }} - token_url: {{ .Values.otel.oauthTokenEndpoint }} + client_id: {{ .Values.dataPlane.id }} + client_secret: {{ .Values.dataPlane.key }} + token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: audience: https://ddn.hasura.io exporters: otlp/oauth: - endpoint: {{ .Values.otel.endpoint }} + endpoint: {{ .Values.controlPlane.otlpEndpoint }} auth: authenticator: oauth2client processors: @@ -97,7 +106,7 @@ otel: - otlp extraVolumes: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: otel-config secret: secretName: {{ printf "%s-secret" (include "common.name" .) }} @@ -107,7 +116,7 @@ extraVolumes: | {{- end }} extraContainers: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: "otel-collector" command: - --config=/etc/otel-collector-config.yaml @@ -115,7 +124,7 @@ extraContainers: | image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.otel.endpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config mountPath: "/etc/otelcol-contrib/config.yaml" diff --git a/charts/v3-engine/Chart.yaml b/charts/v3-engine/Chart.yaml index a002f25..e6d8648 100644 --- a/charts/v3-engine/Chart.yaml +++ b/charts/v3-engine/Chart.yaml @@ -15,13 +15,13 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.3.0 +version: v2024.10.18 # This is the version number of the application being deployed. This version number should be # 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. # It is recommended to use it with quotes. -appVersion: "1.16.0" +appVersion: "3.0.0" dependencies: - name: common diff --git a/charts/v3-engine/README.md b/charts/v3-engine/README.md index f0be329..b348f64 100644 --- a/charts/v3-engine/README.md +++ b/charts/v3-engine/README.md @@ -69,12 +69,12 @@ helm upgrade --install \ | `authnConfigPath` | Path to `auth_config.json` | `/md/auth_config.json` | | `metadataPath` | Path to `metadata.json` | `/md/metadata.json` | | `enableCors` | Enable CORS by sending appropriate headers | `true` | -| `otel.deployOtelCollector` | Deploy OTEL collector as sidecar to v3-engine container | `true` | -| `otel.endpoint` | OTEL endpoint under Hasura | `https://gateway.otlp.hasura.io:443` | -| `otel.dataPlaneID` | Oauth Client ID for pushing telemetry data to endpoint | `""` | -| `otel.dataPlaneKey` | Oauth Client Secret for pushing telemetry data to endpoint | `""` | -| `otel.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | -| `otel.hasuraCanonicalHostname` | Hasura Canonical Hostname (Project hostname) | `""` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `observability.hostName` | Hasura Observability Hostname (Required when observability.enabled is set to true) | `""` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the v3-engine pod | `[]` | | `extraContainers` | Optionally specify extra list of additional containers for the v3-engine pod | `[]` | | `securityContext` | Define privilege and access control settings for a Pod or Container | `{}` | diff --git a/charts/v3-engine/templates/secret.yaml b/charts/v3-engine/templates/secret.yaml index 6ad2830..4bdf429 100644 --- a/charts/v3-engine/templates/secret.yaml +++ b/charts/v3-engine/templates/secret.yaml @@ -4,6 +4,6 @@ metadata: name: {{ printf "%s-secret" (include "common.name" .) }} namespace: {{ template "common.namespace" $ }} data: -{{- if .Values.otel.deployOtelCollector }} +{{- if .Values.observability.enabled }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} \ No newline at end of file diff --git a/charts/v3-engine/values.yaml b/charts/v3-engine/values.yaml index 0baeba5..797d5f4 100644 --- a/charts/v3-engine/values.yaml +++ b/charts/v3-engine/values.yaml @@ -41,25 +41,35 @@ hpa: type: Utilization averageUtilization: 80 # Target 80% memory utilization per pod -otel: - deployOtelCollector: false - endpoint: https://gateway.otlp.hasura.io:443 - dataPlaneID: "" - dataPlaneKey: "" +# Observability defaults are tuned for Hasura hosted Control Plane +# Enable observability +observability: + enabled: true + # Required (when observability.enabled is set to true) + hostName: "" + +# Required (when observability.enabled is set to true) +dataPlane: + id: "" + key: "" + +controlPlane: + otlpEndpoint: https://gateway.otlp.hasura.io:443 oauthTokenEndpoint: https://ddn-oauth.pro.hasura.io/oauth2/token - hasuraCanonicalHost: "" + +otel: config: | extensions: oauth2client: - client_id: {{ .Values.otel.dataPlaneID }} - client_secret: {{ .Values.otel.dataPlaneKey}} - token_url: {{ .Values.otel.oauthTokenEndpoint }} + client_id: {{ .Values.dataPlane.id }} + client_secret: {{ .Values.dataPlane.key}} + token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: audience: https://ddn.hasura.io exporters: otlp/oauth: - endpoint: {{ .Values.otel.endpoint }} + endpoint: {{ .Values.controlPlane.otlpEndpoint }} auth: authenticator: oauth2client processors: @@ -68,7 +78,7 @@ otel: actions: - key: http.host action: upsert - value: {{ .Values.otel.hasuraCanonicalHost }} + value: {{ .Values.observability.hostName }} receivers: otlp: protocols: @@ -113,7 +123,7 @@ authnConfigPath: /md/auth_config.json enableCors: true extraVolumes: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: otel-config secret: secretName: {{ printf "%s-secret" (include "common.name" .) }} @@ -123,7 +133,7 @@ extraVolumes: | {{- end }} extraContainers: | - {{- if .Values.otel.deployOtelCollector }} + {{- if .Values.observability.enabled }} - name: "otel-collector" command: - --config=/etc/otel-collector-config.yaml @@ -131,7 +141,7 @@ extraContainers: | image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.otel.endpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config mountPath: "/etc/otelcol-contrib/config.yaml" From 0bf1a20fbff2c29c2e237c2ce06195569d3b78a5 Mon Sep 17 00:00:00 2001 From: Tom Skawinski Date: Thu, 17 Oct 2024 09:48:02 -0400 Subject: [PATCH 4/8] v3-engine README update related to OTEL --- charts/v3-engine/README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/charts/v3-engine/README.md b/charts/v3-engine/README.md index b348f64..fd4be2c 100644 --- a/charts/v3-engine/README.md +++ b/charts/v3-engine/README.md @@ -10,25 +10,21 @@ See all [configuration](#parameters) below. # EXAMPLES: # helm template and apply manifests via kubectl (example) -helm template \ +helm template \ --set image.repository="my_repo/v3-engine" \ --set image.tag="my_custom_image_tag" \ + --set observability.hostName="observability_hostname" \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/v3-engine | kubectl apply -f- # helm upgrade --install (pass configuration via command line) helm upgrade --install \ --set image.repository="my_repo/v3-engine" \ --set image.tag="my_custom_image_tag" \ - hasura-ddn/v3-engine - -# helm upgrade --install (with OTEL variabes) -helm upgrade --install \ - --set image.repository="my_repo/v3-engine" \ - --set image.tag="my_custom_image_tag" \ - --set otel.deployOtelCollector="true" \ - --set otel.dataPlaneID= \ - --set otel.dataPlaneKey= \ - --set otel.hasuraCanonicalHost=. \ + --set observability.hostName="observability_hostname" \ + --set dataPlane.id="data_plane_id" \ + --set dataPlane.key="data_plane_key" \ hasura-ddn/v3-engine ``` From 55c0a15757c89ef92c36c5d2e0efc05f0d8bd7e1 Mon Sep 17 00:00:00 2001 From: Tom Skawinski Date: Thu, 17 Oct 2024 10:15:42 -0400 Subject: [PATCH 5/8] Re-arrenge documented parameters within READMEs --- charts/ndc-connector-oracle/README.md | 38 +++++++++++------------ charts/ndc-connector-phoenix/README.md | 36 +++++++++++----------- charts/ndc-graphql/README.md | 36 +++++++++++----------- charts/ndc-mongodb/README.md | 36 +++++++++++----------- charts/ndc-nodejs-lambda/README.md | 34 ++++++++++----------- charts/ndc-postgres/README.md | 42 +++++++++++++------------- charts/v3-engine/README.md | 16 +++++----- 7 files changed, 119 insertions(+), 119 deletions(-) diff --git a/charts/ndc-connector-oracle/README.md b/charts/ndc-connector-oracle/README.md index 284ceb5..3ae1003 100644 --- a/charts/ndc-connector-oracle/README.md +++ b/charts/ndc-connector-oracle/README.md @@ -30,7 +30,15 @@ helm upgrade --install \ hasura-ddn/ndc-connector-oracle ``` -## Parameters +## Connector ENV Inputs + +| Name | Description | Value | +| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.JDBC_URL` | The JDBC URL to connect to the database (Required) | `""` | +| `connectorEnvVars.JDBC_SCHEMAS` | A comma-separated list of schemas to include in the metadata (Optional) | `""` | + +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------| @@ -40,6 +48,15 @@ helm upgrade --install \ | `image.pullPolicy` | Image pull policy | `Always` | | `image.otelCollectorRepository` | OTEL collector image repository | `otel/opentelemetry-collector` | | `image.otelCollectorTag` | OTEL collector image tag | `0.104.0` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | +| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-connector-oracle pod | `[]` | +| `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-oracle pod | `[]` | +| `resources` | Resource requests and limits of ndc-connector-oracle container | `{}` | +| `env` | Env variable section for ndc-connector-oracle | `[]` | | `replicas` | Replicas setting for pod | `1` | | `wsInactiveExpiryMins` | To be documented | `1` | | `securityContext` | Define privilege and access control settings for a Pod or Container | `{}` | @@ -50,21 +67,4 @@ helm upgrade --install \ | `hpa.minReplicas` | minReplicas setting for HPA | `2` | | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | -| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | -| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | -| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | -| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | -| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | -| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-connector-oracle pod | `[]` | -| `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-oracle pod | `[]` | -| `resources` | Resource requests and limits of ndc-connector-oracle container | `{}` | -| `env` | Env variable section for ndc-connector-oracle | `[]` | - -## Connector ENV Inputs - -| Name | Description | Value | -| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connectorEnvVars.JDBC_URL` | The JDBC URL to connect to the database (Required) | `""` | -| `connectorEnvVars.JDBC_SCHEMAS` | A comma-separated list of schemas to include in the metadata (Optional) | `""` | \ No newline at end of file +| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | \ No newline at end of file diff --git a/charts/ndc-connector-phoenix/README.md b/charts/ndc-connector-phoenix/README.md index 4714501..27fd026 100644 --- a/charts/ndc-connector-phoenix/README.md +++ b/charts/ndc-connector-phoenix/README.md @@ -30,7 +30,14 @@ helm upgrade --install \ hasura-ddn/ndc-connector-phoenix ``` -## Parameters +## Connector ENV Inputs + +| Name | Description | Value | +| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.JDBC_URL` | The JDBC URL to connect to the database (Required) | `""` | + +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------| @@ -40,6 +47,15 @@ helm upgrade --install \ | `image.pullPolicy` | Image pull policy | `Always` | | `image.otelCollectorRepository` | OTEL collector image repository | `otel/opentelemetry-collector` | | `image.otelCollectorTag` | OTEL collector image tag | `0.104.0` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | +| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-connector-phoenix pod | `[]` | +| `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-phoenix pod | `[]` | +| `resources` | Resource requests and limits of ndc-connector-phoenix container | `{}` | +| `env` | Env variable section for ndc-connector-phoenix | `[]` | | `replicas` | Replicas setting for pod | `1` | | `wsInactiveExpiryMins` | To be documented | `1` | | `securityContext` | Define privilege and access control settings for a Pod or Container | `{}` | @@ -50,20 +66,4 @@ helm upgrade --install \ | `hpa.minReplicas` | minReplicas setting for HPA | `2` | | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | -| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | -| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | -| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | -| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | -| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | -| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-connector-phoenix pod | `[]` | -| `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-phoenix pod | `[]` | -| `resources` | Resource requests and limits of ndc-connector-phoenix container | `{}` | -| `env` | Env variable section for ndc-connector-phoenix | `[]` | - -## Connector ENV Inputs - -| Name | Description | Value | -| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connectorEnvVars.JDBC_URL` | The JDBC URL to connect to the database (Required) | `""` | \ No newline at end of file +| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | \ No newline at end of file diff --git a/charts/ndc-graphql/README.md b/charts/ndc-graphql/README.md index f34ac34..f1a0cab 100644 --- a/charts/ndc-graphql/README.md +++ b/charts/ndc-graphql/README.md @@ -30,7 +30,14 @@ helm upgrade --install \ hasura-ddn/ndc-graphql ``` -## Parameters +## Connector ENV Inputs + +| Name | Description | Value | +| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.GRAPHQL_ENDPOINT` | The GraphQL Endpoint (Required) | `""` | + +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | @@ -40,6 +47,15 @@ helm upgrade --install \ | `image.pullPolicy` | Image pull policy | `Always` | | `image.otelCollectorRepository` | OTEL collector image repository | `otel/opentelemetry-collector` | | `image.otelCollectorTag` | OTEL collector image tag | `0.104.0` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | +| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-graphql pod | `[]` | +| `extraContainers` | Optionally specify extra list of additional containers for the ndc-graphql pod | `[]` | | +| `resources` | Resource requests and limits of ndc-graphql container | `{}` | +| `env` | Env variable section for ndc-graphql | `[]` | | `replicas` | Replicas setting for pod | `1` | | `wsInactiveExpiryMins` | To be documented | `1` | | `securityContext` | Define privilege and access control settings for a Pod or Container | `{}` | @@ -50,20 +66,4 @@ helm upgrade --install \ | `hpa.minReplicas` | minReplicas setting for HPA | `2` | | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | -| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | -| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | -| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | -| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | -| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | -| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-graphql pod | `[]` | -| `extraContainers` | Optionally specify extra list of additional containers for the ndc-graphql pod | `[]` | | -| `resources` | Resource requests and limits of ndc-graphql container | `{}` | -| `env` | Env variable section for ndc-graphql | `[]` | - -## Connector ENV Inputs - -| Name | Description | Value | -| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connectorEnvVars.GRAPHQL_ENDPOINT` | The GraphQL Endpoint (Required) | `""` | \ No newline at end of file +| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | \ No newline at end of file diff --git a/charts/ndc-mongodb/README.md b/charts/ndc-mongodb/README.md index e185d5b..122c1cc 100644 --- a/charts/ndc-mongodb/README.md +++ b/charts/ndc-mongodb/README.md @@ -30,7 +30,14 @@ helm upgrade --install \ hasura-ddn/ndc-mongodb ``` -## Parameters +## Connector ENV Inputs + +| Name | Description | Value | +| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.MONGODB_DATABASE_URI` | Database Connection URI (Required) | `""` | + +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------| @@ -40,6 +47,15 @@ helm upgrade --install \ | `image.pullPolicy` | Image pull policy | `Always` | | `image.otelCollectorRepository` | OTEL collector image repository | `otel/opentelemetry-collector` | | `image.otelCollectorTag` | OTEL collector image tag | `0.104.0` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | +| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-mongodb pod | `[]` | +| `extraContainers` | Optionally specify extra list of additional containers for the ndc-mongodb pod | `[]` | +| `resources` | Resource requests and limits of ndc-mongodb container | `{}` | +| `env` | Env variable section for ndc-mongodb | `[]` | | `replicas` | Replicas setting for pod | `1` | | `wsInactiveExpiryMins` | To be documented | `1` | | `securityContext` | Define privilege and access control settings for a Pod or Container | `{}` | @@ -50,20 +66,4 @@ helm upgrade --install \ | `hpa.minReplicas` | minReplicas setting for HPA | `2` | | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | -| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | -| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | -| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | -| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | -| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | -| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-mongodb pod | `[]` | -| `extraContainers` | Optionally specify extra list of additional containers for the ndc-mongodb pod | `[]` | -| `resources` | Resource requests and limits of ndc-mongodb container | `{}` | -| `env` | Env variable section for ndc-mongodb | `[]` | - -## Connector ENV Inputs - -| Name | Description | Value | -| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connectorEnvVars.MONGODB_DATABASE_URI` | Database Connection URI (Required) | `""` | \ No newline at end of file +| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | \ No newline at end of file diff --git a/charts/ndc-nodejs-lambda/README.md b/charts/ndc-nodejs-lambda/README.md index 08a388a..a40436c 100644 --- a/charts/ndc-nodejs-lambda/README.md +++ b/charts/ndc-nodejs-lambda/README.md @@ -28,7 +28,13 @@ helm upgrade --install \ hasura-ddn/nodejs-lambda ``` -## Parameters +## Connector ENV Inputs + +| Name | Description | Value | +| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | + +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | @@ -38,6 +44,15 @@ helm upgrade --install \ | `image.pullPolicy` | Image pull policy | `Always` | | `image.otelCollectorRepository` | OTEL collector image repository | `otel/opentelemetry-collector` | | `image.otelCollectorTag` | OTEL collector image tag | `0.104.0` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | +| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-nodejs-lambda pod | `[]` | +| `extraContainers` | Optionally specify extra list of additional containers for the ndc-nodejs-lambda pod | `[]` | | +| `resources` | Resource requests and limits of ndc-nodejs-lambda container | `{}` | +| `env` | Env variable section for ndc-nodejs-lambda | `[]` | | `replicas` | Replicas setting for pod | `1` | | `wsInactiveExpiryMins` | To be documented | `1` | | `securityContext` | Define privilege and access control settings for a Pod or Container | `{}` | @@ -48,19 +63,4 @@ helm upgrade --install \ | `hpa.minReplicas` | minReplicas setting for HPA | `2` | | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | -| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | -| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | -| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | -| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | -| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | -| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-nodejs-lambda pod | `[]` | -| `extraContainers` | Optionally specify extra list of additional containers for the ndc-nodejs-lambda pod | `[]` | | -| `resources` | Resource requests and limits of ndc-nodejs-lambda container | `{}` | -| `env` | Env variable section for ndc-nodejs-lambda | `[]` | - -## Connector ENV Inputs - -| Name | Description | Value | -| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | \ No newline at end of file +| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | \ No newline at end of file diff --git a/charts/ndc-postgres/README.md b/charts/ndc-postgres/README.md index 7b5b0f6..cb44478 100644 --- a/charts/ndc-postgres/README.md +++ b/charts/ndc-postgres/README.md @@ -30,7 +30,17 @@ helm upgrade --install \ hasura-ddn/ndc-postgres ``` -## Parameters +## Connector ENV Inputs + +| Name | Description | Value | +| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | +| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | +| `connectorEnvVars.CONNECTION_URI` | Database Connection URI (Required) | `""` | +| `connectorEnvVars.CLIENT_CERT` | Database Client cert (Optional) | `""` | +| `connectorEnvVars.CLIENT_KEY` | Database Client key (Optional) | `""` | +| `connectorEnvVars.ROOT_CERT` | Database Root cert (Optional) | `""` | + +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | @@ -40,6 +50,15 @@ helm upgrade --install \ | `image.pullPolicy` | Image pull policy | `Always` | | `image.otelCollectorRepository` | OTEL collector image repository | `otel/opentelemetry-collector` | | `image.otelCollectorTag` | OTEL collector image tag | `0.104.0` | +| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | +| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | +| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | +| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | +| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | +| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-postgres pod | `[]` | +| `extraContainers` | Optionally specify extra list of additional containers for the ndc-postgres pod | `[]` | | +| `resources` | Resource requests and limits of ndc-postgres container | `{}` | +| `env` | Env variable section for ndc-postgres | `[]` | | `replicas` | Replicas setting for pod | `1` | | `wsInactiveExpiryMins` | To be documented | `1` | | `securityContext` | Define privilege and access control settings for a Pod or Container | `{}` | @@ -50,23 +69,4 @@ helm upgrade --install \ | `hpa.minReplicas` | minReplicas setting for HPA | `2` | | `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | | `hpa.metrics.resource.name` | Resource name to autoscale on | `` | -| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | -| `observability.enabled` | Deploy OTEL collector as sidecar | `true` | -| `dataPlane.id` | Data Plane ID (Required when observability.enabled is set to true) | `""` | -| `dataPlane.key` | Data Plane Key (Required when observability.enabled is set to true) | `""` | -| `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | -| `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | -| `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-postgres pod | `[]` | -| `extraContainers` | Optionally specify extra list of additional containers for the ndc-postgres pod | `[]` | | -| `resources` | Resource requests and limits of ndc-postgres container | `{}` | -| `env` | Env variable section for ndc-postgres | `[]` | - -## Connector ENV Inputs - -| Name | Description | Value | -| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -| `connectorEnvVars.CONNECTION_URI` | Database Connection URI (Required) | `""` | -| `connectorEnvVars.CLIENT_CERT` | Database Client cert (Optional) | `""` | -| `connectorEnvVars.CLIENT_KEY` | Database Client key (Optional) | `""` | -| `connectorEnvVars.ROOT_CERT` | Database Root cert (Optional) | `""` | \ No newline at end of file +| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | \ No newline at end of file diff --git a/charts/v3-engine/README.md b/charts/v3-engine/README.md index fd4be2c..230f4d0 100644 --- a/charts/v3-engine/README.md +++ b/charts/v3-engine/README.md @@ -53,14 +53,6 @@ helm upgrade --install \ | `image.tag` | Image tag to use for custom created v3-engine | `""` | | `image.otelCollectorRepository` | OTEL collector image repository | `otel/opentelemetry-collector` | | `image.otelCollectorTag` | OTEL collector image tag | `0.104.0` | -| `healthChecks.enabled` | Enable health check for v3-engine container | `true` | -| `healthChecks.livenessProbePath` | Health check liveness Probe path v3-engine container | `"/health"` | -| `healthChecks.readinessProbePath` | Health check readiness Probe path v3-engine container | `"/health"` | -| `hpa.enabled` | Enable HPA for mongo-connector. Ensure metrics cluster is configured when enabling | `false` | -| `hpa.minReplicas` | minReplicas setting for HPA | `2` | -| `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | -| `hpa.metrics.resource.name` | Resource name to autoscale on | `` | -| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | | `openDDPath` | Path to `opendd.json` | `/md/open_dd.json` | | `authnConfigPath` | Path to `auth_config.json` | `/md/auth_config.json` | | `metadataPath` | Path to `metadata.json` | `/md/metadata.json` | @@ -78,3 +70,11 @@ helm upgrade --install \ | `replicas` | Replicas setting for pod | `1` | | `resources` | Resource requests and limits of v3-engine container | `{}` | | `env` | Env variable section for v3-engine | `[]` | +| `healthChecks.enabled` | Enable health check for v3-engine container | `true` | +| `healthChecks.livenessProbePath` | Health check liveness Probe path v3-engine container | `"/health"` | +| `healthChecks.readinessProbePath` | Health check readiness Probe path v3-engine container | `"/health"` | +| `hpa.enabled` | Enable HPA for mongo-connector. Ensure metrics cluster is configured when enabling | `false` | +| `hpa.minReplicas` | minReplicas setting for HPA | `2` | +| `hpa.maxReplicas` | maxReplicas setting for HPA | `4` | +| `hpa.metrics.resource.name` | Resource name to autoscale on | `` | +| `hpa.metrics.resource.target.averageUtilization` | Utilization target on specific resource type | `` | \ No newline at end of file From e282d9997dddf2e077c02903b028dab5ca2265ef Mon Sep 17 00:00:00 2001 From: Tom Skawinski Date: Thu, 17 Oct 2024 13:17:51 -0400 Subject: [PATCH 6/8] Helm lint fixes --- charts/ndc-connector-oracle/templates/secret.yaml | 4 ++-- charts/ndc-connector-phoenix/templates/secret.yaml | 4 ++-- charts/ndc-graphql/templates/secret.yaml | 2 +- charts/ndc-graphql/values.yaml | 3 +-- charts/ndc-mongodb/templates/secret.yaml | 2 +- charts/ndc-nodejs-lambda/templates/secret.yaml | 2 +- 6 files changed, 8 insertions(+), 9 deletions(-) diff --git a/charts/ndc-connector-oracle/templates/secret.yaml b/charts/ndc-connector-oracle/templates/secret.yaml index 9ea41ae..7d7e22f 100644 --- a/charts/ndc-connector-oracle/templates/secret.yaml +++ b/charts/ndc-connector-oracle/templates/secret.yaml @@ -5,7 +5,7 @@ metadata: namespace: {{ template "common.namespace" $ }} data: HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} - MONGODB_DATABASE_URI: {{ .Values.connectorEnvVars.MONGODB_DATABASE_URI | b64enc | quote }} -{{- if .Values.otel.deployOtelCollector }} + JDBC_URL: {{ .Values.connectorEnvVars.JDBC_URL | b64enc | quote }} +{{- if .Values.observability.enabled }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} \ No newline at end of file diff --git a/charts/ndc-connector-phoenix/templates/secret.yaml b/charts/ndc-connector-phoenix/templates/secret.yaml index 9ea41ae..7d7e22f 100644 --- a/charts/ndc-connector-phoenix/templates/secret.yaml +++ b/charts/ndc-connector-phoenix/templates/secret.yaml @@ -5,7 +5,7 @@ metadata: namespace: {{ template "common.namespace" $ }} data: HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} - MONGODB_DATABASE_URI: {{ .Values.connectorEnvVars.MONGODB_DATABASE_URI | b64enc | quote }} -{{- if .Values.otel.deployOtelCollector }} + JDBC_URL: {{ .Values.connectorEnvVars.JDBC_URL | b64enc | quote }} +{{- if .Values.observability.enabled }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} \ No newline at end of file diff --git a/charts/ndc-graphql/templates/secret.yaml b/charts/ndc-graphql/templates/secret.yaml index 79e4376..3968bb9 100644 --- a/charts/ndc-graphql/templates/secret.yaml +++ b/charts/ndc-graphql/templates/secret.yaml @@ -6,7 +6,7 @@ metadata: data: HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} GRAPHQL_ENDPOINT: {{ .Values.connectorEnvVars.GRAPHQL_ENDPOINT | b64enc | quote }} -{{- if .Values.otel.deployOtelCollector }} +{{- if .Values.observability.enabled }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} diff --git a/charts/ndc-graphql/values.yaml b/charts/ndc-graphql/values.yaml index acd463f..baa9b18 100644 --- a/charts/ndc-graphql/values.yaml +++ b/charts/ndc-graphql/values.yaml @@ -153,7 +153,6 @@ env: | valueFrom: secretKeyRef: key: GRAPHQL_ENDPOINT - name: {{ printf "%s-secret" (include "common.name" .) }} - {{- end }} + name: {{ printf "%s-secret" (include "common.name" .) }} - name: OTEL_EXPORTER_OTLP_ENDPOINT value: http://localhost:4317 diff --git a/charts/ndc-mongodb/templates/secret.yaml b/charts/ndc-mongodb/templates/secret.yaml index 9ea41ae..709bada 100644 --- a/charts/ndc-mongodb/templates/secret.yaml +++ b/charts/ndc-mongodb/templates/secret.yaml @@ -6,6 +6,6 @@ metadata: data: HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} MONGODB_DATABASE_URI: {{ .Values.connectorEnvVars.MONGODB_DATABASE_URI | b64enc | quote }} -{{- if .Values.otel.deployOtelCollector }} +{{- if .Values.observability.enabled }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} \ No newline at end of file diff --git a/charts/ndc-nodejs-lambda/templates/secret.yaml b/charts/ndc-nodejs-lambda/templates/secret.yaml index 090af2f..a87909d 100644 --- a/charts/ndc-nodejs-lambda/templates/secret.yaml +++ b/charts/ndc-nodejs-lambda/templates/secret.yaml @@ -5,6 +5,6 @@ metadata: namespace: {{ template "common.namespace" $ }} data: HASURA_SERVICE_TOKEN_SECRET: {{ .Values.connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET | b64enc | quote }} -{{- if .Values.otel.deployOtelCollector }} +{{- if .Values.observability.enabled }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} \ No newline at end of file From 9321aca1394d356318fe7a70993d616632c75da0 Mon Sep 17 00:00:00 2001 From: Nithin <36623418+nithindv@users.noreply.github.com> Date: Fri, 18 Oct 2024 19:33:59 +0530 Subject: [PATCH 7/8] remove trailing spaces & others add validation for dataplane.key and id remove trailing spaces add custom helm release notes for v3-engine other fixes --- charts/ndc-connector-oracle/README.md | 6 ++--- .../templates/imagepullsecret.yaml | 6 ++--- charts/ndc-connector-oracle/values.yaml | 26 +++++++++---------- charts/ndc-connector-phoenix/README.md | 8 +++--- .../templates/imagepullsecret.yaml | 6 ++--- charts/ndc-connector-phoenix/values.yaml | 24 ++++++++--------- charts/ndc-graphql/README.md | 6 ++--- .../templates/imagepullsecret.yaml | 6 ++--- charts/ndc-graphql/templates/secret.yaml | 2 +- charts/ndc-graphql/values.yaml | 26 +++++++++---------- charts/ndc-mongodb/README.md | 4 +-- .../templates/imagepullsecret.yaml | 6 ++--- charts/ndc-mongodb/values.yaml | 24 ++++++++--------- charts/ndc-nodejs-lambda/README.md | 2 +- .../templates/imagepullsecret.yaml | 6 ++--- charts/ndc-nodejs-lambda/values.yaml | 26 +++++++++---------- charts/ndc-postgres/README.md | 2 +- .../templates/imagepullsecret.yaml | 6 ++--- charts/ndc-postgres/values.yaml | 24 ++++++++--------- charts/v3-engine/README.md | 2 +- charts/v3-engine/templates/NOTES.txt | 22 ++++++++++++++++ charts/v3-engine/templates/_helpers.tpl | 12 ++++----- .../v3-engine/templates/imagepullsecret.yaml | 6 ++--- charts/v3-engine/values.yaml | 26 +++++++++---------- 24 files changed, 153 insertions(+), 131 deletions(-) create mode 100644 charts/v3-engine/templates/NOTES.txt diff --git a/charts/ndc-connector-oracle/README.md b/charts/ndc-connector-oracle/README.md index 3ae1003..2866aa1 100644 --- a/charts/ndc-connector-oracle/README.md +++ b/charts/ndc-connector-oracle/README.md @@ -13,7 +13,7 @@ See all [configuration](#parameters) below. helm template \ --set image.repository="my_repo/ndc-jvm-oracle" \ --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set dataPlane.id="data_plane_id" \ --set dataPlane.key="data_plane_key" \ @@ -23,7 +23,7 @@ helm template \ helm upgrade --install \ --set image.repository="my_repo/ndc-jvm-oracle" \ --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set dataPlane.id="data_plane_id" \ --set dataPlane.key="data_plane_key" \ @@ -54,7 +54,7 @@ helm upgrade --install \ | `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | | `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-connector-oracle pod | `[]` | -| `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-oracle pod | `[]` | +| `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-oracle pod | `[]` | | `resources` | Resource requests and limits of ndc-connector-oracle container | `{}` | | `env` | Env variable section for ndc-connector-oracle | `[]` | | `replicas` | Replicas setting for pod | `1` | diff --git a/charts/ndc-connector-oracle/templates/imagepullsecret.yaml b/charts/ndc-connector-oracle/templates/imagepullsecret.yaml index 4f630fe..679ba77 100644 --- a/charts/ndc-connector-oracle/templates/imagepullsecret.yaml +++ b/charts/ndc-connector-oracle/templates/imagepullsecret.yaml @@ -8,9 +8,9 @@ metadata: name: hasura-image-pull namespace: {{ template "common.namespace" $ }} type: kubernetes.io/dockerconfigjson -data: +data: .dockerconfigjson: | -{{- toJson .imagePullSecret | b64enc | nindent 4 }} +{{- toJson .imagePullSecret | b64enc | nindent 4 }} {{- end }} {{- end }} -{{- end -}} \ No newline at end of file +{{- end -}} \ No newline at end of file diff --git a/charts/ndc-connector-oracle/values.yaml b/charts/ndc-connector-oracle/values.yaml index 3b3541b..d45b88f 100644 --- a/charts/ndc-connector-oracle/values.yaml +++ b/charts/ndc-connector-oracle/values.yaml @@ -28,7 +28,7 @@ hpa: enabled: false minReplicas: 2 maxReplicas: 4 - metrics: + metrics: - type: Resource resource: name: cpu @@ -40,9 +40,9 @@ hpa: name: memory target: type: Utilization - averageUtilization: 80 # Target 80% memory utilization per pod + averageUtilization: 80 # Target 80% memory utilization per pod -# Observability defaults are tuned for Hasura hosted Control Plane +# Observability defaults are tuned for Hasura hosted Control Plane # Enable observability observability: enabled: true @@ -60,8 +60,8 @@ otel: config: | extensions: oauth2client: - client_id: {{ .Values.dataPlane.id }} - client_secret: {{ .Values.dataPlane.key }} + client_id: {{ required "Error: .Values.dataPlane.id is required!" .Values.dataPlane.id }} + client_secret: {{ required "Error: .Values.dataPlane.key is required!" .Values.dataPlane.key }} token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: @@ -103,13 +103,13 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | {{- if .Values.observability.enabled }} - name: otel-config secret: - secretName: {{ printf "%s-secret" (include "common.name" .) }} + secretName: {{ printf "%s-secret" (include "common.name" .) }} items: - key: otel-collector-config.yaml path: otel-collector-config.yaml @@ -119,15 +119,15 @@ extraContainers: | {{- if .Values.observability.enabled }} - name: "otel-collector" command: - - --config=/etc/otel-collector-config.yaml - command: - image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} + - --config=/etc/otel-collector-config.yaml + command: + image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.controlPlane.otlpEndpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config - mountPath: "/etc/otelcol-contrib/config.yaml" + mountPath: "/etc/otelcol-contrib/config.yaml" subPath: otel-collector-config.yaml {{- end }} @@ -165,4 +165,4 @@ env: | - name: OTEL_EXPORTER_OTLP_ENDPOINT value: http://localhost:4317 - name: HASURA_CONFIGURATION_DIRECTORY - value: {{ .Values.connectorEnvVars.configDirectory }} \ No newline at end of file + value: {{ .Values.connectorEnvVars.configDirectory }} diff --git a/charts/ndc-connector-phoenix/README.md b/charts/ndc-connector-phoenix/README.md index 27fd026..2b098ee 100644 --- a/charts/ndc-connector-phoenix/README.md +++ b/charts/ndc-connector-phoenix/README.md @@ -13,7 +13,7 @@ See all [configuration](#parameters) below. helm template \ --set image.repository="my_repo/ndc-jvm-phoenix" \ --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set dataPlane.id="data_plane_id" \ --set dataPlane.key="data_plane_key" \ @@ -23,7 +23,7 @@ helm template \ helm upgrade --install \ --set image.repository="my_repo/ndc-jvm-phoenix" \ --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.JDBC_URL="jdbc_url" \ + --set connectorEnvVars.JDBC_URL="jdbc_url" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set dataPlane.id="data_plane_id" \ --set dataPlane.key="data_plane_key" \ @@ -37,7 +37,7 @@ helm upgrade --install \ | `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | | `connectorEnvVars.JDBC_URL` | The JDBC URL to connect to the database (Required) | `""` | -## Additional Parameters +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------| @@ -53,7 +53,7 @@ helm upgrade --install \ | `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | | `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-connector-phoenix pod | `[]` | -| `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-phoenix pod | `[]` | +| `extraContainers` | Optionally specify extra list of additional containers for the ndc-connector-phoenix pod | `[]` | | `resources` | Resource requests and limits of ndc-connector-phoenix container | `{}` | | `env` | Env variable section for ndc-connector-phoenix | `[]` | | `replicas` | Replicas setting for pod | `1` | diff --git a/charts/ndc-connector-phoenix/templates/imagepullsecret.yaml b/charts/ndc-connector-phoenix/templates/imagepullsecret.yaml index 4f630fe..679ba77 100644 --- a/charts/ndc-connector-phoenix/templates/imagepullsecret.yaml +++ b/charts/ndc-connector-phoenix/templates/imagepullsecret.yaml @@ -8,9 +8,9 @@ metadata: name: hasura-image-pull namespace: {{ template "common.namespace" $ }} type: kubernetes.io/dockerconfigjson -data: +data: .dockerconfigjson: | -{{- toJson .imagePullSecret | b64enc | nindent 4 }} +{{- toJson .imagePullSecret | b64enc | nindent 4 }} {{- end }} {{- end }} -{{- end -}} \ No newline at end of file +{{- end -}} \ No newline at end of file diff --git a/charts/ndc-connector-phoenix/values.yaml b/charts/ndc-connector-phoenix/values.yaml index bb27cf2..e684ff8 100644 --- a/charts/ndc-connector-phoenix/values.yaml +++ b/charts/ndc-connector-phoenix/values.yaml @@ -28,7 +28,7 @@ hpa: enabled: false minReplicas: 2 maxReplicas: 4 - metrics: + metrics: - type: Resource resource: name: cpu @@ -40,9 +40,9 @@ hpa: name: memory target: type: Utilization - averageUtilization: 80 # Target 80% memory utilization per pod + averageUtilization: 80 # Target 80% memory utilization per pod -# Observability defaults are tuned for Hasura hosted Control Plane +# Observability defaults are tuned for Hasura hosted Control Plane # Enable observability observability: enabled: true @@ -60,8 +60,8 @@ otel: config: | extensions: oauth2client: - client_id: {{ .Values.dataPlane.id }} - client_secret: {{ .Values.dataPlane.key }} + client_id: {{ required "Error: .Values.dataPlane.id is required!" .Values.dataPlane.id }} + client_secret: {{ required "Error: .Values.dataPlane.key is required!" .Values.dataPlane.key }} token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: @@ -103,13 +103,13 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | {{- if .Values.observability.enabled }} - name: otel-config secret: - secretName: {{ printf "%s-secret" (include "common.name" .) }} + secretName: {{ printf "%s-secret" (include "common.name" .) }} items: - key: otel-collector-config.yaml path: otel-collector-config.yaml @@ -119,15 +119,15 @@ extraContainers: | {{- if .Values.observability.enabled }} - name: "otel-collector" command: - - --config=/etc/otel-collector-config.yaml - command: - image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} + - --config=/etc/otel-collector-config.yaml + command: + image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.controlPlane.otlpEndpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config - mountPath: "/etc/otelcol-contrib/config.yaml" + mountPath: "/etc/otelcol-contrib/config.yaml" subPath: otel-collector-config.yaml {{- end }} diff --git a/charts/ndc-graphql/README.md b/charts/ndc-graphql/README.md index f1a0cab..f510c43 100644 --- a/charts/ndc-graphql/README.md +++ b/charts/ndc-graphql/README.md @@ -13,7 +13,7 @@ See all [configuration](#parameters) below. helm template \ --set image.repository="my_repo/ndc-graphql" \ --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ + --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set dataPlane.id="data_plane_id" \ --set dataPlane.key="data_plane_key" \ @@ -23,7 +23,7 @@ helm template \ helm upgrade --install \ --set image.repository="my_repo/ndc-graphql" \ --set image.tag="my_custom_image_tag" \ - --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ + --set connectorEnvVars.GRAPHQL_ENDPOINT="graphql_endpoint" \ --set connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET="token" \ --set dataPlane.id="data_plane_id" \ --set dataPlane.key="data_plane_key" \ @@ -37,7 +37,7 @@ helm upgrade --install \ | `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | | `connectorEnvVars.GRAPHQL_ENDPOINT` | The GraphQL Endpoint (Required) | `""` | -## Additional Parameters +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | diff --git a/charts/ndc-graphql/templates/imagepullsecret.yaml b/charts/ndc-graphql/templates/imagepullsecret.yaml index 4f630fe..679ba77 100644 --- a/charts/ndc-graphql/templates/imagepullsecret.yaml +++ b/charts/ndc-graphql/templates/imagepullsecret.yaml @@ -8,9 +8,9 @@ metadata: name: hasura-image-pull namespace: {{ template "common.namespace" $ }} type: kubernetes.io/dockerconfigjson -data: +data: .dockerconfigjson: | -{{- toJson .imagePullSecret | b64enc | nindent 4 }} +{{- toJson .imagePullSecret | b64enc | nindent 4 }} {{- end }} {{- end }} -{{- end -}} \ No newline at end of file +{{- end -}} \ No newline at end of file diff --git a/charts/ndc-graphql/templates/secret.yaml b/charts/ndc-graphql/templates/secret.yaml index 3968bb9..edd4b36 100644 --- a/charts/ndc-graphql/templates/secret.yaml +++ b/charts/ndc-graphql/templates/secret.yaml @@ -9,4 +9,4 @@ data: {{- if .Values.observability.enabled }} otel-collector-config.yaml: {{ (tpl .Values.otel.config .) | b64enc | quote }} {{- end }} - + diff --git a/charts/ndc-graphql/values.yaml b/charts/ndc-graphql/values.yaml index baa9b18..263d570 100644 --- a/charts/ndc-graphql/values.yaml +++ b/charts/ndc-graphql/values.yaml @@ -28,7 +28,7 @@ hpa: enabled: false minReplicas: 2 maxReplicas: 4 - metrics: + metrics: - type: Resource resource: name: cpu @@ -40,9 +40,9 @@ hpa: name: memory target: type: Utilization - averageUtilization: 80 # Target 80% memory utilization per pod + averageUtilization: 80 # Target 80% memory utilization per pod -# Observability defaults are tuned for Hasura hosted Control Plane +# Observability defaults are tuned for Hasura hosted Control Plane # Enable observability observability: enabled: true @@ -60,8 +60,8 @@ otel: config: | extensions: oauth2client: - client_id: {{ .Values.dataPlane.id }} - client_secret: {{ .Values.dataPlane.key }} + client_id: {{ required "Error: .Values.dataPlane.id is required!" .Values.dataPlane.id }} + client_secret: {{ required "Error: .Values.dataPlane.key is required!" .Values.dataPlane.key }} token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: @@ -103,13 +103,13 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | {{- if .Values.observability.enabled }} - name: otel-config secret: - secretName: {{ printf "%s-secret" (include "common.name" .) }} + secretName: {{ printf "%s-secret" (include "common.name" .) }} items: - key: otel-collector-config.yaml path: otel-collector-config.yaml @@ -119,15 +119,15 @@ extraContainers: | {{- if .Values.observability.enabled }} - name: "otel-collector" command: - - --config=/etc/otel-collector-config.yaml - command: - image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} + - --config=/etc/otel-collector-config.yaml + command: + image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.controlPlane.otlpEndpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config - mountPath: "/etc/otelcol-contrib/config.yaml" + mountPath: "/etc/otelcol-contrib/config.yaml" subPath: otel-collector-config.yaml {{- end }} @@ -153,6 +153,6 @@ env: | valueFrom: secretKeyRef: key: GRAPHQL_ENDPOINT - name: {{ printf "%s-secret" (include "common.name" .) }} + name: {{ printf "%s-secret" (include "common.name" .) }} - name: OTEL_EXPORTER_OTLP_ENDPOINT value: http://localhost:4317 diff --git a/charts/ndc-mongodb/README.md b/charts/ndc-mongodb/README.md index 122c1cc..e806538 100644 --- a/charts/ndc-mongodb/README.md +++ b/charts/ndc-mongodb/README.md @@ -37,7 +37,7 @@ helm upgrade --install \ | `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | | `connectorEnvVars.MONGODB_DATABASE_URI` | Database Connection URI (Required) | `""` | -## Additional Parameters +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------| @@ -53,7 +53,7 @@ helm upgrade --install \ | `controlPlane.otlpEndpoint` | OTEL endpoint under Hasura | `"https://gateway.otlp.hasura.io:443"` | | `controlPlane.oauthTokenEndpoint` | Oauth Token URL | `"https://ddn-oauth.pro.hasura.io/oauth2/token"` | | `extraVolumes` | Optionally specify extra list of additional volumes for the ndc-mongodb pod | `[]` | -| `extraContainers` | Optionally specify extra list of additional containers for the ndc-mongodb pod | `[]` | +| `extraContainers` | Optionally specify extra list of additional containers for the ndc-mongodb pod | `[]` | | `resources` | Resource requests and limits of ndc-mongodb container | `{}` | | `env` | Env variable section for ndc-mongodb | `[]` | | `replicas` | Replicas setting for pod | `1` | diff --git a/charts/ndc-mongodb/templates/imagepullsecret.yaml b/charts/ndc-mongodb/templates/imagepullsecret.yaml index 4f630fe..679ba77 100644 --- a/charts/ndc-mongodb/templates/imagepullsecret.yaml +++ b/charts/ndc-mongodb/templates/imagepullsecret.yaml @@ -8,9 +8,9 @@ metadata: name: hasura-image-pull namespace: {{ template "common.namespace" $ }} type: kubernetes.io/dockerconfigjson -data: +data: .dockerconfigjson: | -{{- toJson .imagePullSecret | b64enc | nindent 4 }} +{{- toJson .imagePullSecret | b64enc | nindent 4 }} {{- end }} {{- end }} -{{- end -}} \ No newline at end of file +{{- end -}} \ No newline at end of file diff --git a/charts/ndc-mongodb/values.yaml b/charts/ndc-mongodb/values.yaml index 686cb73..3952231 100644 --- a/charts/ndc-mongodb/values.yaml +++ b/charts/ndc-mongodb/values.yaml @@ -28,7 +28,7 @@ hpa: enabled: false minReplicas: 2 maxReplicas: 4 - metrics: + metrics: - type: Resource resource: name: cpu @@ -40,9 +40,9 @@ hpa: name: memory target: type: Utilization - averageUtilization: 80 # Target 80% memory utilization per pod + averageUtilization: 80 # Target 80% memory utilization per pod -# Observability defaults are tuned for Hasura hosted Control Plane +# Observability defaults are tuned for Hasura hosted Control Plane # Enable observability observability: enabled: true @@ -60,8 +60,8 @@ otel: config: | extensions: oauth2client: - client_id: {{ .Values.dataPlane.id }} - client_secret: {{ .Values.dataPlane.key }} + client_id: {{ required "Error: .Values.dataPlane.id is required!" .Values.dataPlane.id }} + client_secret: {{ required "Error: .Values.dataPlane.key is required!" .Values.dataPlane.key }} token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: @@ -103,13 +103,13 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | {{- if .Values.observability.enabled }} - name: otel-config secret: - secretName: {{ printf "%s-secret" (include "common.name" .) }} + secretName: {{ printf "%s-secret" (include "common.name" .) }} items: - key: otel-collector-config.yaml path: otel-collector-config.yaml @@ -119,15 +119,15 @@ extraContainers: | {{- if .Values.observability.enabled }} - name: "otel-collector" command: - - --config=/etc/otel-collector-config.yaml - command: - image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} + - --config=/etc/otel-collector-config.yaml + command: + image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.controlPlane.otlpEndpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config - mountPath: "/etc/otelcol-contrib/config.yaml" + mountPath: "/etc/otelcol-contrib/config.yaml" subPath: otel-collector-config.yaml {{- end }} diff --git a/charts/ndc-nodejs-lambda/README.md b/charts/ndc-nodejs-lambda/README.md index a40436c..c23ca4e 100644 --- a/charts/ndc-nodejs-lambda/README.md +++ b/charts/ndc-nodejs-lambda/README.md @@ -34,7 +34,7 @@ helm upgrade --install \ | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | | `connectorEnvVars.HASURA_SERVICE_TOKEN_SECRET` | Hasura Service Token Secret (Required) | `""` | -## Additional Parameters +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | diff --git a/charts/ndc-nodejs-lambda/templates/imagepullsecret.yaml b/charts/ndc-nodejs-lambda/templates/imagepullsecret.yaml index 4f630fe..679ba77 100644 --- a/charts/ndc-nodejs-lambda/templates/imagepullsecret.yaml +++ b/charts/ndc-nodejs-lambda/templates/imagepullsecret.yaml @@ -8,9 +8,9 @@ metadata: name: hasura-image-pull namespace: {{ template "common.namespace" $ }} type: kubernetes.io/dockerconfigjson -data: +data: .dockerconfigjson: | -{{- toJson .imagePullSecret | b64enc | nindent 4 }} +{{- toJson .imagePullSecret | b64enc | nindent 4 }} {{- end }} {{- end }} -{{- end -}} \ No newline at end of file +{{- end -}} \ No newline at end of file diff --git a/charts/ndc-nodejs-lambda/values.yaml b/charts/ndc-nodejs-lambda/values.yaml index 4170d1a..6b4caed 100644 --- a/charts/ndc-nodejs-lambda/values.yaml +++ b/charts/ndc-nodejs-lambda/values.yaml @@ -20,7 +20,7 @@ securityContext: fsGroup: 1000 initContainers: - gitSync: + gitSync: enabled: false repo: "git@github.com:hasura/ddn-example" branch: "main" @@ -34,7 +34,7 @@ hpa: enabled: false minReplicas: 2 maxReplicas: 4 - metrics: + metrics: - type: Resource resource: name: cpu @@ -46,9 +46,9 @@ hpa: name: memory target: type: Utilization - averageUtilization: 80 # Target 80% memory utilization per pod + averageUtilization: 80 # Target 80% memory utilization per pod -# Observability defaults are tuned for Hasura hosted Control Plane +# Observability defaults are tuned for Hasura hosted Control Plane # Enable observability observability: enabled: true @@ -66,8 +66,8 @@ otel: config: | extensions: oauth2client: - client_id: {{ .Values.dataPlane.id }} - client_secret: {{ .Values.dataPlane.key }} + client_id: {{ required "Error: .Values.dataPlane.id is required!" .Values.dataPlane.id }} + client_secret: {{ required "Error: .Values.dataPlane.key is required!" .Values.dataPlane.key }} token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: @@ -109,13 +109,13 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | {{- if .Values.observability.enabled }} - name: otel-config secret: - secretName: {{ printf "%s-secret" (include "common.name" .) }} + secretName: {{ printf "%s-secret" (include "common.name" .) }} items: - key: otel-collector-config.yaml path: otel-collector-config.yaml @@ -125,15 +125,15 @@ extraContainers: | {{- if .Values.observability.enabled }} - name: "otel-collector" command: - - --config=/etc/otel-collector-config.yaml - command: - image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} + - --config=/etc/otel-collector-config.yaml + command: + image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.controlPlane.otlpEndpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config - mountPath: "/etc/otelcol-contrib/config.yaml" + mountPath: "/etc/otelcol-contrib/config.yaml" subPath: otel-collector-config.yaml {{- end }} diff --git a/charts/ndc-postgres/README.md b/charts/ndc-postgres/README.md index cb44478..87f0d60 100644 --- a/charts/ndc-postgres/README.md +++ b/charts/ndc-postgres/README.md @@ -40,7 +40,7 @@ helm upgrade --install \ | `connectorEnvVars.CLIENT_KEY` | Database Client key (Optional) | `""` | | `connectorEnvVars.ROOT_CERT` | Database Root cert (Optional) | `""` | -## Additional Parameters +## Additional Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | diff --git a/charts/ndc-postgres/templates/imagepullsecret.yaml b/charts/ndc-postgres/templates/imagepullsecret.yaml index 4f630fe..679ba77 100644 --- a/charts/ndc-postgres/templates/imagepullsecret.yaml +++ b/charts/ndc-postgres/templates/imagepullsecret.yaml @@ -8,9 +8,9 @@ metadata: name: hasura-image-pull namespace: {{ template "common.namespace" $ }} type: kubernetes.io/dockerconfigjson -data: +data: .dockerconfigjson: | -{{- toJson .imagePullSecret | b64enc | nindent 4 }} +{{- toJson .imagePullSecret | b64enc | nindent 4 }} {{- end }} {{- end }} -{{- end -}} \ No newline at end of file +{{- end -}} \ No newline at end of file diff --git a/charts/ndc-postgres/values.yaml b/charts/ndc-postgres/values.yaml index 2cb6993..886de7a 100644 --- a/charts/ndc-postgres/values.yaml +++ b/charts/ndc-postgres/values.yaml @@ -28,7 +28,7 @@ hpa: enabled: false minReplicas: 2 maxReplicas: 4 - metrics: + metrics: - type: Resource resource: name: cpu @@ -42,7 +42,7 @@ hpa: type: Utilization averageUtilization: 80 # Target 80% memory utilization per pod -# Observability defaults are tuned for Hasura hosted Control Plane +# Observability defaults are tuned for Hasura hosted Control Plane # Enable observability observability: enabled: true @@ -60,8 +60,8 @@ otel: config: | extensions: oauth2client: - client_id: {{ .Values.dataPlane.id }} - client_secret: {{ .Values.dataPlane.key }} + client_id: {{ required "Error: .Values.dataPlane.id is required!" .Values.dataPlane.id }} + client_secret: {{ required "Error: .Values.dataPlane.key is required!" .Values.dataPlane.key }} token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: @@ -103,13 +103,13 @@ otel: processors: - batch receivers: - - otlp + - otlp extraVolumes: | {{- if .Values.observability.enabled }} - name: otel-config secret: - secretName: {{ printf "%s-secret" (include "common.name" .) }} + secretName: {{ printf "%s-secret" (include "common.name" .) }} items: - key: otel-collector-config.yaml path: otel-collector-config.yaml @@ -119,15 +119,15 @@ extraContainers: | {{- if .Values.observability.enabled }} - name: "otel-collector" command: - - --config=/etc/otel-collector-config.yaml - command: - image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} + - --config=/etc/otel-collector-config.yaml + command: + image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.controlPlane.otlpEndpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config - mountPath: "/etc/otelcol-contrib/config.yaml" + mountPath: "/etc/otelcol-contrib/config.yaml" subPath: otel-collector-config.yaml {{- end }} @@ -177,6 +177,6 @@ env: | secretKeyRef: key: ROOT_CERT name: {{ printf "%s-secret" (include "common.name" .) }} - {{- end }} + {{- end }} - name: OTEL_EXPORTER_OTLP_ENDPOINT value: http://localhost:4317 diff --git a/charts/v3-engine/README.md b/charts/v3-engine/README.md index 230f4d0..36ae6d3 100644 --- a/charts/v3-engine/README.md +++ b/charts/v3-engine/README.md @@ -43,7 +43,7 @@ helm upgrade --install \ hasura-ddn/v3-engine ``` -## Parameters +## Parameters | Name | Description | Value | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------- | diff --git a/charts/v3-engine/templates/NOTES.txt b/charts/v3-engine/templates/NOTES.txt new file mode 100644 index 0000000..e437a4a --- /dev/null +++ b/charts/v3-engine/templates/NOTES.txt @@ -0,0 +1,22 @@ +V3 Engine Helm Chart Deployment + +1. Deployment Information: + - Release Name: {{ .Release.Name }} + - Namespace: {{ template "common.namespace" . }} + - Chart Name: {{ .Chart.Name }} + - Chart Version: {{ .Chart.Version }} + +2. Service Information: + - Service Name: {{ template "common.name" . }} + - Service Port: {{ .Values.httpPort }} + +3. Useful Commands: + - Check the Deployment Status: + helm status {{ .Release.Name }} + + - Get Detailed Information about the Deployment: + helm get all {{ .Release.Name }} + +4. Clean Up: + - To uninstall/delete the deployment, run: + helm uninstall {{ .Release.Name }} \ No newline at end of file diff --git a/charts/v3-engine/templates/_helpers.tpl b/charts/v3-engine/templates/_helpers.tpl index 2e9c7ff..bb3f555 100644 --- a/charts/v3-engine/templates/_helpers.tpl +++ b/charts/v3-engine/templates/_helpers.tpl @@ -1,21 +1,21 @@ -{{- define "v3-engine-st.domain" -}} -{{- if .Values.global.subDomain -}} +{{- define "v3-engine-st.domain" -}} +{{- if .Values.global.subDomain -}} {{- printf "v3-engine-st.%s" .Values.global.domain -}} {{- else -}} {{- printf "%s" .Values.global.domain -}} {{- end -}} {{- end -}} -{{- define "v3-engine-st.path" -}} -{{- if .Values.global.subDomain -}} +{{- define "v3-engine-st.path" -}} +{{- if .Values.global.subDomain -}} {{- printf "" -}} {{- else -}} {{- printf "v3-engine-st(/|$)(.*)" -}} {{- end -}} {{- end -}} -{{- define "v3-engine-st.ingress.annotations" -}} -{{- if not .Values.global.subDomain -}} +{{- define "v3-engine-st.ingress.annotations" -}} +{{- if not .Values.global.subDomain -}} {{- printf "nginx.ingress.kubernetes.io/rewrite-target: /$2" -}} {{- end -}} {{- end -}} \ No newline at end of file diff --git a/charts/v3-engine/templates/imagepullsecret.yaml b/charts/v3-engine/templates/imagepullsecret.yaml index 4f630fe..679ba77 100644 --- a/charts/v3-engine/templates/imagepullsecret.yaml +++ b/charts/v3-engine/templates/imagepullsecret.yaml @@ -8,9 +8,9 @@ metadata: name: hasura-image-pull namespace: {{ template "common.namespace" $ }} type: kubernetes.io/dockerconfigjson -data: +data: .dockerconfigjson: | -{{- toJson .imagePullSecret | b64enc | nindent 4 }} +{{- toJson .imagePullSecret | b64enc | nindent 4 }} {{- end }} {{- end }} -{{- end -}} \ No newline at end of file +{{- end -}} \ No newline at end of file diff --git a/charts/v3-engine/values.yaml b/charts/v3-engine/values.yaml index 797d5f4..2cd5fe4 100644 --- a/charts/v3-engine/values.yaml +++ b/charts/v3-engine/values.yaml @@ -13,7 +13,7 @@ image: otelCollectorTag: 0.104.0 initContainers: - gitSync: + gitSync: enabled: false repo: "git@github.com:/" branch: "main" @@ -27,7 +27,7 @@ hpa: enabled: false minReplicas: 2 maxReplicas: 4 - metrics: + metrics: - type: Resource resource: name: cpu @@ -41,7 +41,7 @@ hpa: type: Utilization averageUtilization: 80 # Target 80% memory utilization per pod -# Observability defaults are tuned for Hasura hosted Control Plane +# Observability defaults are tuned for Hasura hosted Control Plane # Enable observability observability: enabled: true @@ -61,8 +61,8 @@ otel: config: | extensions: oauth2client: - client_id: {{ .Values.dataPlane.id }} - client_secret: {{ .Values.dataPlane.key}} + client_id: {{ required "Error: .Values.dataPlane.id is required!" .Values.dataPlane.id }} + client_secret: {{ required "Error: .Values.dataPlane.key is required!" .Values.dataPlane.key }} token_url: {{ .Values.controlPlane.oauthTokenEndpoint }} scopes: ["opentelemetry:write"] endpoint_params: @@ -78,7 +78,7 @@ otel: actions: - key: http.host action: upsert - value: {{ .Values.observability.hostName }} + value: {{ required "Error: .Values.observability.hostName is required!" .Values.observability.hostName }} receivers: otlp: protocols: @@ -110,7 +110,7 @@ otel: - batch - attributes/host receivers: - - otlp + - otlp openDDPath: /md/open_dd.json authnConfigPath: /md/auth_config.json @@ -126,7 +126,7 @@ extraVolumes: | {{- if .Values.observability.enabled }} - name: otel-config secret: - secretName: {{ printf "%s-secret" (include "common.name" .) }} + secretName: {{ printf "%s-secret" (include "common.name" .) }} items: - key: otel-collector-config.yaml path: otel-collector-config.yaml @@ -136,15 +136,15 @@ extraContainers: | {{- if .Values.observability.enabled }} - name: "otel-collector" command: - - --config=/etc/otel-collector-config.yaml - command: - image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} + - --config=/etc/otel-collector-config.yaml + command: + image: {{ template "common.image" (dict "Values" $.Values "repository" .Values.image.otelCollectorRepository "tag" .Values.image.otelCollectorTag) }} env: - name: "OTEL_ENDPOINT" - value: "{{ .Values.controlPlane.otlpEndpoint }}" + value: "{{ .Values.controlPlane.otlpEndpoint }}" volumeMounts: - name: otel-config - mountPath: "/etc/otelcol-contrib/config.yaml" + mountPath: "/etc/otelcol-contrib/config.yaml" subPath: otel-collector-config.yaml {{- end }} From 0b7b91385bd96506eb979872b30632ce3f843456 Mon Sep 17 00:00:00 2001 From: Tom Skawinski Date: Thu, 17 Oct 2024 17:32:07 -0400 Subject: [PATCH 8/8] Modify NOTES.txt under v3-engine to add a next step section. Add NOTES.txt into all connectors --- .../ndc-connector-oracle/templates/NOTES.txt | 22 +++++++++++++++++++ .../ndc-connector-phoenix/templates/NOTES.txt | 22 +++++++++++++++++++ charts/ndc-graphql/templates/NOTES.txt | 22 +++++++++++++++++++ charts/ndc-mongodb/templates/NOTES.txt | 22 +++++++++++++++++++ charts/ndc-nodejs-lambda/templates/NOTES.txt | 22 +++++++++++++++++++ charts/ndc-postgres/templates/NOTES.txt | 22 +++++++++++++++++++ charts/v3-engine/templates/NOTES.txt | 7 ++++-- 7 files changed, 137 insertions(+), 2 deletions(-) create mode 100644 charts/ndc-connector-oracle/templates/NOTES.txt create mode 100644 charts/ndc-connector-phoenix/templates/NOTES.txt create mode 100644 charts/ndc-graphql/templates/NOTES.txt create mode 100644 charts/ndc-mongodb/templates/NOTES.txt create mode 100644 charts/ndc-nodejs-lambda/templates/NOTES.txt create mode 100644 charts/ndc-postgres/templates/NOTES.txt diff --git a/charts/ndc-connector-oracle/templates/NOTES.txt b/charts/ndc-connector-oracle/templates/NOTES.txt new file mode 100644 index 0000000..451347c --- /dev/null +++ b/charts/ndc-connector-oracle/templates/NOTES.txt @@ -0,0 +1,22 @@ +Ndc-connector-oracle Helm Chart Deployment + +1. Deployment Information: + - Release Name: {{ .Release.Name }} + - Namespace: {{ template "common.namespace" . }} + - Chart Name: {{ .Chart.Name }} + - Chart Version: {{ .Chart.Version }} + +2. Service Information: + - Service Name: {{ template "common.name" . }} + - Service Port: {{ .Values.httpPort }} + +3. Useful Commands: + - Check the Deployment Status: + helm status {{ .Release.Name }} + + - Get Detailed Information about the Deployment: + helm get all {{ .Release.Name }} + +4. Clean Up: + - To uninstall/delete the deployment, run: + helm uninstall {{ .Release.Name }} \ No newline at end of file diff --git a/charts/ndc-connector-phoenix/templates/NOTES.txt b/charts/ndc-connector-phoenix/templates/NOTES.txt new file mode 100644 index 0000000..36403f0 --- /dev/null +++ b/charts/ndc-connector-phoenix/templates/NOTES.txt @@ -0,0 +1,22 @@ +Ndc-connector-phoenix Helm Chart Deployment + +1. Deployment Information: + - Release Name: {{ .Release.Name }} + - Namespace: {{ template "common.namespace" . }} + - Chart Name: {{ .Chart.Name }} + - Chart Version: {{ .Chart.Version }} + +2. Service Information: + - Service Name: {{ template "common.name" . }} + - Service Port: {{ .Values.httpPort }} + +3. Useful Commands: + - Check the Deployment Status: + helm status {{ .Release.Name }} + + - Get Detailed Information about the Deployment: + helm get all {{ .Release.Name }} + +4. Clean Up: + - To uninstall/delete the deployment, run: + helm uninstall {{ .Release.Name }} \ No newline at end of file diff --git a/charts/ndc-graphql/templates/NOTES.txt b/charts/ndc-graphql/templates/NOTES.txt new file mode 100644 index 0000000..36aaf05 --- /dev/null +++ b/charts/ndc-graphql/templates/NOTES.txt @@ -0,0 +1,22 @@ +Ndc-graphql Helm Chart Deployment + +1. Deployment Information: + - Release Name: {{ .Release.Name }} + - Namespace: {{ template "common.namespace" . }} + - Chart Name: {{ .Chart.Name }} + - Chart Version: {{ .Chart.Version }} + +2. Service Information: + - Service Name: {{ template "common.name" . }} + - Service Port: {{ .Values.httpPort }} + +3. Useful Commands: + - Check the Deployment Status: + helm status {{ .Release.Name }} + + - Get Detailed Information about the Deployment: + helm get all {{ .Release.Name }} + +4. Clean Up: + - To uninstall/delete the deployment, run: + helm uninstall {{ .Release.Name }} \ No newline at end of file diff --git a/charts/ndc-mongodb/templates/NOTES.txt b/charts/ndc-mongodb/templates/NOTES.txt new file mode 100644 index 0000000..487ef07 --- /dev/null +++ b/charts/ndc-mongodb/templates/NOTES.txt @@ -0,0 +1,22 @@ +Ndc-mongodb Helm Chart Deployment + +1. Deployment Information: + - Release Name: {{ .Release.Name }} + - Namespace: {{ template "common.namespace" . }} + - Chart Name: {{ .Chart.Name }} + - Chart Version: {{ .Chart.Version }} + +2. Service Information: + - Service Name: {{ template "common.name" . }} + - Service Port: {{ .Values.httpPort }} + +3. Useful Commands: + - Check the Deployment Status: + helm status {{ .Release.Name }} + + - Get Detailed Information about the Deployment: + helm get all {{ .Release.Name }} + +4. Clean Up: + - To uninstall/delete the deployment, run: + helm uninstall {{ .Release.Name }} \ No newline at end of file diff --git a/charts/ndc-nodejs-lambda/templates/NOTES.txt b/charts/ndc-nodejs-lambda/templates/NOTES.txt new file mode 100644 index 0000000..16a92c5 --- /dev/null +++ b/charts/ndc-nodejs-lambda/templates/NOTES.txt @@ -0,0 +1,22 @@ +Ndc-nodejs-lambda Helm Chart Deployment + +1. Deployment Information: + - Release Name: {{ .Release.Name }} + - Namespace: {{ template "common.namespace" . }} + - Chart Name: {{ .Chart.Name }} + - Chart Version: {{ .Chart.Version }} + +2. Service Information: + - Service Name: {{ template "common.name" . }} + - Service Port: {{ .Values.httpPort }} + +3. Useful Commands: + - Check the Deployment Status: + helm status {{ .Release.Name }} + + - Get Detailed Information about the Deployment: + helm get all {{ .Release.Name }} + +4. Clean Up: + - To uninstall/delete the deployment, run: + helm uninstall {{ .Release.Name }} \ No newline at end of file diff --git a/charts/ndc-postgres/templates/NOTES.txt b/charts/ndc-postgres/templates/NOTES.txt new file mode 100644 index 0000000..97de95e --- /dev/null +++ b/charts/ndc-postgres/templates/NOTES.txt @@ -0,0 +1,22 @@ +Ndc-postgres Helm Chart Deployment + +1. Deployment Information: + - Release Name: {{ .Release.Name }} + - Namespace: {{ template "common.namespace" . }} + - Chart Name: {{ .Chart.Name }} + - Chart Version: {{ .Chart.Version }} + +2. Service Information: + - Service Name: {{ template "common.name" . }} + - Service Port: {{ .Values.httpPort }} + +3. Useful Commands: + - Check the Deployment Status: + helm status {{ .Release.Name }} + + - Get Detailed Information about the Deployment: + helm get all {{ .Release.Name }} + +4. Clean Up: + - To uninstall/delete the deployment, run: + helm uninstall {{ .Release.Name }} \ No newline at end of file diff --git a/charts/v3-engine/templates/NOTES.txt b/charts/v3-engine/templates/NOTES.txt index e437a4a..4ffcf70 100644 --- a/charts/v3-engine/templates/NOTES.txt +++ b/charts/v3-engine/templates/NOTES.txt @@ -1,4 +1,4 @@ -V3 Engine Helm Chart Deployment +V3-engine Helm Chart Deployment 1. Deployment Information: - Release Name: {{ .Release.Name }} @@ -19,4 +19,7 @@ V3 Engine Helm Chart Deployment 4. Clean Up: - To uninstall/delete the deployment, run: - helm uninstall {{ .Release.Name }} \ No newline at end of file + helm uninstall {{ .Release.Name }} + +5. Next steps: + - You may now want to add connector(s) into your deployment stack. Perform a "helm search repo hasura-ddn" to see what connector Helm charts are available for installation \ No newline at end of file