zinv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86314f00d9a9972624e43251f0229d59db862cfc
+  data.tar.gz: 290eeae1e53e7aaa8b15c670153fc5cc909969d9
+SHA512:
+  metadata.gz: 313efc1d49516bf8bf32d31c2c733d60b80ca2220037e832e16f000a4e5c17c3c70af0cabd3f3f3a85c4da8e5efcfed894eaf903263e29450021998eea9a4d5e
+  data.tar.gz: aba6e685e120f0e5b05d1ef09f1b86a74329fc204aad85c31ea034e0d29b60a6a532c720d73867980d18a41e9d6da8b19cd2a3aa116f373994b267fdf142f91b

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zinv.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Dave Parker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Zinv
+
+zinv.rb generates a dynamic inventory structure for Ansible based on your Zabbix installation's data.  It generates groups based on both host groups and templates by collecting all hosts that use templates directly or indirectly derived from a template list you provide in an environment variable.  It also provides a small "hook" for the addition of hosts that are not yet defined in Zabbix.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zinv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zinv
+
+## Usage
+
+To use zinv.rb you must (by one of the several methods available) tell Ansible to use zinv.rb as its inventory.   Having done that, define the following environment variables for zinv.rb to work properly:
+
+* ZINV_ZABBIX_URL = your zabbix web interface URL
+* ZINV_ZABBIX_USER = user to log into zabbix as
+* ZINV_ZABBIX_PASS = password for that user
+
+
+zinv.rb by default uses the following templates as its "root" ones:
+
+* Template OS Linux
+* Template OS Linux Active
+* Template SNMP OS Linux
+
+You can override this by setting the following:
+
+* ZINV_ROOT_TEMPLATES = comma separated list of 'root' templates to seed template tree generation (optional)
+
+You can insert hosts into the inventory "manually" by setting the following:
+
+* ZINV_ADD_HOSTS = comma separated list of host names to inject into the inventory under group New_Hosts
+
+In all cases, zinv.rb presumes that the host names it's getting from zabbix (or you, in the case of ZINV_ADD_HOSTS) are resolvable by the host you're running ansible on.  Which is to say if you have a host called myhost1, you should be able to ping myhost1 on the ansible machine.  The implication is that you've either defined all your host names as fqdns in Zabbix, or you've set up your resolver search list properly.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zinv. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zinv"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/zinv.rb

@@ -0,0 +1,218 @@
+#!/usr/bin/env ruby
+require 'zabbixapi'
+require 'json'
+require 'trollop'
+require 'awesome_print'
+require 'set'
+require 'yaml'
+
+
+
+
+if not (ENV['ZINV_ZABBIX_URL'] and ENV['ZINV_ZABBIX_USER'] and ENV['ZINV_ZABBIX_PASS'])
+	puts "\nYou *must* define the following environment variables for zinv.rb to work properly:\n\n"
+	puts "ZINV_ZABBIX_URL = your zabbix web interface URL"
+	puts "ZINV_ZABBIX_USER = user to log into zabbix as"
+	puts "ZINV_ZABBIX_PASS = password for that user\n\n"
+	puts "OPTIONAL variables are:"
+	puts "ZINV_ROOT_TEMPLATES = comma separated list of 'root' templates to seed template tree generation (optional)"
+	puts "ZINV_ADD_HOSTS = comma separated list of host names to inject into the inventory under group New_Hosts"
+	puts "\nExiting"
+	exit(1)
+end
+
+
+
+
+# This list forms the basis for the collection of hosts and
+# templates included in inventory.  Any template directly or
+# indirectly derived from these will be included.  Any host
+# using any of the included templates will be included.
+
+roottemplatenames = [
+                'Template OS Linux',
+                'Template OS Linux Active',
+                'Template SNMP OS Linux'
+]
+
+if ENV['ZINV_ROOT_TEMPLATES']
+   roottemplatenames = ENV['ZINV_ROOT_TEMPLATES'].split(',')
+end
+
+# Assign a comma separated list of host names to this before running
+# ansible-playbook to have hosts not yet in zabbix listed in inventory
+runtimehostvar = 'ZINV_ADD_HOSTS'
+
+opts = Trollop::options do
+    opt :list, "List entire inventory" # required by ansible
+    opt :host, "List a single host", :type => :string  # required by ansible
+    opt :debug, "Debugging verbosity"
+    opt :groups, "Dump groups list"
+    opt :templates, "Dump templates list"
+end
+
+# Generate an in-memory host group with the comma delim list in this env var
+if ENV[runtimehostvar]
+    newhostnamelist = ENV[runtimehostvar].split(',')
+else
+    newhostnamelist = Array.new
+end
+
+# This is here just to satisfy the spec.  This script generates a top level
+# _meta element which deprecates the requirement so this is basically
+# dead code.
+if opts[:host]
+    puts Hash.new.to_json
+    exit
+end
+
+# Connect to zabbix.
+zbx = ZabbixApi.connect(
+  :url => "#{ENV['ZINV_ZABBIX_URL']}/api_jsonrpc.php",
+  :user => ENV['ZINV_ZABBIX_USER'],
+  :password => ENV['ZINV_ZABBIX_PASS'],
+  :debug => opts[:debug]
+)
+
+
+# Get all the root template objects
+roottemplates = zbx.query(
+    :method => 'template.get',
+    :params => {
+        :filter => {
+            :host =>  roottemplatenames
+        }
+    }
+)
+
+
+ansibletemplates = roottemplates # This list is used by host gathering logic later on
+ansibletemplategroups = Hash.new # This holds hosts-by-template - rendered as inventory later
+prevchunk = roottemplates # this is for the "walking the tree" logic
+
+# Set up template groups for the root templates
+prevchunk.each {|template|
+    name = template['name'].gsub(/[ ]/,'_')
+    if not ansibletemplategroups.has_key?(name)
+        ansibletemplategroups[name] = {'hosts' => Set.new}
+    end
+}
+
+# Find all templates that derive from the root ones, adding to ansibletemplates
+# and ansibletemplategroups as we go
+begin
+    nextchunk = zbx.query(
+        :method => 'template.get',
+        :params => {
+            :parentTemplateids => prevchunk.collect {|each| each['templateid']}
+        }
+    )
+    nextchunk.each {|template|
+        name = template['name'].gsub(/[ ]/,'_')
+        if not ansibletemplategroups.has_key?(name)
+            ansibletemplategroups[name] = {'hosts' => Set.new}
+        end
+    }
+
+    if nextchunk.size > 0
+        ansibletemplates += nextchunk
+        prevchunk = nextchunk
+    end
+end while nextchunk.size > 0
+
+# Also fudge up a container for all hosts. Probably not necessary as ansible does this
+# for us
+ansiblehostgroups = {'All_Hosts' => {'hosts' => Set.new}}
+# And fudge up a group for whatever host names came at us from the environment variable above
+ansiblehostgroups['New_Hosts'] = {'hosts' => newhostnamelist}
+
+# This has will hold host variables from the notes field in zabbix's inventory for a host.
+# We render this under the _meta top level entity below. By doing this we force
+# ansible to *not* call --host <hostname> a gillion times, which saves a lot of time & cpu
+metadata = Hash.new
+
+
+# Gather all the hosts that use the templates we've collected.  We'll put them in
+# two types of hashes: host group hashes and template group hashes.
+zbx.hostgroups.all.each { |name,id|
+    hostlist = Array.new
+    # Gather hosts using our templates, ensuring we also grab inventory for this host
+    hosts = zbx.query(
+        :method => 'host.get',
+        :params => {
+            :groupids => [id],
+            :templateids => ansibletemplates.collect {|each| each['templateid']},
+            :selectParentTemplates => [
+                'name'
+            ],
+            :selectInventory => 'extend'
+        }
+    )
+
+    # For each host we've collected, add it to each group it belongs in (both host and template),
+    # but only if its inclusion in those groups is not overridded by the string DONOTMANAGE
+    # in the host's description field.
+    hosts.each { |host|
+        # You can put the string DONOTMANAGE anywhere in the zabbix host description
+        # If you do that the node in question will be excluded from inventory
+        if host['description']  !~ /DONOTMANAGE/
+            hostlist.push(host['host'])
+            host['parentTemplates'].each { |template|
+                templatename = template['name'].gsub(/[ ]/,'_')
+                if ansibletemplategroups.has_key?(templatename)
+                    ansibletemplategroups[templatename]['hosts'].add(host['name'])
+                end
+            }
+            # If you need to define host variables, in the zabbix host definition select "Inventory" and put yaml in the Notes field.
+            # See the host "speedtest" for an example.  First line should be '---', then each line after is "key: value"
+	    # e.g.:
+            # ---
+            # ereiamjh: The ghost in the machine
+            # youshouldwatch: Brazil
+            #
+            if host.has_key?('inventory') and host['inventory'].class == Hash and host['inventory'].has_key?('notes') and host['inventory']['notes'].size > 0
+                begin
+                    metadata[host['name']] = YAML.load(host['inventory']['notes'])
+                rescue Exception => e
+                    puts "Error parsing inventory notes field for host #{host['name']} - SKIPPING"
+                    ap e
+                end
+            end
+
+        end
+    }
+
+    if hostlist.size > 0
+        ansiblehostgroups[name.gsub(/[ ]/,'_')] = {'hosts'=>hostlist}
+        ansiblehostgroups['All_Hosts']['hosts'].merge(hostlist) # probably don't need this
+    end
+}
+
+# These are just for more informative dumps...
+hostgroupcount = ansiblehostgroups.keys.size
+if opts[:groups]
+    puts ansiblehostgroups.keys.sort.join("\n")
+end
+if opts[:templates]
+    puts ansibletemplategroups.keys.sort.join("\n")
+end
+templategroupcount = ansibletemplategroups.keys.size
+ansiblehostgroups['All_Hosts']['hosts'] = ansiblehostgroups['All_Hosts']['hosts'].to_a
+
+# Here we add the top level _meta element containing whatever host variables we might have 
+# defined in zabbix.  This really *needs* to be here; minus this performance is just awful.
+ansiblehostgroups['_meta'] = { 'hostvars' => metadata }
+ansibletemplategroups.each { |k,v| 
+    v['hosts'] = v['hosts'].to_a
+    if v['hosts'].size > 0
+    	ansiblehostgroups[k] = v
+    end
+}
+if opts[:list]  # This is the final output to ansible - the inventory
+    puts ansiblehostgroups.to_json
+elsif not (opts[:groups] or opts[:templates]) # informative dump
+    ap ansiblehostgroups
+    puts "Root templates #{roottemplatenames.join(',')}"
+    puts "#{hostgroupcount} host groups, #{templategroupcount} template groups"
+    puts "#{ansiblehostgroups['All_Hosts']['hosts'].size} hosts total"
+end

data/lib/zinv.rb

@@ -0,0 +1,5 @@
+require "zinv/version"
+
+module Zinv
+  # Your code goes here...
+end

data/lib/zinv/version.rb

@@ -0,0 +1,3 @@
+module Zinv
+  VERSION = "0.1.0"
+end

data/zinv.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zinv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zinv"
+  spec.version       = Zinv::VERSION
+  spec.authors       = ["Dave Parker"]
+  spec.email         = ["david.parker _AT_ nsight.com"]
+
+  spec.summary       = %q{Ansible dynamic inventory script for hosts monitored by zabbix}
+  spec.homepage      = "https://github.com/svdasein/zinv"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "zabbixapi", '~> 3.1'
+  spec.add_runtime_dependency "trollop", '~> 2.1'
+  spec.add_runtime_dependency "awesome_print", '~> 1.8'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: zinv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Parker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: zabbixapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 
+email:
+- david.parker _AT_ nsight.com
+executables:
+- zinv.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/zinv.rb
+- lib/zinv.rb
+- lib/zinv/version.rb
+- zinv.gemspec
+homepage: https://github.com/svdasein/zinv
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ansible dynamic inventory script for hosts monitored by zabbix
+test_files: []
+has_rdoc: