[chore] Add ALPHA notice for the Network Explorer in values.yaml, NOT…

…ES.txt, and advanced-configuration.md
signalfx · Oct 16, 2023 · c6e17ed · c6e17ed
1 parent 44ecdff
commit c6e17ed
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/docs/advanced-configuration.md b/docs/advanced-configuration.md
@@ -539,6 +539,10 @@ Note: Running the collector agent for log collection in non-root mode is not cur
 [related GitHub feature request issue](https://github.com/signalfx/splunk-otel-collector-chart/issues/891).
 
 ## Network explorer
+
+**NOTE:** Network Explorer related features should be considered to have an ALPHA maturity level and be experimental.
+There may be breaking changes or Network Explorer features may be replaced entirely with a better alternative in the future.
+
 [Network explorer](network-explorer-architecture.md) allows you to collect network telemetry for ingest and analysis.  This telemetry is sent to the Open Telemetry Collector Gateway.
 To enable the network explorer, set the `enabled` flag to `true`
 ```yaml

diff --git a/helm-charts/splunk-otel-collector/templates/NOTES.txt b/helm-charts/splunk-otel-collector/templates/NOTES.txt
@@ -80,6 +80,11 @@ Splunk Network Explorer is installed and configured.
           Upgrade guidelines: https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#0670-to-0680
 {{ end }}
 {{- if .Values.operator.enabled }}
+[INFO] You've activated the Network Explorer feature (networkExplorer.enabled=true), currently considered ALPHA.
+  - Performance may vary depending on host environment specifications.
+  - Splunk offers best-effort support; however, not all deployment environments for Network Explorer may be tested or fully supported.
+{{- end }}
+{{- if .Values.operator.enabled }}
 [INFO] You've enabled the operator's auto-instrumentation feature (operator.enabled=true), currently considered ALPHA.
   - Instrumentation library maturity varies (e.g., Java is more mature than Go). For library stability, visit: https://opentelemetry.io/docs/instrumentation/#status-and-releases
   - Some libraries may be enabled by default. For current status, see: https://github.com/open-telemetry/opentelemetry-operator#controlling-instrumentation-capabilities

diff --git a/helm-charts/splunk-otel-collector/values.yaml b/helm-charts/splunk-otel-collector/values.yaml
@@ -1111,6 +1111,11 @@ gateway:
   config: {}
 
 ################################################################################
+# Notice: Network Explorer related features should be considered to have an
+# ALPHA maturity level and be experimental. There may be breaking changes or
+# Network Explorer features may be replaced entirely with a better alternative
+# in the future.
+#
 # OpenTelemetry service config, used for otel collector deployment.
 # Disabled by default
 ################################################################################