Class Rye::Set
In: lib/rye/set.rb
Parent: Object

Methods

[]   add_box   add_boxes   add_key   add_keys   cd   empty?   inspect   keys   method_missing   new   opts   remove_key   remove_keys   root?   setenv   setenvironment_variable   to_s   user  

Attributes

boxes  [R] 
name  [R] 
opts  [R] 
parallel  [RW]  Run commands in parallel? A Boolean value. Default: false.

Public Class methods

  • name The name of the set of machines
  • opts a hash of optional arguments

The opts hash is used as defaults for all for all Rye::Box objects. All args supported by Rye::Box are available here with the addition of:

  • :parallel => run the commands in parallel? true or false (default).

Public Instance methods

  • boxes one or more boxes. Rye::Box objects will be added directly

to the set. Hostnames will be used to create new instances of Rye::Box and those will be added to the list.

add_boxes(*boxes)

Alias for add_box

add_key(*additional_keys)

Alias for add_keys

Add one or more private keys to each box. Also stores key paths in the set so when new boxes are added they will get the same keys,

  • additional_keys is a list of file paths to private keys

Returns the instance of Rye::Set

alias :cd :’[]’ # fix for jruby

Are there any boxes in this set?

Catches calls to Rye::Box commands. If meth is the name of an instance method defined in Rye::Cmd then we call it against all the boxes in +@boxes+. Otherwise this method raises a Rye::CommandNotFound exception. It will also raise a Rye::NoBoxes exception if this set has no boxes defined.

Returns a Rye::Rap object containing the responses from each Rye::Box.

remove_key(*keys)

Alias for remove_keys

Add an environment variable. n and v are the name and value. Returns the instance of Rye::Set

setenvironment_variable(n, v)

Alias for setenv

[Validate]