vagrant-orchestrate 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8023ff8aefbb5ace0220aa2fe90faec3fa8d6173
-  data.tar.gz: 0eb7261e2e546c4ab2b47f698ee0e530585227cd
+  metadata.gz: ae428a0690c14047e05845e7f3a24da592882c9d
+  data.tar.gz: 6f3269c537f110f8c9b66c03e3b8cd2cf689d462
 SHA512:
-  metadata.gz: f6f2c0bd2b1926895766f035d3bd2a905a9606988d2285a9bf9f5015a62844f9f6510171a22d5fa54978da90819bc192a1e8d23295ca68f25c1f1cc468e9a53a
-  data.tar.gz: 7f3c108151121a98bae3d22324e1851d2cd3444d780db0dc56c4cd2f01d740771437781c3d0b82961b8c2b9b5271b3ec028f5a09985dd8bd37a2fe6cb2552cc7
+  metadata.gz: bd77d6176cf9fc391905c6f913a84719b0a6fecc1ead0a75e25d6d8ff390b97a45422db484b8a0a831de7090b9e4cfd36d7ecb1de044c855673584de51be3fdd
+  data.tar.gz: 5502b1cef7a68f9c8f5438d1958f9ec51ffb9ed5f50967029cc989a42b2fb75d386a89e1b05b691ac94dd35cf299af61ec9282e53818baef49d7c752192ce26e

data/.gitignore

@@ -14,4 +14,5 @@
 mkmf.log
 
 /.vagrant/
+Vagrantfile
 .DS_Store

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git", ref: "v1.7.2"
   gem "vagrant-spec", git: "https://github.com/mitchellh/vagrant-spec.git"
 end
 
@@ -12,4 +12,5 @@ group :plugins do
   gem "vagrant-orchestrate", path: "."
   gem "vagrant-managed-servers"
   gem "vagrant-librarian-puppet"
+  gem "vagrant-winrm-s"
 end

data/README.md

@@ -1,10 +1,37 @@
 # Vagrant Orchestrate
 
 This is a Vagrant 1.6+ plugin that allows orchestrated deployments
-to existing servers on top of the excellent vagrant-managed-servers plugin.
+to already provisioned (non-elastic) servers on top of the excellent vagrant-managed-servers plugin.
 It features a powerful templating `init` command and is designed from the
-ground up to be cross-platform, with first class support for Windows,
-Linux, and Mac.
+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 push
+==> managed-myserver1.mydomain.com: Linking vagrant with managed server myserver1.mydomain.com
+==> managed-myserver1.mydomain.com:  -- Server: myserver1.mydomain.com
+==> managed-myserver1.mydomain.com: Rsyncing folder: ~/dev/demo => /vagrant
+==> managed-myserver1.mydomain.com: Running provisioner: shell...
+==> managed-myserver1.mydomain.com: Running: inline script
+==> managed-myserver1.mydomain.com: Hello
+==> managed-myserver1.mydomain.com: Unlinking vagrant from managed server myserver1.mydomain.com
+==> managed-myserver1.mydomain.com:  -- Server: myserver1.mydomain.com
+==> managed-myserver2.mydomain.com: Linking vagrant with managed server myserver2.mydomain.com
+==> managed-myserver2.mydomain.com:  -- Server: myserver2.mydomain.com
+==> managed-myserver2.mydomain.com: Rsyncing folder: ~/dev/demo => /vagrant
+==> managed-myserver2.mydomain.com: Running provisioner: shell...
+==> managed-myserver2.mydomain.com: Running: inline script
+==> 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 --wirnm-password` parameters, but currently must be initiated from a Windows host.
 
 ## Usage
 
@@ -17,21 +44,99 @@ Initialize a Vagrantfile to orchestrate running a script on multiple managed ser
 
     $ vagrant orchestrate init --shell
 
+Which produces a simple default Vagrantfile that can push to managed servers:
+```ruby
+managed_servers = %w( )
+
+required_plugins = %w( vagrant-managed-servers )
+required_plugins.each do |plugin|
+  system "vagrant plugin install #{plugin}" unless Vagrant.has_plugin? plugin
+end
+Vagrant.configure("2") do |config|
+  config.vm.provision "shell", path: "{{YOUR_SCRIPT_PATH}}"
+  config.ssh.username = "{{YOUR_SSH_USERNAME}}"
+  config.ssh.private_key_path = "{{YOUR_SSH_PRIVATE_KEY_PATH}}"
+
+  managed_servers.each do |instance|
+    config.vm.define "managed-#{instance}" do |box|
+      box.vm.box = "tknerr/managed-server-dummy"
+      box.vm.box_url = "./dummy.box"
+      box.vm.provider :managed do |provider|
+        provider.server = instance
+      end
+    end
+  end
+end
+```
+
 You'll need to edit your Vagrantfile and replace some variables, such as ssh username and
-password, and the path to the script to run. The first line of the file defines an array of
+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.
 
-This works for Windows managed servers as well
+```ruby
+managed_servers = %w( myserver1.mydomain.com myserver2.mydomain.com ) 
+```
+
+This works for Windows managed servers using WinRM as well
 
     $ 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
+```
+
+This also supports a self-contained way to install plugins, just list them in the required_plugins section
+
+```ruby
+required_plugins = %w( vagrant-managed-servers vagrant-hostsupdater )
+```
+
+Experimental puppet templating support is available as well with the `--puppet` flag and associated options
+
+```ruby
+  required_plugins = %w( vagrant-managed-servers vagrant-librarian-puppet )
+
+  ...
+
+  config.librarian_puppet.placeholder_filename = ".gitignore"
+  config.vm.provision "puppet" do |puppet|
+    puppet.module_path = 'modules'
+    puppet.hiera_config_path = 'hiera.yaml'
+  end
+```
+
+The following files and folders will be placed in the current directory
+
+```
+Puppetfile
+Vagrantfile
+dummy.box
+hiera/
+  common.yaml
+hiera.yaml
+manifests/
+  default.pp
+modules/
+  .gitignore
+```
+
 For a full list of init options, run `vagrant orchestrate init --help`
 
 ### Pushing changes
-Go ahead and push changes to your managed servers
+Go ahead and push changes to your managed servers, one at a time. Support for parallel deployments is planned.
 
     $ vagrant orchestrate push
 
+The push command is currently limited by convention to vagrant machines that start with the "managed-" prefix. So if you have other, local machines defined in the Vagrantfile, `vagrant orchestrate push` will not operate on those, but be cautioned that `vagrant up`, `provision` and `destroy` will by default.
+
 You can run vagrant with increased verbosity if you run into problems
 
     $ vagrant orchestrate push --debug
@@ -60,12 +165,6 @@ merge that feature into downstream environments to avoid conflicts.
 
 You'll want Ruby v2.0.0* and bundler for developing changes.
 
-You can install bundler by running
-
-    $ gem install bundler
-
-Bundler documentation is available here (http://bundler.io/).
-
 During the course of development you'll want to run the code you're working on,
 not the version of Vagrant Orchestrate you've installed. In order to accomplish
 this, run your vagrant orchestrate commands in the bundler environment.

data/Rakefile

@@ -1,4 +1,8 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task build: ["rubocop:auto_correct", :spec]

data/lib/vagrant-orchestrate/action/filtermanaged.rb

@@ -0,0 +1,27 @@
+module VagrantPlugins
+  module Orchestrate
+    module Action
+      class FilterManaged
+        def initialize(app, _env)
+          @app = app
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        def call(env)
+          machine = env[:machine]
+          if machine.provider_name == :managed
+            if (machine.config.orchestrate.filter_managed_commands) && (ENV["VAGRANT_ORCHESTRATE_COMMAND"] != "PUSH")
+              env[:ui].info("Ignoring action #{env[:machine_action]} for managed server #{machine.name}.")
+              env[:ui].info("Set `config.orchestrate.filter_managed_commands = false` in your vagrantfile to disable.")
+            else
+              @app.call(env)
+            end
+          else
+            @app.call(env)
+          end
+        end
+        # rubocop:enable Metrics/AbcSize
+      end
+    end
+  end
+end

data/lib/vagrant-orchestrate/command/push.rb

@@ -22,16 +22,24 @@ module VagrantPlugins
           # Parse the options
           argv = parse_options(opts)
 
-          with_target_vms(argv, provider: :managed) do |machine|
-            unless machine.name.to_s.start_with? "managed-"
-              @logger.debug("Skipping machine #{machine.name}")
+          with_target_vms(argv) do |machine|
+            unless machine.provider_name.to_sym == :managed
+              @env.ui.info("Skipping machine #{machine.name}")
               next
             end
+            push(options)
+          end
+        end
 
+        def push(options)
+          ENV["VAGRANT_ORCHESTRATE_COMMAND"] = "PUSH"
+          begin
             machine.action(:up, options)
             machine.action(:provision, options)
             machine.action(:reload, options) if options[:reboot]
             machine.action(:destroy, options)
+          ensure
+            ENV.delete "VAGRANT_ORCHESTRATE_COMMAND"
           end
         end
       end

data/lib/vagrant-orchestrate/config.rb

@@ -0,0 +1,17 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Orchestrate
+    class Config < Vagrant.plugin(2, :config)
+      attr_accessor :filter_managed_commands
+
+      def initialize
+        @filter_managed_commands = UNSET_VALUE
+      end
+
+      def finalize!
+        @filter_managed_commands = false if @filter_managed_commands == UNSET_VALUE
+      end
+    end
+  end
+end

data/lib/vagrant-orchestrate/plugin.rb

@@ -1,3 +1,5 @@
+require "vagrant-orchestrate/action/filtermanaged"
+
 begin
   require "vagrant"
 rescue LoadError
@@ -18,6 +20,11 @@ module VagrantPlugins
       This plugin installs commands that make pushing changes to vagrant-managed-servers easy.
       DESC
 
+      config "orchestrate" do
+        require_relative "config"
+        Config
+      end
+
       command(:orchestrate) do
         setup_i18n
         setup_logging
@@ -26,6 +33,22 @@ module VagrantPlugins
         Command::Root
       end
 
+      action_hook(:orchestrate, :machine_action_up) do |hook|
+        hook.prepend Action::FilterManaged
+      end
+
+      action_hook(:orchestrate, :machine_action_provision) do |hook|
+        hook.prepend Action::FilterManaged
+      end
+
+      action_hook(:orchestrate, :machine_action_destroy) do |hook|
+        hook.prepend Action::FilterManaged
+      end
+
+      action_hook(:orchestrate, :machine_action_reload) do |hook|
+        hook.prepend Action::FilterManaged
+      end
+
       # This initializes the internationalization strings.
       def self.setup_i18n
         I18n.load_path << File.expand_path("locales/en.yml", Orchestrate.source_root)

data/lib/vagrant-orchestrate/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Orchestrate
-    VERSION = "0.0.7"
+    VERSION = "0.1.0"
   end
 end

data/spec/vagrant-orchestrate/command/init_spec.rb

@@ -166,7 +166,7 @@ describe VagrantPlugins::Orchestrate::Command::Init do
       it "includes the vagrant-winrm-s plugin"do
         subject.execute
         vagrantfile = File.readlines(File.join(iso_env.cwd, "Vagrantfile")).join
-        expect(vagrantfile).to include("vagrant-winrm-s")        
+        expect(vagrantfile).to include("vagrant-winrm-s")
       end
     end
 
@@ -272,4 +272,13 @@ describe VagrantPlugins::Orchestrate::Command::Init do
       end
     end
   end
+
+  context "orchestrate config" do
+    describe "filter_managed_servers" do
+      it "is set to true" do
+        subject.execute
+        expect(iso_env.vagrantfile.config.orchestrate.filter_managed_commands).to be true
+      end
+    end
+  end
 end

data/templates/vagrant/Vagrantfile.erb

@@ -7,6 +7,10 @@ required_plugins.each do |plugin|
 end
 <% end %>
 Vagrant.configure("2") do |config|
+  # This disables up, provision, reload, and destroy for managed servers. Use
+  # `vagrant orchestrate push` to communicate with managed servers.
+  config.orchestrate.filter_managed_commands = true
+
   <% if provisioners.include? "shell" -%>
   <% shell_paths.each do |path| -%>
   config.vm.provision "shell", path: "<%= path %>"
@@ -44,9 +48,13 @@ Vagrant.configure("2") do |config|
   config.winrm.transport = :sspinegotiate
   <% end -%>
 
+  config.vm.define "local", primary: true do |local|
+    local.vm.box = "ubuntu/trusty64"
+  end
+
   managed_servers.each do |instance|
-    config.vm.define "managed-#{instance}" do |box|
-      box.vm.box = "tknerr/managed-server-dummy"
+    config.vm.define instance, autostart: false do |box|
+      box.vm.box = "managed-server-dummy"
       box.vm.box_url = "./dummy.box"
       box.vm.provider :managed do |provider|
         provider.server = instance

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Christopher Baldauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,9 +82,11 @@ files:
 - Rakefile
 - dummy.box
 - lib/vagrant-orchestrate.rb
+- lib/vagrant-orchestrate/action/filtermanaged.rb
 - lib/vagrant-orchestrate/command/init.rb
 - lib/vagrant-orchestrate/command/push.rb
 - lib/vagrant-orchestrate/command/root.rb
+- lib/vagrant-orchestrate/config.rb
 - lib/vagrant-orchestrate/plugin.rb
 - lib/vagrant-orchestrate/version.rb
 - locales/en.yml