Add an optional cluster_name field to GetEventsResponse

Add an optional cluster_name field to GetEventsResponse. To enable the field, set tetragon.clusterName Helm value. Signed-off-by: Michi Mutsuzaki <[email protected]>
cilium · Oct 22, 2024 · b83744f · b83744f
1 parent 1b279b8
commit b83744f
Show file tree

Hide file tree

Showing 17 changed files with 138 additions and 79 deletions.
diff --git a/api/v1/README.md b/api/v1/README.md
diff --git a/api/v1/tetragon/events.pb.go b/api/v1/tetragon/events.pb.go
diff --git a/api/v1/tetragon/events.proto b/api/v1/tetragon/events.proto
@@ -204,4 +204,6 @@ message GetEventsResponse {
     // aggregation_info contains information about aggregation results. This field
     // is set only for aggregated responses.
     AggregationInfo aggregation_info = 1002;
+    // Name of the cluster where this event was observed.
+    string cluster_name = 1003;
 }
diff --git a/contrib/tetragon-rthooks/vendor/github.com/cilium/tetragon/api/v1/tetragon/events.pb.go b/contrib/tetragon-rthooks/vendor/github.com/cilium/tetragon/api/v1/tetragon/events.pb.go
diff --git a/contrib/tetragon-rthooks/vendor/github.com/cilium/tetragon/api/v1/tetragon/events.proto b/contrib/tetragon-rthooks/vendor/github.com/cilium/tetragon/api/v1/tetragon/events.proto
diff --git a/docs/content/en/docs/reference/grpc-api.md b/docs/content/en/docs/reference/grpc-api.md
diff --git a/docs/content/en/docs/reference/helm-chart.md b/docs/content/en/docs/reference/helm-chart.md
diff --git a/docs/data/tetragon_flags.yaml b/docs/data/tetragon_flags.yaml
diff --git a/install/kubernetes/tetragon/README.md b/install/kubernetes/tetragon/README.md
diff --git a/install/kubernetes/tetragon/templates/tetragon_configmap.yaml b/install/kubernetes/tetragon/templates/tetragon_configmap.yaml
@@ -6,6 +6,7 @@ metadata:
   labels:
   {{- include "tetragon.labels" . | nindent 4 }}
 data:
+  cluster-name: {{ .Values.tetragon.clusterName | quote }}
 {{- if .Values.tetragon.btf }}
   btf: {{ .Values.tetragon.btf }}
 {{- end }}
@@ -75,4 +76,4 @@ data:
 {{- if .Values.tetragon.enableKeepSensorsOnExit }}
   keep-sensors-on-exit: "true"
   release-pinned-bpf: "false"
-{{- end }}
+{{- end }}
diff --git a/install/kubernetes/tetragon/values.yaml b/install/kubernetes/tetragon/values.yaml
@@ -137,6 +137,9 @@ tetragon:
   # With both of the above redaction filters in place, we are now redacting all
   # password arguments.
   redactionFilters: ""
+  # -- Name of the cluster where Tetragon is installed. Tetragon uses this value
+  # to set the cluster_name field in GetEventsResponse messages.
+  clusterName: ""
   # -- Access Kubernetes API to associate Tetragon events with Kubernetes pods.
   enableK8sAPI: true
   # -- Enable Capabilities visibility in exec and kprobe events.

diff --git a/pkg/option/config.go b/pkg/option/config.go
@@ -25,6 +25,7 @@ type config struct {
 	Verbosity       int
 	ForceSmallProgs bool
 	ForceLargeProgs bool
+	ClusterName     string
 
 	EnableProcessNs   bool
 	EnableProcessCred bool