Skip to content

Commit 07ddf80

Browse files
authored
Include clusterName in the OBI getting started documentation (#2367)
* Include clusterName in the OBI getting started docs * Clarify when clusterName is needed * Apply feedback
1 parent ebf2ee9 commit 07ddf80

2 files changed

Lines changed: 18 additions & 1 deletion

File tree

docs/zero-code-ebpf-instrumentation.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,24 @@ helm install my-splunk-otel-collector \
4242
splunk-otel-collector-chart/splunk-otel-collector \
4343
--set="splunkObservability.realm=${SPLUNK_REALM}" \
4444
--set="splunkObservability.accessToken=${SPLUNK_ACCESS_TOKEN}" \
45+
--set="clusterName=${CLUSTER_NAME}" \
4546
--set="obi.enabled=true"
4647
```
4748

49+
The chart can auto-detect `k8s.cluster.name` when `distribution` is set to one
50+
of the supported values for auto-discovery: `eks`, `eks/auto-mode`, `gke`,
51+
`gke/autopilot`, or `openshift`. `eks/fargate` is an exception and still
52+
requires `clusterName` to be set explicitly. For other distributions, set
53+
`clusterName` explicitly.
54+
4855
### Configuration Options
4956

50-
For basic usage, no additional configuration is required.
57+
For basic usage, enable OBI with `obi.enabled=true` and make sure the chart can
58+
set `k8s.cluster.name` either by:
59+
60+
- Setting `clusterName` explicitly
61+
- Setting `distribution` to `eks`, `eks/auto-mode`, `gke`, `gke/autopilot`, or
62+
`openshift` so the chart can auto-detect it
5163

5264
Additional configuration options are available to customize OBI features.
5365
Refer to the [OBI chart's documentation] for more details.

examples/ebpf-instrumentation/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ helm install splunk-otel-collector splunk-otel-collector-chart/splunk-otel-colle
2020
--set="environment=<ENVIRONMENT>"
2121
```
2222

23+
`clusterName` can be omitted only when `distribution` is set to a value that
24+
supports auto-discovery of `k8s.cluster.name`: `eks`, `eks/auto-mode`, `gke`,
25+
`gke/autopilot`, or `openshift`. `eks/fargate` is an exception and still
26+
requires `clusterName` to be set explicitly.
27+
2328
Refer to OBI [documentation for deployment on AKS/EKS](https://opentelemetry.io/docs/zero-code/obi/security/#deploy-on-akseks) if needed.
2429

2530
[platform requirements]: ../../docs/zero-code-ebpf-instrumentation.md#platform-requirements

0 commit comments

Comments
 (0)