README.md in vagrant-orchestrate-0.6.0 vs README.md in vagrant-orchestrate-0.6.1.patch

- old
+ new

@@ -4,21 +4,22 @@ # Vagrant Orchestrate ![](http://i.imgur.com/71yAw5v.gif) This is a Vagrant 1.6+ plugin that allows orchestrated deployments -to already provisioned (non-elastic) servers on top of the excellent [vagrant-managed-servers](http://github.com/tknerr/vagrant-managed-servers) plugin. +to already provisioned (non-elastic) servers on top of the excellent [Vagrant Managed Servers](http://github.com/tknerr/vagrant-managed-servers) plugin. It features a powerful templating `init` command, support for multiple environments, several deployment strategies and is designed from the ground up to be cross-platform, with first class support for **Windows, Linux, and Mac**. ## Quick start ``` -$ vagrant orchestrate init --shell --shell-inline "echo Hello" \ - --servers myserver1.mydomain.com,myserver2.mydomain.com \ - --ssh-username USERNAME --ssh-private-key-path PATH +$ vagrant orchestrate init --servers myserver1.mydomain.com,myserver2.mydomain.com \ + --ssh-username USERNAME --ssh-private-key-path PATH \ + --shell --shell-inline "echo Hello" + $ ls Vagrantfile dummy.box $ vagrant orchestrate push ==> managed-myserver1.mydomain.com: Linking vagrant with managed server myserver1.mydomain.com ==> managed-myserver1.mydomain.com: -- Server: myserver1.mydomain.com @@ -36,11 +37,11 @@ ==> managed-myserver2.mydomain.com: Hello ==> managed-myserver2.mydomain.com: Unlinking vagrant from managed server myserver2.mydomain.com ==> managed-myserver2.mydomain.com: -- Server: myserver2.mydomain.com ``` -This also works for Windows with the `--winrm --winrm-username USERNAME --wirnm-password PASSWORD` parameters, but currently must be initiated from a Windows host. +This also works for Windows with the `--winrm --winrm-username USERNAME --wirnm-password PASSWORD` parameters, but must be initiated from a Windows host. ## Usage Install using the standard Vagrant plugin installation method: @@ -84,36 +85,35 @@ end ``` You'll need to edit your Vagrantfile and replace some variables, such as ssh username and private key, and the path to the script to run. Alternatively, you can pass them on the command -line with `--ssh-username` and `--ssh-private-key-path`. The first line of the file defines an array of -managed servers that the `push` command will operate on. +line with `--ssh-username` and `--ssh-private-key-path`. The first line of the file defines an whitespace delimeted +array of managed servers that the `push` command will operate on. ```ruby managed_servers = %w( myserver1.mydomain.com myserver2.mydomain.com ) ``` #### Windows This works for Windows managed servers using WinRM as well - $ vagrant orchestrate init --winrm [--winrm-username USERNAME --winrm-password PASSWORD] + $ vagrant orchestrate init --winrm --winrm-username USERNAME --winrm-password PASSWORD ```ruby required_plugins = %w( vagrant-managed-servers vagrant-winrm-s ) ... config.vm.communicator = "winrm" - config.winrm.username = "{{YOUR_WINRM_USERNAME}}" - config.winrm.password = "{{YOUR_WINRM_PASSWORD}}" - config.winrm.transport = :sspinegotiate + config.winrm.username = "USERNAME" + config.winrm.password = "PASSWORD" ``` #### Plugins -This also supports a portable way to install plugins, just list them in the required_plugins section +This also supports a portable and repeatable way to install plugins, just list them in the required_plugins section ```ruby required_plugins = %w( vagrant-managed-servers vagrant-hostsupdater ) ``` @@ -215,18 +215,13 @@ ## Contributing 1. Fork it ( https://github.com/Cimpress-MCP/vagrant-orchestrate/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create a new Pull Request +4. Run locally with `bundle exec vagrant orchestrate [init|push|status]` +5. `bundle exec rake build` +6. `bundle exec rake acceptance`, which will take a few minutes +7. Push to the branch (`git push origin my-new-feature`) +8. Create a new Pull Request -## Development Flow - Prerequisites: * Ruby 2.0 or greater - -Flow: -1. Develop your feature -2. Run locally with `bundle exec vagrant orchestrate [init|push|status]` -3. `bundle exec rake build` -4. `bundle exec rake acceptance`, which will take a few minutes