[otel-integration] feat: add support for gke/autopilot

coralogix · Dec 1, 2023 · 9b14796 · 9b14796
1 parent 3b5aeca
commit 9b14796
Show file tree

Hide file tree

Showing 4 changed files with 542 additions and 4 deletions.
diff --git a/otel-integration/CHANGELOG.md b/otel-integration/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## OpenTelemtry-Integration
 
+### v0.0.40 / 2023-12-01
+
+- [FEATURE] Add support for GKE Autopilot clusters.
+
 ### v0.0.39 / 2023-11-30
 
 - [FIX] Fix cluster collector k8sattributes should not filter on node level.

diff --git a/otel-integration/k8s-helm/Chart.yaml b/otel-integration/k8s-helm/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 name: otel-integration
 description: OpenTelemetry Integration
-version: 0.0.39
+version: 0.0.40
 keywords:
   - OpenTelemetry Collector
   - OpenTelemetry Agent
@@ -11,17 +11,17 @@ keywords:
 dependencies:
   - name: opentelemetry-collector
     alias: opentelemetry-agent
-    version: "0.77.4"
+    version: "0.77.5"
     repository: https://cgx.jfrog.io/artifactory/coralogix-charts-virtual
     condition: opentelemetry-agent.enabled
   - name: opentelemetry-collector
     alias: opentelemetry-agent-windows
-    version: "0.77.4"
+    version: "0.77.5"
     repository: https://cgx.jfrog.io/artifactory/coralogix-charts-virtual
     condition: opentelemetry-agent-windows.enabled
   - name: opentelemetry-collector
     alias: opentelemetry-cluster-collector
-    version: "0.77.4"
+    version: "0.77.5"
     repository: https://cgx.jfrog.io/artifactory/coralogix-charts-virtual
     condition: opentelemetry-cluster-collector.enabled
 sources:

diff --git a/otel-integration/k8s-helm/README.md b/otel-integration/k8s-helm/README.md
@@ -158,6 +158,37 @@ helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-
   --render-subchart-notes -f values-windows.yaml
 ```
 
+### Installing the chart on GKE Autopilot clusters.
+
+GKE Autopilot has limited access to host filesystems, host netowkring and host ports, due to this some features of OpenTelemetry Collector doesn't work. More information about limitations is available in [GKE Autopilot security capabilities document](https://cloud.google.com/kubernetes-engine/docs/concepts/autopilot-security)
+
+Note important differences between regular otel-integration are:
+- Host metrics receiver is not available, though you still get some metrics about the host thru kubeletstats receiver.
+- Kubernetes Dashboard does not work, due to missing Host Metrics.
+- Host networking and host ports are not available, users need to send tracing spans thru Kubernetes Service. The Service uses `internalTrafficPolicy: Local`, to send traffic to locally running agents. 
+- Log Collection works, but does not store check points. Restarting the agent will collect logs from the beginning.
+
+To install otel-integration to GKE/Autopilot follow these steps:
+
+First make sure to add our Helm charts repository to the local repos list with the following command:
+
+```bash
+helm repo add coralogix-charts-virtual https://cgx.jfrog.io/artifactory/coralogix-charts-virtual
+```
+
+In order to get the updated Helm charts from the added repository, please run:
+
+```bash
+helm repo update
+```
+
+Install the chart with the CRD `gke-autopilot-values.yaml` file:
+
+```bash
+helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-integration \
+  --render-subchart-notes -f gke-autopilot-values.yaml
+```
+
 # How to use it
 
 ## Available Endpoints