xp5k 0.0.9 → 0.0.10

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODk0OGNhZDYyNmE4OGIwNTdjYTlhYjYxNzZjN2Q1YmY3ZGZiNjFmMA==
+    MTY5MDQ3MTllYzcxZjVmZGQyMjcxYzBhNzdiNmQ2MTJhNjQ0YjA5ZQ==
   data.tar.gz: !binary |-
-    YzY0YTc1OTk0NTAzMzE4ZTU4ODI0M2VmMTc4ODZiMGU2NDJlMTFmMw==
+    MWQ2ZjBkZWU3MjI0OTMxZDUwOGRjYjViNjlkYTY4NjQ2ZDUwMTk1OA==
 SHA512:
   metadata.gz: !binary |-
-    MjkwZjViNDRkODllMjIyNmMxMmFlMDJiZmU5YTgyNzU0ODgxZTI3NDY4YTJk
-    M2VhZWM4N2JlMGZhN2E5NzU0ZGNkZDk0Zjk2Zjg1MmIwNWVhMzQ0YWM3NWNm
-    MjBkZmY1ZTdlY2IzYzJlZTMwMTdiODk4Y2ExOTYwYjVhMTBiYjM=
+    NDkwMDgwOTlkN2QzYWYxYjYxNzFkZTJhMWJhYjQ5M2M2Mjk3OGU1YTU3NjAz
+    MzlmMTMzNzMxNmNlZjJlMGVkNzM3MzA0NGQyY2QxYTcwNTJmY2ZmZjQ1N2Ez
+    YzU0NGM2Nzc2YzA5YzBjNTI0ZDg5Yzc0MDBiOWNkZGFkZGQwYmI=
   data.tar.gz: !binary |-
-    YTEzYjBiYWJjMGQ4YzA1ZjhhYTgyNTY2NjI0MjgwZmFhYzg2ODlmMjI5YmM2
-    NThmYjg5MjQ2NWY5MWEzZjgwYmZiYTI5OTJlM2QwYTY2ZDJiODkzZGFlMWI0
-    NzRlMzE0YzEyNjg3M2FiMzIxYzUxZDBkOGUyZDVkZjU5YjBjMjg=
+    OTMzOWE0N2I5MTZhMmYzNDE5YzFiMTllNWJmMzA1YWRiM2I3YjQ1ZmFiOTI3
+    NjUwMDIzZTkzODQ4YzY0ODQwNWNkODM1MzQxY2NmMzQxMDNhZTRiMmM5NjVl
+    NGE3MDNiZmI4MDdiNDUzNzg0Y2Q5NDFiMmQ2OWQ4MzQ2ZjY3YzI=

data/README.md

@@ -1,8 +1,38 @@
-## Installation
+#### Table of Contents
+
+1. [Getting started](#Getting started)
+  * [Gemfile](#Gemfile)
+  * [Restfully](#Restfully)
+  * [Ssh config](#Ssh config)
+2. [Samples](#Samples)
+  * [Hello date](#Hello date)
+  * [Xp5k Roles](#Xp5k Roles)
+  * [Nested roels](#Nested roles)
+  * [Patterns](#Patterns)
+  * [Get the deployed nodes](#Get the deployed nodes)
+  * [Automatic redeployment](#Automatic redeployment)
+  * [Vlan support](#Vlan support)
+  * [Non deploy jobs](#Non deploy jobs)
+
+# Getting started
+
+A typical project architecture using ```xp5k``` and ```capistrano``` looks like :
+
+```bash
+.
+├── Capfile   # deployment logic
+├── Gemfile   # gem dependencies description
+├── LICENSE   # License of utilization
+└── README.md # How to
+```
+
+## Gemfile
 
 Add this to your application Gemfile:
 
 ```ruby
+source "http://rubygems.org"
+
 gem "xp5k"
 gem "capistrano", "< 3.0.0"
 ```
@@ -13,8 +43,15 @@ and then run
 bundle install
 ```
 
-Configure restfully :
+Note : We encourage you to use [```xpm```](http://rvm.io/)
 
+
+##  Restfully
+
+```xp5k``` makes use of ```restfully``` to perform REST calls to the
+[Grid'5000API](https://api.grid5000.fr).
+
+Fill the ```~/.restfully/api.grid5000.fr.yml``` file with your credentials :
 ```bash
 $) cat ~/.restfully/api.grid5000.fr.yml
 base_uri: https://api.grid5000.fr/3.0
@@ -27,7 +64,14 @@ You are now ready to use ```xp5k``` and ```capistrano```.
 You will find the documentation of capistrano in the following link :
 https://github.com/capistrano/capistrano/wiki
 
-## Sample
+## Ssh config
+
+You can have a look at https://www.grid5000.fr/mediawiki/index.php/Xp5k
+
+# Samples
+
+
+## Hello date
 
 Here is an example of a ```Capfile``` :
 
@@ -110,9 +154,7 @@ cap submit # Submit jobs
 
 For instance you can launch : ```cap submit deploy date```
 
-## Extra features
-
-### Xp5k Roles
+## Xp5k Roles
 
 You can define specific roles in you job submission.
 
@@ -158,7 +200,7 @@ role :server do
 end
 ```
 
-#### Nested roles
+## Nested roles
 
 You can also define nested roles (only 1 level) :
 
@@ -177,7 +219,7 @@ You can also define nested roles (only 1 level) :
 
 ```
 
-#### Pattern
+## Patterns
 
 You can select nodes matching a pattern (`String` or `Regexp`) :
 
@@ -197,7 +239,7 @@ scenario['clusters'].each do |cluster|
 end
 ```
 
-### Get the deployed nodes
+## Get the deployed nodes
 
 Some time nodes fail to be deployed. You can get the exact set
 of nodes deployed in your xp5k job or role using the ```get_deployed_nodes```
@@ -209,7 +251,7 @@ role :clients  do
 end
 ```
 
-### Automatic redeployment
+## Automatic redeployment
 
 If some nodes fail to be deployed, ```xp5k``` will by default
 retry to deploy them up to 3 times.
@@ -227,3 +269,49 @@ You can control this behaviour passing special keys in the deployment hash.
                              # can be a percentage : "80%"
 })
 ```
+
+## Vlan support
+
+```ruby
+@myxp.define_job({
+  :resources => "{type='kavlan'}/vlan=1,nodes=2,walltime=1",
+  :site      => XP5K::Config['site'],
+  :queue     => XP5K::Config[:queue] || 'default',
+  :types     => ["deploy"],
+  :name      => "xp5k_vlan",
+  :command   => "sleep 186400"
+})
+```
+
+```ruby
+@myxp.define_deployment({
+  :site          => "rennes",
+  :environment   => "wheezy-x64-base",
+  :roles         => %w{ xp5k_vlan },
+  :key           => File.read("#{ssh_public}"),
+  :vlan_from_job => 'xp5k_vlan',
+  })
+```
+
+## Non deploy jobs
+
+Here we fill the ```types``` field with ```allow_classic_ssh```. 
+
+```ruby
+@myxp.define_job({
+  :resources  => ["nodes=1, walltime=1"],
+  :site       => "rennes",
+  :retry      => true,
+  :goal       => "100%",
+  :types      => ["allow_classic_ssh"],
+  :name       => "init" ,
+  :command    => "sleep 86400"
+  })
+
+role :myrole do
+   @myxp.job_with_name('init')['assigned_nodes']
+end
+```
+
+You should be able to issue :
+```cap invoke ROLES=myrole USER=<g5k-login> COMMAND=date``` to retrieve the date on all the nodes without deploying.

data/lib/xp5k/version.rb

@@ -1,3 +1,3 @@
 module XP5K
-  VERSION='0.0.9'
+  VERSION='0.0.10'
 end

data/lib/xp5k/xp.rb

@@ -174,7 +174,7 @@ module XP5K
         job.delete if (job['state'] =~ /running|waiting/)
         logger.info "Job ##{job["uid"]} deleted !"
       end
-      FileUtils.rm(".xp_cache")
+      FileUtils.rm(".xp_cache") if File.exists?(".xp_cache")
     end
 
     private

data/xp5k.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = '>= 1.3.6'
 
+  s.add_dependency 'rest-client', '1.6.8' # SSL problems with newer version
   s.add_dependency 'restfully', '>1.0.0'
   s.add_dependency 'term-ansicolor', '>= 1.0.7'
   s.add_dependency 'json', '>= 1.5.1'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: xp5k
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Pascal Morillon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
   name: restfully
   requirement: !ruby/object:Gem::Requirement