add opentelemetry-ebpf-instrumentation helm chart #1704

NimrodAvni78 · 2025-06-05T12:57:16Z

Helm chart for opentelemetry-ebpf-instrumentation, the helm chart is based on the original beyla helm chart

issue

TylerHelmuth

We need to discuss this chart addition in the issue first

ittai-coralogix · 2025-06-05T21:12:51Z

We need to discuss this chart addition in the issue first

Hey @TylerHelmuth, just added a comment in the issue. Hope it clarifies everything.

mariomac

Looks great!

NimrodAvni78 · 2025-06-18T13:24:11Z

@mariomac iv'e added to k8s cache to the helm chart, so i would love a re-review

mariomac

LGTM!! Thanks for the contribution

- Integrate the chart with the Makefile for consistent tooling support. - Add examples and render via `make generate-examples'.

NimrodAvni78 · 2025-06-19T14:42:51Z

@TylerHelmuth i see that mario has approved
what are the next steps to get this merged?

I still need to do a real review but wont have time till July. But I dont want to block anymore.

github-actions · 2025-07-05T02:47:00Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

NimrodAvni78 · 2025-07-06T08:04:02Z

hey @TylerHelmuth, are you available for a review of this?

TylerHelmuth · 2025-07-10T18:08:08Z

charts/opentelemetry-ebpf-instrumentation/Chart.yaml

Can you update the github workflows so that this chart is tested? chart-testing will do a default install if there is no ci folder

TylerHelmuth · 2025-07-10T18:11:39Z

charts/opentelemetry-ebpf-instrumentation/README.md

Please add a section detailing requirements

TylerHelmuth · 2025-07-10T18:12:17Z

charts/opentelemetry-ebpf-instrumentation/Chart.yaml

+  - https://github.com/open-telemetry/opentelemetry-helm-charts
+icon: https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png
+maintainers:
+  - name: nimrodavni78


Suggested change

- name: nimrodavni78

- name: dmitryax

- name: jaronoff97

- name: TylerHelmuth

- name: nimrodavni78

charts/opentelemetry-ebpf-instrumentation/Chart.yaml

TylerHelmuth · 2025-07-10T18:16:21Z

charts/opentelemetry-ebpf-instrumentation/templates/_helpers.tpl

+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "obi.name" -}}


Please prefix all the templates with the chart's name instead of obi

TylerHelmuth · 2025-07-10T18:17:26Z

charts/opentelemetry-ebpf-instrumentation/templates/daemon-set.yaml

rename file to daemonset.yaml please.

TylerHelmuth · 2025-07-10T18:17:45Z

charts/opentelemetry-ebpf-instrumentation/templates/cluster-role.yaml

Please rename to clusterrole.yaml

TylerHelmuth · 2025-07-10T18:18:01Z

charts/opentelemetry-ebpf-instrumentation/templates/cluster-role-binding.yaml

please rename to clusterrolebinding.yaml

TylerHelmuth · 2025-07-10T18:18:56Z

charts/opentelemetry-ebpf-instrumentation/templates/configmap.yaml

+  ebpf-instrument-config.yml: |
+    {{- if eq .Values.preset "network" }}
+    {{- if not .Values.config.data.network }}
+    network:
+      enable: true
+    {{- end }}
+    {{- end }}
+    {{- if eq .Values.preset "application" }}
+    {{- if not .Values.config.data.discovery }}
+    discovery:
+      services:
+        - k8s_namespace: .
+      exclude_services:
+        - exe_path: ".*ebpf-instrument.*|.*otelcol.*"
+    {{- end }}
+    {{- end }}
+  {{- toYaml .Values.config.data | nindent 4}}
+{{- end }}


Lets move the configmap logic into a helper template like the other charts do

TylerHelmuth · 2025-07-10T18:19:45Z

charts/opentelemetry-ebpf-instrumentation/values.yaml

+global:
+  image:
+    # -- Global image registry to use if it needs to be overridden for some specific use cases (e.g local registries, custom images, ...)
+    registry: ""
+    # -- Optional set of global image pull secrets.
+    pullSecrets: []


Why do we need this and .Values.image?

there are 2 components, the obi agent and the k8s cache, this allows for configuring the same registry for both

global is a keyword in helm, can we nest this in a different section that is specific to this chart?

@mariomac wdyt, this was copied from the beyla helm chart

I'm fine replacing global by something more meaningful that doesn't collide with the keyword.

According to the block description, it seems something more related to the infrastructure setup (registry, pull secrets...). Maybe something like setup, infrastructure, login?

TBH I don't know about anyone using this section in Beyla.

I vote we simplify then and remove this capability. Users can configure each image in its own section instead.

NimrodAvni78 · 2025-07-27T09:55:55Z

@TylerHelmuth fixed all comments except changing the chart name
@MrAlias @mariomac wdyt the name should be?

mariomac · 2025-07-28T08:11:29Z

@NimrodAvni78 the name that we use for the executable and the docker image is ebpf-instrument. Maybe we can use it? The open-telemetry prefix will be already present, e.g.:

helm install my-obi open-telemetry/ebpf-instrument

TylerHelmuth · 2025-07-28T19:23:26Z

The pattern to match is to include opentelemetry- in the chart some. So we could so open-telemetry/opentelemetry-ebpf-instrument if that matches the image name.

charts/opentelemetry-ebpf-instrumentation/values.yaml

povilasv · 2025-08-07T06:21:20Z

charts/opentelemetry-ebpf-instrumentation/values.yaml

@@ -0,0 +1,327 @@
+image:
+  # -- Opentelemetry eBPF Instrumentation image registry (defaults to docker.io)
+  registry: "docker.io"


I think makes sense to default to "" or ghcr, this is what we recommend for collector;

helm install my-opentelemetry-collector open-telemetry/opentelemetry-collector --set mode= --set image.repository="ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-k8s" --set command.name="otelcol-k8s"

We had a lot of issues with docker.io with publishing our images and rate-limiting

povilasv · 2025-08-07T06:21:41Z

charts/opentelemetry-ebpf-instrumentation/values.yaml

+  repository: otel/ebpf-instrument
+  # -- (string) Opentelemetry eBPF Instrumentation image tag. When empty, the Chart's appVersion is
+  # used.
+  tag: main


let's not default to main

@povilasv obi still doesn't have any official releases, a v0.1.0 release is planned tho, this is the only tag being pushed currently beside commit

I think this a bit troublesome to maintain, as it's very hard to know if a specific commit removed a flag or did breaking change, so one day this helm chart will work another day it won't.

Maybe it makes sense to wait for proper versions, before releasing the chart?

We absolutely should not release a chart that doesn't have an official image. We've had issues in the Collector SIG dealing with some dependencies that didn't have an official tag. I dont want that to happen here.

We should wait for the 0.1.0 release before merging this PR.

povilasv · 2025-08-07T06:23:21Z

charts/opentelemetry-ebpf-instrumentation/values.yaml

+    registry: "docker.io"
+    # -- K8s Cache image repository.
+    repository: otel/opentelemetry-ebpf-k8s-cache
+    # -- (string) K8s Cache image tag. When empty, the Chart's appVersion is used.
+    tag: main


same comment as for main image / repository

povilasv · 2025-08-07T06:24:56Z

charts/opentelemetry-ebpf-instrumentation/values.yaml

@@ -0,0 +1,327 @@
+image:


maybe also make sense to move config here under opentelemetry-ebpf-instrumentation (maybe some better/ shorter name) ? since we have two workflows cache and daemonset?

if i understand what you are suggestion we discussed here its better to seperate them

Co-authored-by: Tyler Helmuth <[email protected]>

add opentelemetry-ebpf-instrumentation helm chart

07fa796

NimrodAvni78 requested a review from a team as a code owner June 5, 2025 12:57

NimrodAvni78 mentioned this pull request Jun 5, 2025

[opentelemetry-ebpf-instrumentation] add new helm chart #1703

Open

TylerHelmuth previously requested changes Jun 5, 2025

View reviewed changes

remove k8s cache from helm

726b3c7

mariomac approved these changes Jun 9, 2025

View reviewed changes

add k8s cache image

f71d691

mariomac approved these changes Jun 18, 2025

View reviewed changes

- Update the root README.md to include a reference to the new chart.

f91fcfa

- Integrate the chart with the Makefile for consistent tooling support. - Add examples and render via `make generate-examples'.

NimrodAvni78 force-pushed the otel-ebpf-instrumentation branch from 9a6914d to f91fcfa Compare June 19, 2025 08:12

fix kubernetes:enabled = true

cd5a327

github-actions bot added the Stale label Jul 5, 2025

github-actions bot removed the Stale label Jul 7, 2025

TylerHelmuth reviewed Jul 10, 2025

View reviewed changes

grcevski mentioned this pull request Jul 23, 2025

Publish Helm Chart open-telemetry/opentelemetry-ebpf-instrumentation#18

Open

NimrodAvni78 added 4 commits July 23, 2025 19:52

add maintainers

daea830

add ci folder with default-values.yaml

884fd4f

renamed yaml files and examples.fresh to examples.default

34e6580

add Prerequisites

e42fe8e

mariomac mentioned this pull request Jul 25, 2025

Migrate beyla documentation for OBI open-telemetry/opentelemetry.io#7399

Merged

9 tasks

NimrodAvni78 added 2 commits July 27, 2025 11:23

remove global

049dce1

move configmap to helper template

8ae443f

NimrodAvni78 force-pushed the otel-ebpf-instrumentation branch from 4c568f9 to 8ae443f Compare July 27, 2025 09:54

fix examples

e39a935

NimrodAvni78 force-pushed the otel-ebpf-instrumentation branch from f253362 to e39a935 Compare August 6, 2025 09:51

Merge branch 'main' into otel-ebpf-instrumentation

ecc59c4

NimrodAvni78 requested a review from TylerHelmuth August 6, 2025 09:59

TylerHelmuth reviewed Aug 6, 2025

View reviewed changes

charts/opentelemetry-ebpf-instrumentation/values.yaml Outdated Show resolved Hide resolved

povilasv reviewed Aug 7, 2025

View reviewed changes

NimrodAvni78 and others added 2 commits August 10, 2025 14:25

Update charts/opentelemetry-ebpf-instrumentation/values.yaml

124d373

Co-authored-by: Tyler Helmuth <[email protected]>

replace docker.io with ghcr.io

4ce86e5

-  - name: nimrodavni78
+  - name: dmitryax
+  - name: jaronoff97
+  - name: TylerHelmuth
+  - name: nimrodavni78

add opentelemetry-ebpf-instrumentation helm chart #1704

Are you sure you want to change the base?

add opentelemetry-ebpf-instrumentation helm chart #1704

Uh oh!

Conversation

NimrodAvni78 commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TylerHelmuth left a comment

Choose a reason for hiding this comment

Uh oh!

ittai-coralogix commented Jun 5, 2025

Uh oh!

mariomac left a comment

Choose a reason for hiding this comment

Uh oh!

NimrodAvni78 commented Jun 18, 2025

Uh oh!

mariomac left a comment

Choose a reason for hiding this comment

Uh oh!

NimrodAvni78 commented Jun 19, 2025

Uh oh!

github-actions bot commented Jul 5, 2025

Uh oh!

NimrodAvni78 commented Jul 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NimrodAvni78 commented Jul 27, 2025

Uh oh!

mariomac commented Jul 28, 2025

Uh oh!

TylerHelmuth commented Jul 28, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NimrodAvni78 commented Jun 5, 2025 •

edited

Loading