Skip to content

Commit

Permalink
Update install-k8s-addon-eks.rst
Browse files Browse the repository at this point in the history
1. We want to also make sure the Splunk Platform (Enterprise/Cloud) users understand the difference between this EKS add-on and other available Splunk Enterprise/Cloud Add-ons.
2. Remove the confusion from the naming as this is not a Otel Collector Add-on but rather Otel Collector as an EKS add-on.
  • Loading branch information
chentaow-splunk authored Dec 15, 2023
1 parent e218f1c commit 9c1a41f
Showing 1 changed file with 16 additions and 18 deletions.
34 changes: 16 additions & 18 deletions gdi/opentelemetry/install-k8s-addon-eks.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,32 @@
.. _install-k8s-addon-eks:

*******************************************************************************
Splunk Distribution of the OTel Collector Add-on for AWS EKS
Splunk Distribution of the OpenTelemetry Collector as EKS Add-on
*******************************************************************************

.. meta::
:description: AWS Add-on for EKS
:description: Kubernetes (EKS Add-on)

An Add-on is a type of app that runs on Splunk Observability Cloud and provides specific capabilities to other apps, such as getting data in, mapping data, or providing saved searches and macros. An add-on is a reusable component that supports other apps across a number of different use cases, and is not typically run as a standalone app. The main benefit of using Add-ons is the ease of deployment compared to standard process to install the OpenTelemetry Collector.

Amazon Elastic Kubernetes Service (EKS) is a managed container service to run and scale Kubernetes applications in the AWS cloud. Splunk Observability Cloud provides an Add-on available in the AWS marketplace that allows you to seamlessly connect to Amazon EKS to track EKS performance by namespace, cluster, pod or organizational concepts such as team or application.
Amazon Elastic Kubernetes Service (EKS) is a managed container service to run and scale Kubernetes applications in the AWS cloud. Splunk Observability Cloud provides an EKS Add-on available in the AWS marketplace that allows you to seamlessly deploy Splunk Distribution of the OpenTelemetry Collector to Amazon EKS clusters to track EKS performance by namespace, cluster, pod or organizational concepts such as team or application.

For more information, read the official AWS documentation at :new-page:`Amazon EKS add-ons <https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html>`

.. note::

To see the Add-ons available for the Splunk Platform, refer to :new-page:`Splunk Supported Add-ons <https://docs.splunk.com/Documentation/AddOns>`.
This is different from Add-ons for the Splunk Platform, refer to :new-page:`Splunk Supported Add-ons <https://docs.splunk.com/Documentation/AddOns>`.

Benefits
=============================================================================================

The Splunk Distribution of the OTel Collector Add-on for AWS EKS:
The Amazon EKS Add-on "Splunk Distribution of the OpenTelemetry Collector":

* Provides simplified installation, configuration and management of Amazon EKS clusters.
* Includes the latest security patches, bug fixes, and are validated by AWS to work with Amazon EKS.

Limitations
=============================================================================================

While the Splunk Distribution of the OpenTelemetry Collector Add-on for AWS EKS offers numerous advantages, be aware of these limitations:
While this deployment approach offers numerous advantages, be aware of these limitations:

* The EKS Add-on integration doesn't support Helm hooks and Helm subcharts. Consequently, certain features that rely on these capabilities are unavailable, such as:

Expand All @@ -37,10 +35,10 @@ While the Splunk Distribution of the OpenTelemetry Collector Add-on for AWS EKS

* With the EKS Add-on, you can only deploy one instance of the Splunk Distribution of the OTel Collector per EKS cluster. Take into account this limitation when planning for scale and redundancy.

Install the AWS EKS Add-on
Install the EKS Add-on
=============================================================================================

To install the Splunk Distribution of the OpenTelemetry Collector Add-on for AWS EKS follow these steps:
To install the EKS Add-on "Splunk Distribution of the OpenTelemetry Collector" follow these steps:

* :ref:`addon-aws-eks-one`
* :ref:`addon-aws-eks-two`
Expand All @@ -50,13 +48,13 @@ To install the Splunk Distribution of the OpenTelemetry Collector Add-on for AWS

.. _addon-aws-eks-one:

Step 1: Subscribe to the AWS Marketplace Splunk Add-on
Step 1: Subscribe to the EKS Add-on in AWS Marketplace
------------------------------------------------------------

In your AWS Marketplace, ensure that:

* You have sufficient permissions in your AWS account to enable the Splunk Add-on.
* Complete the subscription process in the AWS console. Go to the :new-page:`AWS Marketplace Page <https://aws.amazon.com/marketplace/pp/prodview-sjdb4tw5uy47k>` to add the Splunk Distribution of the OpenTelemetry Collector Add-on to your AWS account.
* You have sufficient permissions in your AWS account to enable this Add-on.
* Complete the subscription process in the AWS console. Go to the :new-page:`AWS Marketplace Page <https://aws.amazon.com/marketplace/pp/prodview-sjdb4tw5uy47k>` to add the EKS add-on "Splunk Distribution of the OpenTelemetry Collector" to your AWS account.

.. _addon-aws-eks-two:

Expand Down Expand Up @@ -86,19 +84,19 @@ For ``splunkObservability``:

.. _addon-aws-eks-three:

Step 3: Add the Splunk Add-on to AWS EKS
Step 3: Add the Add-on to EKS clusters
------------------------------------------------------------

Follow the steps outlined in the AWS EKS User Guide to add an Add-on using ``eksctl``, the AWS Management Console, or the AWS CLI.
Follow the steps outlined in the Amazon EKS User Guide to add an Add-on using ``eksctl``, the AWS Management Console, or the AWS CLI.

Find the AWS EKS User guide at :new-page:`Managing Amazon EKS add-ons <https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on>`.
Find the Amazon EKS User guide at :new-page:`Managing Amazon EKS add-ons <https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on>`.

.. _addon-aws-eks-four:

Step 4: Configure the Splunk Observability Cloud Add-on
Step 4: Configure the Add-on
------------------------------------------------------------

To configure the Splunk Observability Cloud Add-on, prepare a YAML file tailored to your Splunk set-up, replacing placeholder values with your specific configuration details.
To configure the EKS Add-on "Splunk Distribution of the OTel Collector", prepare a YAML file tailored to your Splunk set-up, replacing placeholder values with your specific configuration details.

.. caution:: For security reasons, avoid including tokens or any sensitive data in the configuration file, as EKS Add-on configurations are exposed within the EKS web console.

Expand Down

0 comments on commit 9c1a41f

Please sign in to comment.