kameleon-builder 2.0.0.dev

data/lib/kameleon/utils.rb

@@ -0,0 +1,45 @@
+module Kameleon
+  module Utils
+
+    def self.resolve_vars(raw, yaml_path, initial_variables)
+      raw.to_s.gsub(/\$\$\{[a-zA-Z0-9\-_]+\}|\$\$[a-zA-Z0-9\-_]+/) do |var|
+        # remove the dollars
+        if var.include? "{"
+          strip_var = var[3,(var.length - 4)]
+        else
+          strip_var = var[2,(var.length - 2)]
+        end
+        # check in local vars
+        if initial_variables.has_key? strip_var
+          value = initial_variables[strip_var]
+        else
+          fail RecipeError, "#{yaml_path}: variable #{var} not found in local or global"
+        end
+        return $` + resolve_vars(value.to_s + $', yaml_path, initial_variables)
+      end
+    end
+
+    def self.generate_slug(str)
+        value = str.strip
+        value.gsub!(/['`]/, "")
+        value.gsub!(/\s*@\s*/, " at ")
+        value.gsub!(/\s*&\s*/, " and ")
+        value.gsub!(/\s*[^A-Za-z0-9\.]\s*/, '_')
+        value.gsub!(/_+/, "_")
+        value.gsub!(/\A[_\.]+|[_\.]+\z/, "")
+        value
+    end
+
+    def self.extract_meta_var(name, content)
+        start_regex = Regexp.escape("# #{name.upcase}: ")
+        end_regex = Regexp.escape("\n#\n")
+        reg = %r/#{ start_regex }(.*?)#{ end_regex }/m
+        var = content.match(reg).captures.first
+        var.gsub!("\n#", "")
+        var.gsub!("  ", " ")
+        return var
+    rescue
+    end
+
+  end
+end

data/lib/kameleon/version.rb

@@ -0,0 +1,3 @@
+module Kameleon
+  VERSION = "2.0.0.dev" unless defined?(::Kameleon::VERSION)
+end

data/templates/COPYRIGHT

@@ -0,0 +1,21 @@
+#    Kameleon recipes and steps
+#    ==========================
+#
+#    All the files and subdirectories in this directory are part of the
+#    kameleon tool distributed under this copyright.
+#    Copyright (C) 2009-2010 LIG <http://lig.imag.fr/>
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program; if not, write to the Free Software
+#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+

data/templates/aliases/defaults.yaml

@@ -0,0 +1,83 @@
+write_local:
+  - exec_local: |
+      mkdir -p $(dirname @1);
+      cat >@1 <<<"@2"
+
+write_in:
+  - exec_in: |
+      mkdir -p $(dirname @1);
+      cat >@1 <<<"@2"
+
+write_out:
+  - exec_out: |
+      mkdir -p $(dirname @1);
+      cat >@1 <<<"@2"
+
+append_local:
+  - exec_local: |
+      mkdir -p $(dirname @1);
+      cat >>@1 <<<"@2"
+append_in:
+  - exec_in: |
+      mkdir -p $(dirname @1);
+      cat >>@1 <<<"@2"
+
+append_out:
+  - exec_out: |
+      mkdir -p $(dirname @1);
+      cat >>@1 <<<"@2"
+
+local2out:
+  - exec_out: |
+      mkdir -p $(dirname @2)"
+  - pipe:
+      - exec_local: cat @1
+      - exec_out: cat > @2
+
+local2in:
+  - exec_in: mkdir -p $(dirname @2)
+  - pipe:
+      - exec_local: cat @1
+      - exec_in: cat > @2
+
+out2local:
+  - exec_local: mkdir -p $(dirname @2)
+  - pipe:
+      - exec_out: cat @1
+      - exec_local: cat > @2
+
+out2in:
+  - exec_in: mkdir -p $(dirname @2)
+  - pipe:
+      - exec_out: cat @1
+      - exec_in: cat > @2
+
+in2local:
+  - exec_local: mkdir -p $(dirname @2)
+  - pipe:
+      - exec_in: cat @1
+      - exec_local: cat > @2
+
+in2out:
+  - exec_out: mkdir -p $(dirname @2)
+  - pipe:
+      - exec_in: cat @1
+      - exec_out: cat > @2
+
+check_cmd_out:
+  - on_bootstrap_init:
+    - rescue: 
+      - exec_out: command -V @1 2> /dev/null
+      - breakpoint: "@1 is missing"
+
+check_cmd_local:
+  - on_bootstrap_init:
+    - rescue: 
+      - exec_local: command -V @1 2> /dev/null
+      - breakpoint: "@1 is missing"
+
+check_cmd_in:
+  - on_bootstrap_init:
+    - rescue: 
+      - exec_in: command -V @1 2> /dev/null
+      - breakpoint: "@1 is missing"

data/templates/checkpoints/docker.yaml

@@ -0,0 +1,14 @@
+create: |
+    if [ -f MAIN_CONTAINER_ID ] ; then
+      docker commit $(cat MAIN_CONTAINER_ID) $$docker_image:@microstep_id
+    fi
+
+apply: |
+    docker tag $$docker_image:@microstep_id $$docker_image:latest
+
+list: |
+    docker images | grep $$docker_image | awk '{print $2}'
+
+clear: |
+    docker images | grep $$docker_image | awk '{print $3}' \
+    | xargs -I {} bash -c "docker rmi {} | cat || true"

data/templates/checkpoints/qcow2.yaml

@@ -0,0 +1,44 @@
+create: |
+    if [ -e "$$container" ] ; then
+      parent_of_@microstep_id="$(readlink $$container)"
+      mkdir -p checkpoints
+      pushd checkpoints
+      rm -f @microstep_id_$${container}
+      qemu-img create -f qcow2 "@microstep_id_$${container}" \
+                      -o backing_file=$(basename "$parent_of_@microstep_id")
+      popd
+      ln -sf checkpoints/@microstep_id_$$container $$container
+
+      lsmod | grep nbd >/dev/null || modprobe nbd max_part=63
+
+      echo "sync" ; sync
+      qemu-nbd -d $$nbd_device
+      qemu-nbd -c $$nbd_device "$(readlink $$container)"
+    fi
+
+apply: |
+    # apply command use the backing file that represent the real state to restore
+    previous_id=$(qemu-img info "checkpoints/@microstep_id_$${container}" \
+                  | grep backing \
+                  | sed -e 's/.*checkpoints\/\(.*\)_$${container}\(.*\)/\1/p' \
+                  | uniq)
+    
+    ln -sf "checkpoints/${previous_id}_$${container}" "$$container"
+
+    lsmod | grep nbd >/dev/null || modprobe nbd max_part=63
+
+    echo "sync" ; sync
+    qemu-nbd -d $$nbd_device
+    qemu-nbd -c $$nbd_device "$(readlink $$container)"
+
+clear: |
+    if [ -d "checkpoints" ] ; then
+      ls checkpoints/ | \
+        xargs -I {} bash -c "echo Removing checkpoints/{} ; rm checkpoints/{}"
+      rm -f $$container
+    fi
+
+list: |
+    if [ -d "checkpoints" ] ; then
+      ls checkpoints/ | sed -e 's/\(.*\)_$${container}/\1/p' | uniq
+    fi

data/templates/debian-wheezy-chroot.yaml

@@ -0,0 +1,98 @@
+#==============================================================================
+# vim: softtabstop=2 shiftwidth=2 expandtab fenc=utf-8 cc=81 tw=80
+#==============================================================================
+#
+# RECIPE: <%= recipe_name %>
+#
+# DESCRIPTION: Build a debian wheezy appliance using chroot and qemu-nbd.
+#
+# TEMPLATE: <%= @name %>
+#
+#==============================================================================
+
+---
+# Loads some helpful aliases
+aliases: defaults.yaml
+# Enables qcow2 checkpoint
+checkpoint: qcow2.yaml
+#== Global variables use by Kameleon engine and the steps
+global:
+  ## User varibales : used by the recipe
+  cachedir: /var/cache/kameleon
+  rootfs: $$kameleon_cwd/rootfs
+  user_name: kameleon
+  arch: amd64
+
+  nbd_device: /dev/nbd10
+  container: "$${kameleon_recipe_name}_temp.qcow2"
+
+  distrib: debian
+  release: wheezy
+
+  ## System variables. Required by kameleon engine
+  # Include specific steps
+  include_steps: [$$distrib/$$release, $$distrib]
+
+  # Shell session from where we launch exec_out commands. There is often a
+  # local bash session, but it can be a remote shell on other machines or on
+  # any shell. (eg. bash, chroot, fakechroot, ssh, tmux, lxc...)
+  out_context:
+    cmd: bash
+    workdir: $$kameleon_cwd
+
+  # Shell session that allows us to connect to the building machine in order to
+  # configure it and setup additional programs
+  default_env: "USER=root HOME=/root LC_ALL=POSIX"
+  in_context:
+    cmd: $$default_env chroot $$rootfs bash
+    workdir: /
+
+#== Bootstrap the new system and create the 'in_context'
+bootstrap:
+  - debootstrap:
+    - release: $$release
+    - arch: $$arch
+    - repository: http://ftp.fr.debian.org/debian/
+    - rootfs_archive: $$cachedir/$$distrib/$$release/$$arch/debootstrap.tar.gz
+  - prepare_appliance_with_nbd:
+    - mountdir: $$rootfs
+    - image_size: 2G
+    - filesystem_type: ext4
+    - rootfs_archive: $$cachedir/$$distrib/$$release/$$arch/debootstrap.tar.gz
+  - start_chroot:
+    - rootfs: $$rootfs
+
+
+#== Install and configuration steps
+# WARNING: this part should be independante from the build context (whenever
+# possible...)
+setup:
+  # Install
+  - software_install:
+    - packages: >
+        debian-keyring ntp zip unzip rsync sudo less vim bash-completion
+  - kernel_install:
+    - arch: $$arch
+  # Configuration
+  - system_config:
+    - locales: fr_FR en_US
+    - lang: fr_FR.UTF-8
+    - timezone: Europe/Paris
+  - keyboard_config:
+    - layout: "fr,us"
+  - network_config:
+    - hostname: kameleon-$$distrib
+  - create_user:
+    - name: $$user_name
+    - group: admin
+    - password: $$user_name
+
+#== Export the generated appliance in the format of your choice
+export:
+  - save_appliance_from_nbd:
+    - filename: "$${kameleon_recipe_name}"
+    - save_as_qcow2
+    # - save_as_tgz
+    # - save_as_raw
+    # - save_as_vmdk
+    # - save_as_vdi

data/templates/debian-wheezy-docker.yaml

@@ -0,0 +1,97 @@
+#==============================================================================
+# vim: softtabstop=2 shiftwidth=2 expandtab fenc=utf-8 cc=81 tw=80
+#==============================================================================
+#
+# RECIPE: <%= recipe_name %>
+#
+# DESCRIPTION: Build a debian wheezy appliance using Docker.
+#
+# TEMPLATE: <%= @name %>
+#
+#==============================================================================
+
+---
+# Loads some helpful aliases
+aliases: defaults.yaml
+# Enables qcow2 checkpoint
+checkpoint: docker.yaml
+#== Global variables use by Kameleon engine and the steps
+global:
+  ## User varibales : used by the recipe
+  cachedir: /var/cache/kameleon
+  user_name: kameleon
+  arch: amd64
+
+  distrib: debian
+  release: wheezy
+  docker_image: kameleon-$${distrib}-$$release
+  # DNS servers : opendns
+  docker_dns: 208.67.222.222
+
+  ## System variables. Required by kameleon engine
+  # Include specific steps
+  include_steps: [$$distrib/$$release, $$distrib]
+
+  # Shell session from where we launch exec_out commands. There is often a
+  # local bash session, but it can be a remote shell on other machines or on
+  # any shell. (eg. bash, chroot, fakechroot, ssh, tmux, lxc...)
+  out_context:
+    cmd: bash
+    workdir: $$kameleon_cwd
+
+  # Shell session that allows us to connect to the building machine in order to
+  # configure it and setup additional programs
+  ssh_options: -o StrictHostKeyChecking=no -o ForwardAgent=yes
+  ssh_port: $(cat MAIN_CONTAINER_PORT)
+  insecure_ssh_key: insecure_ssh_dsa_key
+  in_context:
+    cmd: LC_ALL=POSIX ssh $$ssh_options localhost -p $$ssh_port -i $$insecure_ssh_key -t /bin/bash
+    workdir: /
+
+#== Bootstrap the new system and create the 'in_context'
+bootstrap:
+  - debootstrap:
+    - release: $$release
+    - arch: $$arch
+    - repository: http://ftp.fr.debian.org/debian/
+    - rootfs_archive: $$cachedir/$$distrib/$$release/$$arch/debootstrap.tar.gz
+  - prepare_docker:
+    - image: $$docker_image
+    - dns: $$docker_dns
+    - rootfs_archive: $$cachedir/$$distrib/$$release/$$arch/debootstrap.tar.gz
+  - start_docker:
+    - image: $$docker_image
+    - dns: $$docker_dns
+    - hostname: kameleon-$$distrib
+
+#== Install and configuration steps
+# WARNING: this part should be independante from the build context (whenever
+# possible...)
+setup:
+  # Install
+  - software_install:
+    - packages: > 
+        debian-keyring ntp zip unzip rsync sudo less vim bash-completion
+        extlinux
+  - kernel_install:
+    - arch: $$arch
+  # Configuration
+  - system_config:
+    - locales: fr_FR en_US
+    - lang: fr_FR.UTF-8
+    - timezone: Europe/Paris
+  - keyboard_config:
+    - layout: "fr,us"
+  - create_user:
+    - name: $$user_name
+    - group: admin
+    - password: $$user_name
+
+#== Export the generated appliance in the format of your choice
+export:
+  - build_appliance_from_docker:
+    - mountdir: $$kameleon_cwd/rootfs
+    - filename: $$kameleon_recipe_name
+    - filesystem_type: ext4
+    - format: qcow2  # Should be raw, qcow2 or qed format
+    - image_size: 2G

data/templates/fedora-docker.yaml

@@ -0,0 +1,96 @@
+#==============================================================================
+# vim: softtabstop=2 shiftwidth=2 expandtab fenc=utf-8 cc=81 tw=80
+#==============================================================================
+#
+# RECIPE: <%= recipe_name %>
+#
+# DESCRIPTION: Fedora base image [Working progress].
+#
+# TEMPLATE: <%= @name %>
+#
+#==============================================================================
+
+---
+# Loads some helpful aliases
+aliases: defaults.yaml
+# Enables qcow2 checkpoint
+checkpoint: docker.yaml
+#== Global variables use by Kameleon engine and the steps
+global:
+  ## User varibales : used by the recipe
+  cachedir: /var/cache/kameleon
+  user_name: kameleon
+  arch: x86_64
+
+  distrib: fedora
+  release: 20
+  docker_image: kameleon-$${distrib}-$$release
+  # DNS servers : opendns
+  docker_dns: 208.67.222.222
+
+  ## System variables. Required by kameleon engine
+  # Include specific steps
+  include_steps: [$$distrib/$$release, $$distrib]
+
+  # Shell session from where we launch exec_out commands. There is often a
+  # local bash session, but it can be a remote shell on other machines or on
+  # any shell. (eg. bash, chroot, fakechroot, ssh, tmux, lxc...)
+  out_context:
+    cmd: bash
+    workdir: $$kameleon_cwd
+
+  # Shell session that allows us to connect to the building machine in order to
+  # configure it and setup additional programs
+  ssh_options: -o StrictHostKeyChecking=no -o ForwardAgent=yes
+  ssh_port: $(cat MAIN_CONTAINER_PORT)
+  insecure_ssh_key: insecure_ssh_dsa_key
+  in_context:
+    cmd: LC_ALL=POSIX ssh $$ssh_options localhost -p $$ssh_port -i $$insecure_ssh_key -t /bin/bash
+    workdir: /
+
+#== Bootstrap the new system and create the 'in_context'
+bootstrap:
+  - docker_bootstrap:
+    - release: $$release
+    - rootfs_archive: $$cachedir/$$distrib/$$release/$$arch/bootstrap.tar.gz
+    - dns: $$docker_dns
+  - prepare_docker:
+    - rootfs_archive: $$cachedir/$$distrib/$$release/$$arch/bootstrap.tar.gz
+    - image: $$docker_image
+    - dns: $$docker_dns
+  - start_docker:
+    - image: $$docker_image
+    - dns: $$docker_dns
+    - hostname: kameleon-$$distrib
+
+#== Install and configuration steps
+# WARNING: this part should be independante from the build context (whenever
+# possible...)
+setup:
+  # Install
+  - software_install:
+    - packages: > 
+        ntp zip unzip rsync sudo less vim bash-completion wget
+    - group_packages: >
+        "Development Tools"
+  - kernel_install
+  # # Configuration
+  # - system_config:
+  #   - locales: fr_FR en_US
+  #   - lang: fr_FR.UTF-8
+  #   - timezone: Europe/Paris
+  # - keyboard_config:
+  #   - layout: "fr,us"
+  - create_user:
+    - name: $$user_name
+    - group: admin
+    - password: $$user_name
+
+#== Export the generated appliance in the format of your choice
+export:
+  - build_appliance_from_docker:
+    - mountdir: $$kameleon_cwd/rootfs
+    - filename: $$kameleon_recipe_name
+    - filesystem_type: ext4
+    - format: qcow2  # Should be raw, qcow2 or qed format
+    - image_size: 2G