right_agent

"master" branch: {}[https://travis-ci.org/rightscale/right_agent]

= RightAgent

= DESCRIPTION

== Synopsis

RightAgent provides a foundation for running an agent on a server to interface in a secure fashion with other agents in the RightScale system using RightNet, which operates in either HTTP or AMQP mode. When using HTTP, RightAgent makes requests to RightApi servers and receives requests using long-polling or WebSockets via the RightNet router. To respond to requests it posts to the HTTP router. When using AMQP, RightAgent uses RabbitMQ as the message bus and the RightNet router as the routing node to make requests; to receives requests routed to it by the RightNet router, it establishes a queue on startup. The packets are structured to invoke services in the agent represented by actors and methods. The RightAgent may respond to these requests with a result packet that the router then routes to the originator.

Refer to the wiki (https://github.com/rightscale/right_agent/wikis) for up-to-date documentation.

Also use the built-in issues tracker (https://github.com/rightscale/right_agent/issues) to report issues.

Maintained by the RightScale Cornsilk Team

== Interface

A RightAgent exposes its services via actors and methods that are invoked by requests packets it receives via its message queue. All RightAgents have a general purpose actor named agent_manager that provides the following services:

• agent_manager/ping: Respond with basic status information to indicate that active
• agent_manager/stats: Retrieve statistics about agent operation
• agent_manager/set_log_level: Change log level of agent
• agent_manager/execute: Eval code in context of agent
• agent_manager/connect: Connect agent to additional broker or reconnect it to one
• agent_manager/disconnect: Disconnect agent from broker

RightAgent comes with several library modules for forming basic command line tools:

• agent_deployer: Build a configuration file for running the agent (rad tool)
• agent_controller: Manage an agent that has been configured (rnac tool)
• stats_manager: Display operation statistics for an agent (rstat tool)
• log_level_manager: Retrieve and set log level for an agent (rlog tool)

== Supported Configuration

RightAgent has been tested on EC2 instances running CentOS 5.2 and Ubuntu 8.10.

== Work in Progress

RightAgent is work in progress, expect more documentation and examples in the near future.

Owned by the RightScale Cornsilk team.

= ADDITIONAL RESOURCES

• [1] RabbitMQ is http://www.rabbitmq.com/documentation.html

= LICENSE

RightAgent

Copyright:: Copyright (c) 2011 RightScale, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.