Merge pull request #2033 from splunk/urbiz-OD6291-helm-images

[6291]: Helm images

Author: aurbiztondo-splunk

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

@@ -11,7 +11,10 @@ Get started with the Collector for Kubernetes
    :maxdepth: 5
    :hidden:
 
-   Install the Collector for Kubernetes <install-k8s.rst>
+   Install with Helm <install-k8s.rst>
+   Helm components <kubernetes-helm-architecture>
+   Helm releases and images <kubernetes-helm-releases>      
+   Install with YAML manifests <install-k8s-manifests.rst>
    Kubernetes (EKS Add-on) <install-k8s-addon-eks.rst>
    Configure with Helm <kubernetes-config.rst>
    Advanced config <kubernetes-config-advanced.rst>
@@ -22,28 +25,65 @@ Get started with the Collector for Kubernetes
    Troubleshoot <troubleshoot-k8s.rst>
    Troubleshoot containers <troubleshoot-k8s-container.rst>
    Support <kubernetes-support.rst>
-   k8s-infrastructure-tutorial/about-k8s-tutorial
-   collector-configuration-tutorial-k8s/about-collector-config-tutorial.rst
+   Tutorial: Monitor your Kubernetes environment <k8s-infrastructure-tutorial/about-k8s-tutorial.rst>
+   Tutorial: Configure the Collector for Kubernetes <collector-configuration-tutorial-k8s/about-collector-config-tutorial.rst>
 
-To install and configure the Splunk Distribution of the OpenTelemetry Collector for Kubernetes, follow these docs:
+To install, configure and use the Splunk Distribution of the Collector for Kubernetes follow this documentation.
+
+.. raw:: html
+
+  <embed>
+    <h2>Install the Collector for Kubernetes<a name="k8s-install" class="headerlink" href="#k8s-install" title="Permalink to this headline">¶</a></h2>
+  </embed>
+
+To install the Splunk Distribution of the OpenTelemetry Collector for Kubernetes using the Helm chart, read and follow these docs:
 
 * :ref:`otel-install-k8s`
-* :ref:`install-k8s-addon-eks`
-* :ref:`otel-kubernetes-config`
-* By default, you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>` 
+* :ref:`kubernetes-helm-architecture`
+* :ref:`kubernetes-helm-releases`
+
+Optionally, you can also:
+
+* :ref:`otel-install-k8s-manifests`
+* :ref:`Deploy the Collector as an AWS EKS Add-on <install-k8s-addon-eks>`
+
+.. note:: By default, you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>`. 
+
+.. raw:: html
 
-For advanced configuration options, see:
+  <embed>
+    <h2>Configure the Collector for Kubernetes<a name="k8s-configure" class="headerlink" href="#k8s-configure" title="Permalink to this headline">¶</a></h2>
+  </embed>
 
+To configure the Collector, see:
+
+* :ref:`otel-kubernetes-config`
 * :ref:`otel-kubernetes-config-advanced`
 * :ref:`kubernetes-config-logs`
 * :ref:`discovery-mode-k8s`
 
+.. raw:: html
+
+  <embed>
+    <h2>Upgrade, uninstall and troubleshoot<a name="k8s-ts" class="headerlink" href="#k8s-ts" title="Permalink to this headline">¶</a></h2>
+  </embed>
+
 To upgrade or uninstall, see:
 
 * :ref:`otel-kubernetes-upgrade`
 * :ref:`otel-kubernetes-uninstall`
 
-.. note:: If you have any installation or configuration issues, refer to :ref:`otel-troubleshooting` and :ref:`troubleshoot-k8s`.
+If you have any installation or configuration issues, refer to: 
+
+* :ref:`otel-troubleshooting` 
+* :ref:`troubleshoot-k8s`
+* :ref:`kubernetes-support`
+
+.. raw:: html
+
+  <embed>
+    <h2>Tutorials<a name="k8s-tutorials" class="headerlink" href="#k8s-tutorials" title="Permalink to this headline">¶</a></h2>
+  </embed>
 
 For a walkthrough of common tasks related to the OpenTelemetry Collector for Kubernetes, see:
 

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

@@ -0,0 +1,89 @@
+.. _otel-install-k8s-manifests:
+.. _resource-yaml-manifests:
+
+********************************************************************
+Install the Collector for Kubernetes with YAML manifests
+********************************************************************
+
+.. meta::
+      :description: Describes how to install the Splunk Distribution of OpenTelemetry Collector for Kubernetes with YAML manifests.
+
+You can also install the Splunk Distribution of the OpenTelemetry Collector for Kubernetes using resource YAML manifests.
+
+.. note:: See also :ref:`otel-install-k8s`.
+
+Prerequisites
+==================================
+
+To specify the configuration, you need to know your Splunk realm and base64-encoded access token.
+
+A configuration file can contain multiple resource manifests. Each manifest applies a specific state to a Kubernetes object. You must configure your manifests for Splunk Observability Cloud only and come with all telemetry types activated for the agent, which is the default if you install using the Helm chart.
+
+Determine which manifest you want to use
+===============================================
+
+Download the necessary manifest files from :new-page:`the examples repository <https://github.com/signalfx/splunk-otel-collector-chart/tree/main/examples>`. Refer to the ``README`` files for more details on each example.
+
+Determine which :ref:`otel-deployment-mode` you want to use, agent or gateway. By default, host monitoring (agent) mode is configured to send data directly to Splunk SaaS endpoints. Host monitoring (agent) mode can be reconfigured to send to a gateway.
+
+Update the manifest
+==================================
+
+Once you've decided which manifest suits you better, make the following updates:
+
+#. In the secret.yaml manifest, update the ``splunk_observability_access_token`` data field with your base64-encoded access token.
+#. Update any configmap-agent.yaml, configmap-gateway.yaml, and configmap-cluster-receiver.yaml manifest files you use. Search for "CHANGEME" to find the values that must be updated to use the rendered manifests directly.
+      #. You need to update "CHANGEME" in exporter configurations to the value of the Splunk realm.
+      #. You need to update "CHANGEME" in attribute processor configurations to the value of the cluster name.
+
+Apply the manifest
+==================================
+
+After you've updated them, apply the manifests using ``kubectl``, as shown in the following examples.
+
+For host monitoring (agent) mode, download the :new-page:`agent-only manifest directory on GitHub <https://github.com/signalfx/splunk-otel-collector-chart/tree/main/examples/default/rendered_manifests>` for pre-rendered Kubernetes resource manifests that can be applied using the ``kubectl apply`` command after being updated with your token, realm information, and cluster name:
+
+.. code-block:: bash
+
+   kubectl apply -f <agent-manifest-directory> --recursive
+
+For data forwarding (gateway) mode, download the :new-page:`gateway-only manifest directory on GitHub <https://github.com/signalfx/splunk-otel-collector-chart/tree/main/examples/collector-gateway-only/rendered_manifests>` for pre-rendered Kubernetes resource manifests that can be applied using the ``kubectl apply`` command after being updated with your token, realm information, and cluster name:
+
+.. code-block:: bash
+
+   kubectl apply -f <gateway-manifest-directory> --recursive
+
+Use templates
+==================================
+
+You can create your own manifest YAML files with customized parameters using ``helm template`` command.
+
+.. code-block:: bash
+
+   helm template --namespace default --set cloudProvider='aws' --set distribution='openshift' --set splunkObservability.accessToken='KUwtoXXXXXXXX' --set clusterName='my-openshift-EKS-dev-cluster' --set splunkObservability.realm='us1' --set gateway.enabled='false' --output-dir <rendered_manifests_dir> --generate-name splunk-otel-collector-chart/splunk-otel-collector
+
+If you prefer, you can update the values.yaml file first.
+
+.. code-block:: bash
+
+   helm template --namespace default --values values.yaml --output-dir <rendered_manifests_dir> --generate-name splunk-otel-collector-chart/splunk-otel-collector
+
+Manifest files will be created in your specified folder ``<rendered_manifests_dir>``.
+
+Manifest examples
+==================================
+See the following manifest to set security constraints:
+
+.. github:: yaml
+   :url: https://raw.githubusercontent.com/signalfx/splunk-otel-collector-chart/main/examples/distribution-openshift/rendered_manifests/securityContextConstraints.yaml
+
+Next steps
+==================================
+
+After installing the Collector you can:
+
+* :ref:`otel-kubernetes-config`
+* :ref:`otel-kubernetes-config-advanced`
+* :ref:`otel-kubernetes-config-logs`
+* :ref:`troubleshoot-k8s`
+* :ref:`apm`