Merge pull request #1638 from splunk/urbiz-OD5041-collector-update

[5041]: Collector uninstall docs

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

@@ -17,6 +17,7 @@ Get started with the Collector for Kubernetes
    kubernetes-config-advanced.rst
    kubernetes-config-logs.rst
    Default Kubernetes metrics <metrics-ootb-k8s.rst>
+   kubernetes-uninstall.rst
 
 To install and configure the Splunk Distribution of OpenTelemetry Collector for Kubernetes, follow these docs:
 
@@ -30,11 +31,13 @@ For advanced configuration options, see:
 * :ref:`otel-kubernetes-config-advanced`
 * :ref:`kubernetes-config-logs`
 
+To uninstall the Collector, refer to :ref:`otel-kubernetes-uninstall`.
+
 .. note::
 
    If you have any installation or configuration issues, refer to :ref:`otel-troubleshooting`.
 
-   To update or uninstall the Collector, see :ref:`otel-upgrade` and :ref:`otel-uninstall-integration`.
+   To update the Collector, see :ref:`otel-upgrade`.
 
 
 

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

@@ -0,0 +1,25 @@
+.. _otel-uninstall-integration:
+.. _otel-kubernetes-uninstall:
+
+********************************************
+Uninstall the Collector for Kubernetes
+********************************************
+
+.. meta::
+      :description: Describes how to uninstall the Splunk Distribution of OpenTelemetry Collector for Kubernetes.
+
+To uninstall the Collector for Kubernetes, run the ``helm uninstall`` command. 
+
+Running this command:
+
+* Removes all Kubernetes components associated with the chart.
+* Deletes the release.
+* Removes the release history.
+
+For example, to uninstall ``my-splunk-otel-collector``, run:
+
+.. code-block:: bash
+
+   helm uninstall my-splunk-otel-collector
+
+

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

@@ -15,16 +15,18 @@ Get started with the Collector for Linux
    Install the Collector for Linux (manual) <install-linux-manual.rst>    
    linux-config.rst
    linux-config-ootb.rst
+   linux-uninstall.rst
 
 To install and configure the Splunk Distribution of OpenTelemetry Collector for Linux, follow these docs:
 
 * :ref:`otel-install-linux`
 * :ref:`otel-install-linux-manual`
 * :ref:`linux-config-ootb`
 * :ref:`otel-linux-config`
+* :ref:`otel-linux-uninstall`
 
 .. note::
 
    If you have any installation or configuration issues, refer to :ref:`otel-troubleshooting`.
 
-   To update or uninstall the Collector, see :ref:`otel-upgrade` and :ref:`otel-uninstall-integration`.
+   To update the Collector, see :ref:`otel-upgrade`.

gdi/opentelemetry/uninstall-the-collector.rst → gdi/opentelemetry/collector-linux/linux-uninstall.rst

@@ -1,45 +1,22 @@
-.. _otel-uninstall-integration:
+.. _otel-linux-uninstall:
 
 ********************************************
-Uninstall the Collector
+Uninstall the Collector for Linux
 ********************************************
 
 .. meta::
-      :description: Describes how to uninstall the Splunk Distribution of OpenTelemetry Collector.
+      :description: Describes how to uninstall the Splunk Distribution of OpenTelemetry Collector for Linux.
 
-Use the platform-specific information provided in this topic if you need to uninstall the Collector.
+Follow these instructions to uninstall the Splunk Distribution of the OpenTelemetry Collector for Linux.
 
-.. _otel-kubernetes-uninstall:
-
-Uninstall on Kubernetes
-==========================
-
-Run the ``helm uninstall`` command to uninstall the Collector for Kubernetes. For example, to uninstall ``my-splunk-otel-collector``, run this command:
-
-.. code-block:: bash
-
-   helm uninstall my-splunk-otel-collector
-
-Running this command does the following things:
-
-* Removes all Kubernetes components associated with the chart
-* Deletes the release
-* Removes the release history
-
-.. _otel-linux-uninstall-otel-and-tdagent:
-
-Uninstall on Linux
-================================================================
-
-This section covers commands you can use to uninstall the Collector and Fluentd packages if you used the :ref:`installer script<linux-scripts>` or :ref:`Debian or RPM package <linux-packages>` to perform the installation.
-
-If you installed the Collector and Fluentd using other methods; such as Ansible, Puppet, and Heroku as described in :ref:`otel-install-linux`; follow uninstall instructions specific to the tool you used.
+You can use commands to uninstall the Collector and Fluentd packages if you used the :ref:`installer script<linux-scripts>` or :ref:`Debian or RPM package <linux-packages>` to perform the installation.
 
+If you installed the Collector and Fluentd using other methods (such as Ansible, Puppet, and Heroku as described in :ref:`otel-install-linux`), follow uninstall instructions specific to the tool you used.
 
 .. _otel-linux-uninstall-details:
 
 Understand which files are deleted by the uninstall
-----------------------------------------------------------------
+================================================================
 
 The uninstall commands covered here don't delete all of the files installed and created by the installer. Likewise, the uninstall commands don't delete all of the files generated by the Collector and Fluent services as they ran after installation. Typically, it's safe to just keep the files that aren't deleted by the uninstall.
 
@@ -103,11 +80,11 @@ While not an exhaustive list, here are key notes about some of the files that ar
 
 * For information about some of the other files that can't be removed by the uninstall commands, see messages in your command-line interface after you run an uninstall command.
 
-
+.. _otel-linux-uninstall-otel-and-tdagent:
 .. _otel-linux-uninstall-both-otel-and-tdagent:
 
 Uninstall the Collector and Fluentd on Linux
--------------------------------------------------------------------------
+================================================================
 
 .. note:: Before you perform the uninstall, be sure to understand its impact. See :ref:`otel-linux-uninstall-details`.
 
@@ -128,19 +105,17 @@ To verify the uninstall, see :ref:`otel-linux-verify-uninstall`.
 
 If you don't want to uninstall :strong:`both` packages and just want to uninstall the Collector package :strong:`or` Fluentd package, see :ref:`otel-linux-uninstall-only-otel-or-tdagent`.
 
-
 .. _otel-linux-uninstall-only-otel-or-tdagent:
 
 Uninstall only the Collector or Fluentd on Linux
---------------------------------------------------------------------
+================================================================
 
 The uninstall command described in :ref:`otel-linux-uninstall-otel-and-tdagent` uninstalls :strong:`both` the Collector and Fluentd packages.
 
 If you want to uninstall only the Collector package :strong:`or` the Fluentd package, use the following command for your platform.
 
-
 For Debian
-^^^^^^^^^^^^^^^
+--------------------------------------------------------------------------------------------
 
 .. note:: Before performing an uninstall, see :ref:`otel-linux-uninstall-details`.
 
@@ -156,9 +131,8 @@ For Debian
 
      sudo apt-get purge td-agent
 
-
 For RPM
-^^^^^^^^^^^^^^^
+--------------------------------------------------------------------------------------------
 
 .. note:: Before performing an uninstall, see :ref:`otel-linux-uninstall-details`.
 
@@ -200,11 +174,10 @@ For RPM
 
 To verify the uninstall, see :ref:`otel-linux-verify-uninstall`.
 
-
 .. _otel-linux-verify-uninstall:
 
 Verify the uninstall of the Collector and Fluentd on Linux
---------------------------------------------------------------------------------------------
+================================================================
 
 While you can verify the uninstall of the Collector and Fluentd packages by watching for success messages in your command-line interface after running an uninstall command, you can also verify the uninstall by running a command that checks on the status of the Collector and Fluentd services. If the package has been successfully uninstalled, the status reflects this.
 
@@ -224,27 +197,6 @@ While you can verify the uninstall of the Collector and Fluentd packages by watc
 
   The expected result is ``Unit td-agent.service could not be found.``
 
-.. _otel-windows-uninstall:
-
-Uninstall on Windows
-=======================
-
-.. _otel-windows-uninstall-panel:
-
-Uninstall using the Windows Control Panel
---------------------------------------------------------------------------------------------
-
-If installed with the installer script, the Collector and td-agent (Fluentd) can be uninstalled from **Programs and Features** in the Windows Control Panel. The configuration files might persist in ``\ProgramData\Splunk\OpenTelemetry Collector`` and ``\opt\td-agent`` after uninstall.
-
-.. _otel-windows-uninstall-powershell:
-
-Uninstall using PowerShell
---------------------------------------------------------------------------------------------
 
-You can also uninstall the Collector for Windows using PowerShell:
 
-.. code-block:: PowerShell
 
-   $MyProgram = Get-ItemProperty HKLM:\Software\Microsoft\Windows\CurrentVersion\uninstall\* | Where { $_.DisplayName -eq "Splunk OpenTelemetry Collector" }
-   
-   cmd /c $MyProgram.UninstallString

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

@@ -15,16 +15,18 @@ Get started with the Collector for Windows
    Install the Collector for Windows (manual) <install-windows-manual.rst>    
    windows-config.rst
    windows-config-ootb.rst
+   windows-uninstall.rst
 
 To install and configure the Splunk Distribution of OpenTelemetry Collector for Windows, follow these docs:
 
 * :ref:`otel-install-windows`
 * :ref:`otel-install-windows-manual`
 * :ref:`windows-config-ootb`
 * :ref:`otel-windows-config`
+* :ref:`otel-windows-uninstall`
 
 .. note::
 
    If you have any installation or configuration issues, refer to :ref:`otel-troubleshooting`.
 
-   To update or uninstall the Collector, see :ref:`otel-upgrade` and :ref:`otel-uninstall-integration`.
+   To update the Collector, see :ref:`otel-upgrade`.

gdi/opentelemetry/collector-windows/windows-uninstall.rst

@@ -0,0 +1,30 @@
+.. _otel-windows-uninstall:
+
+********************************************
+Uninstall the Collector for Windows
+********************************************
+
+.. meta::
+      :description: Describes how to uninstall the Splunk Distribution of OpenTelemetry Collector for Windows.
+
+Follow these instructions to uninstall the Splunk Distribution of the OpenTelemetry Collector for Windows.
+
+.. _otel-windows-uninstall-panel:
+
+Uninstall using the Windows Control Panel
+====================================================
+
+If you installed the Collector with the installer script, the Collector and td-agent (Fluentd) can be uninstalled from **Programs and Features** in the Windows Control Panel. The configuration files might persist in ``\ProgramData\Splunk\OpenTelemetry Collector`` and ``\opt\td-agent`` after uninstall.
+
+.. _otel-windows-uninstall-powershell:
+
+Uninstall using PowerShell
+====================================================
+
+You can also uninstall the Collector for Windows using PowerShell:
+
+.. code-block:: PowerShell
+
+   $MyProgram = Get-ItemProperty HKLM:\Software\Microsoft\Windows\CurrentVersion\uninstall\* | Where { $_.DisplayName -eq "Splunk OpenTelemetry Collector" }
+   
+   cmd /c $MyProgram.UninstallString

gdi/opentelemetry/install-the-collector.rst

@@ -23,7 +23,6 @@ Get started: Understand and use the Collector
     environment-variables.rst
     Internal metrics <metrics-internal-collector.rst>    
     otel-upgrade.rst
-    uninstall-the-collector.rst
 
 For a quick overview of the Collector, see :ref:`otel-intro`.