kameleon-builder 2.0.0 → 2.1.0

data/.env

@@ -1,10 +1,19 @@
+#!/usr/bin/env bash
+
+export QEMU_AUDIO_DRV=alsa
 export GIT_PROJECT=kameleon
 export ROOT_PROJECT=$(dirname $(readlink -f ${BASH_SOURCE[0]}))
 
 export KAMELEON_LOG=${KAMELEON_LOG:-"info"}
 
+# enable kameleon autocompletion
+source $ROOT_PROJECT/completion/kameleon.bash
+
+QEMU_MONITOR_PORT=11023
+
+
 function kameleon {
-    BUNDLE_GEMFILE=$ROOT_PROJECT/Gemfile sudo -E bundle exec kameleon $@
+    sudo -E BUNDLE_GEMFILE=$ROOT_PROJECT/Gemfile bundle exec kameleon $@
 }
 
 function runtest {
@@ -21,31 +30,70 @@ function devrun_chroot_clean() {
 
 
 function devrun_clear() {
-    KAMELEON_WORKSPACE=${KAMELEON_WORKSPACE:-"/tmp/kameleon/"}
+    KAMELEON_WORKDIR=${KAMELEON_WORKDIR:-"/tmp/kameleon/"}
     RECIPE_DEV_NAME=${RECIPE_DEV_NAME:-"mymachine"}
     devrun_chroot_clean
-    kameleon clear $RECIPE_DEV_NAME -w $KAMELEON_WORKSPACE
-    if [ -d "$KAMELEON_WORKSPACE/builds" ]; then
-       sudo rm "$KAMELEON_WORKSPACE/builds" -fr 2> /dev/null
+    cd $KAMELEON_WORKDIR
+    kameleon clear $RECIPE_DEV_NAME.yaml
+    if [ -d "$KAMELEON_WORKDIR/build" ]; then
+       sudo rm "$KAMELEON_WORKDIR/build" -fr 2> /dev/null
     fi
 }
 
+function devrun_qemu_stop() {
+    if nc -w 0 -z localhost $QEMU_MONITOR_PORT 2>/dev/null
+    then
+        echo "Shutting down qemu virtual machine"
+        echo "system_reset" | nc localhost $QEMU_MONITOR_PORT
+        echo ""
+    fi
+    while nc -w 0 -z localhost $QEMU_MONITOR_PORT
+    do
+      sleep 0.5
+      echo -n "."
+    done
+    echo " ~> OK"
+}
+
 function devrun_qemu() {
-    KAMELEON_WORKSPACE=${KAMELEON_WORKSPACE:-"/tmp/kameleon/"}
+    KAMELEON_WORKDIR=${KAMELEON_WORKDIR:-"/tmp/kameleon/"}
     RECIPE_DEV_NAME=${RECIPE_DEV_NAME:-"mymachine"}
-    path="$KAMELEON_WORKSPACE/builds/$RECIPE_DEV_NAME/${RECIPE_DEV_NAME}.qcow2"
-    sudo qemu-system-x86_64 -enable-kvm $path
+    DRIVE="$KAMELEON_WORKDIR/build/$RECIPE_DEV_NAME/${RECIPE_DEV_NAME}.qcow2"
+    RAM_COUNT=2048
+    SPICE_PORT=5900
+    CPU_COUNT=2
+    sudo qemu-system-x86_64 \
+        -name "$VM_NAME" \
+        -machine pc-1.2,accel=kvm,usb=off -m 2048 -realtime mlock=off \
+        -smp $CPU_COUNT \
+        -drive file="$DRIVE",cache=none,media=disk,if=virtio,id=drive0 \
+        -m $RAM_COUNT \
+        -no-reboot \
+        -rtc base=utc \
+        -soundhw ac97 \
+        -net nic,model=virtio -net user \
+        -usb \
+        -usbdevice tablet \
+        -vga qxl \
+        -spice port=$SPICE_PORT,addr=127.0.0.1,disable-ticketing,image-compression=auto_lz \
+        -device virtio-serial-pci \
+        -device virtserialport,chardev=spicechannel0,name=com.redhat.spice.0 \
+        -chardev spicevmc,id=spicechannel0,name=vdagent \
+        -monitor tcp::$QEMU_MONITOR_PORT,server,nowait \
+        -daemonize
+    spicec -h 127.0.0.1 -p $SPICE_PORT --title "$VM_NAME" || :
+    devrun_qemu_stop
 }
 
 function devrun_build() {
-    KAMELEON_WORKSPACE=${KAMELEON_WORKSPACE:-"/tmp/kameleon/"}
+    KAMELEON_WORKDIR=${KAMELEON_WORKDIR:-"/tmp/kameleon/"}
     RECIPE_DEV_NAME=${RECIPE_DEV_NAME:-"mymachine"}
-    TEMPLATE=${1:-"debian-wheezy-chroot"}
-    devrun_chroot_clean
-    cmd="kameleon new $RECIPE_DEV_NAME -t $TEMPLATE -w $KAMELEON_WORKSPACE \
-         && kameleon build $RECIPE_DEV_NAME -w $KAMELEON_WORKSPACE"
+    TEMPLATE=${1:-"debian7"}
+    mkdir -p $KAMELEON_WORKDIR && cd $KAMELEON_WORKDIR
+    cmd="kameleon new $RECIPE_DEV_NAME $TEMPLATE  \
+         && kameleon build $RECIPE_DEV_NAME.yaml"
     eval "$cmd"
-    if [ -d "$KAMELEON_WORKSPACE/builds/$RECIPE_DEV_NAME" ]; then
-        cd "$KAMELEON_WORKSPACE/builds/$RECIPE_DEV_NAME"
+    if [ -d "$KAMELEON_WORKDIR/build/$RECIPE_DEV_NAME" ]; then
+        cd "$KAMELEON_WORKDIR/build/$RECIPE_DEV_NAME"
     fi
 }

data/.gitignore

@@ -20,3 +20,4 @@ coverage
 # Vagrant local workspace
 .vagrant
 *.log
+bin/*

data/README.rst

@@ -80,8 +80,10 @@ Then build your new recipe with the build command:
 
 A `builds` directory was created and contains your new image!
 
-To go further, it is highly recommended you start with the :doc:`getting_started`
-guide.
+To go further, it is highly recommended you start with the `Getting Started`_ guide.
+
+
+.. _Getting Started: http://kameleon.readthedocs.org/en/latest/getting_started.html
 
 ------------
 Contributing

data/Vagrantfile

@@ -2,66 +2,27 @@
 # vi: set ft=ruby :
 
 
+# Require vagrant-kvm plugin
+ENV['VAGRANT_DEFAULT_PROVIDER'] = 'kvm'
+
 Vagrant.configure("2") do |config|
-  config.vm.box = "debian7-dev"
-  config.vm.box_url = "http://cdn.quicker.fr/vagrant/virtualbox/debian7-dev.box"
+  config.vm.box = "oar-team/kameleon-dev"
   config.vm.hostname = "kameleon-devel"
 
-  # Config provider
-  config.vm.provider :virtualbox do |vm|
-    vm.memory = 2024
-    vm.cpus = 2
-  end
-
-  # shared folders
-  config.vm.synced_folder ".", "/vagrant", :nfs => true
-
-  # Provision
-  config.vm.provision "shell", privileged: true, inline: <<-EOF
-    export DEBIAN_FRONTEND=noninteractive
-    apt-get update
-    apt-get -y --force-yes install git python-pip debootstrap \
-      rsync sed qemu-utils
-
-    apt-get -y --force-yes install ruby1.9.1 ruby1.9.1-dev \
-      rubygems1.9.1 irb1.9.1 ri1.9.1 rdoc1.9.1 \
-      build-essential libopenssl-ruby1.9.1 libssl-dev zlib1g-dev
-
-    update-alternatives --install /usr/bin/ruby ruby /usr/bin/ruby1.9.1 400 \
-             --slave   /usr/share/man/man1/ruby.1.gz ruby.1.gz \
-                            /usr/share/man/man1/ruby1.9.1.1.gz \
-            --slave   /usr/bin/ri ri /usr/bin/ri1.9.1 \
-            --slave   /usr/bin/irb irb /usr/bin/irb1.9.1 \
-            --slave   /usr/bin/rdoc rdoc /usr/bin/rdoc1.9.1
+  config.vm.provision "docker", images: ["scratch"]
 
-    # choose your interpreter
-    # changes symlinks for /usr/bin/ruby , /usr/bin/gem
-    # /usr/bin/irb, /usr/bin/ri and man (1) ruby
-    update-alternatives --set ruby /usr/bin/ruby1.9.1
+  config.ssh.forward_x11 = true
+  config.ssh.forward_agent = true
 
-    gem install bundle
+  config.vm.provider :kvm do |kvm|
+    kvm.memory_size = "2GiB"
+    kvm.core_number = 2
+  end
 
-    # Helpful tools
-    pip install pyped
-  EOF
+  config.vm.synced_folder ".", "/home/vagrant/kameleon"
 
   config.vm.provision "shell", privileged: false, inline: <<-EOF
-    cat > ~/.bash_profile <<< "
-    export FORCE_AUTOENV=1
-    source ~/.profile
-    source /vagrant/.env
-    cd /vagrant
-    "
-    cd /vagrant && git stash && bundle install && git stash pop
+    cd /home/vagrant/kameleon && bundle install
   EOF
 
-  # shared folders
-  if File.exists? File.expand_path('~/.dotfiles')
-    config.vm.synced_folder "~/.dotfiles", "/home/vagrant/.dotfiles", :nfs => true
-    config.vm.provision "shell", privileged: false, inline: "python /home/vagrant/.dotfiles/install.py"
-  end
-
-  # Network
-  config.ssh.forward_agent = true
-  config.vm.network :private_network, ip: "10.10.10.120"
 end

data/bin/kameleon

@@ -7,6 +7,11 @@ Signal.trap("INT") { exit 1 }
 $stdout.sync = true
 $stderr.sync = true
 
+require 'log4r-color'
+require 'log4r-color/configurator'
+
+# This is how we specify our levels
+Log4r::Configurator.custom_levels "DEBUG", "INFO", "PROGRESS_INFO", "NOTICE", "PROGRESS_NOTICE", "WARN", "ERROR", "PROGRESS_ERROR", "FATAL"
 require 'kameleon'
 
 require 'kameleon/cli'

data/completion/_kameleon.zsh

@@ -0,0 +1,18 @@
+#!/usr/bin/env zsh
+
+if [[ ! -o interactive ]]; then
+    return
+fi
+
+compctl -f -K _kameleon kameleon
+
+_kameleon() {
+  local words completions
+  read -cA words
+
+  if [ "${#words}" -eq 2 ]; then
+    completions="$(kameleon commands)"
+  fi
+
+  reply=("${(ps:\n:)completions}")
+}

data/completion/kameleon.bash

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+_kameleon() {
+    COMPREPLY=()
+    local word="${COMP_WORDS[COMP_CWORD]}"
+
+    if [ "$COMP_CWORD" -eq 1 ]; then
+        local commands="$(compgen -W "$(kameleon commands)" -- "$word")"
+        COMPREPLY=( $commands $projects )
+    fi
+}
+
+complete -o default -F _kameleon kameleon

data/completion/kameleon.fish

@@ -0,0 +1,10 @@
+complete -c kameleon -l help --description "Describe available commands or one specific command" \
+         -a 'help new templates version build checkpoints clear'
+
+complete -c kameleon -l build --description "Builds the appliance from the recipe"
+complete -c kameleon -l clean --description "Cleaning 'out' and 'local' context and removing all checkpoints"
+complete -c kameleon -l checkpoints --description "Lists all availables checkpoints"
+complete -c kameleon -l version --description "Prints the Kameleon's version information"
+complete -c kameleon -l new --description "Creates a new recipe"
+complete -c kameleon -l import --description "Imports the given template"
+complete -c kameleon -l templates --description "Lists all defined templates"

data/contrib/polipo_env.sh

@@ -0,0 +1,2 @@
+export http_proxy=http://10.0.2.2:<%= @cache.polipo_port %>
+export ftp_proxy=http://10.0.2.2:<%= @cache.polipo_port %>

data/contrib/steps/export/save_as_g5k.yaml

@@ -0,0 +1,63 @@
+# Save as a g5k
+# Export a Grid5000 compliant tar gz image and create the kadeploy config
+- save_as_g5k:
+  - in2out:
+    - /etc/fstab
+    - ./fstab.bak
+  - on_clean:
+    - exec_out: rm -f ./fstab.bak
+  - exec_in: apt-get -f install -y --force-yes ssh libmlx4-1 libmlx4-dev
+  - write_in:
+    - /etc/fstab
+    - |
+      # UNCONFIGURED FSTAB FOR BASE SYSTEM
+  - write_in:
+    - /etc/apt/apt.conf
+    - |
+      APT::Get::AllowUnauthenticated "true";
+  - write_in:
+    - /etc/modules
+    - |
+      ib_ipoib
+      ib_uverbs
+      ib_umad
+      ib_addr
+      mlx4_ib
+      ib_mthca
+  - exec_in: wget  --no-check-certificate https://gforge.inria.fr/frs/download.php/28557/tgz-g5k_1.0.7_all.deb
+  - exec_in: dpkg -i ./tgz-g5k_1.0.7_all.deb
+  - exec_in: rm ./tgz-g5k_1.0.7_all.deb
+  - exec_in: tgz-g5k /tmp/$$filename.tar.gz
+  - in2out:
+    - /tmp/$$filename.tar.gz
+    - $$filename.tar.gz
+  - out2in:
+    - ./fstab.bak
+    - /etc/fstab
+  - exec_out: |
+      echo "Saved tar.gz appliance to $(pwd)/$$filename.tar.gz"
+  - write_out: 
+    - $${kameleon_recipe_name}_img.yaml
+    - |
+      #
+      # Kameleon generated $$distrib $$release kadeploy description file
+      #
+      ---
+      name: $${kameleon_recipe_name}
+      
+      version: 1
+      
+      os: linux
+      
+      image:
+        file: $$g5k_img_path/$$filename.tar.gz
+        kind: tar
+        compression: gzip
+      
+      boot:
+        kernel: /boot/`basename $$rootfs/boot/vmlinu*`
+        initrd: /boot/`basename $$rootfs/boot/init*`
+      
+      filesystem: $$filesystem
+
+

data/contrib/steps/setup/add_to_sudoers.yaml

@@ -0,0 +1,5 @@
+- add_group_to_sudoers:
+  - append_in:
+    - /etc/sudoers
+    - |
+      %$$group ALL=(ALL:ALL) ALL

data/docs/Makefile

@@ -64,6 +64,10 @@ singlehtml:
 	@echo
 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 
+publish: html
+	rsync -avh -e "ssh" $(BUILDDIR)/html/ kameleon.website:~/www
+
+
 pickle:
 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 	@echo
@@ -78,13 +82,13 @@ htmlhelp:
 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 	@echo
 	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+		  ".hhp project file in $(BUILDDIR)/htmlhelp."
 
 qthelp:
 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+		  ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Kameleon.qhcp"
 	@echo "To view the help file:"
 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Kameleon.qhc"
@@ -108,7 +112,7 @@ latex:
 	@echo
 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
+		  "(use \`make latexpdf' here to do that automatically)."
 
 latexpdf:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@@ -137,7 +141,7 @@ texinfo:
 	@echo
 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
 	@echo "Run \`make' in that directory to run these through makeinfo" \
-	      "(use \`make info' here to do that automatically)."
+		  "(use \`make info' here to do that automatically)."
 
 info:
 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@@ -159,12 +163,12 @@ linkcheck:
 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
+		  "or in $(BUILDDIR)/linkcheck/output.txt."
 
 doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
+		  "results in $(BUILDDIR)/doctest/output.txt."
 
 xml:
 	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml

data/docs/README.md

@@ -0,0 +1,17 @@
+Kameleon documentation
+======================
+
+The Kameleon documentation is written in ReStructured Text (.rst) format.
+You can generate a documentaion from the rst source file to (almost) any
+format with Sphinx. To do so, just 
+[install Sphinx](http://sphinx-doc.org/latest/install.html) and run for example:
+```
+make html
+```
+Now you can visualise the created documentation like this:
+```
+firefox ./build/html/index.html
+```
+
+An online version of this documentation can be found at this adresse:
+<http://kameleon.readthedocs.org>

data/docs/source/aliases.rst

@@ -1,3 +1,5 @@
+.. _`aliases`:
+
 -------
 Aliases
 -------
@@ -6,10 +8,10 @@ The aliases can be used anywhere instead of a Kameleon command. Some aliases
 are provided with the templates in the ``aliases/defaults.yaml`` files within
 your workspace. You can add your own aliases in this file.
 
-An alias is define by his name as a key and a list of commands as a value. You
+An alias is define by its name as a key and a list of commands as a value. You
 can call an alias with any number of arguments given in a list.
 
-The alias access to this arguments using the ``@arg_index`` notation. The
+The alias access this arguments using the ``@arg_index`` notation. The
 argument index start at 1. So, ``@1`` is the first argument ``@2`` is the
 second ans so on.