Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
RightLink: server agent for RightScale
Ruby C# Other
tag: v5.8.9

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
actors
bin
init
lib
scripts
spec
.gitignore
CHANGELOG.rdoc
Gemfile
Gemfile.lock
INSTALL.rdoc
LICENSE
README.rdoc
Rakefile
right_link.gemspec
right_link.rconf

README.rdoc

RightLink

DESCRIPTION

Synopsis

RightLink automates servers configuration and monitoring. It uses RabbitMQ as message bus and relies on Chef[2] for configuring. RightLink uses RightPopen[3] to monitor the stdout and stderr streams of scripted processes. Servers running the RightLink agent configures themselves on startup an register with the mapper so that operational recipes and scripts can be run at a later time.

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

Use the built-in issues tracker (github.com/rightscale/right_link/issues) to report issues.

Interface

The RightLink agent exposes actors and methods used to schedule the execution of Chef recipes and RightScripts (shell scripts) and perform other server management operations. You can find these actors in the 'actors' subdirectory of RightLink.

RightLink retrieves executable bundles containing all the information required to run the Chef recipe or RightScript from other agents. An executable bundle consists of a sequence of Chef recipes and/or RightScripts together with any required data (Chef attributes, RightScript parameters, packages etc.). The exact definition can be found in RightAgent[3].

Some of the other agent operations that RightLink relies on:

  • booter actor:

    • booter/declare: Set the RightLink version number

    • booter/get_repositories: Retrieve the repositories bundle used to configure the server

    • booter/get_boot_bundle: Retrieve the boot execution bundle

    • booter/get_decommission_bundle: Retrieve the decommission execution bundle

  • auditor actor:

    • auditor/create_new_section: Create a new audit section

    • auditor/update_status: Update the current audit summary

    • auditor/append_info: Append information text to the audit

    • auditor/append_error: Append error message to the audit

    • auditor/append_output: Append script output to the audit

    • auditor/append_raw_output: Same as above, but don't append newline character

  • forwarder actor:

    • forwarder/schedule_recipe: Request a Chef recipe to be scheduled on this instance

    • forwarder/schedule_right_script: Request a RightScript to be scheduled on this instance

  • state recorder actor:

    • state_recorder/record: Record instance state transitions (e.g. boot->operational)

Upon startup the instance agent will first request the boot execution bundle and run it. If the execution is successful it will then tell the state recorder actor to transition to the operational state. At that point the agent is ready to receive requests.

RightLink comes with two command line tools rs_run_recipe and rs_run_right_script which allow triggering the execution of operational Chef recipes or RighScript respecively from within the instance itself. These two command line tools tell the RightLink agent to send a forwarder/schedule_recipe or forwarder/schedule_right_script request to the agents that provide these operations. These agents should in turn call the instance_scheduler/schedule_bundle operation of the RightLink agent with the right execution bundle.

INSTALLATION

See INSTALL.rdoc for more information

ADDITIONAL RESOURCES

LICENSE

RightLink

Copyright

Copyright © 2009-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.

Something went wrong with that request. Please try again.