nitos_testbed_rc 1.0.0.pre.2 → 1.0.0.pre.4

data/README.md

@@ -1,4 +1,4 @@
-Nitos Testbed resource controllers
+Nitos Testbed resource controllers (NTRC)
 =================
 
 Contains:
@@ -14,3 +14,166 @@ save and load images to nodes.
 
 These tools are under development. Unpredictable behaviour is to be expected untill
 a stable version is provided.
+
+Installation
+------------
+
+First you need to install the gem
+  
+    % gem install nitos_testbed_rc --pre
+
+Then you need to run the install_ntrc script to generate the configuration files.
+
+    % install_ntrc
+
+Create certificates
+-------------------
+
+Use omf_cert.rb script to generate the following certificates and place them on directories '/root/.omf' and /root/.omf.
+
+    % mkdir /root/.omf
+    % mkdir /root/.omf/trusted_roots
+    % cd /root/.omf
+
+Create a root certificate (change DOMAIN)
+
+    % ruby omf_cert.rb --email root@DOMAIN -o /root/.omf/trusted_roots/root.pem --duration 5000000 create_root
+
+Create a certificate for user_proxy of NTRC (change DOMAIN, XMPP_DOMAIN and if you wish the output file names).
+
+    % ruby omf_cert.rb -o user_factory.pem --email user_factory@DOMAIN --resource-type user_factory --resource-id xmpp://user_factory@XMPP_DOMAIN --root /root/.omf/trusted_roots/root.pem --duration 50000000 create_resource
+
+Create a certificate for cm_proxy of NTRC (change DOMAIN, XMPP_DOMAIN and if you wish the output file names).
+
+    % ruby omf_cert.rb -o cm_factory.pem --email cm_factory@DOMAIN --resource-type cm_factory --resource-id xmpp://cm_factory@XMPP_DOMAIN --root /root/.omf/trusted_roots/root.pem --duration 50000000 create_resource
+
+Create a certificate for frisbee_proxy of NTRC (change DOMAIN, XMPP_DOMAIN and if you wish the output file names).
+
+    % ruby omf_cert.rb -o cm_factory.pem --email cm_factory@DOMAIN --resource-type cm_factory --resource-id xmpp://cm_factory@XMPP_DOMAIN --root /root/.omf/trusted_roots/root.pem --duration 50000000 create_resource
+
+Create a certificate for the omf6 script, this certificate is inside the directory '~/.omf', every user of the testbed should have his own certificate in order to use omf6 script (change DOMAIN, USERNAME and if you wish the output file names).
+
+    % ./omf_cert.rb -o user_cert.pem --email root@DOMAIN --user root --root ~/.omf/trusted_roots/root.pem --duration 50000000 --geni_uri URI:urn:publicid:IDN+DOMAIN+user+USERNAME create_user
+
+Configuration files
+-------------------
+
+Change configuration file '/etc/nitos_testbed/user_proxy_conf.yaml', which is related to user_proxy of NTRC. For example:
+
+    #xmpp details
+    :xmpp:
+      :username: user_proxy
+      :password: pw
+      :server: DOMAIN
+    #x509 certificates to be used by user_proxy
+    :auth:
+      :root_cert_dir: ~/.omf/trusted_roots
+      :entity_cert: ~/.omf/user_factory.pem
+      :entity_key: ~/.omf/user_factory.pkey
+    #operation mode for OmfCommon.init (development, production, etc)
+    :operationMode: development 
+
+Change configuration file '/etc/nitos_testbed/cm_proxy_conf.yaml', which is related to cm_proxy of NTRC. For example:
+
+    #details to be used for the connection to the xmpp server
+    :xmpp:
+      :username: cm_proxy
+      :password: pw
+      :server: DOMAIN
+    #x509 certificates to be used by cm_proxy
+    :auth:
+      :root_cert_dir: ~/.omf/trusted_roots
+      :entity_cert: ~/.omf/cm_factory.pem
+      :entity_key: ~/.omf/cm_factory.pkey
+
+    #time (in seconds) before timeout error occurs
+    :timeout: 80
+    #operation mode for OmfCommon.init (development, production, etc)
+    :operationMode: development
+    #testbed xmpp topic
+    :testbedTopic: am_controller
+
+Change configuration file '/etc/nitos_testbed/frisbee_proxy_conf.yaml', which is related to frisbee_proxy of NTRC. For example:
+    
+    #xmpp details
+    :xmpp:
+      :username: frisbee_proxy
+      :password: pw
+      :server: DOMAIN
+    #x509 certificates to be used by user_proxy
+    :auth:
+      :root_cert_dir: ~/.omf/trusted_roots
+      :entity_cert: ~/.omf/frisbee_factory.pem
+      :entity_key: ~/.omf/frisbee_factory.pkey
+
+    #operation Mode for OmfCommon.init (development, production, etc)
+    :operationMode: development
+
+    #testbed xmpp topic
+    :testbedTopic: am_controller
+
+    #frisbee and imagezip configuration
+    :frisbee:
+      # Directory images are stored
+      :imageDir: /var/lib/omf-images-6
+      #defaultImage: orbit-baseline
+      :defaultImage: baseline.ndz
+
+      # max bandwidth for frisbee server
+      :bandwidth: 50000000
+
+      # Multicast address to use for servicing images
+      #mcAddress: 224.0.0.2
+      :mcAddress: 224.0.0.1
+      # Using ports starting at ...
+      :startPort: 7000
+
+      # Time out frisbee server if nobody requested it within TIMEOUT sec
+      :timeout: 3600
+
+      # Directory to find frisbee daemons
+      :frisbeedBin: /usr/sbin/frisbeed
+      :frisbeeBin: /usr/sbin/frisbee
+      :imagezipClientBin: /usr/bin/imagezip
+      :imagezipServerBin: /bin/nc
+
+      # Local interface to bind to for frisbee traffic
+      #multicastIF: 192.168.204.1
+      :multicastIF: 10.0.1.200
+
+Change configuration file '~/.omf/etc/user_proxy_conf.yaml', which is related to omf6 script of NTRC, every user of the testbed should have his own configuration file in order to use omf6 script. For example:
+
+    :xmpp:
+      :script_user: script_user
+      :password: pw
+      :server: DOMAIN
+    :auth:
+      :root_cert_dir: ~/.omf/trusted_roots
+      :entity_cert: ~/.omf/user_cert.pem
+      :entity_key: ~/.omf/user_cert.pkey
+    #operation mode for OmfCommon.init (development, production, etc)
+    :operationMode: development
+    #omf script configuration
+    :omf_script:
+      #default last action on load and save commands (reset or shutdown)
+      :last_action: reset
+
+Run proxies
+-----------
+
+You can execute all proxies with one command:
+
+    % run_proxies
+
+Or you run proxies seperatly
+
+    % user_proxy
+    % cm_proxy
+    % frisbee_proxy
+
+Run omf6 commands
+-----------------
+
+Now you can use omf6 script to execute omf6 related commands
+
+    % omf6 --help

data/bin/cm_proxy

@@ -77,10 +77,12 @@ class CmPDP
               leases = l_msg.read_property("leases")[:resources]
               leases.each do |l|
                 if Time.parse(l[:resource][:valid_from]) <= Time.now && Time.parse(l[:resource][:valid_until]) >= Time.now
-                  l[:resource][:components].each do |c|
-                    if c[:component][:name] == node_name.to_s && l[:resource][:account][:name] == acc
-                      lease = l
-                      break #found the correct lease
+                  unless l[:resource][:components].nil?
+                    l[:resource][:components].each do |c|
+                      if c[:component][:name] == node_name.to_s && l[:resource][:account][:name] == acc
+                        lease = l
+                        break #found the correct lease
+                      end
                     end
                   end
                 end

data/bin/install_ntrc

@@ -4,6 +4,7 @@ require 'fileutils'
 spec = Gem::Specification.find_by_name("nitos_testbed_rc")
 gem_root = spec.gem_dir
 config_path = "/etc/nitos_testbed_rc"
+log_path = "/var/log/ntrc"
 
 puts "Copying configuration files from '#{gem_root}'."
 
@@ -12,6 +13,11 @@ unless File.directory?(config_path)
   FileUtils.mkdir_p(config_path)
 end
 
+unless File.directory?(log_path)
+  puts "Generating directory '#{log_path}'."
+  FileUtils.mkdir_p(log_path)
+end
+
 conf_files = []
 conf_files << "cm_proxy_conf.yaml"
 conf_files << "frisbee_proxy_conf.yaml"
@@ -24,7 +30,7 @@ conf_files.each do |file|
   FileUtils.chmod 0644, "#{config_path}/#{file}"
 end
 
-config_path = "~/.omf/etc"
+config_path = File.expand_path("~/.omf/etc")
 unless File.directory?(config_path)
   puts "Generating directory '#{config_path}'."
   FileUtils.mkdir_p(config_path)
@@ -32,4 +38,17 @@ end
 
 FileUtils.cp "#{gem_root}/etc/omf_script_conf.yaml", "#{config_path}/omf_script_conf.yaml"
 FileUtils.chmod 0644, "#{config_path}/omf_script_conf.yaml"
+
+puts "Copying initialization script 'run_ntrc.sh'."
+FileUtils.cp "#{gem_root}/init/run_ntrc.sh", "/usr/local/bin/run_ntrc.sh"
+
+FileUtils.cp "#{gem_root}/init/ntrc.conf", "/etc/init/ntrc.conf"
+FileUtils.cp "#{gem_root}/init/ntrc_user.conf", "/etc/init/ntrc_user.conf"
+FileUtils.cp "#{gem_root}/init/ntrc_frisbee.conf", "/etc/init/ntrc_frisbee.conf"
+FileUtils.cp "#{gem_root}/init/ntrc_cm.conf", "/etc/init/ntrc_cm.conf"
+puts "Upstart scripts has been installed."
+puts "Execute 'start ntrc' to run all the proxies."
+puts "Execute 'start ntrc_frisbee' to run frisbee proxy."
+puts "Execute 'start ntrc_user' to run user proxy."
+puts "Execute 'start ntrc_cm' to run cm proxy."
 puts "done."

data/bin/omf6

@@ -3,8 +3,9 @@ require 'rubygems'
 require 'time'
 require 'omf_common'
 require 'optparse'
+CONF_PATH = '~/.omf/etc/omf_script_conf.yaml'
 
-@config = YAML.load_file('~/.omf/etc/omf_script_conf.yaml')
+@config = YAML.load_file(File.expand_path(CONF_PATH))
 # @config = YAML.load_file(File.join(File.dirname(File.expand_path(__FILE__)), '.../etc/omf_script_conf.yaml'))
 @auth = @config[:auth]
 @xmpp = @config[:xmpp]

data/etc/cm_proxy_conf.yaml

@@ -5,9 +5,9 @@
   :server: testserver
 #x509 certificates to be used by cm_proxy
 :auth:
-  :root_cert_dir: ~/.omf/trusted_roots
-  :entity_cert: ~/.omf/cm_factory.pem
-  :entity_key: ~/.omf/cm_factory.pkey
+  :root_cert_dir: /root/.omf/trusted_roots
+  :entity_cert: /root/.omf/cm_factory.pem
+  :entity_key: /root/.omf/cm_factory.pkey
 
 #time (in seconds) before timeout error occurs
 :timeout: 80

data/etc/frisbee_proxy_conf.yaml

@@ -5,9 +5,9 @@
   :server: testserver
 #x509 certificates to be used by user_proxy
 :auth:
-  :root_cert_dir: ~/.omf/trusted_roots
-  :entity_cert: ~/.omf/frisbee_factory.pem
-  :entity_key: ~/.omf/frisbee_factory.pkey
+  :root_cert_dir: /root/.omf/trusted_roots
+  :entity_cert: /root/.omf/frisbee_factory.pem
+  :entity_key: /root/.omf/frisbee_factory.pkey
 
 #operation Mode for OmfCommon.init (development, production, etc)
 :operationMode: development

data/etc/user_proxy_conf.yaml

@@ -5,8 +5,8 @@
   :server: testserver
 #x509 certificates to be used by user_proxy
 :auth:
-  :root_cert_dir: ~/.omf/trusted_roots
-  :entity_cert: ~/.omf/user_factory.pem
-  :entity_key: ~/.omf/user_factory.pkey
+  :root_cert_dir: /root/.omf/trusted_roots
+  :entity_cert: /root/.omf/user_factory.pem
+  :entity_key: /root/.omf/user_factory.pkey
 #operation mode for OmfCommon.init (development, production, etc)
 :operationMode: development

data/init/ntrc.conf

@@ -0,0 +1,6 @@
+description     "NITOS Testbed Resource Controllers pack"
+author          "NITOS <nitlab@inf.uth.gr>"
+
+start on (filesystem and net-device-up IFACE=lo)
+stop on runlevel [!2345]
+

data/init/ntrc_cm.conf

@@ -0,0 +1,14 @@
+description     "NITOS proxy for cm controller of NITOS Testbed resource controllers pack"
+author          "NITOS <nitlab@inf.uth.gr>"
+
+start on starting ntrc
+stop on stopping ntrc
+
+env DAEMON=/usr/local/bin/run_ntrc.sh
+
+respawn
+
+script
+  PATH=$PATH:/usr/bin:/usr/local/bin
+  exec $DAEMON 3 2>&1
+end script

data/init/ntrc_frisbee.conf

@@ -0,0 +1,14 @@
+description     "NITOS proxy for frisbee controller of NITOS Testbed resource controllers pack"
+author          "NITOS <nitlab@inf.uth.gr>"
+
+start on starting ntrc
+stop on stopping ntrc
+
+env DAEMON=/usr/local/bin/run_ntrc.sh
+
+respawn
+
+script
+  PATH=$PATH:/usr/bin:/usr/local/bin
+  exec $DAEMON 2 2>&1
+end script

data/init/ntrc_user.conf

@@ -0,0 +1,14 @@
+description     "NITOS proxy for user controller of NITOS Testbed resource controllers pack"
+author          "NITOS <nitlab@inf.uth.gr>"
+
+start on starting ntrc
+stop on stopping ntrc
+
+env DAEMON=/usr/local/bin/run_ntrc.sh
+
+respawn
+
+script
+  PATH=$PATH:/usr/bin:/usr/local/bin
+  exec $DAEMON 1 2>&1
+end script

data/init/run_ntrc.sh

@@ -0,0 +1,86 @@
+#!/bin/bash
+
+# Startup wrapper for the nitos_testbed_rc
+# detects system-wide RVM installations & Ruby from distro packages
+
+# system-wide RVM must be installed using
+# '\curl -L https://get.rvm.io | sudo bash -s stable'
+
+die() { echo "ERROR: $@" 1>&2 ; exit 1; }
+
+RUBY_VER="ruby-1.9.3-p448"
+RUBY_BIN_SUFFIX=""
+
+if [ `id -u` != "0" ]; then
+  die "This script is intended to be run as 'root'"
+fi
+
+if [ -e /etc/profile.d/rvm.sh ]; then
+    # use RVM if installed
+    echo "System-wide RVM installation detected"
+    source /etc/profile.d/rvm.sh
+    if [[ $? != 0 ]] ; then
+        die "Failed to initialize RVM environment"
+    fi
+    # rvm use $RUBY_VER@omf > /dev/null
+    # if [[ $? != 0 ]] ; then
+    #     die "$RUBY_VER with gemset 'omf' is not installed in your RVM"
+    # fi
+    ruby -v | grep 1.9.3  > /dev/null
+    if [[ $? != 0 ]] ; then
+        die "Could not run Ruby 1.9.3"
+    fi
+    gem list | grep nitos_testbed_rc  > /dev/null
+    if [[ $? != 0 ]] ; then
+        die "The nitos_testbed_rc gem is not installed in the 'omf' gemset"
+    fi
+else
+    # check for distro ruby when no RVM was found
+    echo "No system-wide RVM installation detected"
+    ruby -v | grep 1.9.3  > /dev/null
+    if [[ $? != 0 ]] ; then
+        ruby1.9.3 -v | grep 1.9.3  > /dev/null
+        if [[ $? != 0 ]] ; then
+            die "Could not run system Ruby 1.9.3. No useable Ruby installation found."
+        fi
+        RUBY_BIN_SUFFIX="1.9.3"
+    fi
+    echo "Ruby 1.9.3 found"
+    gem$RUBY_BIN_SUFFIX list | grep nitos_testbed_rc  > /dev/null
+    if [[ $? != 0 ]] ; then
+        die "The nitos_testbed_rc gem is not installed"
+    fi
+fi
+
+EXEC=""
+
+case "$1" in
+
+1)  echo "Starting user_proxy"
+    EXEC=`which user_proxy`
+    if [[ $? != 0 ]] ; then
+        die "could not find user_proxy executable"
+    fi
+    ;;
+2)  echo "Starting frisbee_proxy"
+    EXEC=`which frisbee_proxy`
+    if [[ $? != 0 ]] ; then
+        die "could not find frisbee_proxy executable"
+    fi
+    ;;
+3)  echo "Starting cm_proxy"
+    EXEC=`which cm_proxy`
+    if [[ $? != 0 ]] ; then
+        die "could not find cm_proxy executable"
+    fi
+    ;;
+*) echo "Starting run_proxy"
+    EXEC=`which run_proxy`
+    if [[ $? != 0 ]] ; then
+        die "could not find run_proxy executable"
+    fi
+    ;;
+esac
+
+echo "Running $EXEC"
+exec /usr/bin/env ruby$RUBY_BIN_SUFFIX $EXEC 

data/lib/version.rb

@@ -1,5 +1,5 @@
 module NITOS
   module TestbedRc
-    VERSION = "1.0.0.pre.2"
+    VERSION = "1.0.0.pre.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nitos_testbed_rc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.2
+  version: 1.0.0.pre.4
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omf_common
@@ -101,6 +101,11 @@ files:
 - etc/frisbee_proxy_conf.yaml
 - etc/omf_script_conf.yaml
 - etc/user_proxy_conf.yaml
+- init/ntrc.conf
+- init/ntrc_cm.conf
+- init/ntrc_frisbee.conf
+- init/ntrc_user.conf
+- init/run_ntrc.sh
 - lib/nitos_testbed_rc.rb
 - lib/nitos_testbed_rc/cm_factory.rb
 - lib/nitos_testbed_rc/frisbee.rb