vagrant-compose 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5cf1494be11d93a996a0c39fa92a1c52f27dbd5
-  data.tar.gz: 7245362caf0bad80f39bca9ca32caf5bf91bdd40
+  metadata.gz: 829887cd4923b701ab113a461eee004c59f5e53a
+  data.tar.gz: 150222776421af2f4acc3ca9b5177f9cf327e4fd
 SHA512:
-  metadata.gz: 5f83e4c1a6f546027c274ecf619f93ebc1aa286c777f87d2230215077d503d4651056f03cbe5608a2a4bb1d02b84445fdeb4f4a2cc6d796dae5a99ba03803438
-  data.tar.gz: b1afbe56b35f74a62367bf01ea3714428f69942c972625e93966bb41cf9049d684ce9b808b31fdc4e00b2c742d359170b523a9a4d7f9a5870604e4fba0e02fb1
+  metadata.gz: 3f30bf0ae52906e0d09a5cf2bf68a5a9a067c68614a7857fe4562ee805962242ba46dabc7bf96b7540529507e27e751007333fb70e3c79a2294cc479f010e14a
+  data.tar.gz: b868272274ee606bf70138cc7b94d6e66d6278846ef3ad2abe8def377875896a0d8fcb1d19d6147701d878113ce74aa6a526622734ab4284788784d3e747fb4d

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 * Initial release.
 
-# 0.2.0 (December 31, 2015)
+# 0.2.2 (December 31, 2015)
 
 breaking changes! 
 * nodes instances number defined into node method (instances attributes removed)
@@ -12,3 +12,11 @@ other changes:
 * Improved documentation.
 * cluster domain now is optional
 * nodes code block now is optional
+
+# 0.2.3 (April 2, 2016)
+
+* Now custer name can be omitted (thanks to jaydoane)
+
+other changes:
+* Documented cluster.debug feature
+* Improved code inline documentation

data/README.md

@@ -391,7 +391,7 @@ For instance, when building a [Consul](https://consul.io/) cluster, all the `con
 ``` ruby
 config.cluster.compose('test') do |c|
   ...
-  c.context_vars['consul-server'] = lambda { |context, nodes| 
+  c.ansible_context_vars['consul-server'] = lambda { |context, nodes| 
     return { 'consul-serverIPs' => nodes.map { |n| n.ip }.to_a } 
   }
   ...
@@ -403,10 +403,10 @@ Then, you can use the above context var when generating group_vars for nodes in
 ``` ruby
 config.cluster.compose('test') do |c|
   ...
-  c.context_vars['consul-server'] = lambda { |context, nodes| 
+  c.ansible_context_vars['consul-server'] = lambda { |context, nodes| 
     return { 'serverIPs' => nodes.map { |n| n.ip }.to_a } 
   }
-  c.group_vars['consul-agent'] = lambda { |context, nodes| 
+  c.ansible_group_vars['consul-agent'] = lambda { |context, nodes| 
     return { 'consul_joins' => context['consul-serverIPs']  } 
   }
   ...

data/lib/vagrant/compose/config.rb

@@ -4,27 +4,39 @@ require_relative "util/cluster"
 
 module VagrantPlugins
   module Compose
+  	
+  	# Vagrant compose plugin definition class.
+  	# This plugins allows easy configuration of a data structure that can be used as a recipe
+  	# for setting up and provisioning a vagrant cluster composed by several machines with different
+  	# roles.
     class Config < Vagrant.plugin("2", :config)
 
-      attr_reader :nodes, :ansible_groups
+      # After executing compose, it returns the list of nodes in the cluster.
+      attr_reader :nodes
+
+      # After executing compose, it returns the ansible_groups configuration for provisioning nodes in the cluster.
+      attr_reader :ansible_groups
 
 	  def initialize
 		@nodes = {}
 		@ansible_groups = {}
 	  end
-	  
+
+	  # Implements cluster creation, through the execution of the give code. 
 	  def compose (name, &block)
-	    # implementa la creazione di un cluster, l'esecuzione di un blocco di codice
-  		# per la configurazione del cluster stesso, e l'esecuzione della sequenza di compose.
+	    # create the cluster (the data structure representing the cluster)
 		@cluster = Cluster.new(name)
 		begin
+			# executes the cluster configuration code
         	block.call(@cluster)
 		rescue Exception => e
 	      raise VagrantPlugins::Compose::Errors::ClusterInitializeError, :message => e.message, :cluster_name => name
 	    end
+	    # tranform cluster configuration into a list of nodes/ansible groups to be used for
 		@nodes, @ansible_groups = @cluster.compose
  	  end
 
+ 	  # Implements a utility method that allows to check the list of nodes generated by compose.
  	  def debug
  	  	puts "==> cluster #{@cluster.name} with #{nodes.size} nodes" 
  	  	@nodes.each do |node|

data/lib/vagrant/compose/errors.rb

@@ -2,7 +2,10 @@ require "vagrant"
 
 module VagrantPlugins
   module Compose
+
+    #Plugin custom error classes, handling localization of error messages
     module Errors
+      #Base class for vagrant compose custom errors
       class VagrantComposeError < Vagrant::Errors::VagrantError
         error_namespace("vagrant_compose.errors")
       end

data/lib/vagrant/compose/plugin.rb

@@ -15,7 +15,8 @@ module VagrantPlugins
     class Plugin < Vagrant.plugin("2")
       name "Compose"
       description <<-DESC
-      This plugin installs ...
+      A Vagrant plugin that helps building complex multi-machine scenarios.
+      see https://github.com/fabriziopandini/vagrant-compose for documentation.
       DESC
 
       config "cluster" do

data/lib/vagrant/compose/util/cluster.rb

@@ -4,18 +4,40 @@ require_relative "node_group"
 module VagrantPlugins
   module Compose
 
-    # Definisce un cluster, ovvero l'insieme di 1..n gruppi di nodi con caratteristiche simili.
+    # This class defines a cluster, thas is a set of group of nodes, where nodes in each group has similar characteristics.
+    # Basically, a cluster is a data structure that can be used as a recipe for setting up and provisioning a 
+    # vagrant cluster composed by several machines with different roles.
     class Cluster
 
+      # The name of the cluster
       attr_reader   :name
-      attr_reader   :multimachine_filter
+
+      # The default vagrant base box to be used for creating vagrant machines in this cluster. 
+      # This setting can be changed at group/node level
       attr_accessor :box
+      
+      # The network domain to wich the cluster belongs (used for computing nodes fqdn)
       attr_accessor :domain
+      
+
+      # The root path for ansible playbook; it is used as a base path for computing ansible_group_vars and ansible_host_vars
+      # It defaults to current directory/provisioning
       attr_accessor :ansible_playbook_path
-      attr_accessor :ansible_context_vars
+      
+      # The path where ansible group vars files are stores.
+      # It default to ansible_playbook_path/group_vars
       attr_accessor :ansible_group_vars
+      
+      # The path where ansible group vars files are stores.
+      # It default to ansible_playbook_path/host_vars
       attr_accessor :ansible_host_vars
 
+      # A dictionary, allowing to setup context vars to be uses is value_generators when composing nodes
+      attr_accessor :ansible_context_vars
+
+      # A variable that reflects if vagrant is tageting a single machine, like f.i. when executing vagrant up machine-name
+      attr_reader   :multimachine_filter
+
       # Costruttore di una istanza di cluster.
       def initialize(name)
         @group_index             = 0
@@ -25,6 +47,8 @@ module VagrantPlugins
         @ansible_host_vars     = {}
         @multimachine_filter   = ""
         @ansible_playbook_path = File.join(Dir.pwd, 'provisioning')
+        @ansible_group_vars_path = File.join(@ansible_playbook_path, 'group_vars')
+        @ansible_host_vars_path = File.join(@ansible_playbook_path, 'host_vars')
 
         @name        = name 
         @box         = 'ubuntu/trusty64'
@@ -129,8 +153,6 @@ module VagrantPlugins
         end
 
         # cleanup ansible_group_vars files
-        # TODO: make variable public
-        @ansible_group_vars_path = File.join(@ansible_playbook_path, 'group_vars')
         # TODO: make safe
         FileUtils.mkdir_p(@ansible_group_vars_path) unless File.exists?(@ansible_group_vars_path)
         Dir.foreach(@ansible_group_vars_path) {|f| fn = File.join(@ansible_group_vars_path, f); File.delete(fn) if f.end_with?(".yml")}
@@ -166,8 +188,6 @@ module VagrantPlugins
         end
 
         # cleanup ansible_host_vars files (NB. 1 nodo = 1 host)
-        # TODO: make variable public
-        @ansible_host_vars_path = File.join(@ansible_playbook_path, 'host_vars')
         # TODO: make safe
         FileUtils.mkdir_p(@ansible_host_vars_path) unless File.exists?(@ansible_host_vars_path)
         Dir.foreach(@ansible_host_vars_path) {|f| fn = File.join(@ansible_host_vars_path, f); File.delete(fn) if f.end_with?(".yml")}

data/lib/vagrant/compose/util/node.rb

@@ -1,19 +1,45 @@
 module VagrantPlugins
   module Compose
 
-    # Definisce un nodo, ovvero uno delle istanze di nodi che compongono il cluster
+    # This class define a node throught a set of setting to be used when creating vagrant machines in the cluster.
+    # Settings will be assigned value by cluster.compose method, according with the connfiguration 
+    # of the group of nodes to which the node belongs.
     class Node
+
+      # The vagrant base box to be used for creating the vagrant machine that implements the node. 
       attr_reader :box
+
+      # The box name for this node a.k.a. the name for the machine in VirtualBox/VMware console.
       attr_reader :boxname
+
+      # The hostname for the node.
       attr_reader :hostname
+
+      # The fully qualified name for the node.
       attr_reader :fqdn
+
+      # The list of aliases a.k.a. alternative host names for the node.
       attr_reader :aliases
+
+      # The ip for the node.      
       attr_reader :ip
+
+      # The cpu for the node.
       attr_reader :cpus
+
+      # The memory for the node.
       attr_reader :memory
+
+      # The list of ansible_groups for the node.
       attr_reader :ansible_groups
+      
+      # A set of custom attributes for the node.
       attr_reader :attributes
+      
+      # A number identifying the node within the group of nodes to which the node belongs.
       attr_reader :index
+      
+      # A number identifying the group of nodes to which the node belongs.
       attr_reader :group_index
 
       def initialize(box, boxname, hostname, fqdn, aliases, ip, cpus, memory, ansible_groups, attributes, index, group_index) 

data/lib/vagrant/compose/util/node_group.rb

@@ -3,21 +3,45 @@ require_relative "node"
 module VagrantPlugins
   module Compose
 
-    # Definisce un node group, ovvero un insieme di nodi con caratteristiche omogenee.
-    # i singoli nodi del gruppo, sono generati in fase di compose tramite delle espressioni 
-    # che generano i valori degli attributi che caratterizzano ogni nodo 
+    # This class defines a group of nodes, representig a set of vagrant machines with similar characteristics.
+    # Nodes will be composed by NodeGroup.compose method, according with the configuration of values/value_generator
+    # of the group of node itself.
     class NodeGroup 
-      attr_reader :uid
+
+      # A number identifying the group of nodes withing the cluster.
+      attr_reader :index
+      
+      # The name of the group of nodes 
       attr_reader :name
+      
+      # The number of nodes/instances to be created in the group of nodes.
       attr_reader :instances
+      
+      # The vagrant base box to be used for creating vagrant machines implementing nodes in this group. 
       attr_accessor :box
+      
+      # The value geneator to be used for assigning to each node in this group a box name a.k.a. the name for the machine in VirtualBox/VMware console.
       attr_accessor :boxname
+      
+      # The value geneator to be used for assigning to each node in this group a unique hostname
       attr_accessor :hostname
+      
+      # The value geneator to be used for assigning to each node in this group a unique list of aliases a.k.a. alternative host names
       attr_accessor :aliases
+      
+      # The value geneator to be used for assigning to each node in this groupa unique ip
       attr_accessor :ip
+      
+      # The value/value geneator to be used for assigning to each node in this group cpus
       attr_accessor :cpus
+      
+      # The value/value geneator to be used for assigning to each node in this group memory
       attr_accessor :memory
+      
+      # The value/value geneator to be used for assigning each node in this group to a list of ansible groups
       attr_accessor :ansible_groups
+      
+      # The value/value geneator to be used for assigning a dictionary with custom attributes - Hash(String, obj) - to each node in this group.
       attr_accessor :attributes
 
       def initialize(index, instances, name)  
@@ -26,13 +50,18 @@ module VagrantPlugins
         @instances = instances
       end  
 
-      # compone il gruppo, generando le istanze dei vari nodi
+      # Composes the group of nodes, by creating the requiring number of nodes
+      # in accrodance with values/value_generators.
+      # Additionally, some "embedded" trasformation will be applied to attributes (boxname, hostname) and 
+      # some "autogenerated" node properties will be computed (fqdn).
       def compose(cluster_name, cluster_domain, cluster_offset)
         node_index = 0
         while node_index < @instances
           box            = generate(:box, @box, node_index) 
-          boxname        = "#{cluster_name}-#{generate(:boxname, @boxname, node_index)}" 
-          hostname       = "#{cluster_name}-#{generate(:hostname, @hostname, node_index)}" 
+          boxname        = maybe_prefix(cluster_name,
+                                        "#{generate(:boxname, @boxname, node_index)}")
+          hostname       = maybe_prefix(cluster_name,
+                                        "#{generate(:hostname, @hostname, node_index)}")
           aliases        = generate(:aliases, @aliases, node_index).join(',')
           fqdn           = cluster_domain.empty? ? "#{hostname}" : "#{hostname}.#{cluster_domain}"
           ip             = generate(:ip, @ip, node_index)
@@ -46,8 +75,16 @@ module VagrantPlugins
         end
       end
 
-      # funzione di utilità per l'esecuzione delle espressioni che generano 
-      # i valori degli attributi
+      # utility function for concatenating cluster name (if present) to boxname/hostname
+      def maybe_prefix(cluster_name, name)
+        if cluster_name && cluster_name.length > 0
+          "#{cluster_name}-" + name
+        else
+          name
+        end
+      end
+
+      # utility function for resolving value/value generators
       def generate(var, generator, node_index)
         unless generator.respond_to? :call
           return generator

data/lib/vagrant/compose/version.rb

@@ -1,5 +1,5 @@
-module Vagrant
+module Vagrant	
   module Compose
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

data/lib/vagrant/compose.rb

@@ -5,7 +5,6 @@ require "vagrant/compose/plugin"
 module VagrantPlugins
   module Compose
     lib_path = Pathname.new(File.expand_path("../compose", __FILE__))
-
     autoload :Errors, lib_path.join("errors")
 
     # This returns the path to the source of this plugin.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-compose
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Fabrizio Pandini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-31 00:00:00.000000000 Z
+date: 2016-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake