libvirtinator 0.0.2 → 0.1.0

data/lib/libvirtinator/config.rb

@@ -1,7 +1,26 @@
+module Capistrano
+  module TaskEnhancements
+    alias_method :original_default_tasks, :default_tasks
+    def default_tasks
+      original_default_tasks + [
+        "libvirtinator:install",
+        "libvirtinator:install_vm",
+        "image:list_bases",
+        "image:build_base",
+        "users:setup_domain"
+      ]
+    end
+  end
+end
+
 namespace :libvirtinator do
-  # TODO: fix needing to define a stage before being able to install
+  task :load_settings do
+    load "./config/deploy.rb"
+    SSHKit.config.output_verbosity = fetch(:log_level)
+  end
+
   desc 'Write example config files'
-  task :install do
+  task :install => 'libvirtinator:load_settings' do
     run_locally do
       execute "mkdir", "-p", "config/deploy", "templates/libvirtinator"
       {
@@ -9,7 +28,6 @@ namespace :libvirtinator do
         'examples/config/deploy.rb'             => 'config/deploy_example.rb',
         'examples/config/sysadmins_keys.rb'     => 'config/sysadmins_keys_example.rb',
         'examples/config/deploy/vm_name.rb'     => 'config/deploy/vm_name_example.rb',
-        'examples/config/deploy/manual.rb'      => 'config/deploy/manual_example.rb',
         'examples/first_boot.sh.erb'            => 'templates/libvirtinator/first_boot_example.sh.erb',
         'examples/fstab.erb'                    => 'templates/libvirtinator/fstab_example.erb',
         'examples/hostname.erb'                 => 'templates/libvirtinator/hostname_example.erb',
@@ -29,7 +47,7 @@ namespace :libvirtinator do
   end
 
   desc 'Write an example VM config file'
-  task :install_vm do
+  task :install_vm => 'libvirtinator:load_settings' do
     run_locally do
       execute "mkdir", "-p", "config/deploy"
       {

data/lib/libvirtinator/examples/config/deploy/vm_name.rb

@@ -22,7 +22,7 @@ set :ip,                    "123.123.123.123"
 set :cidr,                  "123_123_123_123-27"
 
 set :node_fqdn,             -> { "#{fetch(:node_name)}.example.com" }
-set :app_fqdn,              "my-app.example.com"
-set :hostname,              "my-app"
+set :app_fqdn,              -> { "#{fetch(:node_name)}.example.com" }
+set :hostname,              -> { fetch(:node_name) }
 
 set :usergroups,            ["sysadmins"]

data/lib/libvirtinator/examples/config/deploy.rb

@@ -31,19 +31,23 @@ set "231_231_231_231-27_netmask",         "255.255.255.224"
 set :dns_search,                          "example.com example2.com"
 
 # Setup vmbuilder for building a base image
-set :release_name,                        "ubuntu-14.04-v0.0.1-docker1.3.1"
+set :release_name,                        "ubuntu-14.04_docker-1.9.1_v0.0.0"
+set :build_user,                          -> { ENV['USER'] }
+set :build_host,                          "myhost.example.com"
 set :vmbuilder_run_command,               -> {
-  [ "kvm", "ubuntu",
+  # [ "vmbuilder", "kvm", "ubuntu", # Ubuntu 12.04 and older hosts
+  [ "ubuntu-vm-builder", "kvm", "ubuntu", # Ubuntu 14.04 and newer hosts
     "-o",
     "--debug",
     "--verbose",
     "--dest=/tmp/#{fetch(:release_name)}",
-    "--config=templates/#{fetch(:release_name)}.cfg",
-    "--execscript=templates/#{fetch(:release_name)}-init.sh",
+    "--config=/tmp/vmbuilder.cfg",
+    "--execscript=/tmp/vmbuilder-init.sh",
     "--firstboot=/tmp/first_boot.sh",
+    # rootsize & swapsize settings do not get picked up in cfg file, so set here
     "--rootsize=15360",
     "--swapsize=2048"
-  ].join(' ')
+  ]
 }
 
 

data/lib/libvirtinator/image.rb

@@ -1,30 +1,34 @@
 namespace :image do
   desc "Build a base qcow2 image."
-  task :build_base do
-    on roles(:app) do
+  task :build_base => 'libvirtinator:load_settings' do
+    on "#{fetch(:build_user)}@#{fetch(:build_host)}" do
       as :root do
         ["first_boot.sh", "vmbuilder-init.sh", "vmbuilder.cfg"].each do |file|
-          template = File.new(File.expand_path("templates/#{file}.erb")).read
+          template = File.new(File.expand_path("templates/libvirtinator/#{file}.erb")).read
           generated_config_file = ERB.new(template).result(binding)
           upload! StringIO.new(generated_config_file), "/tmp/#{file}"
-          execute("chown", "-R", "root:root", "/tmp/#{file}")
           execute("chmod", "770", "/tmp/#{file}")
         end
-        # rootsize & swapsize settings do not get picked up in cfg file, so set here
-        if test "vmbuilder", fetch(:vmbuilder_run_command)
-          execute "mv /tmp/#{fetch(:release_name)}/*.qcow2 /tmp/#{fetch(:release_name)}/#{fetch(:release_name)}.qcow2"
+        command_options = fetch(:vmbuilder_run_command)
+        entrypoint = command_options.shift
+        SSHKit.config.output_verbosity = :debug # watch long running output
+        if test entrypoint, command_options
+          final_path = "/tmp/#{fetch(:release_name)}/#{fetch(:release_name)}.qcow2"
+          execute "mv /tmp/#{fetch(:release_name)}/*.qcow2 #{final_path}"
           info("Build finished successfully!")
-          info("You probably want to run 'cp /tmp/#{fetch(:release_name)}/#{fetch(:release_name)}.qcow2 <root partitions path>'.")
-          info("If you ran this on a Ubuntu 14.04 or later host, you'll probabaly want to make the image compatible " +
-              "with older versions of qemu using a command like this: 'sudo qemu-img amend -f qcow2 -o compat=0.10 #{fetch(:release_name)}.qcow2'.")
+          info("You probably want to copy '#{final_path}' to your root partitions path.")
+          info("If you ran this on a Ubuntu 14.04 or later host, you may want to make the image compatible " +
+              "with older versions of qemu using a command like this: 'sudo qemu-img amend -f qcow2 -o compat=0.10 #{final_path}'.")
+        else
+          fatal "Build failed!"
         end
-        execute "rm", "/tmp/first_boot.sh", "-f"
+        SSHKit.config.output_verbosity = fetch(:log_level)
       end
     end
   end
 
   #desc "Mount qcow2 image by creating a run file holding the nbd needed."
-  task :mount do
+  task :mount => 'libvirtinator:load_settings' do
     on roles(:app) do
       as :root do
         if test "[", "-f", fetch(:nbd_run_file), "]"
@@ -56,7 +60,7 @@ namespace :image do
   end
 
   #desc "Un-mount qcow2 image"
-  task :umount do
+  task :umount => 'libvirtinator:load_settings' do
     on roles(:app) do
       as :root do
         if test "[", "-f", fetch(:nbd_run_file), "]"
@@ -81,7 +85,7 @@ namespace :image do
   end
 
   desc "Find the base image for each root qcow2 image on the host machine"
-  task :list_bases do
+  task :list_bases => 'libvirtinator:load_settings' do
     on roles(:app) do
       as :root do
         set :files, -> { capture("ls", "#{fetch(:root_partitions_path)}/*.qcow2" ).split }
@@ -106,7 +110,7 @@ namespace :image do
     end
   end
 
-  task :connect_to_unused_nbd do
+  task :connect_to_unused_nbd => 'libvirtinator:load_settings' do
     on roles(:app) do
       as :root do
         set :prelock, -> { "#{fetch(:nbd_lock_file)}.prelock" }
@@ -158,7 +162,7 @@ namespace :image do
     end
   end
 
-  task :disconnect_from_nbd do
+  task :disconnect_from_nbd => 'libvirtinator:load_settings' do
     on roles(:app) do
       as :root do
         execute "qemu-nbd", "-d", fetch(:dev_nbd)

data/lib/libvirtinator/lv.rb

@@ -1,6 +1,6 @@
 namespace :lv do
   #desc "Remove a logical volume and recreate it."
-  task :recreate do
+  task :recreate => 'libvirtinator:load_settings' do
     on roles(:app) do
       as :root do
         if test "[", "-b", fetch(:data_disk_lv_path), "]"
@@ -18,7 +18,7 @@ namespace :lv do
   end
 
   #desc "Create a logical volume."
-  task :create do
+  task :create => 'libvirtinator:load_settings' do
     on roles(:app) do
       as :root do
         if test "lvcreate", fetch(:data_disk_vg_path), "-L", "#{fetch(:data_disk_gb)}G", "-n", fetch(:data_disk_lv_name)
@@ -32,7 +32,7 @@ namespace :lv do
   end
 
   #desc "Create an ext4 filesystem."
-  task :mkfs do
+  task :mkfs => 'libvirtinator:load_settings' do
     on roles(:app) do
       as :root do
         unless test "[", "-b", fetch(:data_disk_lv_path), "]"

data/lib/libvirtinator/users.rb

@@ -1,6 +1,6 @@
 namespace :users do
 
-  task :load_settings do
+  task :load_settings => 'libvirtinator:load_settings' do
     if ENV['key_path'].nil?
       set :path, ""
       until File.exists?(fetch(:path)) and (! File.directory?(fetch(:path)))
@@ -19,15 +19,19 @@ namespace :users do
     end
   end
 
-  desc "Idempotently setup admin UNIX users using only a domain name (or IP) and a usergroup file"
-  task :setup_domain, [:domain, :usergroup] do |t, args|
-    set :ip,          -> { args.domain }
-    set :usergroups,  -> { Array(args.usergroup) }
+  desc "Idempotently setup admin UNIX users using only a domain name (or IP) and usergroups files"
+  task :setup_domain => 'libvirtinator:load_settings' do
+    if ENV['domain'].nil? or ENV['usergroups'].nil?
+      fatal "Please set domain and usergroups like 'cap users:setup_domain domain=example.com usergroups=sysadmins,others'"
+      exit
+    end
+    set :ip,          -> { ENV['domain'] }
+    set :usergroups,  -> { Array(ENV['usergroups'].split',') }
     Rake::Task['users:setup'].invoke
   end
 
   desc "Idempotently setup admin UNIX users."
-  task :setup => :load_settings do
+  task :setup => ['libvirtinator:load_settings', 'users:load_settings'] do
     on "#{fetch(:user)}@#{fetch(:ip)}" do
       as :root do
         fetch(:usergroups).each do |usergroup|

data/lib/libvirtinator/vm.rb

@@ -3,7 +3,7 @@ require 'timeout'
 require 'erb'
 
 desc "Check the current status of a VM"
-task :status do
+task :status => 'libvirtinator:load_settings' do
   on roles(:app) do
     as :root do
       if test("virsh", "list", "--all", "|", "grep", "-q", "#{fetch(:node_name)}")
@@ -32,7 +32,7 @@ task :status do
 end
 
 desc "Start a copy-on-write VM from a base image."
-task :start do
+task :start => 'libvirtinator:load_settings' do
   on roles(:app) do
     info "Preparing to start #{fetch(:node_name)}"
     Rake::Task['ensure_nbd_module'].invoke
@@ -56,12 +56,14 @@ task :start do
     Rake::Task['setup_agent_forwarding'].invoke
     Rake::Task['wait_for_ping'].invoke
     Rake::Task['wait_for_ssh_alive'].invoke
+    # TODO make users:setup offer a yes/no try-again when a specified key doesn't work to connect.
+    # TODO make users:setup failure invoke notice "don't worry, you can resume setting up users with 'cap <stage> users:setup'"
     Rake::Task['users:setup'].invoke
     info "Say, you don't say? Are we finished?"
   end
 end
 
-task :ensure_root_partitions_path do
+task :ensure_root_partitions_path => 'libvirtinator:load_settings' do
   on roles(:app) do
     as :root do
       dir = fetch(:root_partitions_path)
@@ -73,7 +75,7 @@ task :ensure_root_partitions_path do
   end
 end
 
-task :ensure_nbd_module do
+task :ensure_nbd_module => 'libvirtinator:load_settings' do
   on roles(:app) do
     as :root do
       unless test("lsmod | grep -q nbd")
@@ -89,7 +91,7 @@ task :ensure_nbd_module do
   end
 end
 
-task :ensure_vm_not_running do
+task :ensure_vm_not_running => 'libvirtinator:load_settings' do
   on roles(:app) do
     as :root do
       if test("virsh", "list", "|", "grep", "-q", "#{fetch(:node_name)}")
@@ -100,7 +102,7 @@ task :ensure_vm_not_running do
   end
 end
 
-task :ensure_ip_no_ping do
+task :ensure_ip_no_ping => 'libvirtinator:load_settings' do
   run_locally do
     info "Attempting to ping #{fetch(:ip)}"
     if system "bash -c \"ping -c 3 -w 5 #{fetch(:ip)} &> /dev/null\""
@@ -112,7 +114,7 @@ task :ensure_ip_no_ping do
   end
 end
 
-task :ensure_vm_not_defined do
+task :ensure_vm_not_defined => 'libvirtinator:load_settings' do
   on roles(:app) do
     as :root do
       if test("virsh", "list", "--all", "|", "grep", "-q", "#{fetch(:node_name)}")
@@ -130,7 +132,7 @@ task :ensure_vm_not_defined do
   end
 end
 
-task :verify_base do
+task :verify_base => 'libvirtinator:load_settings' do
   on roles(:app) do
     as :root do
       unless test "[", "-f", fetch(:base_image_path), "]"
@@ -142,7 +144,7 @@ task :verify_base do
   end
 end
 
-task :remove_root_image do
+task :remove_root_image => 'libvirtinator:load_settings' do
   on roles(:app) do
     as :root do
       # use 'cap <server> create recreate_root=true' to recreate the root image
@@ -162,7 +164,7 @@ task :remove_root_image do
   end
 end
 
-task :create_root_image do
+task :create_root_image => 'libvirtinator:load_settings' do
   on roles(:app) do
     as :root do
       unless test "[", "-f", fetch(:root_image_path), "]"
@@ -183,7 +185,7 @@ task :create_root_image do
   end
 end
 
-task :update_root_image do
+task :update_root_image => 'libvirtinator:load_settings' do
   on roles(:app) do
     as :root do
       mount_point = fetch(:mount_point)
@@ -216,6 +218,7 @@ task :update_root_image do
         upload! StringIO.new(generated_config_file), "/tmp/#{file}.file"
         execute("mv", "/tmp/#{file}.file", path)
         execute("chown", "root:root", path)
+        execute("chmod", "644", path)
       end
       execute "sed", "-i\"\"", "\"/PermitRootLogin/c\\PermitRootLogin no\"",
         "#{mount_point}/etc/ssh/sshd_config"
@@ -254,7 +257,7 @@ task :update_root_image do
   end
 end
 
-task :create_data do
+task :create_data => 'libvirtinator:load_settings' do
   on roles(:app) do
     as 'root' do
       unless fetch(:data_disk_enabled)
@@ -293,7 +296,7 @@ _EOF_"
   end
 end
 
-task :define_domain do
+task :define_domain => 'libvirtinator:load_settings' do
   on roles(:app) do
     as 'root' do
       # instance variables needed for ERB
@@ -315,7 +318,7 @@ task :define_domain do
   end
 end
 
-task :start_domain do
+task :start_domain => 'libvirtinator:load_settings' do
   on roles(:app) do
     as 'root' do
       execute "virsh", "start", "#{fetch(:node_name)}"
@@ -324,7 +327,7 @@ task :start_domain do
 end
 
 # Keep this to aid with users setup
-task :reset_known_hosts_on_host do
+task :reset_known_hosts_on_host => 'libvirtinator:load_settings' do
   run_locally do
     user = if ENV['SUDO_USER']; ENV['SUDO_USER']; else; ENV['USER']; end
     execute "sudo", "-u", user, "ssh-keygen", "-R", "#{fetch(:node_name)}"
@@ -335,7 +338,7 @@ task :reset_known_hosts_on_host do
   end
 end
 
-task :wait_for_ping do
+task :wait_for_ping => 'libvirtinator:load_settings' do
   run_locally do
     info "Waiting for VM to respond to ping.."
     begin
@@ -362,7 +365,11 @@ task :wait_for_ping do
   end
 end
 
-task :setup_agent_forwarding do
+# TODO confirm and remove auto-setup of agent forwarding,
+#   not only is this not idempotent (it continually adds to `.ssh/config`),
+#   but it should not be needed, since capistrano forwards the agent automatically.
+#   Manual SSH configuration for agent fowarding should be needed. - Confirm VM creation still work this way.
+task :setup_agent_forwarding => 'libvirtinator:load_settings' do
   run_locally do
     lines = <<-eos
 \nHost #{fetch(:node_fqdn)}
@@ -388,7 +395,7 @@ Host #{fetch(:node_name)}
   end
 end
 
-task :wait_for_ssh_alive do
+task :wait_for_ssh_alive => 'libvirtinator:load_settings' do
   run_locally do
     info "Waiting for VM SSH alive.."
     begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libvirtinator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.1
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.1
 description: An Opinionated libvirt VM Deployment gem
@@ -42,7 +42,6 @@ files:
 - lib/libvirtinator/examples/Capfile
 - lib/libvirtinator/examples/config/deploy.rb
 - lib/libvirtinator/examples/config/deploy/vm_name.rb
-- lib/libvirtinator/examples/config/deploy/manual.rb
 - lib/libvirtinator/examples/config/sysadmins_keys.rb
 - lib/libvirtinator/examples/first_boot.sh.erb
 - lib/libvirtinator/examples/fstab.erb
@@ -72,11 +71,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- Docker ~1.3.1
+requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
 summary: Deploy libvirt VMs
 test_files: []
+has_rdoc: 

data/lib/libvirtinator/examples/config/deploy/manual.rb

@@ -1,25 +0,0 @@
-set :host_machine_name,     "none"
-set :user,                  -> { ENV['USER'] }
-
-role :app,                  "none"
-
-set :base_image,            "none"
-set :node_name,             "none"
-
-set :data_disk_enabled,     false
-set :data_disk_gb,          "0"
-set :data_disk_type,        "lv"
-set :data_disk_mount_point, "/"
-set :data_disk_partition,   "0"
-
-set :memory_gb,             "0"
-set :cpus,                  "0"
-
-set :ip,                    "none"
-set :cidr,                  "none"
-
-set :node_fqdn,             "none"
-set :app_fqdn,              "none"
-set :hostname,              "none"
-
-set :usergroups,            ["none"]