vagrant-g5k 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 434ab6db97a6c01d75354834cde480eeab3d174b
-  data.tar.gz: dd8d702c1e0245781af2503ccc37f7b7c8634643
+  metadata.gz: 2d6991228db63db381f8f2516facf3887ad4b9ee
+  data.tar.gz: 278db64626910dd610636f6c46491273513a0855
 SHA512:
-  metadata.gz: e499327e153f8a18e80af8d7c2ddd724b42518ed01618381a7a492a6bb550c074d0ab1a05ecb879da49bbe5e01f6414335b7b94acacc0e5406859783325177cb
-  data.tar.gz: 95349e887d1802f26b0a2871faf3cef7c3a8f399b44906c422c9d9edd53c678146136409f4fe4600d66617be4385e1d0d401522182e220d49880b9102be741d8
+  metadata.gz: c6850fa3f81a71b3f626d41cc7fe10207de2b6c65635c15ab038e6674075a67f459ed10706529ced9d414eca28dc868be0c456032a68a71f972f2f751c396614
+  data.tar.gz: c9997684c3978324128e5ec035a9f0fb96982f2e0266ec31d7bdd512649f0d976049480c9549038683d7dae2a39f4547caed648c76285740bdfa27d3d16d8469

data/CHANGELOG.md

@@ -1,6 +1,16 @@
+# 0.9.5 (unreleased)
+
+  * Fix import error on command 
+  [[-]](https://github.com/msimonin/vagrant-g5k/commit/d5b69cc48c2e38de0895498c7bf1dfe7df2fa96c)
+  * bridge mode now reserves a /18 and take ips in the first 1024 ips. 
+  [[-]](https://github.com/msimonin/vagrant-g5k/commit/9d7511e030cae63c6496c7c96fb713c6347dbadd)
+  * Support for container job
+  [[-]](https://github.com/msimonin/vagrant-g5k/commit/cf30db9324a2a5dc29b96f43372786b4c7843e53)
+  * Document sharing g5k user home
+
 # 0.9.4
 
-  * TODO
+  * fix version mistake 
 
 # 0.9.3 
 

data/README.md

@@ -1,14 +1,47 @@
-> The plugin is updated often, this may include breaking changes.
+> The plugin is updated frequently, this may include breaking changes.
 
 # Vagrant G5K Provider
-This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds an [G5K](https://www.grid5000.fr)
-provider to Vagrant, allowing Vagrant to control and provision **virtual machines** on Grid5000.
+This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds an
+[G5K](https://www.grid5000.fr) provider to Vagrant, allowing Vagrant to control
+and provision **virtual machines** on Grid5000.
 
-More generally any *OAR behind ssh* that support launching `kvm` could be used (e.g [Igrida](http://igrida.gforge.inria.fr/)). Thus *vagrant-oar* could be a more appropriate name.
+More generally any *OAR behind ssh* that support launching `kvm` could be used
+(e.g [Igrida](http://igrida.gforge.inria.fr/)). Thus *vagrant-oar* could be a
+more appropriate name.
 
 > This plugin requires
   * Vagrant 1.2+,
 
+---
+
+* [Supported operations](#supported-operations)
+* [Usage](#usage)
+* [Configuration](#configuration)
+* [Note on the insecure vagrant key](#note-on-the-insecure-vagrant-key)
+* [Note on shared folders](note-on-local-shared-folders)
+  * [Local files](#local-files)
+  * [Grid5000 home](#grid5000-home)
+* [Note on disk format and backing strategy](#note-on-disk-format-and-backing-strategy)
+* [Note on network configuration](#note-on-network-configuration)
+  * [NAT networking](#nat-networking)
+  * [Bridge networking](#bridge-networking)
+* [Note on resource demand](#note-on-resource-demand)
+* [Reservation in advance](#reservation-in-advance)
+* [Developping](#developping)
+
+---
+
+## Supported operations
+
+* `vagrant destroy`
+* `vagrant halt`
+* `vagrant provision`
+* `vagrant rsync|rsync-auto`
+* `vagrant ssh`
+* `vagrant ssh-config`
+* `vagrant status`
+* `vagrant up`
+
 
 ## Usage
 
@@ -23,7 +56,8 @@ $ wget https://raw.githubusercontent.com/msimonin/vagrant-g5k/master/Vagrantfile
 $ vagrant up --provider=g5k
 ...
 ```
-Vagrant requires a box to start with. As a consequence you can add one `dummy` box with the following command :
+Vagrant requires a box to start with. As a consequence you can add one `dummy`
+box with the following command :
 
 ```
  vagrant box add dummy https://github.com/msimonin/vagrant-g5k/raw/master/dummy.box
@@ -41,15 +75,29 @@ Prior to some operation vagrant will replace this by a generated key.
 This operation isn't supported by vagrant-g5k thus you need to specify
 `config.vmssh.insert_key = false` in the Vagrantfile.
 
-For instance this is needed when using shared folders, hostmanager plugin.
+For instance this is needed when using shared folders, hostmanager plugin...
 
 ## Note on shared folders
 
-Rsync shared folders are supported. The copy of your local files is hooked in the `up` phase. After this you can use :
+### Local files
+
+Rsync shared folders are supported. The copy of your local files is hooked in
+the `up` phase. After this you can use :
 
 * `vagrant rsync` to force a synchronization
 * `vagrant rsync-auto` to watch your local modifications
 
+### Grid5000 home
+
+Your home on Grid'5000 can be shared with your virtual machine through VirtFS.
+If the VM supports Plan 9 folder sharing you can connect to the VM and type :
+
+```
+mkdir /g5k
+mount -t 9p -o trans=virtio hostshare /g5k -oversion=9p2000.L
+```
+
+
 ## Note on disk format and backing strategy
 
 Virtual Machines can be booted either :
@@ -60,17 +108,30 @@ Virtual Machines can be booted either :
 Once the base image is chosen, you can pick one of the following strategy
 to back the disk image of the virtual machines :
 
-* `copy`: will make a full copy of the image in your home directory (resp. in the same pool as the rbd)
-* `cow`: will create a Copy On write image in your home directory (resp. in the same pool as the rbd)
+* `copy`: will make a full copy of the image in your home directory (resp. in
+  the same pool as the rbd)
+* `cow`: will create a Copy On write image in your home directory (resp. in the
+  same pool as the rbd)
 * `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.
 
+### Use ceph as backing strategy
+
+Vagrant-g5k will look into `~/.ceph/config` on each frontend where VMs are started.
+You can read[1] for further information on how to configure ceph on grid'5000.
+
+[1] : https://www.grid5000.fr/mediawiki/index.php/Ceph
+
 ## 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.
+### 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|
   [...]
@@ -81,9 +142,14 @@ config.vm.provider "g5k" do |g5k|
 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.
+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.
+### 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|
@@ -94,7 +160,10 @@ config.vm.provider "g5k" do |g5k|
 end
 ```
 
-> Due to the dynamic nature of the subnet reserved on Grid'5000, IPs of the VMs will change accross reboots
+> Due to the dynamic nature of the subnet reserved on Grid'5000, IPs of the VMs
+> will change accross reboots a /18 is reserved but only the first 1024 ips are
+> reserved for the VMs. That means you can use the remaining ips without any
+> conflict.
 
 ## Note on resource demand
 
@@ -109,26 +178,25 @@ config.vm.provider "g5k" do |g5k|
   }
 end
 ```
-You can use `:cpu => -1` to express that you want all the cpu of the reserved node (but not necesseraly all the memory). Similarly `:mem => -1` will give you all the memory available on the reserved node. These are the default values.
+You can use `:cpu => -1` to express that you want all the cpu of the reserved
+node (but not necesseraly all the memory). Similarly `:mem => -1` will give you
+all the memory available on the reserved node. These are the default values.
 
+## Reservation in advance
 
-## Supported operations
+If you plan to use a reservation or if you expect all your VMs to be ready
+almost on the same time you can use a job container (see:
+https://www.grid5000.fr/mediawiki/index.php/Advanced_OAR#Container_jobs)
 
-* `vagrant destroy`
-* `vagrant halt`
-* `vagrant provision`
-* `vagrant rsync|rsync-auto`
-* `vagrant ssh`
-* `vagrant ssh-config`
-* `vagrant status`
-* `vagrant up`
-
-## Use ceph as backing strategy
-
-Vagrant-g5k will look into `~/.ceph/config` on each frontend where VMs are started.
-You can read[1] for further information on how to configure ceph on grid'5000.
+* First create you container job using OAR cli from the fronted of your choice.
+* Then instruct vagrant-g5k about this job container id in the Vagrantfile :
 
-[1] : https://www.grid5000.fr/mediawiki/index.php/Ceph
+```
+config.vm.provider "g5k" do |g5k|
+  [...]
+  g5k.job_container_id = "your container job id"
+end
+```
 
 ## Developping
 

data/Vagrantfile

@@ -3,11 +3,25 @@
 #
 # Sample Vagrantfile
 #
+
+# Allow to mount the home directory of G5k inside the VM
+$script = <<SCRIPT
+mkdir /g5k
+mount -t 9p -o trans=virtio hostshare /g5k -oversion=9p2000.L
+SCRIPT
+
 Vagrant.configure(2) do |config|
 
     config.vm.provider "g5k" do |g5k, override|
       # This is mandatory for the shared folders to work correctly
       override.nfs.functional = false
+      # vagrant-g5k only supports rsync shared folders
+      override.vm.synced_folder ".", "/vagrant", type: "rsync", disabled: false
+
+      override.ssh.insert_key = false
+
+      # Mount the home dir
+      override.vm.provision "shell", inline: $script
       # project id must be unique accross all
       # your projects using vagrant-g5k to avoid conflict
       # on vm disks
@@ -17,11 +31,12 @@ Vagrant.configure(2) do |config|
       g5k.site = "rennes"
       g5k.username = "msimonin"
       g5k.gateway = "access.grid5000.fr"
-      g5k.walltime = "00:10:00"
+      g5k.walltime = "01:00:00"
+      #g5k.private_key = "your private key"
 
       # Image backed on the frontend filesystem
       g5k.image = {
-        :path    => "/home/msimonin/public/ubuntu1404-9p.qcow2",
+        :path    => "/home/msimonin/public/debian-8.7-amd64-bento.qcow2",
         :backing => "snapshot"
       }
 
@@ -51,21 +66,17 @@ Vagrant.configure(2) do |config|
         :cpu => 1,
         :mem => 2048
       }
+      ## Job container id
+      ## see https://www.grid5000.fr/mediawiki/index.php/Advanced_OAR#Container_jobs
+      # g5k.job_container_id = "907864"
+
     end #g5k
 
-    ## This define a VM.
-    ## a g5k provider section will override top level options
-    ## To define multiple VMs you can
-    ## * either repeat the block
-    ## * loop over using (1..N).each block
+    # This defines a VM
+    # If you want to use a local virtual machine (vbox, libvirt...)
+    # add your vagrant options below as usual.
     config.vm.define "test" do |my|
       my.vm.box = "dummy"
-      ## Configure the shared folders between your host and the VM
-      my.vm.synced_folder ".", "/vagrant", type: "rsync", disabled: false
-      ## This is mandatory until #6 is fixed
-      ## In particular this is needed for the shared folders
-      my.ssh.insert_key = false
-
-    end #vm
+    end
 
 end

data/Vagrantfile.multi

@@ -5,42 +5,34 @@
 #
 Vagrant.configure(2) do |config|
 
+      config.vm.provider "g5k" do |g5k, override|
+        # some overrides
+        override.nfs.functional = false
+        override.vm.synced_folder ".", "/vagrant", type: "rsync", disabled: true
+        override.ssh.insert_key = false
+
+        g5k.project_id = "test-vagrant-g5k"
+        g5k.site = "rennes"
+        g5k.username = "msimonin"
+        g5k.gateway = "access.grid5000.fr"
+        g5k.walltime = "00:30:00"
+        g5k.image = {
+          :path    => "/home/msimonin/public/ubuntu1404-9p.qcow2",
+          :backing => "snapshot"
+        }
+        g5k.net = {
+          :type => "bridge",
+        }
+        g5k.oar = "virtual != 'none'"
+        g5k.resources = {
+          :cpu => 1,
+          :mem => 2048
+        }
+      end #g5k
 
-    ## This define a VM.
-    ## a g5k provider section will override top level options
-    ## To define multiple VMs you can
-    ## * either repeat the block
-    ## * loop over using (1..N).each block
     (1..3).each do |i|
       config.vm.define "test-#{i}" do |my|
         my.vm.box = "dummy"
-        ## Configure the shared folders between your host and the VM
-        my.vm.synced_folder ".", "/vagrant", type: "rsync", disabled: false
-        ## This is mandatory until #6 is fixed
-        ## In particular this is needed for the shared folders
-        my.ssh.insert_key = false
-        my.vm.provider "g5k" do |g5k, override|
-          override.nfs.functional = false
-          g5k.project_id = "test-vagrant-g5k"
-          g5k.site = "rennes"
-          g5k.username = "msimonin"
-          g5k.gateway = "access.grid5000.fr"
-          g5k.walltime = "00:10:00"
-          g5k.image = {
-            :path    => "/home/msimonin/public/ubuntu1404-9p.qcow2",
-            :backing => "snapshot"
-          }
-          g5k.net = {
-            :type => "bridge",
-#            :ports => ["#{2222+i}-:22"]
-          }
-          g5k.oar = "virtual != 'none'"
-          g5k.resources = {
-            :cpu => 1,
-            :mem => 2048
-          }
-        end #g5k
-
       end #vm
     end
 

data/Vagrantfile.old

@@ -3,84 +3,77 @@
 #
 # Sample Vagrantfile
 #
+
+# Allow to mount the home directory of G5k inside the VM
 $script = <<SCRIPT
-add-apt-repository ppa:ubuntu-lxc/lxd-stable
-apt-get update
-apt-get install -y lxd
-lxd init --auto
-lxc network attach-profile br0 default eth0
+mkdir /g5k
+mount -t 9p -o trans=virtio hostshare /g5k -oversion=9p2000.L
 SCRIPT
 
-
 Vagrant.configure(2) do |config|
-    config.hostmanager.enabled = true
-    config.hostmanager.manage_guest = true
 
-    (0..0).each do |i|
-      config.vm.provider "g5k" do |g5k, override|
-        # This is mandatory for the shared folders to work correctly
-        override.nfs.functional = false
-        # project id must be unique accross all
-        # your projects using vagrant-g5k to avoid conflict
-        # on vm disks
-        g5k.project_id = "test-vagrant-g5k"
+    config.vm.provider "g5k" do |g5k, override|
+      # This is mandatory for the shared folders to work correctly
+      override.nfs.functional = false
+      # vagrant-g5k only supports rsync shared folders
+      override.vm.synced_folder ".", "/vagrant", type: "rsync", disabled: false
 
-        #g5k.site = "igrida"
-        g5k.site = "rennes"
-        g5k.username = "msimonin"
-         g5k.gateway = "access.grid5000.fr"
-        g5k.walltime = "02:00:00"
+      override.ssh.insert_key = false
 
-        # Image backed on the frontend filesystem
-        g5k.image = {
-        #  :path    => "/udd/msimonin/precise.qcow2",
-          :path    => "/home/msimonin/public/ubuntu1404-9p.qcow2",
-          :backing => "snapshot"
-        }
+      # Mount the home dir
+      override.vm.provision "shell", inline: $script
+      # project id must be unique accross all
+      # your projects using vagrant-g5k to avoid conflict
+      # on vm disks
+      g5k.project_id = "test-vagrant-g5k"
 
-        ## Bridged network : this allow VMs to communicate
-        g5k.net = {
-          :type => "bridge"
-        }
+      #g5k.site = "igrida"
+      g5k.site = "rennes"
+      g5k.username = "msimonin"
+      g5k.gateway = "access.grid5000.fr"
+      g5k.walltime = "01:00:00"
+      #g5k.private_key = "your private key"
 
-        ## Nat network : VMs will only have access to the external world
-        ## Forwarding ports will allow you to access services hosted inside the
-        ## VM.
-        #g5k.net = {
-        #  :type => "nat",
-        #  :ports => ["2222-:22"]
-        #}
+      # Image backed on the frontend filesystem
+      g5k.image = {
+        :path    => "/home/msimonin/public/debian-8.7-amd64-bento.qcow2",
+        :backing => "snapshot"
+      }
 
-        ## OAR selection of resource
-        g5k.oar = "virtual != 'none'"
-        #g5k.oar = "virtual != 'None' and network_address in ('paranoia-2.rennes.grid5000.fr')"
-        #g5k.oar = "network_address in ('igrida12-12.irisa.fr')"
+      ## Bridged network : this allow VMs to communicate
+      #g5k.net = {
+      #  :type => "bridge"
+      #}
 
-        ## VM size customization default values are
-        ## cpu => -1 -> all the cpu of the reserved node
-        ## mem => -1 -> all the mem of the reserved node
-        ##
-        #g5k.resources = {
-        #  :cpu => 1,
-        #  :mem => 2048
-        #}
-      end #g5k
+      ## Nat network : VMs will only have access to the external world
+      ## Forwarding ports will allow you to access services hosted inside the
+      ## VM.
+      g5k.net = {
+        :type => "nat",
+        :ports => ["2222-:22"]
+      }
 
-      ## This define a VM.
-      ## a g5k provider section will override top level options
-      ## To define multiple VMs you can
-      ## * either repeat the block
-      ## * loop over using (1..N).each block
-      config.vm.define "exp#{i}" do |my|
-        my.vm.box = "dummy"
-        ## Configure the shared folders between your host and the VM
-        my.vm.synced_folder ".", "/vagrant", type: "rsync", disabled: true
-        ## This is mandatory until #6 is fixed
-        ## In particular this is needed for the shared folders
-        my.ssh.insert_key = false
+      ## OAR selection of resource
+      g5k.oar = "virtual != 'none'"
+      #g5k.oar = "virtual != 'None' and network_address in ('paranoia-2.rennes.grid5000.fr')"
+      #g5k.oar = "network_address in ('igrida12-12.irisa.fr')"
 
-        my.vm.provision "shell", inline: $script
-      end #vm
+      ## VM size customization default values are
+      ## cpu => -1 -> all the cpu of the reserved node
+      ## mem => -1 -> all the mem of the reserved node
+      ##
+      g5k.resources = {
+        :cpu => 1,
+        :mem => 2048
+      }
+      g5k.job_container_id = "907864"
+    end #g5k
 
+    # This defines a VM
+    # If you want to use a local virtual machine (vbox, libvirt...)
+    # add your vagrant options below as usual.
+    config.vm.define "test" do |my|
+      my.vm.box = "dummy"
     end
+
 end