hosttag 0.12

data/README

@@ -0,0 +1,92 @@
+Introduction
+------------
+
+Hosttag is a client for tagging hostnames into groups or classes, storing 
+the mappings in a redis datastore. It requires the 'redis' rubygem.
+
+
+Hosttag assumes your redis server is found on a server called 'hosttag' on
+the default redis port (6379). You can either setup 'hosttag' as a hostname
+alias in a local hosts file, or specify an alternative host to use in a
+HOSTTAG_SERVER environment variable, or explicitly via a -s/--server
+<hostname> argument. Similarly, an alternate port can be specified using a
+HOSTTAG_PORT environment variable, or a -p/--port <port> command line
+argument.
+
+
+
+Basic Usage
+-----------
+
+  # Set some tags (-T says assume anything you don't know is a tag)
+  $ htset -T zeus dell centos centos5 server
+  $ htset -T minerva dell centos centos6 laptop
+  $ htset -T hermes hp ubuntu lucid desktop
+  $ htset -T athena hp ubuntu maverick server
+
+
+  # Queries
+  $ ht dell               
+  minerva zeus
+
+  $ ht ubuntu
+  hermes athena
+
+  $ ht -o hp dell         # -o/--or ORs arguments
+  hermes minerva zeus
+
+  $ ht -a ubuntu server   # -a/--and ANDs arguments
+  athena
+
+  $ ht -A                 # all hosts
+  athena hermes minerva zeus
+
+  $ ht -T                 # all tags
+  centos centos5 centos6 dell desktop hp laptop lucid maverick server
+
+
+
+
+Security
+--------
+
+A warning on security: basically, there isn't any. Anyone who can get write
+to your redis server can write, rewrite, and delete all your hosttags. So
+you should only use hosttag on a trusted network.
+
+Redis supports a password-ed mode, and it might make sense to use that via
+a config file or something, so you could at least restrict usage via file
+permissions (although traffic would still be in the clear, I believe). For
+now, though, there's no security.
+
+
+
+Installation
+------------
+
+To install from source, unpack the tarball and run 'rake install' (requires
+rubygems and rake). You can set GEM_HOME to an alternate install directory 
+(e.g. ~/.gem) if you want to install somewhere other than your gem default.
+
+RPMs are available for CentOS/RHEL {5,6} from the Open Fusion repository:
+
+  http://www.openfusion.net/linux/openfusion_rpm_repository
+
+
+
+
+Author
+------
+
+Gavin Carr <gavin@openfusion.com.au>, http://www.openfusion.net/
+
+Copyright 2010-2011 Gavin Carr.
+
+
+
+Licence
+-------
+
+This software is free software, licensed under the GNU Public License v3
+or any later version.
+

data/Rakefile

@@ -0,0 +1,30 @@
+
+desc 'Run tests'
+task :test do
+  system 'ruby -I lib -I test test/ts_all.rb'
+end
+
+gemspec = eval(File.read(Dir["*.gemspec"].first))
+
+desc "Validate the gemspec"
+task :validate do
+  gemspec.validate
+end
+
+desc "Build gem locally"
+task :build => :validate do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/#{gemspec.name}-#{gemspec.version}"
+end
+
+desc "Clean automatically generated files"
+task :clean do
+  FileUtils.rm_rf "pkg"
+end
+

data/TODO

@@ -0,0 +1,4 @@
+- ht -l -A doesn't work as expected
+- ht -l -T doesn't work as expected
+- it would be nice to able to do 'ht -x usd001 na', 'ht -X ignore_file na', 'ht -x usd001 -A'
+- it would also be nice to able to do 'ht -n dell -n supermicro -A', 'ht -n dell server', 'ht -N not_file -A', 'ht -N not_file server'

data/bin/hosttag

@@ -0,0 +1,168 @@
+#!/usr/bin/env ruby
+#
+# hosttag query client
+#
+# Usage:
+#   ht <tag>
+#
+#   ht [-a] <tag1> <tag2>           Show hosts with tag1 AND tag2 (intersection, default)
+#   ht -o <tag1> <tag2>             Show hosts with tag1 OR  tag2 (union)
+#
+#   ht -A                           Show all hosts
+#
+#   ht -t <host>                    Show tags on 'host'
+#   ht -t [-o] <host1> <host2>      Show tags on 'host' OR  'host2' (union, default)
+#   ht -t -a <host1> <host2>        Show tags on 'host' AND 'host2' (intersection)
+#
+#   ht -T                           Show all tags
+#
+
+require 'optparse'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'hosttag'
+include Hosttag
+
+# -------------------------------------------------------------------------
+# Subroutines
+
+def die(error)
+  warn error
+  exit 1
+end
+
+def usage(opts, msg = nil)
+  if msg
+    warn msg
+    $stderr.puts
+  end
+  warn opts
+  exit
+end
+
+def render(results, options, arg = nil)
+  return unless results and results.length > 0
+  # Report
+  if options[:list]
+    puts "#{arg}: #{results.sort.join(' ')}"
+  else
+    puts results.sort.join(options[:join])
+  end
+end
+
+# -------------------------------------------------------------------------
+# Main
+
+options = { :join => ' ' }
+
+opts = OptionParser.new
+opts.banner = "Usage: hosttag [options] <tag> [<tag2>...]"
+opts.on('-?', '-h', '--help') do
+  puts opts
+  exit
+end
+opts.on('-a', '--and', 'Report hosts with ALL the given tags (AND result sets)') do
+  options[:rel] = :and
+end
+opts.on('-o', '--or',  'Report hosts with ANY of the given tags (OR result sets)') do
+  options[:rel] = :or
+end
+opts.on('-l', '--list', "List hosts/tags separately for each tag/host") do
+  options[:list] = 1
+end
+opts.on('-t', '--tag', '--tags', "Tag mode: report tags for the given hosts") do
+  options[:type] = :host
+end
+opts.on('-A', '--all', 'Report all hosts') do
+  if not options[:all]
+    options[:all] = :hosts
+  elsif options[:all] == :hosts
+    options[:include_skip?] ||= true
+  else
+    usage(opts, "Error: can't specify both -A/--all-hosts and -T/--all-tags")
+  end
+end
+opts.on('-T', '--all-tags', 'Report all tags') do
+  if not options[:all]
+    options[:all] = :tags
+  elsif options[:all] == :tags
+    options[:include_skip?] ||= true
+  else
+    usage(opts, "Error: can't specify both -A/--all-hosts and -T/--all-tags")
+  end
+end
+opts.on('-1', 'List one item per line') do
+  options[:one] = 1
+  options[:join] = "\n"
+end
+opts.on('-d', '--delimiter=STR', String, 'Delimiter for reporting (default " ")') do |val|
+  options[:join] = val
+end
+opts.on('-s=ARG', '--server=ARG', String, 'Server hostname to connect to. Default: hosttag') do |val|
+  options[:server] = val
+end
+opts.on('-p=ARG', '--port=ARG', Integer, 'Server port to connect to') do |val|
+  options[:port] = val
+end
+opts.on('--ns=STR', '--namespace=STR', String, 'Namespace into which we load hosttag data. Default: hosttag') do |val|
+  options[:namespace] = val
+end
+opts.on('-v', '--verbose', 'Verbose output') do
+  options[:verbose] = true
+end
+
+# Parse options
+begin
+  args = opts.parse(ARGV) 
+rescue => e
+  usage(opts, "Error: " << e)
+end
+
+# Sanity checks
+if args.length == 0 and not options[:all]
+  usage(opts) 
+end
+if args.length > 0 and options[:all]
+  if options[:all] == :hosts
+    error = "Error: can't specify hosts with -A/--all-hosts"
+  else
+    error = "Error: can't specify tags with -T/--all-tags"
+  end
+  usage(opts, error) 
+end
+if options[:list] and options[:one]
+  usage(opts, "Warning: -L/--list and -1 are incompatible")
+end 
+
+# All request
+if options[:all]
+  if options[:all] == :hosts
+    all = hosttag_all_hosts(options)
+  else
+    all = hosttag_all_tags(options)
+  end
+  if options[:list]
+    args = all
+  else
+    render all, options
+    exit
+  end
+end
+
+# Standard request
+# In list mode, process all args separately; otherwise, do them all at once
+if options[:list]
+  arg_list = args
+else
+  arg_list = [ args ]
+end
+
+arg_list.each do |a|
+  begin
+    results = hosttag_lookup(a, options)
+    render results, options, a
+  rescue => e
+    warn e
+  end
+end
+

data/bin/ht

@@ -0,0 +1,168 @@
+#!/usr/bin/env ruby
+#
+# hosttag query client
+#
+# Usage:
+#   ht <tag>
+#
+#   ht [-a] <tag1> <tag2>           Show hosts with tag1 AND tag2 (intersection, default)
+#   ht -o <tag1> <tag2>             Show hosts with tag1 OR  tag2 (union)
+#
+#   ht -A                           Show all hosts
+#
+#   ht -t <host>                    Show tags on 'host'
+#   ht -t [-o] <host1> <host2>      Show tags on 'host' OR  'host2' (union, default)
+#   ht -t -a <host1> <host2>        Show tags on 'host' AND 'host2' (intersection)
+#
+#   ht -T                           Show all tags
+#
+
+require 'optparse'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'hosttag'
+include Hosttag
+
+# -------------------------------------------------------------------------
+# Subroutines
+
+def die(error)
+  warn error
+  exit 1
+end
+
+def usage(opts, msg = nil)
+  if msg
+    warn msg
+    $stderr.puts
+  end
+  warn opts
+  exit
+end
+
+def render(results, options, arg = nil)
+  return unless results and results.length > 0
+  # Report
+  if options[:list]
+    puts "#{arg}: #{results.sort.join(' ')}"
+  else
+    puts results.sort.join(options[:join])
+  end
+end
+
+# -------------------------------------------------------------------------
+# Main
+
+options = { :join => ' ' }
+
+opts = OptionParser.new
+opts.banner = "Usage: hosttag [options] <tag> [<tag2>...]"
+opts.on('-?', '-h', '--help') do
+  puts opts
+  exit
+end
+opts.on('-a', '--and', 'Report hosts with ALL the given tags (AND result sets)') do
+  options[:rel] = :and
+end
+opts.on('-o', '--or',  'Report hosts with ANY of the given tags (OR result sets)') do
+  options[:rel] = :or
+end
+opts.on('-l', '--list', "List hosts/tags separately for each tag/host") do
+  options[:list] = 1
+end
+opts.on('-t', '--tag', '--tags', "Tag mode: report tags for the given hosts") do
+  options[:type] = :host
+end
+opts.on('-A', '--all', 'Report all hosts') do
+  if not options[:all]
+    options[:all] = :hosts
+  elsif options[:all] == :hosts
+    options[:include_skip?] ||= true
+  else
+    usage(opts, "Error: can't specify both -A/--all-hosts and -T/--all-tags")
+  end
+end
+opts.on('-T', '--all-tags', 'Report all tags') do
+  if not options[:all]
+    options[:all] = :tags
+  elsif options[:all] == :tags
+    options[:include_skip?] ||= true
+  else
+    usage(opts, "Error: can't specify both -A/--all-hosts and -T/--all-tags")
+  end
+end
+opts.on('-1', 'List one item per line') do
+  options[:one] = 1
+  options[:join] = "\n"
+end
+opts.on('-d', '--delimiter=STR', String, 'Delimiter for reporting (default " ")') do |val|
+  options[:join] = val
+end
+opts.on('-s=ARG', '--server=ARG', String, 'Server hostname to connect to. Default: hosttag') do |val|
+  options[:server] = val
+end
+opts.on('-p=ARG', '--port=ARG', Integer, 'Server port to connect to') do |val|
+  options[:port] = val
+end
+opts.on('--ns=STR', '--namespace=STR', String, 'Namespace into which we load hosttag data. Default: hosttag') do |val|
+  options[:namespace] = val
+end
+opts.on('-v', '--verbose', 'Verbose output') do
+  options[:verbose] = true
+end
+
+# Parse options
+begin
+  args = opts.parse(ARGV) 
+rescue => e
+  usage(opts, "Error: " << e)
+end
+
+# Sanity checks
+if args.length == 0 and not options[:all]
+  usage(opts) 
+end
+if args.length > 0 and options[:all]
+  if options[:all] == :hosts
+    error = "Error: can't specify hosts with -A/--all-hosts"
+  else
+    error = "Error: can't specify tags with -T/--all-tags"
+  end
+  usage(opts, error) 
+end
+if options[:list] and options[:one]
+  usage(opts, "Warning: -L/--list and -1 are incompatible")
+end 
+
+# All request
+if options[:all]
+  if options[:all] == :hosts
+    all = hosttag_all_hosts(options)
+  else
+    all = hosttag_all_tags(options)
+  end
+  if options[:list]
+    args = all
+  else
+    render all, options
+    exit
+  end
+end
+
+# Standard request
+# In list mode, process all args separately; otherwise, do them all at once
+if options[:list]
+  arg_list = args
+else
+  arg_list = [ args ]
+end
+
+arg_list.each do |a|
+  begin
+    results = hosttag_lookup(a, options)
+    render results, options, a
+  rescue => e
+    warn e
+  end
+end
+