Skip to content

Commit 41da320

Browse files
authored
components description made collapsable in k8s otel operator main README.md (#60)
* components description made collapsable
1 parent d345c08 commit 41da320

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/kubernetes/operator/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This guide describes how to:
44

55
- Install the [OpenTelemetry Operator](https://github.com/open-telemetry/opentelemetry-operator/) using the [kube-stack Helm chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack).
6-
- Use the EDOT Collector to send Kubernetes logs, metrics, and application traces to an Elasticsearch cluster.
6+
- Use the EDOT Collectors to send Kubernetes logs, metrics, and application traces to an Elasticsearch cluster.
77
- Use the operator for applications [auto-instrumentation](https://opentelemetry.io/docs/kubernetes/operator/automatic/) in all supported languages.
88

99
## Table of Contents
@@ -42,6 +42,11 @@ When [installing the release](#manual-deployment-of-all-components), ensure you
4242

4343
## Components description
4444

45+
Getting started with OpenTelemetry for Kubernetes observability requires an understanding of the following components, their functions, and interactions: OpenTelemetry Operator, Collectors, kube-stack Helm Chart, and auto-instrumentation resources.
46+
47+
<details>
48+
<summary>Expand this section for a detailed description of these components.</summary>
49+
4550
### OpenTelemetry Operator
4651

4752
The OpenTelemetry Operator is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) implementation designed to manage OpenTelemetry resources in a Kubernetes environment. It defines and oversees the following Custom Resource Definitions (CRDs):
@@ -53,7 +58,7 @@ All signals including logs, metrics, and traces are processed by the collectors
5358

5459
### Kube-stack Helm Chart
5560

56-
The [kube-stack Helm chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack) is used to manage the installation of the operator (including its CRDs) and to configure a suite of collectors, which instrument various Kubernetes components to enable comprehensive observability and monitoring.
61+
The [kube-stack Helm chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack) is used to manage the installation of the operator (including its CRDs), and to configure a suite of collectors, which instrument various Kubernetes components to enable comprehensive observability and monitoring.
5762

5863
The chart is installed with a provided default `values.yaml` file that can be customized when needed.
5964

@@ -87,6 +92,8 @@ The Helm chart is configured to enable zero-code instrumentation using the [Oper
8792
- Python
8893
- .NET
8994

95+
</details>
96+
9097
## Deploy components using the guided onboarding
9198

9299
The guided onboarding simplifies deploying your Kubernetes components by setting up an [API Key](https://www.elastic.co/guide/en/kibana/current/api-keys.html) and the needed [Integrations](https://www.elastic.co/docs/current/en/integrations) in the background. Follow these steps to use the guided onboarding:
@@ -169,10 +176,10 @@ Regardless of the installation method followed, perform the following checks to
169176
- Verify that the **[OTEL][Metrics Kubernetes] Cluster Overview** dashboard in **Kibana** is displaying data correctly.
170177
171178
4. **Log Data Availability in Kibana**
172-
- In **Kibana Discovery**, confirm the availability of data under the `__logs-*__` data view.
179+
- In **Kibana Discover**, confirm the availability of data under the `__logs-*__` data view.
173180
174181
5. **Metrics Data Availability in Kibana**
175-
- In **Kibana Discovery**, ensure data is available under the `__metrics-*__` data view.
182+
- In **Kibana Discover**, ensure data is available under the `__metrics-*__` data view.
176183
177184
## Instrumenting Applications
178185

0 commit comments

Comments
 (0)