teagent Cookbook

This cookbook installs and configures the ThousandEyes Enterprise Agent.

Platform

• Ubuntu 14.04(trusty) and 16.04 (xenial)
• CentOS 6.3
• Red Hat 6.3

Requirements

Debian/Ubuntu Linux distributions require the lsb-release package which
will be installed if missing.

Attributes

Key	Type	Description	Default
['teagent']['browserbot']	Boolean	Enable Browserbot	false
['teagent']['international_langs']	Boolean	install the international language support package	false
['teagent']['account_token']	String	Account token for the agent	sample value (equals a disabled agent)
['teagent']['log_path']	String	Agent log path	''
['teagent']['proxy_host']	String	Proxy hostname	''
['teagent']['proxy_port']	String	Proxy port	'0'
['teagent']['ip_version']	String	Ip version for the agent to run with ('ipv4' or 'ipv6')	'ipv4'

Usage

teagent::default

Just include teagent in your node's run_list: Don't forget to set the attributes based on your use case.

• Default settings

{
    "teagent": {
        "account_token": "your_account_token_goes_here"
    },
    "run_list": ["recipe[teagent]" ]
}

• Enable browserbot

{
    "teagent": {
        "browserbot": true,
        "account_token": "your_account_token_goes_here"
    },
    "run_list": ["recipe[teagent]" ]
}  

• Enable browserbot and install the international language packages

{
    "teagent": {
        "browserbot": true,
        "international_langs": true,
        "account_token": "your_account_token_goes_here"
    },
    "run_list": ["recipe[teagent]" ]
}

• Set the log path location

{
    "teagent": {
        "account_token": "your_account_token_goes_here",
        "log_path": "/var/log"
    },
    "run_list": ["recipe[teagent]" ]
}

• Set the proxy (http proxy, no auth)

{
    "teagent": {
        "account_token": "your_account_token_goes_here",
        "proxy_host": "proxy.example.com",
        "proxy_port": "8080"
    },
    "run_list": ["recipe[teagent]" ]
}

• Set the ThousandEyes Enterprise Agent to run with an IPv6 address

{
    "teagent": {
        "account_token": "your_account_token_goes_here",
        "ip_version": "ipv6"
    },
    "run_list": ["recipe[teagent]" ]
}

Alternatively Include the teagent recipe to install the ThousandEyes Enterprise Agent. The only recipe you need to include is the default one.

• include_recipe 'teagent'

Example

Steps to run the chef Enterprise Agent:

1. Clone the repository.
2. Rename the folder to teagent.
3. Create a json file with a valid token as explained in the Usage section.
4. Optional: Create a configuration file solo.rb with the cookbook path, like this:

    cookbook_path [ 'path_to_cookbook',
                   ] ```
   

5. One way of executing the cookbook is using chef solo by issuing this command chef-solo -j path_to_file.json -c path_to_solo.rb .
6. Agents will start running and will show up in the ThousandEyes Enterprise Agent list.

License and Authors

License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses/.

Contact

If you have questions or comments, please send them to
[email protected], or to the following address:

ThousandEyes, Inc.
301 Howard Street #1320
San Francisco, CA 94105
Attn: ThousandEyes Open Source Projects