oxidized 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f601ebdf3c7562322e2b76313f60e4128863968
-  data.tar.gz: c0151bcf8e6c02d53511321f198bdd7fd55ac1cf
+  metadata.gz: cdb31290367c66dd2c76fe99a93efa832e676446
+  data.tar.gz: 23e3a5a6c42f603d72e8266f2b705e03edec502b
 SHA512:
-  metadata.gz: ff1578ea27961bdf57d32433da245795a880f95e6698f1f2b37692617d4779467673c78a1e27318204c8fc5b0ef4bbb05c379bee870f1fe59365727bef7a8222
-  data.tar.gz: fde31a1ef6e58ceebe9b1bcc822efdcc37971c234b474f64daa679bb50c87f308e474c7aad132ac41f837be91e4034aaba8db346fed987cc3f3a6dea7846bc3d
+  metadata.gz: 48675858978583b89c86a3943fe4f95a78d44eedffe4ae59a0e624a608707a9e85ad93277e3bd878710777208bc45100b10dc8fd9824f67fe476d0db9577ed41
+  data.tar.gz: 4f2dfe9e24f3e6f9afe878c5cf786c89701aaeb531966d37dd2e37e188be6069cbca9358f3a61b6bf9db8cf4e02c5261bbe45d90f2625784445cec127427b8bf

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.11.0
+- FEATURE: ssh proxycommand (by @ElvinEfendi)
+- FEATURE: basic auth in HTTP source (by @laf)
+- BUGFIX: do not inject string to output before model gets it
+- BUGFIX: store pidfile in oxidized root
+
 # 0.10.0
 - FEATURE: Various refactoring (by @ElvinEfendi)
 - FEATURE: Ciena SOAS support (by @jgroom33)

data/Dockerfile

@@ -1,11 +1,15 @@
-FROM debian:latest
+FROM phusion/baseimage:0.9.18
 MAINTAINER Samer Abdel-Hafez <sam@arahant.net>
 
-RUN apt-get update && \
-	apt-get install -y ruby ruby-dev libsqlite3-dev libssl-dev pkg-config make cmake
+RUN add-apt-repository ppa:brightbox/ruby-ng && \
+	apt-get update && \
+  apt-get install -y ruby2.1 ruby2.1-dev libsqlite3-dev libssl-dev pkg-config make cmake
 
 RUN gem install oxidized oxidized-web --no-ri --no-rdoc
 
 RUN apt-get remove -y ruby-dev pkg-config make cmake
 
-RUN apt-get -y autoremove
+RUN apt-get -y autoremove
+
+ADD extra/oxidized.runit /etc/service/oxidized/run
+ADD extra/auto-reload-config.runit /etc/service/auto-reload-config/run

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oxidized (0.9.0)
+    oxidized (0.10.0)
       asetus (~> 0.1)
       net-ssh (~> 3.0, >= 3.0.2)
       rugged (~> 0.21, >= 0.21.4)

data/README.md

@@ -7,8 +7,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
 * automatically adds/removes threads to meet configured retrieval interval
 * restful API to move node immediately to head-of-queue (GET/POST /node/next/[NODE])
   * syslog udp+file example to catch config change event (ios/junos) and trigger config fetch
-  * will signal ios/junos user who made change, which output module can (git does) use (via POST)
-  * 'git blame' will show for each line who and when the change was made
+  * will signal ios/junos user who made change, which output modules can use (via POST)
+  * The git output module uses this info - 'git blame' will for each line show who made the change and when
 * restful API to reload list of nodes (GET /reload)
 * restful API to fetch configurations (/node/fetch/[NODE] or /node/fetch/group/[NODE])
 * restful API to show list of nodes (GET /nodes)
@@ -144,7 +144,7 @@ Maps define how to map a model's fields to model [model fields](https://github.c
 
 First create the directory where the CSV ```output``` is going to store device configs and start Oxidized once.
 ```
-mkdir ~/.config/oxidized/configs
+mkdir -p ~/.config/oxidized/configs
 oxidized
 ```
 
@@ -230,6 +230,11 @@ rvm use --default 2.1.2
     root@bla:~#
 ```
 
+If you want to have the config automatically reloaded (e.g. when using a http source that changes)
+```
+    root@bla:~# docker run -v /etc/oxidized:/root/.config/oxidized -p 8888:8888/tcp -e CONFIG_RELOAD_INTERVAL=3600 -t oxidized/oxidized:latest oxidized
+```
+
 ## Cookbook
 ### Debugging
 In case a model plugin doesn't work correctly (ios, procurve, etc.), you can enable live debugging of SSH/Telnet sessions. Just add a ```debug``` option, specifying a log file destination to the ```input``` section.
@@ -272,6 +277,21 @@ source:
       enable: 4
 ```
 
+### SSH Proxy Command
+
+Oxidized can `ssh` through a proxy as well. To do so we just need to set `proxy` variable.
+
+```
+...
+map:
+  name: 0
+  model: 1
+vars_map:
+  enable: 2
+  proxy: 3
+...
+```
+
 ### Source: SQLite
 
 One row per device, filtered by hostname.
@@ -296,6 +316,8 @@ source:
 
 One object per device.
 
+HTTP Supports basic auth, configure the user and pass you want to use under the http: section.
+
 ```
 source:
   default: http
@@ -326,6 +348,8 @@ output:
 
 ### Output: Git
 
+This uses the rugged/libgit2 interface. So you should remember that normal Git hooks will not be executed.
+
 ```
 output:
   default: git
@@ -455,7 +479,7 @@ Following configuration keys need to be defined for all hooks:
 ### Events
   * `node_success`: triggered when configuration is succesfully pulled from a node and right before storing the configuration.
   * `node_fail`: triggered after `retries` amount of failed node pulls.
-  * `post_store`: triggered after node configuration is stored.
+  * `post_store`: triggered after node configuration is stored (this is executed only when the configuration has changed).
 
 ## Hook type: exec
 The `exec` hook type allows users to run an arbitrary shell command or a binary when triggered.

data/extra/auto-reload-config.runit

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+if [ -z "$CONFIG_RELOAD_INTERVAL" ]; then
+    # Just stop and do nothing
+    read
+fi
+
+while true; do
+    sleep $CONFIG_RELOAD_INTERVAL
+    echo "Reloading config..."
+    curl -s http://localhost:8888/reload?format=json -O /dev/null
+done

data/extra/oxidized-report-git-commits

@@ -23,7 +23,7 @@
 #  email_output:
 #    type: exec
 #    events: [post_store, node_fail]
-#    cmd: 'update-local-repo.sh ~/gitdir/ | mail -s "Oxidized updates for ${OX_NODE_NAME}" update-recipient@example.com'
+#    cmd: '/home/oxidized/extra/oxidized-report-git-commits ~/gitdir/ | mail -s "Oxidized updates for ${OX_NODE_NAME}" update-recipient@example.com'
 #    async: true
 #    timeout: 120
 # 

data/extra/oxidized.runit

@@ -0,0 +1,2 @@
+#!/bin/bash
+exec setuser root oxidized

data/lib/oxidized/cli.rb

@@ -24,7 +24,7 @@ module Oxidized
       Config.load(@opts)
       Oxidized.setup_logger
 
-      @pidfile = File.expand_path("pid")
+      @pidfile = File.join(Oxidized::Config::Root, 'pid')
     end
 
     def crash error

data/lib/oxidized/input/ssh.rb

@@ -1,5 +1,6 @@
 module Oxidized
   require 'net/ssh'
+  require 'net/ssh/proxy/command'
   require 'timeout'
   require 'oxidized/input/cli'
   class SSH < Input
@@ -22,11 +23,15 @@ module Oxidized
       secure = Oxidized.config.input.ssh.secure
       @log = File.open(Oxidized::Config::Crash + "-#{@node.ip}-ssh", 'w') if Oxidized.config.input.debug?
       port = vars(:ssh_port) || 22
-      @ssh = Net::SSH.start @node.ip, @node.auth[:username], :port => port.to_i,
+      if proxy_host = vars(:proxy)
+        proxy =  Net::SSH::Proxy::Command.new("ssh #{proxy_host} nc %h %p")
+      end
+      @ssh = Net::SSH.start(@node.ip, @node.auth[:username], :port => port.to_i,
                             :password => @node.auth[:password], :timeout => Oxidized.config.timeout,
                             :paranoid => secure,
                             :auth_methods => %w(none publickey password keyboard-interactive),
-                            :number_of_password_prompts => 0
+                            :number_of_password_prompts => 0,
+                            :proxy => proxy)
       unless @exec
         shell_open @ssh
         begin

data/lib/oxidized/model/aosw.rb

@@ -56,7 +56,7 @@ class AOSW < Oxidized::Model
       next if line.match /Output \d Config/i
       next if line.match /(Tachometers|Temperatures|Voltages)/
       next if line.match /((Card|CPU) Temperature|Chassis Fan|VMON1[0-9])/
-      next if line.match /[0-9]+ (RPM|mV|C)$/
+      next if line.match /[0-9]+ (RPM|RPMs|mV|C)$/
       out << line.strip
     end
     out = comment out.join "\n"

data/lib/oxidized/model/ciscosmb.rb

@@ -33,9 +33,12 @@ class CiscoSMB < Oxidized::Model
     cfg
   end
 
-  cfg :telnet, :ssh do
+  cfg :telnet do
     username /^User Name:/
     password /^\r?Password:$/
+  end
+
+  cfg :telnet, :ssh do
     post_login 'terminal datadump' # Disable pager
     post_login 'terminal width 0'
     pre_logout 'exit'

data/lib/oxidized/model/model.rb

@@ -79,7 +79,7 @@ module Oxidized
     attr_accessor :input, :node
 
     def cmd string, &block
-      out = "====================== #{string} ======================\n" + @input.cmd(string)
+      out = @input.cmd(string)
       return false unless out
       self.class.cmds[:all].each do |all_block|
         out = instance_exec Oxidized::String.new(out), string, &all_block

data/lib/oxidized/source/http.rb

@@ -28,6 +28,9 @@ class HTTP < Source
     end
 
     request = Net::HTTP::Get.new(uri.request_uri, headers)
+    if (@cfg.user && @cfg.pass)
+        request.basic_auth(@cfg.user,@cfg.pass)
+    end
 
     response = http.request(request)
     data = JSON.parse(response.body)

data/lib/oxidized/version.rb

@@ -1,3 +1,3 @@
 module Oxidized
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oxidized
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Saku Ytti
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asetus
@@ -170,9 +170,11 @@ files:
 - TODO.md
 - bin/console
 - bin/oxidized
+- extra/auto-reload-config.runit
 - extra/nagios_check_failing_nodes.rb
 - extra/oxidized-report-git-commits
 - extra/oxidized.init
+- extra/oxidized.runit
 - extra/oxidized.service
 - extra/oxidized.supervisord
 - extra/oxidized.upstart