add OTEL trace env for helm chart

Signed-off-by: KubeKyrie <[email protected]>
clusterpedia-io · Dec 5, 2023 · 9b7b55a · 9b7b55a
1 parent d65f4a3
commit 9b7b55a
Show file tree

Hide file tree

Showing 12 changed files with 305 additions and 5 deletions.
diff --git a/charts/clusterpedia-core/README.md b/charts/clusterpedia-core/README.md
@@ -0,0 +1,97 @@
+# clusterpedia-core
+
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.6.0](https://img.shields.io/badge/AppVersion-v0.6.0-informational?style=flat-square)
+
+A Helm chart for Clusterpedia
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| clusterpedia-io |  | <https://github.com/clusterpedia-io/clusterpedia-helm> |
+
+## Source Code
+
+* <https://github.com/clusterpedia-io/clusterpedia-helm>
+
+## Requirements
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://charts.bitnami.com/bitnami | common | 1.x.x |
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| apiserver.affinity | object | `{}` |  |
+| apiserver.enableSHA1Cert | bool | `false` |  |
+| apiserver.featureGates.AllowRawSQLQuery | bool | `false` |  |
+| apiserver.featureGates.RemainingItemCount | bool | `false` |  |
+| apiserver.image.pullPolicy | string | `"IfNotPresent"` |  |
+| apiserver.image.pullSecrets | list | `[]` |  |
+| apiserver.image.registry | string | `"ghcr.io"` |  |
+| apiserver.image.repository | string | `"clusterpedia-io/clusterpedia/apiserver"` |  |
+| apiserver.image.tag | string | `"v0.6.0"` |  |
+| apiserver.labels | object | `{}` |  |
+| apiserver.nodeSelector | object | `{}` |  |
+| apiserver.podAnnotations | object | `{}` |  |
+| apiserver.podLabels | object | `{}` |  |
+| apiserver.replicaCount | int | `1` |  |
+| apiserver.resources | object | `{}` |  |
+| apiserver.tolerations | list | `[]` |  |
+| clustersynchroManager.affinity | object | `{}` |  |
+| clustersynchroManager.featureGates.AllowSyncAllCustomResources | bool | `false` |  |
+| clustersynchroManager.featureGates.AllowSyncAllResources | bool | `false` |  |
+| clustersynchroManager.featureGates.PruneLastAppliedConfiguration | bool | `true` |  |
+| clustersynchroManager.featureGates.PruneManagedFields | bool | `true` |  |
+| clustersynchroManager.image.pullPolicy | string | `"IfNotPresent"` |  |
+| clustersynchroManager.image.pullSecrets | list | `[]` |  |
+| clustersynchroManager.image.registry | string | `"ghcr.io"` |  |
+| clustersynchroManager.image.repository | string | `"clusterpedia-io/clusterpedia/clustersynchro-manager"` |  |
+| clustersynchroManager.image.tag | string | `"v0.6.0"` |  |
+| clustersynchroManager.labels | object | `{}` |  |
+| clustersynchroManager.nodeSelector | object | `{}` |  |
+| clustersynchroManager.podAnnotations | object | `{}` |  |
+| clustersynchroManager.podLabels | object | `{}` |  |
+| clustersynchroManager.replicaCount | int | `1` |  |
+| clustersynchroManager.resources | object | `{}` |  |
+| clustersynchroManager.tolerations | list | `[]` |  |
+| commonAnnotations | object | `{}` |  |
+| commonLabels | object | `{}` |  |
+| controllerManager.affinity | object | `{}` |  |
+| controllerManager.featureGates | object | `{}` |  |
+| controllerManager.image.pullPolicy | string | `"IfNotPresent"` |  |
+| controllerManager.image.pullSecrets | list | `[]` |  |
+| controllerManager.image.registry | string | `"ghcr.io"` |  |
+| controllerManager.image.repository | string | `"clusterpedia-io/clusterpedia/controller-manager"` |  |
+| controllerManager.image.tag | string | `"v0.6.0"` |  |
+| controllerManager.labels | object | `{}` |  |
+| controllerManager.nodeSelector | object | `{}` |  |
+| controllerManager.podAnnotations | object | `{}` |  |
+| controllerManager.podLabels | object | `{}` |  |
+| controllerManager.replicaCount | int | `1` |  |
+| controllerManager.resources | object | `{}` |  |
+| controllerManager.tolerations | list | `[]` |  |
+| global.imagePullSecrets | list | `[]` |  |
+| global.imageRegistry | string | `""` |  |
+| hookJob.image.pullPolicy | string | `"IfNotPresent"` |  |
+| hookJob.image.registry | string | `"ghcr.io"` |  |
+| hookJob.image.repository | string | `"cloudtty/cloudshell"` |  |
+| hookJob.image.tag | string | `"v0.4.0"` |  |
+| installCRDs | bool | `false` |  |
+| storage.componentEnv | list | `[]` |  |
+| storage.config | object | `{}` |  |
+| storage.configMap | string | `""` |  |
+| storage.image.pullPolicy | string | `"IfNotPresent"` |  |
+| storage.image.registry | string | `""` |  |
+| storage.image.repository | string | `""` |  |
+| storage.image.tag | string | `""` |  |
+| storage.name | string | `""` |  |
+| telemetry.tracing.addOtelEnv | bool | `false` |  |
+| telemetry.tracing.enabled | bool | `false` |  |
+| telemetry.tracing.endpoint | string | `"localhost:4317"` |  |
+| telemetry.tracing.samplingRatePerMillion | int | `1000000` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.9.1](https://github.com/norwoodj/helm-docs/releases/v1.9.1)
diff --git a/charts/clusterpedia-core/templates/_helpers.tpl b/charts/clusterpedia-core/templates/_helpers.tpl
@@ -139,8 +139,13 @@ initContainers:
 {{- end -}}
 
 {{- define "clusterpedia.volumes" -}}
-{{- if or (include "clusterpedia.storage.configmap.name" .) (include "clusterpedia.storage.plugin.initContainer" .) }}
+{{- if or .Values.telemetry.tracing.enabled (include "clusterpedia.storage.configmap.name" .) (include "clusterpedia.storage.plugin.initContainer" .) }}
 volumes:
+{{- if .Values.telemetry.tracing.enabled }}
+- name: tracing-config
+  configMap:
+    name: clusterpedia-tracing-config
+{{- end }}
 {{- if (include "clusterpedia.storage.configmap.name" .) }}
 - name: storage-config
   configMap:
@@ -154,8 +159,13 @@ volumes:
 {{- end -}}
 
 {{- define "clusterpedia.volumeMounts" -}}
-{{- if or (include "clusterpedia.storage.configmap.name" .) (include "clusterpedia.storage.plugin.initContainer" .) }}
+{{- if or .Values.telemetry.tracing.enabled (include "clusterpedia.storage.configmap.name" .) (include "clusterpedia.storage.plugin.initContainer" .) }}
 volumeMounts:
+{{- if .Values.telemetry.tracing.enabled }}
+- name: tracing-config
+  mountPath: /etc/clusterpedia/trace
+  readOnly: true
+{{- end }}
 {{- if (include "clusterpedia.storage.configmap.name" .) }}
 - name: storage-config
   mountPath: /etc/clusterpedia/storage
@@ -170,12 +180,15 @@ volumeMounts:
 {{- end -}}
 
 {{- define "clusterpedia.apiserver.env" -}}
-{{- if or .Values.apiserver.enableSHA1Cert .Values.storage.componentEnv (include "clusterpedia.storage.override.componentEnv" .) (include "clusterpedia.storage.plugin.initContainer" .) }}
+{{- if or .Values.apiserver.enableSHA1Cert .Values.storage.componentEnv (include "clusterpedia.storage.override.componentEnv" .) (include "clusterpedia.storage.plugin.initContainer" .) (include "clusterpedia.tracing.env" .) }}
 env:
 {{- if (include "clusterpedia.storage.plugin.initContainer" .) }}
 - name: STORAGE_PLUGINS
   value: /var/lib/clusterpedia/plugins
 {{- end }}
+{{- if (include "clusterpedia.tracing.env" .) }}
+{{ include "clusterpedia.tracing.env" . }}
+{{- end }}
 {{- if .Values.apiserver.enableSHA1Cert }}
 - name: GODEBUG
   value: x509sha1=1
@@ -188,6 +201,32 @@ env:
 {{- end }}
 {{- end -}}
 
+{{- define "clusterpedia.tracing.env" -}}
+{{- if and (.Values.telemetry.tracing.enabled) (.Values.telemetry.tracing.addOtelEnv) }}
+- name: OTEL_EXPORTER_OTLP_ENDPOINT
+  value: {{ .Values.telemetry.tracing.endpoint }}
+- name: 'OTEL_SERVICE_NAME'
+  value: {{ include "common.names.fullname" . }}-apiserver
+- name: 'OTEL_K8S_NAMESPACE'
+  valueFrom:
+    fieldRef:
+      apiVersion: v1
+      fieldPath: metadata.namespace
+- name: OTEL_RESOURCE_ATTRIBUTES_NODE_NAME
+  valueFrom:
+    fieldRef:
+      apiVersion: v1
+      fieldPath: spec.nodeName
+- name: OTEL_RESOURCE_ATTRIBUTES_POD_NAME
+  valueFrom:
+    fieldRef:
+      apiVersion: v1
+      fieldPath: metadata.name
+- name: OTEL_RESOURCE_ATTRIBUTES
+  value: 'k8s.namespace.name=$(OTEL_K8S_NAMESPACE),k8s.node.name=$(OTEL_RESOURCE_ATTRIBUTES_NODE_NAME),k8s.pod.name=$(OTEL_RESOURCE_ATTRIBUTES_POD_NAME)'
+{{- end }}
+{{- end -}}
+
 {{- define "clusterpedia.clustersynchroManager.env" -}}
 {{- if or .Values.storage.componentEnv (include "clusterpedia.storage.override.componentEnv" .) (include "clusterpedia.storage.plugin.initContainer" .) }}
 env:
@@ -202,3 +241,9 @@ env:
 {{- end }}
 {{- end }}
 {{- end -}}
+
+{{- define "clusterpedia.tracing.args" -}}
+{{- if .Values.telemetry.tracing.enabled }}
+- --tracing-config-file=/etc/clusterpedia/trace/tracing-config.yaml
+{{- end }}
+{{- end -}}
diff --git a/charts/clusterpedia-core/templates/apiserver-deployment.yaml b/charts/clusterpedia-core/templates/apiserver-deployment.yaml
@@ -38,6 +38,7 @@ spec:
         command:
         - /usr/local/bin/apiserver
         - --secure-port=443
+      {{- include "clusterpedia.tracing.args" . | nindent 8}}
       {{- if .Values.storage.name }}
         - --storage-name={{ .Values.storage.name }}
       {{- end }}

diff --git a/charts/clusterpedia-core/templates/clusterpedia-tracing-config.yaml b/charts/clusterpedia-core/templates/clusterpedia-tracing-config.yaml
@@ -0,0 +1,13 @@
+{{- if .Values.telemetry.tracing.enabled }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: clusterpedia-tracing-config
+  namespace: {{ .Release.Namespace }}
+data:
+  tracing-config.yaml: |
+    apiVersion: apiserver.config.k8s.io/v1beta1
+    kind: TracingConfiguration
+    endpoint: {{ .Values.telemetry.tracing.endpoint }}
+    samplingRatePerMillion: {{ .Values.telemetry.tracing.samplingRatePerMillion }}
+{{- end }}
diff --git a/charts/clusterpedia-core/values.yaml b/charts/clusterpedia-core/values.yaml
@@ -20,6 +20,14 @@ commonLabels: {}
 ## @param commonAnnotations Annotations to add to all deployed objects
 ##
 commonAnnotations: {}
+## @param telemetry define flag whether to enable otel trace
+##
+telemetry:
+  tracing:
+    enabled: false
+    endpoint: "localhost:4317"
+    samplingRatePerMillion: 1000000
+    addOtelEnv: true
 
 ## clusterpedia apiserver config
 apiserver:

diff --git a/charts/clusterpedia-mysql/README.md b/charts/clusterpedia-mysql/README.md
@@ -0,0 +1,66 @@
+# clusterpedia-mysql
+
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.6.0](https://img.shields.io/badge/AppVersion-v0.6.0-informational?style=flat-square)
+
+A Helm chart for Clusterpedia
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| clusterpedia-io |  | <https://github.com/clusterpedia-io/clusterpedia-helm> |
+
+## Source Code
+
+* <https://github.com/clusterpedia-io/clusterpedia-helm>
+
+## Requirements
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://charts.bitnami.com/bitnami | common | 1.x.x |
+| https://charts.bitnami.com/bitnami | mysql | 9.x.x |
+| https://clusterpedia-io.github.io/clusterpedia-helm/ | clusterpedia-core | 0.1.x |
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| commonAnnotations | object | `{}` |  |
+| commonLabels | object | `{}` |  |
+| externalStorage.createDatabase | bool | `false` |  |
+| externalStorage.database | string | `""` |  |
+| externalStorage.host | string | `""` |  |
+| externalStorage.password | string | `""` |  |
+| externalStorage.port | string | `nil` |  |
+| externalStorage.user | string | `""` |  |
+| global.imagePullSecrets | list | `[]` |  |
+| global.imageRegistry | string | `""` |  |
+| installCRDs | bool | `false` |  |
+| mysql.auth.database | string | `"clusterpedia"` |  |
+| mysql.auth.password | string | `""` |  |
+| mysql.auth.rootPassword | string | `"dangerous0"` |  |
+| mysql.auth.username | string | `""` |  |
+| mysql.image.pullPolicy | string | `"IfNotPresent"` |  |
+| mysql.image.pullSecrets | list | `[]` |  |
+| mysql.image.registry | string | `"docker.io"` |  |
+| mysql.image.repository | string | `"bitnami/mysql"` |  |
+| mysql.image.tag | string | `"8.0.28-debian-10-r23"` |  |
+| mysql.primary.persistence.enabled | bool | `true` |  |
+| mysql.primary.persistence.size | string | `"10Gi"` |  |
+| persistenceMatchNode | string | `""` |  |
+| storageConfig.connPool.connMaxLifetime | string | `"60m"` |  |
+| storageConfig.connPool.maxIdleConns | int | `5` |  |
+| storageConfig.connPool.maxOpenConns | int | `40` |  |
+| storageConfig.log.enabled | bool | `false` |  |
+| storageConfig.log.ignoreRecordNotFoundError | bool | `false` |  |
+| storageConfig.log.level | string | `"Warn"` |  |
+| storageConfig.log.logger.filename | string | `"/var/log/clusterpedia/internalstorage.log"` |  |
+| storageConfig.log.logger.maxbackups | int | `0` |  |
+| storageConfig.log.logger.maxsize | int | `100` |  |
+| storageConfig.log.slowThreshold | string | `"100ms"` |  |
+| storageConfig.log.stdout | bool | `false` |  |
+| storageInstallMode | string | `"internal"` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.9.1](https://github.com/norwoodj/helm-docs/releases/v1.9.1)
diff --git a/charts/clusterpedia/Chart.yaml b/charts/clusterpedia/Chart.yaml
@@ -15,7 +15,7 @@ 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: 2.0.0
+version: 2.0.1
 
 # 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

diff --git a/charts/clusterpedia/README.md b/charts/clusterpedia/README.md
@@ -187,6 +187,10 @@ rm /var/local/clusterpedia/internalstorage/<storage type>
 | postgresql.primary.persistence.enabled | bool | `true` |  |
 | postgresql.primary.persistence.size | string | `"10Gi"` |  |
 | storageInstallMode | string | `"internal"` |  |
+| telemetry.tracing.addOtelEnv | bool | `true` |  |
+| telemetry.tracing.enabled | bool | `false` |  |
+| telemetry.tracing.endpoint | string | `"localhost:4317"` |  |
+| telemetry.tracing.samplingRatePerMillion | int | `1000000` |  |
 
 ### StorageConfig
 
@@ -248,6 +252,7 @@ rm /var/local/clusterpedia/internalstorage/<storage type>
 | clustersynchroManager.image.registry | string | `"ghcr.io"` |  |
 | clustersynchroManager.image.repository | string | `"clusterpedia-io/clusterpedia/clustersynchro-manager"` |  |
 | clustersynchroManager.image.tag | string | `"v0.7.0"` |  |
+| clustersynchroManager.kubeStateMetrics.enabled | bool | `false` |  |
 | clustersynchroManager.labels | object | `{}` |  |
 | clustersynchroManager.leaderElect.leaseDuration | string | `"15s"` |  |
 | clustersynchroManager.leaderElect.renewDeadline | string | `"10s"` |  |
@@ -281,4 +286,4 @@ rm /var/local/clusterpedia/internalstorage/<storage type>
 | controllerManager.tolerations | list | `[]` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
diff --git a/charts/clusterpedia/templates/_helpers.tpl b/charts/clusterpedia/templates/_helpers.tpl
@@ -361,3 +361,35 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this
 {{- define "clusterpedia.hookJob.image" -}}
 {{ include "common.images.image" (dict "imageRoot" .Values.hookJob.image "global" .Values.global) }}
 {{- end -}}
+
+{{- define "clusterpedia.tracing.env" -}}
+{{- if and (.Values.telemetry.tracing.enabled) (.Values.telemetry.tracing.addOtelEnv) }}
+- name: OTEL_EXPORTER_OTLP_ENDPOINT
+  value: {{ .Values.telemetry.tracing.endpoint }}
+- name: 'OTEL_SERVICE_NAME'
+  value: {{ include "common.names.fullname" . }}-apiserver
+- name: 'OTEL_K8S_NAMESPACE'
+  valueFrom:
+    fieldRef:
+      apiVersion: v1
+      fieldPath: metadata.namespace
+- name: OTEL_RESOURCE_ATTRIBUTES_NODE_NAME
+  valueFrom:
+    fieldRef:
+      apiVersion: v1
+      fieldPath: spec.nodeName
+- name: OTEL_RESOURCE_ATTRIBUTES_POD_NAME
+  valueFrom:
+    fieldRef:
+      apiVersion: v1
+      fieldPath: metadata.name
+- name: OTEL_RESOURCE_ATTRIBUTES
+  value: 'k8s.namespace.name=$(OTEL_K8S_NAMESPACE),k8s.node.name=$(OTEL_RESOURCE_ATTRIBUTES_NODE_NAME),k8s.pod.name=$(OTEL_RESOURCE_ATTRIBUTES_POD_NAME)'
+{{- end -}}
+{{- end -}}
+
+{{- define "clusterpedia.tracing.args" -}}
+{{- if .Values.telemetry.tracing.enabled }}
+- --tracing-config-file=/etc/clusterpedia/trace/tracing-config.yaml
+{{- end -}}
+{{- end -}}