arborist 0.2.0.pre20170519125456 → 0.2.0

data/Events.md

@@ -1,35 +0,0 @@
-# Events
-
-## Event Types
-
-«type».«subtype»
-
-    node.acked
-    node.delta
-    node.disabled
-    node.down
-    node.quieted
-    node.unknown
-    node.up
-    node.update
-    sys.node_added
-    sys.node_removed
-    sys.reloaded
-    sys.hearbeat
-
-
-## Event Movement
-
-Propagation
-
-	events being sent up the tree to the root node
-
-Broadcast
-
-	events being sent down to node children
-
-Publishing
-
-	events being sent to subscriptions, including dependent nodes
-	triggered via propagation and broadcasting
-

data/Monitors.md

@@ -1,155 +0,0 @@
-# Monitors
-
-Monitors are loaded in a fashion similar to the way nodes describing the network topology are
-loaded: you provide a Enumerator that yields Arborist::Monitor objects to the #load_monitors method
-of an Arborist::MonitorRunner object. The `Arborist::Monitor.each_in` method, given a path to a directory containing `.rb` files that declare one or more monitors, will return such an Enumerator, but you could also use this to load monitor descriptions from any source you prefer, e.g., LDAP, a RDBMS, etc.
-
-
-## Declaration DSL
-
-To facilitate describing monitors to run, Arborist::Monitor also provides a DSL-like syntax for constructing them.
-
-For example, this would declare two monitors, one which pings every 'host' node except those tagged as laptops in the network every 20 seconds, and the other which pings 'host' nodes tagged as laptops every 5 minutes.
-
-    # monitors/pings.rb
-    require 'arborist/monitor'
-
-    Arborist::Monitor 'ping check' do
-        key :pingcheck
-        every 20.seconds
-        match type: 'host'
-        exclude tag: :laptop
-        use :address
-        exec 'fping'
-    end
-
-    Arborist::Monitor 'transient host pings' do
-        key :pingcheck
-        every 5.minutes
-        match type: 'host', tag: 'laptop'
-        use :address
-        exec 'fping'
-    end
-
-Each monitor is given a human-readable description for use in user interfaces, and one or more attributes that describe which nodes should be monitored, how they should be monitored, and how often the monitor should be run.
-
-### Monitor Attributes
-
-#### key
-
-Declare a namespace for the monitor. The error status for a node is keyed by this value, so that monitors with different keys don't clear each other's errors.
-
-This attribute is mandatory.
-
-#### description
-
-Set a human-readable description for the monitor, for use in interfaces or logs.
-
-This attribute is mandatory.
-
-#### every( seconds )
-
-Declare the interval between runs of the monitor. The monitor will be skewed by a small amount from this value (unless you specify `splay 0`) to prevent many monitors from starting up simultaneously.
-
-#### splay( seconds )
-
-Manually set the amount of splay (random offset from the interval) the monitor should use. It defaults to `Math.logn( interval )`.
-
-#### exec( command )
-#### exec {|node_attributes| ... }
-#### exec( module )
-
-Specify what should be run to do the actual monitoring. The first form simply `spawn`s the specified command with its STDIN opened to a stream of serialized node data.
-
-By default, the format of the serialized nodes is one node per line, and each line looks like this:
-
-    «identifier» «attribute1»=«attribute1 value» «attribute2»=«attribute2 value»
-
-Each line should use shell-escaping semantics, so that if an attribute value contains whitespace, it should be quoted, control characters need to be escaped, etc.
-
-For example, the ping checker might receive input like:
-
-    duir address=192.168.16.3
-    sidonie address="192.168.16.3"
-    yevaud address="192.168.16.10"
-
-If the command you are running doesn't support this format, you can override this in one of two ways.
-
-If your command expects the node data as command-line arguments, you can provide a custom `exec_arguments` block. It will receive an Array of Arborist::Node objects and it should generate an Array of arguments to append to the command before `spawn`ing it.
-
-    exec_arguments do |nodes|
-        # Build an address -> node mapping for pairing the updates back up by address
-        @node_map = nodes.each_with_object( {} ) do |node, hash|
-            address = node.address
-            hash[ address ] = node
-        end
-        
-        @node_map.keys
-    end
-
-If your command expects the node data via `STDIN`, but in a different format, you may declare an `exec_input` block. It will be called with the same node array, and additionally an IO open to the STDIN of the running command. This can be combined with the `exec_arguments` block, if you're dealing with something really weird.
-
-    exec_input do |nodes, writer|
-        # Build an address -> node mapping for pairing the updates back up by address
-        @node_map = nodes.each_with_object( {} ) do |node, hash|
-            address = node.address
-            hash[ address ] = node
-        end
-        
-        writer.puts( node_map.values )
-    end
-
-The monitor must write results for any of the listed identifiers that require update in the same format to its STDOUT. For the ping check above, the results might look like:
-
-    duir rtt=20ms
-    sidonie rtt=103ms
-    yevaud rtt= error=Host\ unreachable.
-
-If the program writes its output in some other format, you can provide a `handle_results` block. It will be called with the program's `STDOUT` if the block takes one argument, and if it takes an additional argument its `STDERR` as well. It should return a Hash of update Hashes, keyed by the node identifier it should be sent to.
-
-    handle_results do |pid, out, err|
-        updates = {}
-        
-        out.each_line do |line|
-            address, status = line.split( /\s+:\s+/, 2 )
-            
-            # Use the @node_map we created up in the exec_arguments to map the output
-            # back into identifiers. Error-checking omitted for brevity.
-            identifier = @node_map[ address ].identifier
-
-            # 127.0.0.1 is alive (0.12 ms)
-            # 8.8.8.8 is alive (61.6 ms)
-            # 192.168.16.16 is unreachable
-            if status =~ /is alive \((\d+\.\d+ ms)\)/i
-                updates[ identifier ] = { ping: { rtt: Float($1) } }
-            else
-                updates[ identifier ] = { error: status }
-            end
-        end
-
-        updates
-    end
-
-Unlisted attributes are unchanged.  A listed attribute with an empty value is explicitly cleared. An identifier that isn't listed in the results means no update is necessary for that node.
-
-If you find yourself wanting to repeat one or more of the exec callbacks, you can also wrap them in a module and call `exec_callbacks` with it.
-
-The second and third forms can be used to implement a monitor in Ruby. In the second, the block is called with the Hash of node data, keyed by identifier, and it must return a Hash of updates keyed by identifier. The third form expects any object that responds to `#run`, which will be invoked the same way as the block.
-
-
-#### use( *properties )
-
-Specify the list of properties to provide to the monitor for each node. If this is unspecified, the input to the monitor will be just the list of identifiers.
-
-
-
-    # Does everything in Ruby; gets the Array of Nodes as arguments to the block, expected to
-    # return a Hash of updates keyed by node identifier
-    exec do |nodes|
-        
-    end
-
-
-    # Runs an external
-	exec 'fping', '-e', '-t', '150'
-

data/Nodes.md

@@ -1,70 +0,0 @@
-# Nodes
-
-
-
-    Arborist::Host 'sidonie' do
-    	parent 'duir'
-    	description "NAS and media server"
-    	address '192.168.16.3'
-    
-    	tags :infrastructure,
-    	     :storage,
-    	     :media,
-    	     :rip_status_check
-    
-    	service 'ssh'
-    	service 'demon-http', port: 6666, protocol: 'http'
-    	service 'postgresql'
-    
-    	service 'smtp'
-    
-    	service 'http',
-            depends_on: 'postgresql'
-    	service 'sabnzbd', port: 8080, protocol: 'http'
-    	service 'sickbeard', port: 8081, protocol: 'http'
-    	service 'pms', port: 32400, protocol: 'http'
-    	service 'couchpotato', port: 5050, protocol: 'http'
-    end
-
-
-    Arborist::Host 'jhereg' do
-        parent 'duir'
-        description "Directory server"
-        address '192.168.16.7'
-        
-        service 'ldaps'
-    end
-
-
-    Arborist::Host 'webserver' do
-    	description "Public webserver"
-    	address '54.16.62.181'
-    
-        service 'http',
-            depends_on: 'foo'
-            depends_on: all_of( 'postgresql', 'daemon-http', on: 'sidonie' ),
-                all_of( 'ldaps', on: 'jhereg' )
-    end
-
-
-An application server depends on one each of the 'http' services and 'ldaps' services
-to be up.
-
-    Arborist::Host 'appserver1' do
-        description "Public application webserver"
-        address '54.16.62.185'
-        service 'http',
-            depends_on: all_of(
-                    any_of( 'http', on: %w[service1 service2 service3] ),
-                    any_of( 'ldaps', on: %w[directory1 directory2] ),
-                    all_of( 'else', on: 'something' )
-                )
-    end
-
-
-[ :all_of,
-    [ :any_of, 'service1-http', 'service2-http', 'service3-http' ],
-    [ :any_of, 'directory1-ldaps', 'directory2-ldaps' ],
-    'something-else'
-]
-

data/Observers.md

@@ -1,72 +0,0 @@
-# Observers
-
-subscription
-    * Event to subscribe to
-    * Node to attach subscription to.  No node means 'root', which sees all subnode events.
-    * One or more action blocks
-
-Actions have:
-    * a block to execute
-    * Zero or more time-periods, which are unioned together. No time periods means anytime.
-
-Pragmas:
-    * Summarize:
-      (send a single alert summarizing every event received over x period of time, or n events)
-    * Squelch:
-
-
-:MAHLON:
-    The manager should probably serialize subscriptions for its nodes. Otherwise the manager
-    can restart and any running observers will never again receive events because the
-    subscriptions will have disappeared.
-
-
-
-## Examples
-
-    # -*- ruby -*-
-    #encoding: utf-8
-    
-    require 'arborist'
-    
-    WORK_HOURS = 'hour {8am-6pm}'
-    OFF_HOURS =  'hour {6pm-8am}'
-    
-    Arborist::Observer "Webservers" do
-        subscribe to: 'node.delta',
-            where: {
-                type: 'service',
-                port: 80,
-                delta: { status: ['up', 'down'] }
-            }
-    
-        action( during: WORK_HOURS ) do |uuid, event|
-            $stderr.puts "Webserver %s is DOWN (%p)" % [ event['data']['identifier'], event['data'] ]
-        end
-        summarize( every: 5.minutes, count: 5, during: OFF_HOURS ) do |*tuples|
-            email to: 'ops@example.com', subject: ""
-        end
-    
-    end
-
-
-
-## Schedulability stuff
-
-schedule = Schedule.new
-schedule |= Period.time( '8AM' .. '8PM' )
-schedule |= Period.day( 'Mon' .. 'Fri' )
-
-
-# Thymelörde! - An Amazeballs Gem for Doing Stuff With Time™
-
-
-schedule = Thymelörde!.yes?( 'Tue-Thur {6am-9pm}' )
-schedule.ehh? #=> false
-schedule.yes? #=> false
-
-
-Legba -- the gatekeeper?
-
-
-

data/Protocol.md

@@ -1,276 +0,0 @@
-# Monitors
-
-## Basic Protocol
-
-ZMQ REQ socket, msgpack message consisting of an Array of two elements:
-
-    [
-        header,
-        body
-    ]
-
-Header is a Map of the form:
-
-    {
-        action: «verb»,     # required
-        version: 1,         # required
-        [verb-specific attributes]
-    }
-
-Body is either Nil, a Map of key-value pairs, or an Array of Maps appropriate to the `action`.
-
-
-## Commands
-
-
-### «commandname»
-
-«description»
-
-#### Header
-
-#### Body
-
-#### Return
-
-#### Examples
-
-
-
-
-### status
-
-Fetch the status of the Manager.
-
-    {
-        action: status,
-        version: 1,
-    }
-
-Response:
-
-    {
-        success: true,
-        version: 1
-    },
-    {
-        server_version: 0.0.1,
-        state: 'running',
-        uptime: 17155,
-        nodecount: 342
-    }
-
-
-### list
-
-Retrieve an Array of Maps that describes all or part of the node tree. 
-
-#### Required 
- from the node with the specified `identifier`, or the root node if no `identifier` is specified.
-
-
-Request:
-
-    [
-        {
-            action: list,
-            version: 1
-            [from: «identifier»]
-            [depth: «arg»]
-        }
-    ]
-
-Successful response:
-
-    [
-        {
-            success: true,
-            version: 1
-        },
-        [
-            {
-                identifier: 'foo',
-                status: 'up',
-                parent: '_',
-                properties: {},
-            },
-            {
-                identifier: 'bar',
-                status: 'down',
-                parent: 'foo',
-                properties: {},
-            }
-        ]
-    ]
-
-failure example:
-
-    [
-        {
-            success: false,
-            reason: "human readable exception message or whatever",
-            category: either 'server' or 'client', meaning who is responsible for the error
-            version: 1
-        }
-    ]
-
-
-
-### fetch
-
-Fetch the `address`, `description`, and `status` of all nodes.
-
-    [
-        {
-            action: fetch,
-            version: 1,
-            include_down: true,
-            return: [address, description, status]
-        },
-
-Response
-
-        {
-            'theon' => {
-                address: '10.2.10.4',
-                description: 'no theon, reek',
-                status: down,
-            },
-            'thoros' => {
-                address: '10.2.10.4',
-                description: "The Red God's champion",
-                status: up,
-            }
-        ]
-    ]
-
-
-#### return
-
-- not specified : returns everything.
-- `Nil` : returns just identifiers
-- array of fields : returns the values of those fields
-
-Search for nodes that match the filter given in the request body, returning a serialized map of node identifiers to requested state.
-
-
-### update
-
-    [
-        {
-            action: update,
-            version: 1
-        },
-        {
-            duir: {
-                pingtime: 0.02
-            },
-            sidonie: {
-                pingtime: 0.28
-            }
-        }
-    ]
-
-With a failure:
-
-    [
-        {
-            action: update,
-            version: 1
-        },
-        {
-            duir: {
-                pingtime: null,
-                error: "Host unreachable."
-            },
-            sidonie: {
-                pingtime: 0.28
-            }
-        }
-    ]
-
-
-### subscribe
-
-Get node change delta events for every 'host' type node.
-
-    {
-        action: subscribe,
-        version: 1,
-        event_type: node.delta
-    },
-    {
-        type: 'host',
-    }
-
-Get a snapshot of node state on every update for 'service' type nodes under
-the 'bennett' node.
-
-    {
-        action: subscribe,
-        version: 1,
-        event_type: node.update,
-        identifier: 'bennett'
-    },
-    {
-        type: 'service',
-    }
-
-Get events of state changes to services running on port 80.
-
-    {
-        action: subscribe,
-        version: 1,
-        event_type: node.delta
-    },
-    {
-        type: 'service',
-        port: 80
-    }
-
-Get notified of every system event (startup, shutdown, reload, etc.)
-
-    {
-        action: subscribe,
-        version: 1,
-        event_type: sys.*
-    },
-    Nil
-
-
-### graft
-
-    {
-        action: graft,
-        version: 1,
-        type: 'host',
-        identifier: 'joliet',
-        parent: 'bennett' # defaults to root
-    },
-    {
-        addresses: [],
-        tags: []
-    }
-
-
-### prune
-
-    {
-        action: prune,
-        version: 1,
-        identifier: 'bennett'
-    },
-    Nil
-
-
-### modify
-
-    {
-        action: modify,
-        version: 1,
-        identifier: 'bennett'
-    },
-    {
-        addresses: ['10.13.0.22', '10.1.0.23']
-    }
-