vagrant-g5k 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1df4a32a68cbad5242e82101c86660aec6edf0b
-  data.tar.gz: 2978fdaf2984face9272df254040893082497a7d
+  metadata.gz: 36a28bd1d6c3273013c988e54f99f247d6c23b32
+  data.tar.gz: 4aae9321d7dfdc633d32c15b0c247e4fedfb017b
 SHA512:
-  metadata.gz: 24b08525b133f8f58a185315f8553322b57c1cf16b544634dd3df56695d496a632e073fb5c790cd4a1c0a11a724d5ff9371e40bcb659d0dd3294f35fb47b795a
-  data.tar.gz: 1229bd98b6478fb89a7d68cb486d6c089b88682a2493558d87d9519bd47a3cdb7e955402ac9d345634d97d53c7b1196b4af95fa641ad471216b738b8db65ae50
+  metadata.gz: b2229d27387e2ac38faeb23f29f17d51144cc85aeef103376a4d12786a4e543426bd61f5d5daaddec5606ae07a4b7a94eafa1548abd095bd15ac787773fe4637
+  data.tar.gz: a4d7f6930d7aa1b881cf2576f91251a49b191b4d948bac37e797c6531baaa7a5915416b7cd4b58bf38763b91a88580a07bb2dbdf85ba4c63e20a119a5e6ec0d3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.0.17
+
+  * Add bridged network support
+  * Add support for ssh run command (cli : vagrant ssh vm -c "...".)
+  * Add generic lockable function
+  * Add generic GetState Middleware (destroy can be called even if the VM is
+  terminated)
+
 # 0.0.16
 
   * Improve stdout (add information on physical node)

data/README.md

@@ -39,6 +39,36 @@ to back the disk image of the virtual machines :
 * `direct`: will use the image directly (you'll need r/w access to the image)
 * `snapshot`: will let `kvm` create an ephemeral copy on write image.
 
+## Note on network configuration
+
+Two networking modes are supported :
+
+* NAT networking. VMs traffic is NATed to the outside world.
+The outside world can access the VMs on dedicated ports that are mapped in the host of Grid'5000.
+```
+config.vm.provider "g5k" do |g5k|
+  [...]
+  g5k.net = {
+    "type": "nat",
+    "ports": ["2222-:22", "8080-":80]
+  }
+end
+```
+
+e.g : Assuming `parapluie-1.rennes.grid5000.fr` hosts the VM. A SSH tunnel from your local machine to `parapluie-1.rennes.grid5000.fr:8080` will be forwarded to the port `80` of the VM.
+
+* Bridge networking. VMs are given an IP from a Grid'5000 subnet. They can thus communicate with each others using their IPs.
+
+```
+config.vm.provider "g5k" do |g5k|
+  [...]
+  g5k.net = {
+    "type": "bridge"
+  }
+end
+```
+
+
 ## Supported operations
 
 * `vagrant destroy`
@@ -64,5 +94,3 @@ You can read[1] for further information on how to configure ceph on grid'5000.
 ```
 VAGRANT_LOG=debug VAGRANT_DEFAULT_PROVIDER=g5k bundle exec vagrant up
 ```
-
-

data/Vagrantfile

@@ -4,20 +4,19 @@
 # Testing purpose only
 #Vagrant.require_plugin "vagrant-g5k"
 
-SITES=['rennes']
-
 Vagrant.configure(2) do |config|
-    SITES.each do |site|
-      config.vm.define "vm-#{site}" do |my|
-        my.vm.box = "dummy"
 
-        my.ssh.username = "root"
-        my.ssh.password = ""
+    config.vm.provider "g5k" do |g5k|
+      # project id must be unique accross all
+      # your projects using vagrant-g5k to avoid conflict 
+      # on vm disks
+      g5k.project_id = "vagrant-g5k"
+      g5k.site = "rennes"
+      g5k.username = ENV["USER"]
+      g5k.gateway = "access.grid5000.fr"
+      g5k.walltime = "01:00:00"
 
-        my.vm.provider "g5k" do |g5k|
-          g5k.project_id = "vagrant-g5k"
-          g5k.site = "#{site}"
-          g5k.gateway = "access.grid5000.fr" 
+      # Image backed by the ceph cluster
 #          g5k.image = {
 #             "pool"     => "msimonin_rbds",
 #             "rbd"      => "bases/alpine_docker",
@@ -26,15 +25,45 @@ Vagrant.configure(2) do |config|
 #            "conf"      => "$HOME/.ceph/config",
 #            "backing"   => "snapshot"
 #           }
-          g5k.image = {
-            "path"    => "/grid5000/virt-images/alpine_docker.qcow2",
-            "backing" => "snapshot"
-          }
-          g5k.ports = ['2222-:22']
-          g5k.oar = "virtual != 'none'"
-        end #g5k
-      end #vm
-    end # each
+#
+      # Image backed on the frontend filesystem           
+      g5k.image = {
+        "path"    => "/grid5000/virt-images/alpine_docker.qcow2",
+        "backing" => "snapshot"
+      }
+
+      g5k.net = {
+        "type" => "bridge"
+      }
+#        g5k.net = {
+#          "type" => "nat",
+#          "ports" => ["2222-:22"]
+#        }
+
+
+      # oar selection of resource
+      g5k.oar = "virtual != 'none'"
+    end #g5k
+
+    config.vm.define "vm1" do |my|
+      my.vm.box = "dummy"
+
+      my.ssh.username = "root"
+      my.ssh.password = ""
+
+    end #vm
+    
+    config.vm.define "vm2" do |my|
+      my.vm.box = "dummy"
+
+      my.ssh.username = "root"
+      my.ssh.password = ""
+
+    end #vm
+    # Repeat block to define another vm 
+    # config.vm.define "vm2" do |my|
+    #   
+    # end
 
 end
 

data/lib/vagrant-g5k.rb

@@ -6,6 +6,15 @@ require 'thread'
 module VagrantPlugins
   module G5K
 
+    class << self
+      attr_accessor :g5k_lock
+      attr_accessor :subnet_lock
+      attr_accessor :pool
+    end
+    @g5k_lock = Mutex.new
+    @subnet_lock = Mutex.new
+    @pool = {}
+
     lib_path = Pathname.new(File.expand_path("../vagrant-g5k", __FILE__))
     autoload :Action, lib_path.join("action")
     autoload :Errors, lib_path.join("errors")
@@ -17,5 +26,12 @@ module VagrantPlugins
       @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
     end
 
+    def lockable(opts)
+      opts[:lock].synchronize {
+        yield
+      }
+    end
+
+
   end
 end

data/lib/vagrant-g5k/action.rb

@@ -36,9 +36,11 @@ module VagrantPlugins
       def self.action_ssh
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
-          b.use Call, IsCreated do |env, b2|
-            if !env[:result]
-              b2.use MessageNotCreated
+          # read_state is hook by the call to machine.state.id
+          # in GetState Middleware
+          b.use Call, GetState do |env, b2|
+            if env[:result] != :Running
+              b2.use MessageNotRunning
               next
             end
             b2.use SSHExec
@@ -46,16 +48,36 @@ module VagrantPlugins
         end
       end
 
+
+      # This action is called when vagrant ssh -C "..." is used
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, GetState do |env, b2|
+            if env[:result] != :Running
+              b2.use MessageNotRunning
+              next
+            end
+
+            b2.use SSHRun
+          end
+        end
+      end
+
+
       # This action is called to bring the box up from nothing.
       def self.action_up
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
-          b.use ConnectG5K
-          b.use CreateLocalWorkingDir
-          b.use Call, IsCreated do |env1, b1|
-            if env1[:result] then
-              b1.use MessageAlreadyCreated
+          b.use Call, GetState do |env1, b1|
+            if env1[:result] == :Running then
+              b1.use MessageAlreadyRunning
+            elsif env1[:result] == :Waiting
+              b1.use ConnectG5K
+              b1.use WaitInstance
             else
+              b1.use ConnectG5K
+              b1.use CreateLocalWorkingDir
               b1.use RunInstance # launch a new instance
             end
           end
@@ -69,13 +91,18 @@ module VagrantPlugins
             if env[:result]
               b2.use ConfigValidate
               b2.use ConnectG5K
-              b2.use Call, IsCreated do |env2, b3|
-                if !env2[:result]
+              b2.use Call, GetState do |env2, b3|
+                if [:Running, :Waiting].include?(env2[:result])
+                  b3.use DeleteJob
+                  b3.use DeleteDisk
+                  next
+                elsif env2[:result] == :shutdown
+                  b3.use DeleteDisk
+                  next
+                else
                   b3.use MessageNotCreated
                   next
                 end
-                b3.use DeleteJob
-                b3.use DeleteDisk
               end
             else
               b2.use MessageWillNotDestroy
@@ -89,12 +116,14 @@ module VagrantPlugins
         Vagrant::Action::Builder.new.tap do |b|
             b.use ConfigValidate
             b.use ConnectG5K
-            b.use Call, IsCreated do |env1, b2|
-              if !env1[:result]
+            b.use Call, GetState do |env1, b2|
+              if [:Running, :Waiting].include?(env1[:result])
+                b2.use DeleteJob
+                next
+              else
                 b2.use MessageNotCreated
                 next
               end
-            b2.use DeleteJob
           end
         end
       end
@@ -103,9 +132,9 @@ module VagrantPlugins
       def self.action_provision
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
-          b.use Call, IsCreated do |env, b2|
-            if !env[:result]
-              b2.use MessageNotCreated
+          b.use Call, GetState do |env, b2|
+            if env[:result] != :Running
+              b2.use MessageNotRunning
               next
             end
             b2.use Provision
@@ -119,13 +148,16 @@ module VagrantPlugins
       autoload :CreateLocalWorkingDir, action_root.join("create_local_working_dir")
       autoload :DeleteJob, action_root.join("delete_job")
       autoload :DeleteDisk, action_root.join("delete_disk")
-      autoload :IsCreated, action_root.join("is_created")
-      autoload :MessageAlreadyCreated, action_root.join("message_already_created")
+      autoload :GetState, action_root.join("get_state")
+      autoload :MessageAlreadyRunning, action_root.join("message_already_running")
       autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :MessageNotRunning, action_root.join("message_not_running")
       autoload :ReadSSHInfo, action_root.join("read_ssh_info")
       autoload :ReadState, action_root.join("read_state")
       autoload :RunInstance, action_root.join("run_instance")
       autoload :StartInstance, action_root.join("start_instance")
+      autoload :WaitInstance, action_root.join("wait_instance")
+
 
     end
   end

data/lib/vagrant-g5k/action/connect_g5k.rb

@@ -7,12 +7,6 @@ require 'thread'
 module VagrantPlugins
   module G5K
 
-    class << self
-      attr_accessor :g5k_lock
-      attr_accessor :pool
-    end
-    @g5k_lock = Mutex.new
-    @pool = {}
 
     module Action
       # This action connects to G5K, verifies credentials work, and
@@ -20,6 +14,7 @@ module VagrantPlugins
       # in the environment.
       class ConnectG5K
 
+        include VagrantPlugins::G5K
 
         def initialize(app, env)
           @app    = app
@@ -46,7 +41,7 @@ module VagrantPlugins
             :forward_agent => true
           }
           options[:keys] = [private_key] if !private_key.nil?
-          VagrantPlugins::G5K.g5k_lock.synchronize {
+          lockable(:lock => VagrantPlugins::G5K.g5k_lock) do
             if VagrantPlugins::G5K.pool[key].nil?
               @logger.debug "Creating a new session object for #{key}"
               if gateway.nil?
@@ -61,7 +56,7 @@ module VagrantPlugins
             else
               @logger.debug "Reusing existing session for #{key}"
             end
-          }
+          end
           return VagrantPlugins::G5K.pool[key]
         end
       end

data/lib/vagrant-g5k/action/create_local_working_dir.rb

@@ -16,7 +16,7 @@ module VagrantPlugins
 
         def call(env)
           conn = env[:g5k_connection]
-          conn.create_local_working_dir(env)
+          conn.create_local_working_dir()
           @app.call(env)
         end
 

data/lib/vagrant-g5k/action/get_state.rb

@@ -0,0 +1,23 @@
+require "log4r"
+
+module VagrantPlugins
+  module G5K
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is created and branch in the middleware.
+      class GetState
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant_g5k::action::get_state")
+        end
+
+        def call(env)
+          machine_state_id = env[:machine].state.id
+          @logger.info "machine is in state #{machine_state_id}"
+          env[:result] = machine_state_id
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-g5k/action/is_created.rb

@@ -1,3 +1,5 @@
+require "log4r"
+
 module VagrantPlugins
   module G5K
     module Action
@@ -6,11 +8,13 @@ module VagrantPlugins
       class IsCreated
         def initialize(app, env)
           @app = app
+          @logger = Log4r::Logger.new("vagrant_g5k::action::is_created")
         end
 
         def call(env)
-          state_id = env[:machine].state.id
-          env[:result] = state_id == :Running and state_id == :shutdown
+          machine_state_id = env[:machine].state.id
+          @logger.info "machine is in state #{machine_state_id}"
+          env[:result] = machine_state_id == :Running or machine_state_id == :Waiting
           @app.call(env)
         end
       end

data/lib/vagrant-g5k/action/{message_already_created.rb → message_already_running.rb}

@@ -1,7 +1,7 @@
 module VagrantPlugins
   module G5K
     module Action
-      class MessageAlreadyCreated
+      class MessageAlreadyRunning
         def initialize(app, env)
           @app = app
         end

data/lib/vagrant-g5k/action/message_not_running.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module G5K
+    module Action
+      class MessageNotRunning
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info("vagrant_g5k.not_running")
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-g5k/action/read_ssh_info.rb

@@ -12,15 +12,20 @@ module VagrantPlugins
         end
 
         def call(env)
-          ports = env[:machine].provider_config.ports
-          ssh_fwd = ports.select{ |x| x.split(':')[1] == '22'}.first
-          if ssh_fwd.nil?
-            env[:ui].error "SSH port 22 must be forwarded"
-            raise Error "SSh port 22 isn't forwarded"
+          net = env[:machine].provider_config.net
+          # Note: better to encapsulate this in a NetDriver
+          if net["type"] == 'bridge'
+            env[:machine_ssh_info] = read_ssh_info(env[:g5k_connection], env[:machine])
+          else
+            ports = net["ports"]
+            ssh_fwd = ports.select{ |x| x.split(':')[1] == '22'}.first
+            if ssh_fwd.nil?
+              env[:ui].error "SSH port 22 must be forwarded"
+              raise Error "SSh port 22 isn't forwarded"
+            end
+            ssh_fwd = ssh_fwd.split('-:')[0]
+            env[:machine_ssh_info] = read_ssh_info(env[:g5k_connection], env[:machine], ssh_fwd)
           end
-          ssh_fwd = ssh_fwd.split('-:')[0]
-          env[:machine_ssh_info] = read_ssh_info(env[:g5k_connection], env[:machine], ssh_fwd)
-
           @app.call(env)
         end
 
@@ -33,18 +38,15 @@ module VagrantPlugins
         end
 
 
-        def read_ssh_info(conn, machine, ssh_fwd)
+        def read_ssh_info(conn, machine, ssh_fwd = nil)
           return nil if machine.id.nil?
 
-          if ssh_fwd.nil? 
-            raise Error "ssh_port should be forwarded"
-          end
-          
           ssh_info = {
                    :host          => conn.node,
-                   :port          => ssh_fwd,
           }
 
+          ssh_info[:port] = ssh_fwd unless ssh_fwd.nil?
+
           if !conn.gateway.nil?
             ssh_info[:proxy_command] = "ssh #{conn.username}@#{conn.gateway} #{ssh_key(conn)} nc %h %p"
           end