dev-lxc 0.1.2 → 0.2.0

data/README.md

@@ -42,6 +42,13 @@ Please follow the dev-lxc-platform usage instructions to create a suitable platf
 
 The cookbook will automatically install this dev-lxc tool.
 
+### Use root
+
+Once you login to the Vagrant VM you should run `sudo -i` to login as the root user.
+
+Consider using `byobu` or `tmux` for a terminal multiplexer as `dev-lxc-platform` README
+describes.
+
 ### Mounts and Packages (batteries not included)
 
 As described below `dev-lxc` uses a YAML config file for each cluster.
@@ -67,43 +74,71 @@ the Vagrant VM and then reprovision the VM using `vagrant provision`.
 
 ## Usage
 
-### Shorter Commands are Faster (to type that is :)
+### Base Containers Explained
 
-I like to create an alias for `dev-lxc` for ease of use but for the purpose of these
-instructions I will use `dev-lxc`.
+One of the key things this tool uses is the concept of "base" containers.
 
-	echo 'alias dl=dev-lxc' >> ~/.bashrc && source ~/.bashrc
+`dev-lxc` creates containers with "b-" prepended to the name to distinguish it as
+a base container.
 
-You only have to type enough of a `dev-lxc` subcommand to make it unique.
+Base containers are then snapshot cloned using the btrfs filesystem to provide very
+quick, lightweight duplicates of the base container that are either used to build
+another base container or a container that will actually be run.
 
-The following commands are equivalent:
+During a cluster build process the base containers that get created fall into three categories.
 
-    dev-lxc cluster init tier
-	dl cl i
+1. Platform
 
-    dev-lxc cluster start
-	dl cl start
+    The platform base container is the first to get created.
 
-    dev-lxc cluster destroy
-	dl cl d
+    It is just the chosen OS platform and version (e.g. b-ubuntu-1204). A typical LXC container
+	has minimal packages installed so `dev-lxc` makes sure that the same packages used in Chef's
+	[bento boxes](https://github.com/opscode/bento) are installed to provide a more typical
+	server environment.	A few additional packages are also installed.
 
-### Base Servers
+    Once this platform base container is created there is rarely a need to delete it
+	or recreate it.
 
-One of the key things this tool uses is the concept of "base" servers.
-It creates servers with "b-" prepended to the name to signify it as a base server.
-Base servers are then snapshot cloned using the btrfs filesystem to provide very
-quick, lightweight duplicates of the base server that are either used to build
-another base server or a usable server.
+2. Shared
 
-The initial creation of base servers for the various platforms can take awhile so
-let's go ahead and start creating an Ubuntu 12.04 base server now.
+    The shared base container is the second to get created.
 
-    dev-lxc create b-ubuntu-1204
+    Common Chef packages such as Chef server, opscode-reporting and opscode-push-jobs-server are
+	installed using `dpkg` or `rpm`.
+
+    Note the manage package will not be installed at this point since it is not common to all
+	servers (i.e. it does not get installed on backend servers).
+
+    Since no configuration actually happens yet there is rarely a need to delete this container.
+	If another cluster is configured to use the same packages that are installed in this container
+	then time is saved by just cloning this container for the new cluster to use.
+
+3. Unique
+
+    The unique base container is the last to get created.
+
+    Each unique Chef server (e.g. standalone, backend or frontend) is created.
+
+    * The specified hostname is assigned.
+	* dnsmasq is configured to reserve the specified IP address for the container's MAC address.
+	* A DNS entry is created in dnsmasq if appropriate.
+	* All installed Chef packages are configured.
+	* The opscode-manage package is installed and configured if specified.
+
+### Using `dev-lxc` to manually create a platform base container
 
-You can see a menu of base servers this tool can create by using the following command.
+Platform base containers can be used for purposes other than building clusters. For example, they can
+be used as Chef nodes for testing purposes.
+
+You can see a menu of platform base containers this tool can create by using the following command.
 
     dev-lxc create
 
+The initial creation of platform base containers can take awhile so let's go ahead and start creating
+an Ubuntu 12.04 base container now.
+
+    dev-lxc create b-ubuntu-1204
+
 ### Cluster Config Files
 
 dev-lxc uses a yaml configuration file to define a cluster.
@@ -195,6 +230,24 @@ more clusters you have to maintain uniqueness across the YAML config files for t
 	
     Use unique IP's from that range when configuring clusters.
    
+### Shorter Commands are Faster (to type that is :)
+
+The root user's `~/.bashrc` file has aliased `dl` to `dev-lxc` for ease of use but for most
+instructions in this README I will use `dev-lxc`.
+
+You only have to type enough of a `dev-lxc` subcommand to make it unique.
+
+The following commands are equivalent:
+
+    dev-lxc cluster init standalone
+	dl cl i standalone
+
+    dev-lxc cluster start
+	dl cl start
+
+    dev-lxc cluster destroy
+	dl cl d
+
 ### Create and Manage a Cluster
 
 The following instructions will use a tier cluster for demonstration purposes.

data/lib/dev-lxc/chef-cluster.rb

@@ -68,11 +68,17 @@ module DevLXC
       chef_servers.reverse_each { |cs| cs.destroy }
     end
     
-    def destroy_base_containers
-      @servers.keys.each do |server_name|
-        DevLXC::Container.new("b-#{server_name}").destroy
+    def destroy_base_container(type)
+      case type
+      when :unique
+        @servers.keys.each do |server_name|
+          DevLXC::ChefServer.new(server_name, @cluster_config).destroy_base_container(:unique)
+        end
+      when :shared
+        DevLXC::ChefServer.new(@servers.keys.first, @cluster_config).destroy_base_container(:shared)
+      when :platform
+        DevLXC::ChefServer.new(@servers.keys.first, @cluster_config).destroy_base_container(:platform)
       end
-      DevLXC::Container.new(DevLXC::ChefServer.new(@servers.keys.first, @cluster_config).base_server_name).destroy
     end
 
     def chef_server_config

data/lib/dev-lxc/chef-server.rb

@@ -88,10 +88,15 @@ module DevLXC
       DevLXC.reload_dnsmasq
     end
 
-    def destroy_base_containers
-      DevLXC::Container.new("b-#{@server.name}").destroy
-      DevLXC::Container.new(@base_server_name).destroy
-      DevLXC::Container.new(@base_platform).destroy
+    def destroy_base_container(type)
+      case type
+      when :unique
+        DevLXC::Container.new("b-#{@server.name}").destroy
+      when :shared
+        DevLXC::Container.new(@base_server_name).destroy
+      when :platform
+        DevLXC::Container.new(@base_platform).destroy
+      end
     end
 
     def create

data/lib/dev-lxc/cli.rb

@@ -57,11 +57,15 @@ module DevLXC::CLI
 
     desc "destroy", "Destroy a cluster's Chef servers"
     option :config, :aliases => "-c", :desc => "Specify a cluster's YAML config file. ./dev-lxc.yaml will be used by default"
-    option :base, :aliases => "-b", :type => :boolean, :desc => "Destroy the cluster's base containers also"
+    option :unique, :aliases => "-u", :type => :boolean, :desc => "Also destroy the cluster's unique base containers"
+    option :shared, :aliases => "-s", :type => :boolean, :desc => "Also destroy the cluster's shared base container"
+    option :platform, :aliases => "-p", :type => :boolean, :desc => "Also destroy the cluster's platform base container"
     def destroy
       cluster = get_cluster(options[:config])
       cluster.destroy
-      cluster.destroy_base_containers if options[:base]
+      cluster.destroy_base_container(:unique) if options[:unique]
+      cluster.destroy_base_container(:shared) if options[:shared]
+      cluster.destroy_base_container(:platform) if options[:platform]
     end
   end
 
@@ -107,11 +111,15 @@ module DevLXC::CLI
 
     desc "destroy [NAME]", "Destroy a cluster's Chef server"
     option :config, :aliases => "-c", :desc => "Specify a cluster's YAML config file. ./dev-lxc.yaml will be used by default"
-    option :base, :aliases => "-b", :type => :boolean, :desc => "Destroy the server's base containers also"
+    option :unique, :aliases => "-u", :type => :boolean, :desc => "Also destroy the server's unique base container"
+    option :shared, :aliases => "-s", :type => :boolean, :desc => "Also destroy the server's shared base container"
+    option :platform, :aliases => "-p", :type => :boolean, :desc => "Also destroy the server's platform base container"
     def destroy(name)
       server = get_server(name, options[:config])
       server.destroy
-      server.destroy_base_containers if options[:base]
+      server.destroy_base_container(:unique) if options[:unique]
+      server.destroy_base_container(:shared) if options[:shared]
+      server.destroy_base_container(:platform) if options[:platform]
     end
   end
 

data/lib/dev-lxc/version.rb

@@ -1,3 +1,3 @@
 module DevLXC
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dev-lxc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors: