nbkit-caboodle(7) NodeBrain Kit Manual
Version NodeBrain Kit 0.8.17 - August 2004
nbkit-caboodle(7)

NAME | SYNOPSIS | DESCRIPTION | DIRECTORIES | COMMAND | HISTORY | BUGS | AUTHOR | SEE ALSO


NAME

  nbkit-caboodle - Caboodle NodeBrain Kit

SYNOPSIS

  nbkit caboodle { start | stop | bounce | ... } Caboodle

DESCRIPTION

  The Caboodle NodeBrain Kit provides a framework for building and managing NodeBrain applications. While NodeBrain is a rule engine that can be used however you like, NodeBrain kits conform to this framework to provide a quick path to a working application. You are encouraged to build applications and application kits based on this framework, unless you find or create a framework that works better for your application.

The following common terms have a specific meaning within the context of a NodeBrain kit.

caboodle    A directory containing a collection of components organized into a predefined set of subdirectories. Components make reference to other components using paths relative to the caboodle root directory. This makes a caboodle portable.

kit    A collection of components organized like a caboodle, but intended for distribution and used to construct caboodles or add functionality to existing caboodles. A caboodle may be composed from multiple kits.

agent    A NodeBrain script that runs as a background process, or daemon.

plan    An XML document used to represent a set of NodeBrain rules or configuration files based on a translation scheme. A plan compiler converts a plan from XML document format into a target format, often NodeBrain rules.

adapter    A script or program that adapts a caboodle component to another application or specifc environment. For example, adapters may be used to send alarms to syslog, email to administrators, and SNMP traps to down stream systems.

servant    A script or program that runs as a child to NodeBrain to perform a function for which another programming language is preferred. Servants may communicate with NodeBrain on stdin, stdout, and stderr.

DIRECTORIES

  Within a caboodle there are several subdirectories with a defined purpose. All components within a caboodle must assume the caboodle is the working directory and reference other components via a relative path to maintain portability of the caboodle. For a list of directories, see nbkit.caboodle(7).

COMMAND

  This kit provides the "nbkit_" command, and related commands, in a caboodle bin directory that are invoked by the nbkit(1) command to support most operations on a caboodle.

HISTORY

  Work on the Caboodle NodeBrain Kit began in June of 2006. It is based on a prior tool developed in 1998 called the "System Monitor Kit", or "Sysmon". The NodeBrain program, nb(1), was first developed for Sysmon and then released as a single component in 2003 by the NodeBrain Open Source Project. NodeBrain kits were first released by the project in February of 2013.

BUGS

  With prototype 0.8.x releases you can expect to encounter bugs that are unknown to the author. Please report bugs by linking to the project page from the home page, http://www.nodebrain.org, or send email to <bugs@nodebrain.org>.

AUTHOR

  Ed Trettevik <eat@nodebrain.org>

SEE ALSO

  nbkit(1), nbkit.caboodle(7), nodebrain(7), nb(1),

[1] NodeBrain Home Page

[2] Caboodle NodeBrain Kit Manual


Caboodle NodeBrain Kit 0.8.17August 2004nbkit-caboodle(7)