dust-deploy 0.3.3 → 0.4.0

data/bin/dust

@@ -127,9 +127,9 @@ module  Dust
 
         # runs the method with the recipe name, defined and included in recipe/*.rb
         # call recipes for each recipe that is defined for this node
-        recipes.each do |recipe, ingredients|
+        recipes.each do |recipe, config|
           ::Dust.print_recipe recipe
-          send recipe, context, server, ingredients, options
+          send recipe, 'prepare', server, recipe, context, config, options
           puts
         end
 
@@ -140,20 +140,20 @@ module  Dust
     # generate list of recipes for this node
     def generate_recipes node, context
       recipes = {}  
-      node['recipes'].each do |recipe, ingredients|
+      node['recipes'].each do |recipe, config|
       
         # in case --recipes was set, skip unwanted recipes
         next unless options[:recipes].include?(recipe) if options[:recipes]
       
         # skip disabled recipes
-        next if ingredients == 'disabled'
+        next if config == 'disabled'
       
         # check if method and thor task actually exist
         k = Thor::Util.find_by_namespace recipe
         next unless k
         next unless k.method_defined? context
       
-        recipes[recipe] = ingredients
+        recipes[recipe] = config
       end
       recipes
     end
@@ -220,8 +220,8 @@ module  Dust
 
           # if hostname is a valid ip address, don't add domain
           # so we can connect via ip address only
-          unless IPAddress.valid? hostname and n['domain']
-            n['fqdn'] += '.' + n['domain']
+          unless IPAddress.valid? hostname
+            n['fqdn'] += '.' + n['domain'] if n['domain']
           end
 
           # pass command line proxy option

data/changelog.md

@@ -1,6 +1,15 @@
 Changelog
 =============
 
+0.4.0
+------------
+
+switches to the new recipe superclass. please upgrade your recipes and templates
+-  quick hint: change node -> @node and config/ingredients -> @config, options -> @options
+-  the new system makes it easier to write recipes, and you can also use methods more easily, as configuration and node are class-wide private variables now.
+-  if you need more information, best have a look at the iptables recipe at https://github.com/kechagia/dust-deploy/blob/master/lib/dust/recipes/iptables.rb (or one of the others)
+
+
 0.3.3
 ------------
 

data/lib/dust.rb

@@ -2,6 +2,7 @@ require 'dust/helper'
 require 'dust/print_status'
 require 'dust/convert_size'
 require 'dust/server'
+require 'dust/recipe'
 
 module Dust
 end

data/lib/dust/examples/nodes/db-staging.yaml

@@ -8,14 +8,13 @@ recipes:
     dbuser: 'postgres:postgres'
 
   iptables:
-    ports:
-      - 22
-      - port: 5432
-        source: 10.13.37.0/24
-        interface: eth1
-        ip-version: 4
-      - port: [ 5404, 5405 ]
-        interface: eth1
-        protocol: udp
-
+    input:
+      - ssh: { dport: 22, match: state, state: NEW }
+      - postgres:
+          dport: 5432
+          match: state
+          state: new
+          in-interface: eth1
+          source: 10.0.0.0/8
+          
   rc_local: blockdev --setra 8192 /dev/vda

data/lib/dust/examples/nodes/mail.yaml

@@ -4,4 +4,5 @@ inherits: [ _default, _debian ]
 recipes:
   aliases: true
   iptables:
-    ports: [ 22, 25 ]
+    input:
+      - ports: { dport: [22, 25], match: state, state: NEW }

data/lib/dust/examples/nodes/mysql-production.yaml

@@ -4,7 +4,10 @@ group: mysql
 
 recipes:
   iptables:
-    ports: [ 22, 3306 ]
+    input:
+      - ssh: { dport: 22, match: state, state: NEW }
+      - mysql: { dport: 3306, match: state, state: NEW }
+
   rc_local: blockdev --setra 8192 /dev/vdc
   mysql:
     bind_address: 0.0.0.0

data/lib/dust/examples/nodes/proxy-staging.yaml

@@ -7,15 +7,7 @@ recipes:
     sites-enabled: [ proxy ]
 
   iptables:
-    ports:
-      - [ 22, 80, 443 ]
-      - port: 53
-        protocol: tcp
-        source: 10.13.37.0/24
-        interface: eth1
-        ip-version: 4
-      - port: 53
-        protocol: udp
-        source: 10.13.37.0/24
-        interface: eth1
-        ip-version: 4
+    input:
+      - ssh: { dport: 22, match: state, state: NEW }
+      - http: { dport: [80, 443], match: state, state: NEW, source: 192.168.1.0/24 }
+      - dns: { dport: 53, protocol: udp }

data/lib/dust/examples/templates/motd/motd.erb

@@ -1,6 +1,6 @@
-this is <%= Dust.blue %><%= node['hostname'] %><%= Dust.none %>, a <%= node['domain'] %> <%= node['environment'] %> server
+this is <%= Dust.blue %><%= @node['hostname'] %><%= Dust.none %>, a <%= @node['domain'] %> <%= @node['environment'] %> server
 
-% if node['environment'] == 'production'
+% if @node['environment'] == 'production'
 just in case you didn't notice the line above, maybe this cow helps:
 
  ___________________________________ 

data/lib/dust/examples/templates/postgres/pacemaker.sh.erb

@@ -1,25 +1,25 @@
 #!/bin/bash
 
 # user as which postgres runs
-PG_USER=<%= config['dbuser'] %>
+PG_USER=<%= @config['dbuser'] %>
 
 # path to postgres directory (data and archives)
-PG_DATA=<%= config['data-dir'] %>
-PG_ARCHIVE=<%= config['archive-dir'] %>
+PG_DATA=<%= @config['data-dir'] %>
+PG_ARCHIVE=<%= @config['archive-dir'] %>
 
 # path to recovery.conf (on slaves)
 RECOVERY=$PG_DATA/recovery.conf
 RECOVERY_DONE=$PG_DATA/recovery.done
 
 # path to postgresql init script
-% if node.is_gentoo?
-PG_INIT=/etc/init.d/postgresql-<%= config['version'] %>
+% if @node.is_gentoo?
+PG_INIT=/etc/init.d/postgresql-<%= @config['version'] %>
 % else
 PG_INIT=/etc/init.d/postgresql
 % end
 
 # the clustered IP
-DB_MASTER=db-<%= node['environment'] %>-master.<%= node['domain'] %>
+DB_MASTER=db-<%= @node['environment'] %>-master.<%= @node['domain'] %>
 
 
 start() {

data/lib/dust/examples/templates/postgres/postgresql.conf.erb

@@ -1,19 +1,19 @@
-data_directory = '<%= config['data-dir'] %>'
-hba_file = '<%= config['conf-dir'] %>/pg_hba.conf'
-ident_file = '<%= config['conf-dir'] %>/pg_ident.conf'
+data_directory = '<%= @config['data-dir'] %>'
+hba_file = '<%= @config['conf-dir'] %>/pg_hba.conf'
+ident_file = '<%= @config['conf-dir'] %>/pg_ident.conf'
 
 listen_addresses = '*'
 port = 5432
 ssl = on
 
-% if node['environment'] == 'production'
+% if @node['environment'] == 'production'
 max_connections = 200
 % else
 max_connections = 100
 % end
 
 
-% if node['environment'] == 'production'
+% if @node['environment'] == 'production'
 shared_buffers = 1152MB			# min 128kB
 work_mem = 12MB				# min 64kB
 maintenance_work_mem = 288MB		# min 1MB
@@ -27,7 +27,7 @@ full_page_writes = yes                  # make xfs usage safe
 
 wal_level = hot_standby			# minimal, archive, or hot_standby
 
-% if node['environment'] == 'production'
+% if @node['environment'] == 'production'
 wal_buffers = 8MB			# min 32kB
 checkpoint_segments = 16		# in logfile segments, min 1, 16MB each
 checkpoint_completion_target = 0.9	# checkpoint target duration, 0.0 - 1.0
@@ -39,13 +39,13 @@ checkpoint_completion_target = 0.9	# checkpoint target duration, 0.0 - 1.0
 
 
 archive_mode = yes
-archive_command = 'cp -i %p <%= config['archive-dir'] %>/%f < /dev/null'
+archive_command = 'cp -i %p <%= @config['archive-dir'] %>/%f < /dev/null'
 
 max_wal_senders = 5
 wal_keep_segments = 32
 hot_standby = on
 
-% if node['environment'] == 'production'
+% if @node['environment'] == 'production'
 effective_cache_size = 3584MB
 % else
 #effective_cache_size = 128MB

data/lib/dust/examples/templates/postgres/recovery.conf.erb

@@ -43,7 +43,7 @@
 # NOTE that the basename of %p will be different from %f; do not
 # expect them to be interchangeable.
 #
-restore_command = 'cp -i <%= config['archive-dir'] %>/%f %p < /dev/null'
+restore_command = 'cp -i <%= @config['archive-dir'] %>/%f %p < /dev/null'
 #
 #
 # archive_cleanup_command
@@ -97,9 +97,9 @@ restore_command = 'cp -i <%= config['archive-dir'] %>/%f %p < /dev/null'
 #
 standby_mode = 'on'
 #
-% if node['environment'] == 'production'
+% if @node['environment'] == 'production'
 primary_conninfo = '<your pg connection string here>'
-% elsif node['environment'] == 'staging'
+% elsif @node['environment'] == 'staging'
 primary_conninfo = '<your pg connection string here>'
 % end
 
@@ -111,7 +111,7 @@ primary_conninfo = '<your pg connection string here>'
 # Server will poll the trigger file path periodically and stop streaming
 # when it's found.
 #
-trigger_file = '/var/lib/postgresql/<%= config['version'] %>/master_trigger'
+trigger_file = '/var/lib/postgresql/<%= @config['version'] %>/master_trigger'
 #
 #---------------------------------------------------------------------------
 # HOT STANDBY PARAMETERS

data/lib/dust/examples/templates/zabbix_agent/zabbix_agentd.conf.erb

@@ -10,7 +10,7 @@
 # Note that hostnames must resolve hostname->IP address and
 # IP address->hostname.
 
-Server=zabbix.<%= node['domain'] %>
+Server=zabbix.<%= @node['domain'] %>
 
 # Server port for sending active checks
 
@@ -18,7 +18,7 @@ Server=zabbix.<%= node['domain'] %>
 
 # Unique hostname. Required for active checks.
 
-Hostname=<%= node['fqdn'] %>
+Hostname=<%= @node['fqdn'] %>
 
 # Listen port. Default is 10050
 
@@ -59,22 +59,22 @@ DebugLevel=3
 
 # Name of PID file
 
-% if node.uses_apt?
+% if @node.uses_apt?
 PidFile=/var/run/zabbix-agent/zabbix_agentd.pid
-% elsif node.uses_emerge?
+% elsif @node.uses_emerge?
 PidFile=/var/run/zabbix/zabbix_agentd.pid
-% elsif node.uses_rpm?
+% elsif @node.uses_rpm?
 PidFile=/var/run/zabbix/zabbix_agentd.pid
 % end
 
 # Name of log file.
 # If not set, syslog will be used
 
-% if node.uses_apt?
+% if @node.uses_apt?
 LogFile=/var/log/zabbix-agent/zabbix_agentd.log
-% elsif node.uses_emerge?
+% elsif @node.uses_emerge?
 LogFile=/var/log/zabbix/zabbix_agentd.log
-% elsif node.uses_emerge?
+% elsif @node.uses_emerge?
 LogFile=/var/log/zabbix/zabbix_agentd.log
 % end
 
@@ -91,21 +91,21 @@ Timeout=30
 # Note that shell command must not return empty string or EOL only
 
 # system updates
-% if node.uses_apt?
+% if @node.uses_apt?
 UserParameter=debian.updates,aptitude search '~U' |wc -l
 UserParameter=debian.security,debsecan --suite squeeze --only-fixed --format packages |wc -l
 
-% elsif node.uses_emerge?
+% elsif @node.uses_emerge?
 UserParameter=gentoo.security,glsa-check -t all 2>/dev/null | wc -l
 UserParameter=gentoo.updates,emerge -uNDp @world | grep ebuild|wc -l
 UserParameter=gentoo.portage,emerge --info| grep 'Timestamp of tree' | sed -e s/'Timestamp of tree':// -e 's/\n//' | xargs -I {} date --date={} +%s |xargs -I {} expr $(date +%s) - {}
 UserParameter=gentoo.config,find /etc/ -name '._cfg*' 2>/dev/null|wc -l
 
-% elsif node.uses_rpm?
+% elsif @node.uses_rpm?
 UserParameter=centos.updates,yum check-update -q |wc -l
 % end
 
-% if node.package_installed?( [ 'postgresql-server', 'postgresql' ], true )
+% if @node.package_installed?( [ 'postgresql-server', 'postgresql' ], true )
 # postgres
 UserParameter=psql.version,psql --version|head -n1
 UserParameter=psql.server_processes,psql -U zabbix -t -c "select sum(numbackends) from pg_stat_database" postgres
@@ -121,7 +121,7 @@ UserParameter=psql.blks_hit,psql -U zabbix -t -c "select sum(blks_hit) from pg_s
 UserParameter=psql.blks_read,psql -U zabbix -t -c "select sum(blks_read) from pg_stat_database" postgres
 % end
 
-% if node.package_installed?('arcconf', true)
+% if @node.package_installed?('arcconf', true)
 # adaptec raid
 UserParameter=raid.smart_warnings,/sbin/arcconf getconfig 1 pd |grep "S.M.A.R.T. warnings" | awk '{SMART += $4} END {print SMART}'
 UserParameter=raid.disk_rpm,/sbin/arcconf getconfig 1 pd |grep "Power State" |grep -v "Full rpm" |wc -l

data/lib/dust/recipe.rb

@@ -0,0 +1,15 @@
+class Recipe < Thor
+
+  desc 'prepare', 'prepare recipe (do not use manually)'
+  def prepare node, recipe, context, config, options
+
+    # prepare class variables
+    @template_path = "./templates/#{recipe}"
+    @node = node
+    @config = config
+    @options = options
+
+    # run task
+    send context
+  end
+end

data/lib/dust/recipes/aliases.rb

@@ -1,13 +1,11 @@
-class Aliases < Thor
+class Aliases < Recipe
   desc 'aliases:deploy', 'installs email aliases'
-  def deploy node, ingredients, options
-    template_path = "./templates/#{ File.basename(__FILE__).chomp( File.extname(__FILE__) ) }"
-
-    return unless node.package_installed? 'postfix'
-    node.scp "#{template_path}/aliases", '/etc/aliases'
+  def deploy 
+    return unless @node.package_installed? 'postfix'
+    @node.scp "#{@template_path}/aliases", '/etc/aliases'
 
     ::Dust.print_msg 'running newaliases'
-    ::Dust.print_result node.exec('newaliases')[:exit_code]
+    ::Dust.print_result @node.exec('newaliases')[:exit_code]
   end
 end
 

data/lib/dust/recipes/basic_setup.rb

@@ -1,33 +1,31 @@
-class BasicSetup < Thor
+class BasicSetup < Recipe
   desc 'basic_setup:deploy', 'installs basic packages and config files'
-  def deploy node, ingredients, options
-    template_path = "./templates/#{ File.basename(__FILE__).chomp( File.extname(__FILE__) ) }"
-
+  def deploy 
     # install some basic packages
     ::Dust.print_msg "installing basic packages\n"
 
-    node.install_package 'screen', :indent => 2
-    node.install_package 'rsync', :indent => 2
-    node.install_package 'psmisc', :indent => 2 if node.uses_apt?
+    @node.install_package 'screen', :indent => 2
+    @node.install_package 'rsync', :indent => 2
+    @node.install_package 'psmisc', :indent => 2 if @node.uses_apt?
 
-    if node.uses_rpm?
-      node.install_package 'vim-enhanced', :indent => 2
+    if @node.uses_rpm?
+      @node.install_package 'vim-enhanced', :indent => 2
     else
-      node.install_package 'vim', :indent => 2
+      @node.install_package 'vim', :indent => 2
     end
 
-    if node.uses_apt?
-      node.install_package 'git-core', :indent => 2
+    if @node.uses_apt?
+      @node.install_package 'git-core', :indent => 2
     else
-      node.install_package 'git', :indent => 2
+      @node.install_package 'git', :indent => 2
     end
     puts
     
     # deploy basic configuration for root user
     ::Dust.print_msg "deploying configuration files for root\n"
-    Dir["#{template_path}/.*"].each do |file|
+    Dir["#{@template_path}/.*"].each do |file|
       next unless File.file? file
-      node.scp file, "/root/#{File.basename file}", :indent => 2
+      @node.scp file, "/root/#{File.basename file}", :indent => 2
     end
 
   end

data/lib/dust/recipes/debsecan.rb

@@ -1,10 +1,10 @@
-class Debsecan < Thor
+class Debsecan < Recipe
   desc 'debsecan:deploy', 'installs and configures debian security package "debsecan"'
-  def deploy node, config, options
-    node.collect_facts
+  def deploy
+    @node.collect_facts
 
-    if node.is_os? ['ubuntu', 'debian']
-      node.install_package 'debsecan'
+    if @node.is_os? ['ubuntu', 'debian']
+      @node.install_package 'debsecan'
 
       ::Dust.print_msg 'configuring debsecan'
 
@@ -25,7 +25,7 @@ class Debsecan < Thor
       # configures the suite
       config_file += "# For better reporting, specify the correct suite here, using the code\n" +
                      "# name (that is, \"sid\" instead of \"unstable\").\n" +
-                     "SUITE=#{node['lsbdistcodename']}\n\n"
+                     "SUITE=#{@node['lsbdistcodename']}\n\n"
 
       # which user gets the reports?
       config_file += "# Mail address to which reports are sent.\n" +
@@ -36,7 +36,7 @@ class Debsecan < Thor
                      "# built-in default.\n" +
                      "SOURCE=#{config['source']}\n\n"
 
-      node.write '/etc/default/debsecan', config_file, :quiet => true
+      @node.write '/etc/default/debsecan', config_file, :quiet => true
       ::Dust.print_ok
     else
       ::Dust.print_failed 'os not supported'