Module | Capistrano::Configuration::Roles |
In: |
lib/capistrano/configuration/roles.rb
|
Define a new role and its associated servers. You must specify at least one host for each role. Also, you can specify additional information (in the form of a Hash) which can be used to more uniquely specify the subset of servers specified by this specific role definition.
Usage:
role :db, "db1.example.com", "db2.example.com" role :db, "master.example.com", :primary => true role :app, "app1.example.com", "app2.example.com"
You can also encode the username and port number for each host in the server string, if needed:
role :web, "www@web1.example.com" role :file, "files.example.com:4144" role :db, "admin@db3.example.com:1234"
Lastly, username and port number may be passed as options, if that is preferred; note that the options apply to all servers defined in that call to "role":
role :web, "web2", "web3", :user => "www", :port => 2345
An alternative way to associate servers with roles. If you have a server that participates in multiple roles, this can be a DRYer way to describe the relationships. Pass the host definition as the first parameter, and the roles as the remaining parameters:
server "master.example.com", :web, :app