Install OneAgent using Puppet

Dynatrace provides a Puppet module that you can use to orchestrate OneAgent deployment in your environment.

Requirements

Dependencies

Download OneAgent Puppet module

Install the OneAgent Puppet

Configure OneAgent Puppet module

The OneAgent Puppet module requires access to the appropriate OneAgent installer files.

Option 1: Use direct download from Dynatrace environment

The module utilizes the Dynatrace Deployment API to download the platform-specific installers to the Puppet agent nodes. You will need to specify the variables to supply the information required to authenticate the API call in your environment:

For more examples, see Examples.

Option 2: Use local installers

Use the Dynatrace web UI to download the required OneAgent installer files and then upload them to the appropriate mounting point on the server node. The Puppet module will then download the installers from the Puppet server to the Puppet agent nodes.

Use the local_installer variable to supply the module with the path of the installer within the specified mounting point. This requires a configured file server on the server node.

For example:

class { 'oneagent':
     # Set environment variables
     local_installer => mounting_point/path/of/oneagent-linux-installer.sh
     # (...)
   }

Note that Windows, Linux, and AIX require their dedicated installers. The original installer names, as downloaded from Dynatrace, include target platform designations. If you change the installer names, make sure the module can distinguish them.
If you don't specify a local installer, the module will attempt to use the direct download method to download the installers from the Dynatrace environment.

Variables

The OneAgent Puppet module supports the following variables:

Logging

By default, Puppet logs messages to syslog (for Linux-based hosts) or to Event Log (for Windows-based hosts). However, Puppet can be configured to store deployment-specific logs in designated files.

(...)
    <appender name="F1" class="ch.qos.logback.core.FileAppender">
        <file>/new/log/location</file>
(...)

For more details, see logback config.

(...)
logdest=absolute_path_of_log_location.log
(...)

The location of the configuration file varies with the operating system:

For more details, see configuring UNIX agent and configuring Windows agent.

Examples

This example manifest:

# Download OneAgent installer in specific version to a custom 
# directory with additional OneAgent install parameters

$env_url = 'https://abc12345.live.dynatrace.com'
$paas_token = 'abcdefghijk1234567890'
$install_args = [ '--set-host-group=My.HostGroup_123-456', '--set-network-zone=my.network.zone' ]
$preserve_installer = true
$version = '1.219.0.20210422-111723'

if $::osfamily == 'Windows' {
  class { 'oneagent':
    environment_url => $env_url,
    paas_token => $paas_token,
    preserve_installer => $preserve_installer,
    install_args => $install_args,
    platform_install_args => [ 'INSTALL_PATH=C:\\dynatrace', 'USER=LocalService' ],
    download_dir => 'C:\\temp',
    version => $version
  }
} else {
  class { 'oneagent':
    environment_url => $env_url,
    paas_token => $paas_token,
    preserve_installer => $preserve_installer,
    install_args => $install_args,
    platform_install_args => [ 'INSTALL_PATH=/opt/dynatrace', 'USER=linux_user' ],
    download_dir => '/tmp',
    version => $version,
    installer_arch => 'ppcle'
  }
}

You can find more example manifests in the examples directory. The directory contains the following manifests:

For path issues when installing on Windows, review Path Formatting for Windows in Puppet documentation.