Skip to content

Commit

Permalink
Merge pull request #1566 from splunk/theletterf-add-translatesfx-depr…
Browse files Browse the repository at this point in the history
…ecation-note

Add deprecation note to translatesfx docs
  • Loading branch information
aurbiztondo-splunk authored Dec 12, 2023
2 parents 1d95b26 + c4da02e commit e7c2cfb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
12 changes: 6 additions & 6 deletions gdi/opentelemetry/smart-agent-migration-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Migration process from the Smart Agent to the Splunk Distribution of the OpenTel
Do the following steps to migrate from the Smart Agent to the Collector:

#. :ref:`Deploy the Collector in a non-production environment <deploy-the-collector-non-prod-env>`
#. :ref:`Validate the deployment of the Collector <validate-deployment-of-collector>`
#. :ref:`Validate the deployment of the Collector <validate-deployment-of-collector>`
#. :ref:`Locate your existing Smart Agent configuration file <locate-sa-config-file>`
#. :ref:`Translate the Smart Agent configuration file using translatesfx <use-translatefx>`
#. :ref:`Estimate resource utilization (sizing) for the production environment <estimate-sizing>`
#. :ref:`Deploy the Collector to the non-production environment using the updated configuration file <deploy-non-prod-updated-config>`
#. :ref:`Deploy the Collector to a production host using the updated configuration file <deploy-to-prod-updated-config>`
#. :ref:`Translate the Smart Agent configuration file using translatesfx <use-translatefx>`
#. :ref:`Estimate resource utilization (sizing) for the production environment <estimate-sizing>`
#. :ref:`Deploy the Collector to the non-production environment using the updated configuration file <deploy-non-prod-updated-config>`
#. :ref:`Deploy the Collector to a production host using the updated configuration file <deploy-to-prod-updated-config>`

.. _deploy-the-collector-non-prod-env:

Expand All @@ -27,7 +27,7 @@ Do the following steps to migrate from the Smart Agent to the Collector:

Deploy the Collector in a non-production environment, for example, a development host or VM or a Kubernetes cluster in staging. The environment needs to be a copy or identical to your production environment.

Navigate to your instance of Splunk Observability Cloud and select :menuselection:`Data Management` in the navigation bar. Choose the platform you would like to deploy the Collector to.
Navigate to your instance of Splunk Observability Cloud and select :menuselection:`Data Management` in the navigation bar. Choose the platform you want to deploy the Collector to.

.. image:: /_images/gdi/3886-choose-your-platform.png
:width: 99%
Expand Down
8 changes: 5 additions & 3 deletions gdi/opentelemetry/translation-tool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ Configuration translation rules and tool
.. meta::
:description: Use this tool to convert a SignalFX Smart Agent YAML configuration file into the Splunk Distribution of OpenTelemetry Collector YAML configuration file.

``translatesfx`` is a command-line tool provided by Splunk Observability Cloud that helps you translate your existing Smart Agent YAML configuration file into a configuration that can be used by the Collector.
.. note:: The SignalFx Smart Agent and its ``translatesfx`` tool are deprecated.

Note that this only affects the agent and the translation tool; Smart Agent receivers bundled in the Splunk Distribution of OpenTelemetry Collector are available and supported. See more at :ref:`migrate-from-sa-to-otel`.

.. caution::
``translatesfx`` is a command-line tool provided by Splunk Observability Cloud that helps you translate your existing Smart Agent YAML configuration file into a configuration that can be used by the Collector.

With ``translatesfx`` you can automate most of the configuration changes when migrating from the Smart Agent to the Splunk OpenTelemetry Collector. Evaluate and test any configuration produced by ``translatesfx`` carefully before releasing it into production environments.
With ``translatesfx`` you can automate most of the configuration changes when migrating from the Smart Agent to the Splunk OpenTelemetry Collector. Evaluate and test any configuration produced by ``translatesfx`` carefully before releasing it into production environments.

Configuration translation rules
==========================================================================
Expand Down

0 comments on commit e7c2cfb

Please sign in to comment.