UAMS Client Cookbook

The uamsclient cookbook is used to deploy and configure the UAMS Client (SolarWinds Observability agent).

Setup

The uamsclient cookbook is compatible with Chef >= 16.0. It might work on older versions, but it's not guaranteed.

Installation

Chef Supermarket

This cookbook is available in Chef Supermarket -> direct link and is available for any common Chef usage pattern.

Manual installation/configuration for private/managed Chef server

1. Clone the repository.
2. Set the required attributes (attributes/default.rb / role / environment / use wrapper cookbook).
3. Upload the cookbook(s) to the Chef server: knife cookbook upload ...
4. Add the uamsclient::uamsclient recipe (or/and wrapper recipe) to the run_list.
5. Run chef-client on the node (or wait for scheduled execution).

Managed Locally Agents

The variable ['uamsclient']['uams_managed_locally'] is used to set the Agent as managed locally by a configuration file. It is designed to allow configuration of the UAMS Agent locally, without the necessity of adding integrations manually from the SWO page.

If the UAMS Agent is installed as a managed locally agent, it will wait for the local configuration file to be accessible. The default local configuration locations are:
- Linux - /opt/solarwinds/uamsclient/var/local_config.yaml
- Windows - C:\ProgramData\SolarWinds\UAMSClient\local_config.yaml

Chef will automatically copy the file to the needed location.
The default template of the local config file is located at templates/default/local_config.yaml.erb.
You can specify a template for each host using paths for each host as described in the Chef documentation.

An additional optional configuration file credentials_config.yaml can be used to define credentials providers. This file can be used in conjunction with local_config.yaml to retrieve a credential from a defined credential provider.

The default template of the credentials configuration file is located at templates/default/credentials_config.yaml.erb.

Chef will automatically copy both files (credentials_config.yaml and local_config.yaml) to the needed location.

You can use Chef template syntax to fill the templates with appropriate variables.
To assign values to variables in the template, you can fill the attribute file and dictionary ['uamsclient']['local_config'] and ['uamsclient']['credentials_config'] as in the example below.
```

Template variables for local config

default['uamsclient']['local_config']['mysql_host'] = 'mysql_test'
default['uamsclient']['local_config']['user'] = 'user_test'

Template variables for credentials config

default['uamsclient']['credentials_config']['aws_access_key_id'] = 'your_access_key_id'
default['uamsclient']['credentials_config']['aws_secret_access_key'] = 'your_secret_access_key'
```
To learn more about building the appropriate local config and credentials config, check out the SolarWinds Observability documentation. You can find information about deploying different plugins, integrations, and supported credential providers.

Attributes

Remember that the uams_https_proxy attribute sets the HTTPS proxy only for the connections established by the UAMS Client and its plugins. To use an HTTPS proxy during installation, set up the HTTPS proxy on your machine so that Chef will be able to use it.