Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the clusterName option to documentation with description and usage examples. #1126

Merged
merged 3 commits into from
Jan 11, 2024
Merged

Add the clusterName option to documentation with description and usage examples. #1126

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
180fd40
Update kubernetes-config.rst
crobert-1 Jan 10, 2024
6a2ebb0
Update gdi/opentelemetry/collector-kubernetes/kubernetes-config.rst
crobert-1 Jan 10, 2024
cb0ae49
Update kubernetes-config.rst
aurbiztondo-splunk Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions gdi/opentelemetry/collector-kubernetes/kubernetes-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ For example:
accessToken: xxxxxx
realm: us0
clusterName: my-k8s-cluster
distribution: gke
distribution: gke

Configure Google Kubernetes Engine
-----------------------------------------------------------------------------
Expand Down Expand Up @@ -130,6 +130,25 @@ This distribution operates similarly to the ``eks`` distribution, but with the f
* The configured cluster receiver is deployed as a two-replica StatefulSet instead of a Deployment, and uses a Kubernetes Observer extension that discovers the cluster's nodes and, on the second replica, its pods for user-configurable receiver creator additions.Using this observer dynamically creates the Kubelet Stats receiver instances that report kubelet metrics for all observed Fargate nodes. The first replica monitors the cluster with a ``k8s_cluster`` receiver, and the second cluster monitors all kubelets except its own (due to an EKS/Fargate networking restriction).
* The first replica's Collector monitors the second's kubelet. This is made possible by a Fargate-specific ``splunk-otel-eks-fargate-kubeletstats-receiver-node`` node label. The Collector ClusterRole for ``eks/fargate`` allows the ``patch`` verb on ``nodes`` resources for the default API groups to allow the cluster receiver's init container to add this node label for designated self monitoring.

.. _otel-kubernetes-config-clustername:

Configure the cluster name
============================================

Use the ``clusterName`` parameter to specify the name of the Kubernetes cluster. This parameter is optional for the ``eks``, ``eks/fargate``, ``gke``, and ``gke/autopilot`` distributions, but required for all of others.

Apply the following to configure your cluster name:

.. code-block:: bash

--set clusterName=my-k8s-cluster

For example:

.. code-block:: yaml

clusterName: my-k8s-cluster

.. _otel-kubernetes-config-environment:

Configure the deployment environment
Expand All @@ -139,7 +158,6 @@ If applicable, use the ``environment`` parameter to specify an additional ``depl

.. code-block:: yaml


splunkObservability:
accessToken: xxxxxx
realm: us0
Expand Down