Documentation forSolarWinds Observability SaaS

Deploy Agent in locally managed mode

Setting up the locally managed mode requires installing the agent in a specific mode by adding parameters. The parameters depend on the operating system and installation type used.

Changing an Agent back from locally managed requires removing it from SolarWinds Observability SaaS and reinstalling it.

An Agent installed as locally managed waits until the local configuration file (local_config.yaml) is accessible.

Create the local_config.yaml file in one of the following relevant locations:

  • Linux: /opt/solarwinds/uamsclient/var/local_config.yaml
  • Windows: C:\ProgramData\SolarWinds\UAMSClient\local_config.yaml
  • Docker: Path defined in the variable UAMS_LOCAL_CONFIGURATION_FILE_PATH

Linux

Add the UAMS_MANAGED_LOCALLY=true environmental variable when using the installation script or an installation package (for example deb or rpm).

Script installation

env UAMS_ACCESS_TOKEN="<SWO_Ingestion_Access_Token>" UAMS_MANAGED_LOCALLY="true" SWO_URL="xx-xx.cloud.solarwinds.com" bash -c "$(curl -sSL https://agent-binaries.cloud.solarwinds.com/uams/latest/uamsclient_install.sh)"

Package installation

  1. Download the package that matches your system's package manager.

    RPM: https://agent-binaries.cloud.solarwinds.com/uams/latest/uamsclient.rpm

    DEB: https://agent-binaries.cloud.solarwinds.com/uams/latest/uamsclient.deb

  2. Select the tab that matches your package / package manager. Install the package using the command for your package / package manager.

    • Replace YourApiToken in UAMS_ACCESS_TOKEN with the ingestion token you prepared earlier.
    • Replace YourSwoBaseUrl in SWO_URL with the base URL for your organization's endpoints. The base URL is in the form of xx-yy.cloud.solarwinds.com, where xx-yy represents the data center your organization uses. See Find the data center and endpoints for your organization.
    RPM / RPM
    env UAMS_ACCESS_TOKEN="YourApiToken" UAMS_MANAGED_LOCALLY="true" SWO_URL="YourSwoBaseUrl" rpm -i uamsclient.rpm
    RPM / YUM
    env UAMS_ACCESS_TOKEN="YourApiToken" UAMS_MANAGED_LOCALLY="true" SWO_URL="YourSwoBaseUrl" yum localinstall -y uamsclient.rpm
    RPM / DNF
    env UAMS_ACCESS_TOKEN="YourApiToken" UAMS_MANAGED_LOCALLY="true" SWO_URL="YourSwoBaseUrl" dnf install -y uamsclient.rpm
    RPM / ZYPPER
    env UAMS_ACCESS_TOKEN="YourApiToken" UAMS_MANAGED_LOCALLY="true" SWO_URL="YourSwoBaseUrl" zypper install uamsclient.rpm
    DEB / DPKG
    env UAMS_ACCESS_TOKEN="YourApiToken" UAMS_MANAGED_LOCALLY="true" SWO_URL="YourSwoBaseUrl" dpkg -i uamsclient.deb

For ARM versions or legacy OSs (CentOS 6/RedHat 6), refer to the host onboarding flow in SolarWinds Observability SaaS.

For installation parameters, see SolarWinds Observability Agent installation parameters

Windows

Add the MANAGED_LOCALLY=true argument when using the installation script or the MSI installer.

Script installation

[Net.ServicePointManager]::SecurityProtocol = "Tls11, Tls12"; irm https://agent-binaries.cloud.solarwinds.com/uams/latest/uamsclient_install.ps1 | iex; install -AccessToken "<SWO_Ingestion_Access_Token>" -ManagedLocally "true" -SwoUrl "xx-xx.cloud.solarwinds.com"

Package installation

msiexec /i uamsclient.msi ACCESSTOKEN="<SWO_Ingestion_Access_Token>" MANAGED_LOCALLY="true" SWO_URL="xx-xx.cloud.solarwinds.com"

For installation parameters, see SolarWinds Observability Agent installation parameters

Docker

Add the UAMS_CREDENTIALS_CONFIGURATION_FILE_PATH=<credentials config path> environmental variable when starting a Docker container. This variable should point to a credentials configuration file, which should be attached to the Docker container using a Docker volume.

Add the UAMS_LOCAL_CONFIGURATION_FILE_PATH=<local config path> environmental variable when starting a Docker container. This variable should point to a local configuration file, which should be attached to the Docker container using a Docker volume.

docker run \
  -e UAMS_CLIENT_ID_OVERRIDE="<your uams client id override>" \
  -e UAMS_ACCESS_TOKEN="<your access token>" \
  -e SWO_URL="<xx-yy.cloud.solarwinds.com>" \
  -e UAMS_MANAGED_LOCALLY="true" \
  -e UAMS_LOCAL_CONFIGURATION_FILE_PATH="/etc/local_config.yaml" \
  -e UAMS_CREDENTIALS_CONFIGURATION_FILE_PATH="/etc/credentials_config.yaml" \
  -v ${PWD}/local_config.yaml:/etc/local_config.yaml \
  -v ${PWD}/credentials_config.yaml:/etc/credentials_config.yaml \
  solarwinds/swo-agent:latest

Automation tools

For automation tools such as Ansible, Chef, Puppet, and SaltStack, refer to the following links: