veewee 0.3.0.alpha4 → 0.3.0.alpha5

data/.gitignore

@@ -1,7 +1,10 @@
 .DS_Store
 .bundle
+Gemfile.lock
 gems/*
 iso/*
+iso
+*.ova
 tmp/*
 definitions/*
 Vagrantfile

data/.rvmrc

@@ -1,4 +1,5 @@
-rvm use ruby-1.8.7
-rvm gemset use veewee
+rvm use ruby-1.9.2@veewee --create
+
+alias veewee="bundle exec veewee"
 alias vagrant="bundle exec vagrant"
 alias irb="bundle exec irb"

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem "veewee", :path => "."
+#gem "veewee", :path => "."
 
 group :test do
   gem "rake"

data/License

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010-2011 Patrick Debois
+Copyright (c) 2010-2012 Patrick Debois
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,198 +1,54 @@
-**VeeWee:** the tool to easily build vagrant base boxes
-Vagrant is a great tool to test new things or changes in a virtual machine(Virtualbox) using either chef or puppet.
-The first step is to download an existing 'base box'. I believe this scares a lot of people as they don't know who or how this box was build. Therefore lots of people end up first building their own base box to use with vagrant.
-
-Veewee tries to automate this and to share the knowledge and sources you need to create a basebox. Instead of creating custom ISO's from your favorite distribution, it leverages the 'keyboardputscancode' command of Virtualbox so send the actual 'boot prompt' keysequence to boot an existing iso.
-
-Before we can actually build the boxes, we need to take care of the minimal things to install:
-
-- Have Virtualbox 4.x installed -> download it from http://download.virtualbox.org/virtualbox/
-
-
-People have reported good experiences, why don't you give it a try?
-
-## Installation:
-__as a gem__
-
-    $ gem install veewee
-
-__from source__
-
-    $ git clone https://github.com/jedi4ever/veewee.git
-    $ cd veewee
-    $ gem install bundler
-    $ bundle install
-
-If you don't use rvm, be sure to execute vagrant through bundle exec
-
-    $ alias vagrant="bundle exec vagrant"
-
-
-## List all templates
-
-    $ vagrant basebox templates
-    The following templates are available:
-    vagrant basebox define '<box_name>' 'ubuntu-10.10-server-i386-netboot'
-    vagrant basebox define '<box_name>' 'ubuntu-10.10-server-amd64-netboot'
-    vagrant basebox define '<box_name>' 'solaris-11-express-i386'
-    vagrant basebox define '<box_name>' 'freebsd-8.2-pcbsd-i386-netboot'
-    vagrant basebox define '<box_name>' 'Fedora-14-amd64-netboot'
-    vagrant basebox define '<box_name>' 'ubuntu-11.04-server-amd64'
-    vagrant basebox define '<box_name>' 'freebsd-8.2-experimental'
-    vagrant basebox define '<box_name>' 'archlinux-i686'
-    vagrant basebox define '<box_name>' 'CentOS-5.6-i386-netboot'
-    vagrant basebox define '<box_name>' 'openindiana-148-ai-x86'
-    vagrant basebox define '<box_name>' 'ubuntu-10.10-server-i386'
-    vagrant basebox define '<box_name>' 'ubuntu-10.04.2-server-i386'
-    vagrant basebox define '<box_name>' 'ubuntu-10.04.2-amd64-netboot'
-    vagrant basebox define '<box_name>' 'Sysrescuecd-2.0.0-experimental'
-    vagrant basebox define '<box_name>' 'Debian-6.0.1a-amd64-netboot'
-    vagrant basebox define '<box_name>' 'freebsd-8.2-pcbsd-i386'
-    vagrant basebox define '<box_name>' 'Fedora-14-i386'
-    vagrant basebox define '<box_name>' 'Fedora-14-amd64'
-    vagrant basebox define '<box_name>' 'ubuntu-10.04.2-server-i386-netboot'
-    vagrant basebox define '<box_name>' 'opensuse-11.4-i386-experimental'
-    vagrant basebox define '<box_name>' 'CentOS-4.8-i386'
-    vagrant basebox define '<box_name>' 'ubuntu-10.04.2-server-amd64'
-    vagrant basebox define '<box_name>' 'ubuntu-8.04.4-server-amd64'
-    vagrant basebox define '<box_name>' 'gentoo-latest-i386-experimental'
-    vagrant basebox define '<box_name>' 'ubuntu-8.04.4-server-i386'
-    vagrant basebox define '<box_name>' 'windows-2008R2-amd64'
-    vagrant basebox define '<box_name>' 'Fedora-14-i386-netboot'
-    vagrant basebox define '<box_name>' 'archlinux-64-experimental'
-    vagrant basebox define '<box_name>' 'Debian-6.0.1a-i386-netboot'
-    vagrant basebox define '<box_name>' 'ubuntu-10.10-server-amd64'
-    vagrant basebox define '<box_name>' 'archlinux-64-aif-experimental'
-    vagrant basebox define '<box_name>' 'ubuntu-11.04-server-i386'
-    vagrant basebox define '<box_name>' 'CentOS-5.6-i386'
-
-
-## Define a new box
-Let's define a  Ubuntu 10.10 server i386 basebox called myunbuntubox
-this is essentially making a copy based on the  templates provided above.
-
-    $ vagrant basebox define 'myubuntubox' 'ubuntu-10.10-server-i386'
-    The basebox 'myubuntubox' has been succesfully created from the template ''ubuntu-10.10-server-i386'
-    You can now edit the definition files stored in definitions/myubuntubox
-    or build the box with:
-    vagrant basebox build 'myubuntubox'
-
--> This copies over the templates/ubuntu-10.10-server-i386 to definition/myubuntubox
+# Note: due to a miss manipulation on my side, the veewee03 branch got merged with master
+# Therefore the current state of the masterbranch on github is highly unstable
 
-    $ ls definitions/myubuntubox
-    definition.rb	postinstall.sh	postinstall2.sh	preseed.cfg
+To refer to the old master, I've put up the state before the error at
+<https://github.com/jedi4ever/veewee-old>
 
-## Optionally modify the definition.rb , postinstall.sh or preseed.cfg
+-------
 
-    Veewee::Definition.declare( {
-    :cpu_count => '1', :memory_size=> '256', 
-    :disk_size => '10140', :disk_format => 'VDI',
-    :os_type_id => 'Ubuntu',
-    :iso_file => "ubuntu-10.10-server-i386.iso", 
-    :iso_src => "http://releases.ubuntu.com/maverick/ubuntu-10.10-server-i386.iso",
-    :iso_md5 => "ce1cee108de737d7492e37069eed538e",
-    :iso_download_timeout => "1000",
-    :boot_wait => "10",
-    :boot_cmd_sequence => [ 
-        '<Esc><Esc><Enter>',
-        '/install/vmlinuz noapic preseed/url=http://%IP%:%PORT%/preseed.cfg ',
-        'debian-installer=en_US auto locale=en_US kbd-chooser/method=us ',
-        'hostname=%NAME% ',
-        'fb=false debconf/frontend=noninteractive ',
-        'console-setup/ask_detect=false console-setup/modelcode=pc105 console-setup/layoutcode=us ',
-        'initrd=/install/initrd.gz -- <Enter>' 
-      ],
-    :kickstart_port => "7122", :kickstart_timeout => "10000",:kickstart_file => "preseed.cfg",
-    :ssh_login_timeout => "10000",:ssh_user => "vagrant", :ssh_password => "vagrant",:ssh_key => "",
-    :ssh_host_port => "2222", :ssh_guest_port => "22",
-    :sudo_cmd => "echo '%p'|sudo -S sh '%f'",
-    :shutdown_cmd => "shutdown -H",
-    :postinstall_files => [ "postinstall.sh"],:postinstall_timeout => "10000"
-     }
-    )
+Maintaining two branches with complete different structures isn't fun. So..... I want to merge the two.
 
-If you need to change values in the templates, be sure to run the rake undefine, the rake define again to copy the changes across.
+Veewee03 will bring many new features:
 
-## Getting the cdrom file in place
-Put your isofile inside the 'currentdir'/iso directory or if you don't run
+- kvm and vmware fusion support -
+- veewee as a standalone tool tool if you don't use virtualbox,vagrant 
+- postinstall scripts can now be toggle with --include and --exclude
 
-    $ vagrant basebox build 'myubuntubox'
-
-- the build assumes your iso files are in 'currentdir'/iso
-- if it can not find it will suggest to download the iso for you
-- use '--force' to overwrite an existing install
-
-## Build the new box:
-
-    $ vagrant basebox build 'myubuntubox'
-
-- This will create a machine + disk according to the definition.rb
-- Note: :os_type_id = The internal Name Virtualbox uses for that Distribution
-- Mount the ISO File :iso_file
-- Boot up the machine and wait for :boot_time
-- Send the keystrokes in :boot_cmd_sequence
-- Startup a webserver on :kickstart_port to wait for a request for the :kickstart_file
-- Wait for ssh login to work with :ssh_user , :ssh_password
-- Sudo execute the :postinstall_files
-
-## Validate the vm 
-
-    $ vagrant basebox validate 'myubuntubox'
-
-this will run some cucumber test against the box to see if it has the necessary bits and pieces for vagrant to work
-
-## Export the vm to a .box file
+Caveat: it's alpha-functional but not as polished as the previous version. But I'm sure with your help this won't take long.
 
-    $ vagrant basebox export 'myubuntubox'
+My apologies for all the pull-requests to the previous version that will not be merged automatically. I'm focusing more on get this version stable and will incorporate the ideas later (some already are)
 
-this is actually calling - vagrant package --base 'myubuntubox' --output 'boxes/myubuntubox.box'
+---
+**VeeWee:** the tool to easily build vagrant base boxes or kvm,virtualbox and fusion images
 
-this will result in a myubuntubox.box
-
-## Add the box as one of your boxes
-To import it into vagrant type:
-
-    $ vagrant box add 'myubuntubox' 'myubuntubox.box'
-
-## Use it in vagrant
-
-To use it:
+Vagrant is a great tool to test new things or changes in a virtual machine(Virtualbox) using either chef or puppet.
+The first step is to download an existing 'base box'. I believe this scares a lot of people as they don't know who or how this box was build. Therefore lots of people end up first building their own base box to use with vagrant.
 
-    $ vagrant init 'myubuntubox'
-    $ vagrant up
-    $ vagrant ssh
+Besides building Vagrant boxes, veewee can also be used for:
 
-## How to add a new OS/installation (needs some love)
+- create vmware (fusion), kvm  virtual machines 
+- interact with with those vms (up, destroy, halt, ssh)
+- export them : OVA for fusion, IMG for KVM and ovf for virtualbox
 
-I suggest the easiest way is to get an account on github and fork of the veewee repository
+Before you start read through:
 
-    $ git clone https://github.com/*your account*/veewee.git
-    $ cd veewee
-    $ gem install bundler
-    $ bundle install
+- the [requirements](veewee/tree/master/doc/requirements.md)
+- the [installation](veewee/tree/master/doc/installation.md) procedure
 
-If you don't use rvm, be sure to execute vagrant through bundle exec
+Depending on how you want to use veewee, read through one of the following guides: (**work in progres**)
 
-    $ alias vagrant="bundle exec vagrant"
+- [guide for vagrant](veewee/tree/master/doc/vagrant.md)
 
-Start of an existing one
+- [guide for Virtualbox](veewee/tree/master/doc/vbox.md)
+- [guide for Vmware fusion](veewee/tree/master/doc/fusion.md)
+- [guide for KVM](veewee/tree/master/doc/kvm.md)
 
-    $ vagrant basebox define 'mynewos' 'ubuntu...'
+You can also look at the more detailed pages on each subject in the [documentation directory](veewee/tree/master/doc)
 
-- Do changes in the currentdir/definitions/mynewos
-- When it builds ok, move the definition/mynewos to a sensible directory under templates
-- commit the changes (git commit -a)
-- push the changes to github (git push)
-- go to the github gui and issue a pull request for it
+People have reported good experiences, why don't you give it a try?
 
 ## If you have a setup working, share your 'definition' with me. That would be fun! 
 
 IDEAS:
 
 - Now you integrate this with your CI build to create a daily basebox
-
-FUTURE IDEAS:
-
-- export to AMI too
-- provide for more failsafe execution, testing parameters
-- Do the same for Vmware Fusion

data/Rakefile

@@ -20,6 +20,7 @@ desc 'Tests requiring an real box'
 Rake::TestTask.new do |t|
   t.name="realtest"
   t.libs << "test"
+  t.libs << "."
   t.pattern = 'test/**/*_realtest.rb'
 end
 
@@ -32,8 +33,9 @@ task :iso, [:box_name] do |t,args|
   #end
   Dir.glob("templates/*").each do |name|
     definition_name=File.basename(name)
-    definition=Veewee::Environment.new(:cwd => ".",:definition_dir => "templates",:definition_path => "templates").get_definition(definition_name)
-    next if definition.iso_src.nil? || definition.iso_src==""
+    puts name
+    definition=Veewee::Environment.new(:cwd => ".",:definition_dir => "templates").definitions[definition_name]
+    next if definition.nil? || definition.iso_src.nil? || definition.iso_src==""
     begin
       url=definition.iso_src
       found=false

data/doc/README-changes.txt

@@ -0,0 +1,19 @@
+Changelog
+  now has include-postinstall, exclude-postinstall
+  ostypes are now synchronized accross kvm
+  require libvirt 0.8+ version 
+  user veewee instead of vagrant
+  veewee::session.declare / not veewee.defintion...
+  veewee subcommand compared to vagrant subcommand
+  veewee ssh
+  veewee start/stop
+  veewee steps (username,password, + VEEWEE env variables)
+
+Todo:
+  validate vms - + features selection
+  check libvirt version
+  windows test
+  validation of checks (also - inclide/exclude)
+  check execs with exit code
+  multinetwork card 
+  dkms for kernel installs

data/doc/TODO

@@ -0,0 +1,60 @@
+Still to document:
+
+# Requirements
+  virtualbox -> 
+
+  kvm -> ruby-libvirt gem
+    v0.8.3 or higher
+  require libvirt 0.8+ version 
+    have a default dir pool installed
+    permissions to write create new volumes
+
+  vmfusion -> VMWare fusion installed
+    Tested on VMWare fusion 0.3.x
+
+# Changes to Definitions
+
+  Virtualbox options ioapic, pae are now moved to :virtualbox => { vm_options => [ :ioapic => 'on' ]}
+    now you can pass all options you have to virtualbox
+
+# Use as a library
+
+# ostype_id (not everytime exists on all providers)
+
+# Rakefile contains check iso
+# Rakefile contains test
+# Rakefile contains real_test
+
+# Templates
+  idea is to split postinstall.sh to multiple pieces
+  check for .veewee_version or .vmfusion_version to see for which provider we are building this
+  include/exclude can do this
+  default user becomes veewee, vagrant.sh will create the vagrant user if used under vagrant 
+  uploading vmware.iso
+  uploading virtualbox.iso
+
+# Validation
+  veewee.feature (depending on virtualbox, vagrant)
+  no more ssh_steps
+  uses @tags per provider
+
+# veewee vmfusion export ova
+# vagrant basebox export box
+
+# New options
+  --postinstall-include/exclude
+  --auto (download yes)
+  --force also for export
+  --debug (debug output)
+
+  ostypes are now synchronized accross kvm
+
+Todo:
+  veewee steps (username,password, + VEEWEE env variables)
+  validate vms - + features selection
+  check libvirt version
+  windows test
+  validation of checks (also - inclide/exclude)
+  check execs with exit code
+  multinetwork card 
+  dkms for kernel installs

data/doc/definition.md

@@ -0,0 +1,58 @@
+# Veewee definition
+
+## Creating a definition
+A definition is create be 'cloning' a *template*.
+
+To create a definition you use the 'define' subcommand:
+
+    veewee vbox define 'myubuntu' 'ubuntu-10.10-server-amd64'
+
+## Modifying a definition
+Definitions are stored under a directory 'definitions' relative to the current directory.
+
+    <currentdir>
+    |- <definitions>
+    |   |--myubuntu
+    |      |-- definition.rb
+    |      |-- <preseed.cfg,kickstart.cfg,....>
+           |-- base.sh
+           |-- ....sh
+           |-- ruby.sh
+           |-- chef.sh
+           |-- puppet.sh
+           |-- virtualbox.sh
+           |-- ...sh
+           |-- cleanup.sh
+
+The file 'definition.rb' contains all the parameters to define the machine to be build:
+
+  - memorysize
+  - number of cpus
+  - user account and password
+  - sudo command
+  - shutdown command
+  - URL and checksum to download the ISO
+  - ....
+
+When a new boots, it will typically fetch it's initial configuration file over http from a preseed.cfg, kickstart, ... file
+
+Once the initial installation is done, veewee will log in to the sytem and starts executing the 'shell files'
+
+The main reason for splitting up the postinstall.sh we used to have, it to make the script parts reusable for different virtualization systems: f.i. no need to install virtualbox guest additions on kvm or vmware fusion.
+
+_Changes between v0.2 -> v0.3_
+
+The 'Veewee::Session.declare' is now deprecated and you should use 'Veewee::Definition.declare'
+
+'Postinstall_files' prefixed with an  _underscore_ are not executed but can be toggled with the --include, --exclude with the <build> command. This allows you to insert different ruby.sh scripts, disable the installation of puppet, etc...
+
+The default user of definitions is now 'veewee' and not 'vagrant'. This is because on other virtualizations like fusion and kvm, there is not relationship with the 'vagrant'. Users 'vagrant' are created by the 'vagrant.sh' script and not by the preseed or kickstart.
+
+
+## Listing existing definitions
+
+    veewee vbox list
+
+## Removing a definition
+
+    veewee vbox undefine 'myubuntu'

data/doc/fusion.md

@@ -0,0 +1,2 @@
+Coming Soon
+

data/doc/install.md

@@ -0,0 +1,16 @@
+## Installation:
+__as a gem__
+
+    $ gem install veewee
+
+__from source__
+
+    $ git clone https://github.com/jedi4ever/veewee.git
+    $ cd veewee
+    $ gem install bundler
+    $ bundle install
+
+If you don't use rvm, be sure to execute vagrant through bundle exec
+
+    $ alias vagrant="bundle exec vagrant"
+