Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit ac7e4b4

Browse files
Feedback, new doc
1 parent f2f227b commit ac7e4b4

File tree

4 files changed

+122
-72
lines changed

4 files changed

+122
-72
lines changed

gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst

Lines changed: 45 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,43 +12,78 @@ Get started with the Collector for Kubernetes
1212
:hidden:
1313

1414
Install with Helm <install-k8s.rst>
15+
Helm components <kubernetes-helm-architecture>
16+
Helm releases and images <kubernetes-helm-releases>
1517
Install with YAML manifests <install-k8s-manifests.rst>
1618
Kubernetes (EKS Add-on) <install-k8s-addon-eks.rst>
1719
Configure with Helm <kubernetes-config.rst>
1820
Advanced config <kubernetes-config-advanced.rst>
1921
Configure logs and events <kubernetes-config-logs.rst>
20-
Helm architecture <kubernetes-helm-architecture>
2122
Default Kubernetes metrics <metrics-ootb-k8s.rst>
2223
Upgrade <kubernetes-upgrade.rst>
2324
Uninstall <kubernetes-uninstall.rst>
2425
Troubleshoot <troubleshoot-k8s.rst>
2526
Troubleshoot containers <troubleshoot-k8s-container.rst>
2627
Support <kubernetes-support.rst>
27-
k8s-infrastructure-tutorial/about-k8s-tutorial
28-
collector-configuration-tutorial-k8s/about-collector-config-tutorial.rst
28+
Tutorial: Monitor your Kubernetes environment <k8s-infrastructure-tutorial/about-k8s-tutorial.rst>
29+
Tutorial: Configure the Collector for Kubernetes <collector-configuration-tutorial-k8s/about-collector-config-tutorial.rst>
2930

30-
To install and configure the Splunk Distribution of the OpenTelemetry Collector for Kubernetes, follow these docs:
31+
To install, configure and use the Splunk Distribution of the Collector for Kubernetes follow this documentation.
32+
33+
.. raw:: html
34+
35+
<embed>
36+
<h2>Install the Collector for Kubernetes<a name="k8s-install" class="headerlink" href="#k8s-install" title="Permalink to this headline">¶</a></h2>
37+
</embed>
38+
39+
To install the Splunk Distribution of the OpenTelemetry Collector for Kubernetes using the Helm chart, read and follow these docs:
3140

3241
* :ref:`otel-install-k8s`
42+
* :ref:`kubernetes-helm-architecture`
43+
* :ref:`kubernetes-helm-releases`
44+
45+
Optionally, you can also:
46+
3347
* :ref:`otel-install-k8s-manifests`
34-
* :ref:`install-k8s-addon-eks`
35-
* :ref:`otel-kubernetes-config`
36-
* By default, you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>`
48+
* :ref:`Deploy the Collector as an AWS EKS Add-on <install-k8s-addon-eks>`
49+
50+
.. note:: By default, you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>`.
3751

38-
Learn more about the Collector's Helm architecture, components, and images at :ref:`kubernetes-helm-architecture`.
52+
.. raw:: html
3953

40-
For advanced configuration options, see:
54+
<embed>
55+
<h2>Configure the Collector for Kubernetes<a name="k8s-configure" class="headerlink" href="#k8s-configure" title="Permalink to this headline">¶</a></h2>
56+
</embed>
4157

58+
To configure the Collector, see:
59+
60+
* :ref:`otel-kubernetes-config`
4261
* :ref:`otel-kubernetes-config-advanced`
4362
* :ref:`kubernetes-config-logs`
4463
* :ref:`discovery-mode-k8s`
4564

65+
.. raw:: html
66+
67+
<embed>
68+
<h2>Upgrade, uninstall and troubleshoot<a name="k8s-ts" class="headerlink" href="#k8s-ts" title="Permalink to this headline">¶</a></h2>
69+
</embed>
70+
4671
To upgrade or uninstall, see:
4772

4873
* :ref:`otel-kubernetes-upgrade`
4974
* :ref:`otel-kubernetes-uninstall`
5075

51-
.. note:: If you have any installation or configuration issues, refer to :ref:`otel-troubleshooting` and :ref:`troubleshoot-k8s`.
76+
If you have any installation or configuration issues, refer to:
77+
78+
* :ref:`otel-troubleshooting`
79+
* :ref:`troubleshoot-k8s`
80+
* :ref:`kubernetes-support`
81+
82+
.. raw:: html
83+
84+
<embed>
85+
<h2>Tutorials<a name="k8s-tutorials" class="headerlink" href="#k8s-tutorials" title="Permalink to this headline">¶</a></h2>
86+
</embed>
5287

5388
For a walkthrough of common tasks related to the OpenTelemetry Collector for Kubernetes, see:
5489

gdi/opentelemetry/collector-kubernetes/install-k8s.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ Use the Helm chart to do the following:
1717
* Create a Kubernetes DaemonSet along with other Kubernetes objects in a Kubernetes cluster.
1818
* Receive, process, and export metric, trace, and log data for Splunk Enterprise, Splunk Cloud Platform, and Splunk Observability Cloud.
1919

20+
To learn more about the Collector for Kubernetes Helm chart, see:
21+
22+
* :ref:`kubernetes-helm-architecture`
23+
* :ref:`kubernetes-helm-releases`
24+
2025
.. _helm-chart-supported-distros:
2126

2227
Supported Kubernetes distributions
@@ -43,8 +48,6 @@ You need the following resources to use the chart:
4348
* :new-page:`Helm 3 <https://helm.sh/docs/intro/install/>`. Helm 2 is not supported.
4449
* Administrator access to your Kubernetes cluster.
4550

46-
Learn more about the helm components and images at :ref:`kubernetes-helm-architecture`.
47-
4851
.. _collector-k8s-destination:
4952

5053
Prerequisites: Destination
Lines changed: 7 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
11
.. _kubernetes-helm-architecture:
2+
.. _kubernetes-helm-components:
3+
.. _helm-chart-components:
24

35
*****************************************************
4-
Helm architecture and components
6+
Helm chart architecture and components
57
*****************************************************
68

79
.. meta::
810
:description: Describes the architecture and components of the Splunk Distribution of the OpenTelemetry Collector for Kubernetes.
911

10-
See an overview of the Helm architecture of the Splunk Distribution of the OpenTelemetry Collector for Kubernetes.
11-
12-
.. _helm-chart-components:
13-
14-
Helm chart components
15-
==============================================
16-
1712
The Helm chart for the Collector has three components: agent, cluster receiver, and gateway (optional).
1813

19-
For use cases about the different components, see the GitHub documentation :new-page:`Splunk OpenTelemetry Collector Helm Chart Components: Use Cases <https://github.com/jvoravong/splunk-otel-collector-chart/blob/Feature-components-doc/docs/components.md#use-cases>`.
14+
.. note:: For use cases about the different components, see the GitHub documentation :new-page:`Splunk OpenTelemetry Collector Helm Chart Components: Use Cases <https://github.com/jvoravong/splunk-otel-collector-chart/blob/Feature-components-doc/docs/components.md#use-cases>`.
2015

2116
Agent component
22-
------------------------------------------------
17+
==============================================
2318

2419
The agent component is deployed to each node in the Kubernetes cluster as a DaemonSet, and monitors all the data sources within each node.
2520

@@ -41,7 +36,7 @@ The agent component consists of the following config files:
4136
* Used for internal communication within the cluster or for exposing specific metrics or health endpoints.
4237

4338
Cluster receiver component
44-
------------------------------------------------
39+
==============================================
4540

4641
The cluster receiver component runs as a single pod in the cluster created by a deployment, and collects data from a single location. Use this component in scenarios where telemetry data is available from a cluster-wide service or endpoint.
4742

@@ -68,7 +63,7 @@ The cluster receiver component consists of the following config files:
6863
* Associated with a StatefulSet and used for load balancing, internal communication, or exposing specific endpoints.
6964

7065
Gateway component (optional)
71-
------------------------------------------------
66+
==============================================
7267

7368
The gateway component serves as an intermediary. It receives, processes, enriches, and forwards data, enhancing data exportation. Use it primarily in larger clusters to scale monitoring capabilities.
7469

@@ -94,51 +89,3 @@ The gateway component consists of the following config files:
9489
* Defines a Pod Disruption Budget (PDB) for the gateway.
9590
* Ensures that a certain number or percentage of replicas of the gateway remain available during voluntary disruptions.
9691

97-
.. _helm-chart-releases:
98-
99-
Helm chart releases
100-
==============================================
101-
102-
Here's a list of the main chart binaries, images and dependencies available in Splunk Observability Cloud's GitHub. You can use them, for instance, in air gapped environments, push them manually to your own registry, and test them out.
103-
104-
Primary chart release
105-
------------------------------------------------
106-
107-
* :new-page:`https://github.com/signalfx/splunk-otel-collector-chart/releases/download/splunk-otel-collector-X.X.X/splunk-otel-collector-X.X.X.tgz`
108-
109-
Optional releases for subcharts
110-
------------------------------------------------
111-
112-
* :new-page:`https://github.com/open-telemetry/opentelemetry-helm-charts/releases/download/opentelemetry-operator-X.X.X/opentelemetry-operator-X.X.X.tgz`
113-
114-
* :new-page:`https://github.com/cert-manager/cert-manager/archive/refs/tags/vX.X.X.tar.gz`
115-
116-
.. _helm-chart-images:
117-
118-
Helm chart images
119-
==============================================
120-
121-
Images used by default
122-
------------------------------------------------
123-
124-
* :new-page:`quay.io/signalfx/splunk-otel-collector`
125-
126-
Optional add-on feature images
127-
------------------------------------------------
128-
129-
* :new-page:`docker.io/splunk/fluentd-hec`
130-
* :new-page:`quay.io/signalfx/splunk-otel-collector-windows`
131-
* :new-page:`registry.access.redhat.com/ubi9/ubi`
132-
* :new-page:`ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator`
133-
* :new-page:`quay.io/jetstack/cert-manager-controller`
134-
* :new-page:`quay.io/jetstack/cert-manager-acmesolver`
135-
* :new-page:`quay.io/jetstack/cert-manager-webhook`
136-
* :new-page:`quay.io/jetstack/cert-manager-cainjector`
137-
* :new-page:`quay.io/jetstack/cert-manager-ctl`
138-
* :new-page:`ghcr.io/signalfx/splunk-otel-java/splunk-otel-java`
139-
* :new-page:`ghcr.io/signalfx/splunk-otel-java/splunk-otel-js`
140-
* :new-page:`ghcr.io/signalfx/splunk-otel-java/splunk-otel-dotnet`
141-
* :new-page:`ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-go`
142-
* :new-page:`ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd`
143-
* :new-page:`ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-python`
144-
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
.. _kubernetes-helm-releases:
2+
3+
*****************************************************
4+
Helm chart releases and images
5+
*****************************************************
6+
7+
.. meta::
8+
:description: Lists Helm releases and charts for the Splunk Distribution of the OpenTelemetry Collector for Kubernetes.
9+
10+
Here's a list of the main chart binaries and images available in Splunk Observability Cloud's GitHub. For example, in air gapped environments, you can use push them manually to your own registry and test them out.
11+
12+
.. _helm-chart-releases:
13+
14+
Helm chart releases
15+
==============================================
16+
17+
Here's a list of the main chart releases available for the Splunk Distribution of the OpenTelemetry Collector for Kubernetes.
18+
19+
Primary chart release
20+
------------------------------------------------
21+
22+
* :new-page:`https://github.com/signalfx/splunk-otel-collector-chart/releases/download/splunk-otel-collector-X.X.X/splunk-otel-collector-X.X.X.tgz`
23+
24+
Optional releases for subcharts
25+
------------------------------------------------
26+
27+
* :new-page:`https://github.com/open-telemetry/opentelemetry-helm-charts/releases/download/opentelemetry-operator-X.X.X/opentelemetry-operator-X.X.X.tgz`
28+
29+
* :new-page:`https://github.com/cert-manager/cert-manager/archive/refs/tags/vX.X.X.tar.gz`
30+
31+
.. _helm-chart-images:
32+
33+
Helm chart images
34+
==============================================
35+
36+
Here's a list of the main chart images available for the Splunk Distribution of the OpenTelemetry Collector for Kubernetes.
37+
38+
.. _helm-chart-images-default:
39+
40+
Images used by default
41+
------------------------------------------------
42+
43+
* :new-page:`quay.io/signalfx/splunk-otel-collector`
44+
45+
.. _helm-chart-images-optional:
46+
47+
Optional add-on feature images
48+
------------------------------------------------
49+
50+
* :new-page:`docker.io/splunk/fluentd-hec`
51+
* :new-page:`quay.io/signalfx/splunk-otel-collector-windows`
52+
* :new-page:`registry.access.redhat.com/ubi9/ubi`
53+
* :new-page:`ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator`
54+
* :new-page:`quay.io/jetstack/cert-manager-controller`
55+
* :new-page:`quay.io/jetstack/cert-manager-acmesolver`
56+
* :new-page:`quay.io/jetstack/cert-manager-webhook`
57+
* :new-page:`quay.io/jetstack/cert-manager-cainjector`
58+
* :new-page:`quay.io/jetstack/cert-manager-ctl`
59+
* :new-page:`ghcr.io/signalfx/splunk-otel-java/splunk-otel-java`
60+
* :new-page:`ghcr.io/signalfx/splunk-otel-java/splunk-otel-js`
61+
* :new-page:`ghcr.io/signalfx/splunk-otel-java/splunk-otel-dotnet`
62+
* :new-page:`ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-go`
63+
* :new-page:`ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd`
64+
* :new-page:`ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-python`
65+

0 commit comments

Comments
 (0)