maint: Add Sunset notice to collector README (#232)

## Which problem is this PR solving? - Related to #231 ## Short description of the changes - Updates the collector chart's readme with a Sunset notice. --------- Co-authored-by: Phillip Carter <[email protected]>
honeycombio · May 1, 2023 · 0af4658 · 0af4658
1 parent fe88950
commit 0af4658
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/charts/opentelemetry-collector/README.md b/charts/opentelemetry-collector/README.md
@@ -1,3 +1,32 @@
+# Sunset Notice
+
+The OpenTelemetry Collector for Honeycomb helm chart is being sunset in favor of the [OpenTelemetry community's opentelemetry-collector helm chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-collector).
+This community chart provides an overall better experience deploying and managing the collector in kubernetes.  
+
+The primary difference between this chart and the community chart is that the community chart does not include a `honeycomb` section for specifying your API key, API host, and dataset name. Instead, you must configure an otlp/otlphttp exporter following [our Collector documentation](https://docs.honeycomb.io/getting-data-in/otel-collector/).  Example:
+
+```yaml
+mode: deployment
+
+config:
+  exporters:
+    otlp:
+      endpoint: "api.honeycomb.io:443"
+      headers:
+        "x-honeycomb-team": "YOUR_API_KEY"
+        "x-honeycomb-dataset": "YOUR_DATASET_NAME"
+  processors:
+    pipelines:
+      metrics:
+        exporters: [otlp]
+      traces:
+        exporters: [otlp]
+      logs:
+        exporters: [otlp]
+```
+
+See https://github.com/honeycombio/helm-charts/issues/231 for more details.
+
 # OpenTelemetry Collector for Honeycomb
 
 [OpenTelemetry](https://opentelemetry.io) provides a single set of APIs, libraries, agents, and collector services to 

diff --git a/charts/opentelemetry-collector/templates/NOTES.txt b/charts/opentelemetry-collector/templates/NOTES.txt
@@ -8,5 +8,7 @@ secret resource name which contains your API Key
 #####
 {{- end }}
 
+[WARNING] This chart has been sunset, please use the open-telemetry/opentelemetry-collector chart instead. See https://github.com/honeycombio/helm-charts#sunset-notice for more details.
+
 OpenTelemetry Collector is setup and configured to collect traces and send them to Honeycomb. 
 You can see your traces at https://ui.honeycomb.io