-
-
-
-
-
-
-
diff --git a/_layouts/post.html b/_layouts/post.html
deleted file mode 100644
index 155e67bd38f..00000000000
--- a/_layouts/post.html
+++ /dev/null
@@ -1,7 +0,0 @@
----
-layout: default
----
-This page provides a basic overview of correct YAML syntax.
+For ansible, every YAML script must be a list at it’s root-most +element. Each item in the list is a dictionary. These dictionaries +represent all the options you can use to write a ansible script. In +addition, all YAML files (regardless of their association with +ansible or not) should start with ---.
+In YAML a list can be represented in two ways. In one way all members +of a list are lines beginning at the same indentation level starting +with a - character:
+---
+# A list of tasty fruits
+- Apple
+- Orange
+- Strawberry
+- Mango
+In the second way a list is represented as comma separated elements +surrounded by square brackets. Newlines are permitted between +elements:
+---
+# A list of tasty fruits
+[apple, orange, banana, mango]
+A dictionary is represented in a simple key: and value form:
+---
+# An employee record
+name: John Eckersberg
+job: Developer
+skill: Elite
+Like lists, dictionaries can be represented in an abbreviated form:
+---
+# An employee record
+{name: John Eckersberg, job: Developer, skill: Elite}
+You can specify a boolean value (true/false) in several forms:
+---
+knows_oop: True
+likes_emacs: TRUE
+uses_cvs: false
+Finally, you can combine these data structures:
+---
+# An employee record
+name: John Eckersberg
+job: Developer
+skill: Elite
+employed: True
+foods:
+ - Apple
+ - Orange
+ - Strawberry
+ - Mango
+languages:
+ ruby: Elite
+ python: Elite
+ dotnet: Lame
+That’s all you really need to know about YAML to get started writing +Ansible scripts.
+See also
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009,2011, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks.puppet import PuppetTaskResult
+from taboot.tasks.rpm import RPMTaskResult
+import re
+
+
+class _FileLikeOutputObject(object):
+ """
+ A file-like parent class.
+ """
+
+ import exceptions
+ import time as _time
+ defaults = None
+ starttime = None
+
+ def __init__(self, *args, **kwargs):
+ """
+ Creates an instance of a file-like object.
+
+ :Parameters:
+ - `args`: all non-keyword arguments.
+ - `kwargs`: all keyword arguments.
+ """
+ import ConfigParser
+ import os.path
+
+ if _FileLikeOutputObject.defaults is None:
+ if os.path.expanduser("~/.taboot.conf"):
+ _FileLikeOutputObject.defaults = ConfigParser.ConfigParser()
+ _FileLikeOutputObject.defaults.read(
+ os.path.expanduser("~/.taboot.conf"))
+
+ # Only set the start time once, not for each logger instance
+ if _FileLikeOutputObject.starttime is None:
+ import datetime
+ _FileLikeOutputObject.starttime = datetime.datetime.today()
+
+ self._pos = 0L
+ self._closed = False
+ self._setup(*args, **kwargs)
+
+ def _setup(self, *args, **kwargs):
+ """
+ Implementation specific setup.
+
+ :Parameters:
+ - `args`: all non-keyword arguments.
+ - `kwargs`: all keyword arguments.
+ """
+ pass
+
+ def flush(self):
+ """
+ We are not buffering so we always just return None.
+ """
+ return None
+
+ def read(self, *args, **kwargs):
+ """
+ We are an output only file-like object. Raise exception.
+
+ :Parameters:
+ - `args`: all non-keyword arguments.
+ - `kwargs`: all keyword arguments.
+ """
+ raise self.exceptions.NotImplementedError('Object for output only.')
+
+ def tell(self):
+ """
+ Returns the position of the file-like object.
+ """
+ return self._pos
+
+ def truncate(self, size):
+ """
+ We are an output only file-like object. Raise exception.
+
+ :Parameters:
+ - `size`: size to truncate to.
+ """
+ raise self.exceptions.NotImplementedError(
+ 'This does not support truncate.')
+
+ def writelines(self, sequence):
+ """
+ Writes a sequence of lines.
+
+ :Parameters:
+ - `sequence`: iterable sequence of data to write.
+ """
+ for item in sequence:
+ self.write(item)
+
+ def write(self, item):
+ """
+ Writer wrapper (not rapper, beav). Simply calls _write which is
+ implementation specific and updates the position.
+
+ :Parameters:
+ - `item`: the item to write.
+ """
+ self._write(item)
+ self._pos += 1
+
+ def _write(self, item):
+ """
+ Implementation of writing data.
+
+ :Parameters:
+ - `item`: the item to write.
+ """
+ raise self.exceptions.NotImplementedError(
+ '_write must be overriden.')
+
+ def close(self):
+ """
+ Close wrapper (again, not rapper, beav). Simply calls _close which
+ is implementation specific and updates the closed property.
+ """
+ self._close()
+ self._closed = True
+
+ def _close(self):
+ """
+ Implementation of closing the file-like object.
+ By default nothing occurs.
+ """
+ pass
+
+ # Read aliases
+ readline = read
+ readlines = read
+ xreadlines = read
+ seek = read
+
+ # Read-only Properties
+ closed = property(lambda self: self._closed)
+ timestamp = property(lambda self: self._time.strftime(
+ "%Y-%m-%d %H:%M:%S", self._time.localtime()))
+
+
+[docs]class CLIOutput(_FileLikeOutputObject):
+ """
+ Output a :class:`taboot.tasks.TaskResult` to the command line
+ with pretty formatting and colors.
+ """
+
+ def _setup(self, host, task):
+ """
+ Implementation specific setup for outputting to the CLI.
+
+ :Parameters:
+ - `host`: name of the host
+ - `task`: name of the task
+ """
+ import Colors
+ import sys
+ self._c = Colors.Colors()
+ self._sys = sys
+ self._sys.stdout.write('%s:\n' % (
+ self._c.format_string(host, 'blue')))
+ self._sys.stdout.write('%s Starting Task[%s]\n' % (
+ self.timestamp, self._c.format_string(task, 'white')))
+
+ def _write(self, result):
+ """
+ Implementation of writing to the CLI.
+
+ :Parameters:
+ - `result`: result object to inspect and write
+ """
+ import types
+
+ # Set output color
+ output_color = 'red'
+ if result.success:
+ output_color = 'green'
+
+ self._sys.stdout.write("%s:\n" % (
+ self._c.format_string(result.host, 'blue')))
+ self._sys.stdout.write("%s Finished Task[%s]:\n" % (
+ self.timestamp, self._c.format_string(
+ result.task, output_color)))
+
+ if isinstance(result, PuppetTaskResult):
+ # If result is an instance of PuppetTaskResult,
+ # colorize the puppet output
+ lines = result.output.splitlines()
+ for line in lines:
+ if re.match('info:', line):
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ line.strip(), 'green'))
+ elif re.match('notice:', line):
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ line.strip(), 'blue'))
+ elif re.match('warning:', line):
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ line.strip(), 'yellow'))
+ elif re.match('err:', line):
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ line.strip(), 'red'))
+ else:
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ line.strip(), 'normal'))
+ elif isinstance(result, RPMTaskResult):
+ # If result is an instance of RPMTaskResult,
+ # colorize the rpm.PostManifest output
+ lines = result.output.splitlines()
+ for line in lines:
+ if line.startswith('-'):
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ line.strip(), 'red'))
+ elif line.startswith('+'):
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ line.strip(), 'green'))
+ else:
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ line.strip(), 'normal'))
+ else:
+ # Use standard pass/fall coloring for output
+ if isinstance(result.output, types.ListType):
+ for r in result.output:
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ r.strip(), output_color))
+ else:
+ self._sys.stdout.write("%s\n" % self._c.format_string(
+ result.output.strip(), output_color))
+
+
+[docs]class LogOutput(_FileLikeOutputObject):
+ """
+ Output a :class:`taboot.tasks.TaskResult` to a logfile.
+ """
+
+ def _setup(self, host, task, logfile='taboot.log'):
+ """
+ Implementation specific setup for outputting to a log.
+
+ :Parameters:
+ - `logfile`: name of the logfile to write to.
+ """
+ self._logfile = logfile
+ if self._logfile in ('-', 'stdout', '1'):
+ import sys
+ self._log_fd = sys.stdout
+ else:
+ self._log_fd = open(logfile, 'a')
+ self._log_fd.write('%s:\n%s Starting Task[%s]\n\n' % (
+ host, self.timestamp, task))
+
+ def _write(self, result):
+ """
+ Implementation of writing to a log.
+
+ :Parameters:
+ - `result`: result object to inspect and write
+ """
+ import types
+
+ if result.success:
+ success_str = 'OK'
+ else:
+ success_str = 'FAIL'
+
+ self._log_fd.write("%s:\n%s Finished Task[%s]: %s\n" % (
+ result.host, self.timestamp, result.task, success_str))
+
+ if isinstance(result.output, types.ListType):
+ for r in result.output:
+ self._log_fd.write("%s\n\n" % r.strip())
+ else:
+ self._log_fd.write("%s\n\n" % result.output.strip())
+
+
+[docs]class EmailOutput(_FileLikeOutputObject):
+ """
+ Output a :class:`taboot.tasks.TaskResult` to a logfile.
+ """
+
+ def _setup(self, to_addr, from_addr='taboot@redhat.com'):
+ """
+ Implementation specific setup for outputting to a log.
+
+ :Parameters:
+ - `to_addr`: who to send the email to.
+ - `from_addr`: who the email is from.
+ """
+ try:
+ import cStringIO as StringIO
+ except ImportError, ie:
+ import StringIO
+ self._to_addr = to_addr
+ self._from_addr = from_addr
+ self._buffer = StringIO.StringIO()
+
+ def _write(self, result):
+ """
+ Implementation of writing out to an email.
+
+ :Parameters:
+ - `result`: result object to inspect and write
+ """
+ if result.success:
+ success_str = 'OK'
+ else:
+ success_str = 'FAIL'
+
+ self._buffer.write("%s: %s" % (task_result.task, success_str))
+
+[docs] def flush(self):
+ """
+ Flushing sends the email with the buffer.
+ """
+ import smtplib
+ from email.mime.text import MIMEText
+
+ self._buffer.flush()
+ msg = self.MIMEText(self._buffer.read())
+ msg['Subject'] = task_result.host
+ msg['From'] = self._from_addr
+ msg['To'] = self._to_addr
+
+ smtp = self.smtplib.SMTP()
+ smtp.connect()
+ smtp.sendmail(self._from_addr, [self._to_addr], msg.as_string())
+ smtp.close()
+
+ def __del__(self):
+ """
+ If the buffer is not empty before destroying, flush.
+ """
+ if self._buffer.pos < self._buffer.len:
+ self.flush()
+
+
+[docs]class HTMLOutput(_FileLikeOutputObject):
+ """
+ Output a :class:`taboot.tasks.TaskResult` to the command line
+ with pretty formatting and colors.
+
+ .. document private functions
+ .. automethod:: _write
+ """
+
+ logfile_path = None
+
+ def _expand_starttime(self, param):
+ """
+ Expand any instances of "%s" in `param`
+ """
+ if '%s' in param:
+ p = param % HTMLOutput.starttime
+ return p.replace(" ", "-")
+ else:
+ return param
+
+ def _setup(self, host, task, logfile="taboot-%s.html", destdir="."):
+ """
+ Implementation specific setup for outputting to an HTML file.
+
+ :Parameters:
+ - `host`: name of the host
+ - `task`: name of the task
+ - `logfile`: name of the file to log to, '%s' is substituted
+ with a datestamp
+ - `destdir`: directory in which to save the log file to
+ """
+ import Colors
+ import sys
+ import os.path
+ import os
+
+ _default_logfile = "taboot-%s.html"
+ _default_destdir = "."
+
+ # Pick if the parameter is changed
+ # Pick if above is false and logfile is set in defaults
+ # Else, use parameter
+ if not logfile == _default_logfile:
+ _logfile = logfile
+ elif HTMLOutput.defaults is not None and \
+ HTMLOutput.defaults.has_option("HTMLOutput", "logfile"):
+ _logfile = HTMLOutput.defaults.get("HTMLOutput", "logfile")
+ else:
+ _logfile = logfile
+
+ # Expand %s into a time stamp if necessary
+ _logfile = self._expand_starttime(_logfile)
+
+ if not destdir == _default_destdir:
+ _destdir = destdir
+ elif HTMLOutput.defaults is not None and \
+ HTMLOutput.defaults.has_option("HTMLOutput", "destdir"):
+ _destdir = HTMLOutput.defaults.get("HTMLOutput", "destdir")
+ else:
+ _destdir = destdir
+
+ # Figured it all out, now we join them together!
+ self._logfile_path = os.path.join(_destdir, _logfile)
+ if not os.path.exists(_destdir):
+ os.makedirs(_destdir, 0755)
+
+ self._c = Colors.HTMLColors()
+ self._log_fd = open(self._logfile_path, 'a')
+
+ # Lets only print this when it is set or changed
+ if HTMLOutput.logfile_path is None or \
+ not HTMLOutput.logfile_path == self._logfile_path:
+ sys.stderr.write("Logging HTML Output to %s\n" % \
+ self._logfile_path)
+ HTMLOutput.logfile_path = self._logfile_path
+ sys.stderr.flush()
+
+ # Log the start of this task
+ name = self._fmt_anchor(self._fmt_hostname(host))
+ start_msg = """<p><tt>%s:</tt></p>
+<p><tt>%s Starting Task[%s]\n</tt>""" % (name, self.timestamp, task)
+ self._log_fd.write(start_msg)
+ self._log_fd.flush()
+
+ def _fmt_anchor(self, text):
+ """
+ Format an #anchor and a clickable link to it
+ """
+ h = hash(self.timestamp)
+ anchor_str = "<a name='%s' href='#%s'>%s</a>" % (h, h, text)
+ return anchor_str
+
+ def _fmt_hostname(self, n):
+ """
+ Standardize the hostname formatting
+ """
+ return "<b>%s</b>" % self._c.format_string(n, 'blue')
+
+[docs] def _write(self, result):
+ """
+ Write a tasks `result` out to HTML. Handles enhanced stylizing
+ for task results that support such as:
+
+ - :py:mod:`taboot.tasks.puppet.PuppetTaskResult`
+ - :py:mod:`taboot.tasks.rpm.RPMTaskResult`
+ """
+ import types
+ import sys
+ import cgi
+
+ name = self._fmt_hostname(result.host)
+
+ # escape any html in result.output
+ result.output = cgi.escape(result.output)
+
+ if result.success:
+ success_str = self._c.format_string('<b>OK</b>', 'green')
+ else:
+ success_str = self._c.format_string('<b>FAIL</b>', 'red')
+
+ self._log_fd.write("<p><tt>%s:\n</tt></p>\n<p><tt>%s "\
+ "Finished Task[%s]: %s</tt></p>\n" %
+ (name, self.timestamp, result.task, success_str))
+
+ if isinstance(result, PuppetTaskResult):
+ # If result is an instance of PuppetTaskResult,
+ # colorize the puppet output
+ lines = result.output.splitlines()
+ for line in lines:
+ if re.match('info:', line):
+ self._log_fd.write("%s<br />\n" %
+ self._c.format_string(line.strip(),
+ 'green'))
+ elif re.match('notice:', line):
+ self._log_fd.write("%s<br />\n" %
+ self._c.format_string(line.strip(),
+ 'blue'))
+ elif re.match('warning:', line):
+ self._log_fd.write("%s<br />\n" %
+ self._c.format_string(line.strip(),
+ 'yellow'))
+ elif re.match('err:', line):
+ self._log_fd.write("%s<br />\n" %
+ self._c.format_string(line.strip(),
+ 'red'))
+ else:
+ self._log_fd.write("%s<br />\n" %
+ self._c.format_string(line.strip(),
+ 'normal'))
+ self._log_fd.write("<br /><br />\n")
+ elif isinstance(result, RPMTaskResult):
+ # If result is an instance of RPMTaskResult,
+ # colorize the rpm.PostManifest output
+ lines = result.output.splitlines()
+ for line in lines:
+ if line.startswith('-'):
+ self._log_fd.write("%s<br />\n" %
+ self._c.format_string(line.strip(),
+ 'red'))
+ elif line.startswith('+'):
+ self._log_fd.write("%s<br />\n" %
+ self._c.format_string(line.strip(),
+ 'green'))
+ else:
+ self._log_fd.write("%s<br />\n" %
+ self._c.format_string(line.strip(),
+ 'normal'))
+ self._log_fd.write("<br /><br />\n")
+ else:
+ # Use standard pass/fall coloring for output
+ if isinstance(result.output, types.ListType):
+ for r in result.output:
+ self._log_fd.write("<pre>%s</pre>\n<br /><br />\n" %
+ r.strip())
+ else:
+ self._log_fd.write("<pre>%s</pre>\n<br /><br />\n" %
+ result.output.strip())
+
+ self._log_fd.flush()
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009-2011, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import threading
+from taboot.util import instantiator
+from log import *
+
+
+[docs]class Runner(object):
+ """
+ The Runner, responsible for running a taboot job.
+ """
+
+ import threading
+ import taboot.output
+
+ def __init__(self, script, config, expand_globs=True):
+ """
+ :Parameters:
+ - `script`: an instance of tabootScript
+
+ - `expand_globs`: whether to expand the globs or just leave
+ them as is.
+ """
+ self._config = config
+ self._hosts = script.getHosts()
+ self._tasks = script.getTaskTypes()
+ self._output = script.getOutputTypes()
+ self._task_q = []
+ self._fail_event = self.threading.Event()
+
+ if expand_globs:
+ self._hosts = self._expand_globs()
+ log_debug("Will operate on %s host(s).", len(self._hosts))
+
+ # Prefight threading
+ self._preflight_tasks = script.getPreflightTypes()
+ self._preflight_semaphore = self.threading.Semaphore(
+ len(self._hosts))
+ self._preflight_tasks_q = []
+
+ # Main task-body threading
+ if script.getConcurrency() == "all":
+ self._concurrency = len(self._hosts)
+ else:
+ self._concurrency = int(script.getConcurrency())
+ log_debug("Setting task-body concurrency to %s.",
+ self._concurrency)
+ self._semaphore = self.threading.Semaphore(self._concurrency)
+
+ def _run_preflight(self):
+ """
+ Run the jobs in a prefilght section.
+ """
+ import signal
+
+ rdy_msg = "\nPre-Flight complete, press enter to continue: "
+
+ for host in self._hosts:
+ t = TaskRunner(host, self._preflight_tasks,
+ self._preflight_semaphore,
+ self._output, self._fail_event)
+ t.start()
+ self._preflight_tasks_q.append(t)
+
+ signal.signal(signal.SIGINT, self.__sighandler)
+
+ for task in self._task_q:
+ while task.isAlive():
+ task.join(0.1)
+
+ while len(self.threading.enumerate()) > 1:
+ # Even though all the threads may have been joined we
+ # should still wait for them to terminate. If we don't
+ # wait for that we will likely see the 'continue?' prompt
+ # before the preflight output gets a chance to print.
+ pass
+
+ if not self._config["onlypreflight"]:
+ ready = raw_input(rdy_msg)
+
+ if self._fail_event.isSet():
+ return False
+ return True
+
+ def _run_tasks(self):
+ """
+ Run a task body.
+ """
+ import signal
+
+ for host in self._hosts:
+ t = TaskRunner(host, self._tasks, self._semaphore, self._output,
+ self._fail_event)
+ t.start()
+ self._task_q.append(t)
+
+ signal.signal(signal.SIGINT, self.__sighandler)
+
+ for task in self._task_q:
+ while task.isAlive():
+ task.join(0.1)
+
+ if self._fail_event.isSet():
+ return False
+ return True
+
+[docs] def run(self):
+ """
+ Run the preflight/tasks-body
+ """
+
+ if len(self._preflight_tasks) > 0:
+ if not self._run_preflight():
+ return False
+
+ if self._config["onlypreflight"]:
+ return True
+ else:
+ return self._run_tasks()
+
+ def _expand_globs(self):
+ """
+ Returns the hosts that expand out from globs.
+
+ This is kind of a dirty hack around how Func returns minions
+ in an arbitrary order.
+ """
+
+ import func.overlord.client as fc
+
+ if not self._hosts:
+ return []
+ if isinstance(self._hosts, basestring):
+ glob = self._hosts
+ c = fc.Client(glob)
+ return c.list_minions()
+ else:
+ # Iterate over each given item, expand it, and then push
+ # it onto our list. But only if it doesn't exist already!
+ found_hosts = []
+ for h in self._hosts:
+ c = fc.Client(h)
+ new_hosts = filter(lambda h: h not in found_hosts,
+ c.list_minions())
+ found_hosts.extend(new_hosts)
+ # for found_host in c.list_minions():
+ # h = filter
+ # if not found_host in found_hosts:
+ # found_hosts.append(found_host)
+ return found_hosts
+
+ def __sighandler(self, signal, frame):
+ """
+ If we get SIGINT on the CLI, we need to quit all the threads
+ in our process group
+ """
+ import os
+ import signal
+
+ os.killpg(os.getpgid(0), signal.SIGQUIT)
+
+
+[docs]class TaskRunner(threading.Thread):
+ """
+ TaskRunner is responsible for executing a set of tasks for a
+ single host in it's own thread.
+ """
+
+ from taboot.tasks import TaskResult as _TaskResult
+
+ def __init__(self, host, tasks, semaphore, output, fail_event):
+ """
+ :Parameters:
+ - `host`: The host to operate on.
+ - `tasks`: A list of tasks to perform (see :class:`Runner`)
+ - `semaphore`: The :class:`Runner` semaphore to acquire before
+ executing
+ - `output`: A list of outputters to use. (see :class:`Runner`)
+ - `fail_event`: The :class:`Runner` failure event to check before
+ executing. If this event is set when the TaskRunner acquires the
+ semaphore, then the TaskRunner is effectively a no-op.
+ """
+
+ threading.Thread.__init__(self)
+ self._host = host
+ self._tasks = tasks
+ self._semaphore = semaphore
+ self._output = output
+ self._fail_event = fail_event
+ self._state = {}
+
+ def __getitem__(self, key):
+ return self._state[key]
+
+ def __setitem__(self, key, value):
+ self._state[key] = value
+
+[docs] def run(self):
+ """
+ Run the task(s) for the given host. If the fail_event passed
+ from the invoking :class:`Runner` is set, do nothing.
+ """
+
+ self._semaphore.acquire()
+
+ if self._fail_event.isSet():
+ # some other host has bombed
+ self._semaphore.release()
+ return
+
+ try:
+ host_success = True
+ for task in self._tasks:
+ result = self.run_task(task)
+ if not result.success and not result.ignore_errors:
+ host_success = False
+ break
+ except:
+ self._bail_failure()
+ raise
+
+ if not host_success:
+ self._bail_failure()
+ else:
+ self._semaphore.release()
+ return host_success
+
+ def _bail_failure(self):
+ """
+ Die nicely :)
+ """
+
+ self._fail_event.set()
+ self._semaphore.release()
+
+[docs] def run_task(self, task):
+ """
+ Run a single task. Sets task.host and then invokes the run
+ method for the task.
+
+ :Parameters:
+ - `task`: The task to run
+ """
+
+ ignore_errors = False
+ if 'ignore_errors' in task:
+ if task['ignore_errors'] in ('True', 'true', 1):
+ ignore_errors = True
+
+ task = instantiator(task, 'taboot.tasks', host=self._host)
+
+ outputters = []
+ for o in self._output:
+ instance = instantiator(o, 'taboot.output',
+ host=self._host,
+ task=task)
+ outputters.append(instance)
+
+ try:
+ result = task.run(self)
+ except Exception, e:
+ result = self._TaskResult(task, output=repr(e))
+
+ for o in outputters:
+ o.write(result)
+
+ result.ignore_errors = ignore_errors
+ return result
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009-2011, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+
+[docs]class BaseTask(object):
+ """
+ Base Task. All tasks should inherit from this. It does the
+ pretty string representation of a task and allows setting of the
+ host attribute.
+ """
+
+ def __init__(self, *args, **kwargs):
+ self._name = str(type(self))
+ next = self._name.index("'") + 1
+ self._name = self._name[next:self._name.rindex("'")]
+ self._args = args
+ self.host = kwargs['host']
+ self.concurrentFriendly = True
+
+ def __repr__(self):
+ return "%s%s" % (self._name, self._args)
+
+ def _sethost(self, host):
+ self._host = host
+
+ def _gethost(self):
+ if hasattr(self, '_host'):
+ return self._host
+ else:
+ return None
+
+ host = property(_gethost, _sethost)
+
+
+[docs]class FuncTask(BaseTask):
+ """
+ A Func-based task. All tasks that utilize Func should inherit
+ from this.
+ """
+
+ import func.jobthing
+ from taboot.errors import FuncException as _FuncException
+
+ def _func_run(self, func_command, *args):
+ """
+ Execute a command via Func.
+
+ :Paramaters:
+ - `func_command` String representing func command to run
+ (e.g. 'command.run')
+ - `*args` Argument(s) to be used when invoking the func command
+ """
+
+ import time
+ import func.overlord.client
+ try:
+ client = func.overlord.client.Client(self._host, async=True)
+ job_id = reduce(lambda x, y: getattr(x, y),
+ func_command.split('.'),
+ client)(*args)
+ # poll until the job completes
+ (status, result) = (None, None)
+ while status != self.func.jobthing.JOB_ID_FINISHED:
+ (status, result) = client.job_status(job_id)
+ time.sleep(1)
+ result = result[self._host]
+ if result[0] == 'REMOTE_ERROR':
+ raise self._FuncException(result[1:])
+ return (True, result)
+ except Exception, ex:
+ return (False, repr(ex))
+
+[docs] def run(self, runner):
+ """
+ Run the FuncTask.
+
+ :Parameters:
+ - `runner` A :class:`taboot.runner.TaskRunner` instance
+ """
+
+ if not hasattr(self, '_command'):
+ raise Exception("You MUST set self._command when instantiating " +
+ "a subclass of FuncTask!")
+
+ result = self._func_run(self._command, *(self._args))
+
+ if result[0]:
+ # command executed successfully as far as "func success"
+ return self._process_result(result[1])
+ else:
+ return TaskResult(self, success=False, output=result[1])
+
+
+[docs]class FuncErrorTask(FuncTask):
+ """
+ Explicitly cause a func remote error by calling a bad command.
+ Used to verify func exception handling works as expected
+ """
+
+ def __init__(self, *args, **kwargs):
+ super(FuncErrorTask, self).__init__(*args, **kwargs)
+ self._command = 'thiscommand.DoesntExist'
+
+
+[docs]class TaskResult(object):
+ """
+ An encapsulation of the results of a task. This is passed to one
+ or more instances of output classes (derived from BaseOutput) in
+ order to display to the user.
+ """
+
+ def __init__(self, task, success=False, output='', ignore_errors=False):
+ """
+ :Parameters:
+ - `task`: The task object represented by this result
+ - `success`: Whether the task completed successfully or not
+ - `output`: Any text output produced by the task
+ """
+
+ if hasattr(task, 'host'):
+ self._host = task.host
+ self._task = repr(task)
+ self._taskObj = task
+ self._success = success
+ self._output = output
+ self._ignore_errors = ignore_errors
+
+ def _gettask(self):
+ return self._task
+
+ def _gettaskObj(self):
+ return self._taskObj
+
+ def _settask(self, t):
+ self._task = repr(t)
+
+ def _getsuccess(self):
+ return self._success
+
+ def _setsuccess(self, success):
+ self._success = success
+
+ def _getoutput(self):
+ return self._output
+
+ def _setoutput(self, output):
+ self._output = output
+
+ def _getignore_errors(self):
+ return self._ignore_errors
+
+ def _setignore_errors(self, ignore_errors):
+ self._ignore_errors = ignore_errors
+
+ def _gethost(self):
+ return self._host
+
+ task = property(_gettask, _settask)
+ success = property(_getsuccess, _setsuccess)
+ output = property(_getoutput, _setoutput)
+ ignore_errors = property(_getignore_errors, _setignore_errors)
+ host = property(_gethost)
+ taskObj = property(_gettaskObj)
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009,2010, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks import FuncTask, TaskResult
+
+
+[docs]class Run(FuncTask):
+ """
+ Run arbitrary commands via Func. The arguments passed to __init__
+ are used to execute func.overlord.Client.command.run(args).
+
+ :Parameters:
+ - `command`: Command to run on the remote host
+ """
+
+ def __init__(self, command, **kwargs):
+ super(Run, self).__init__(command, **kwargs)
+ self._command = 'command.run'
+
+ def _process_result(self, result):
+ t = TaskResult(self)
+ if result[0] == 0:
+ t.success = True
+ else:
+ t.success = False
+ t.output = result[1]
+ return t
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009-2011, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks import BaseTask, FuncTask, TaskResult
+
+JK_ENABLE = 0
+JK_DISABLE = 1
+JK_STOP = 2
+
+
+class ToggleHost(FuncTask):
+ def __init__(self, action, proxyhost, **kwargs):
+ super(ToggleHost, self).__init__(proxyhost, **kwargs)
+ self._action = action
+ if action == JK_ENABLE:
+ self._command = 'taboot.modjk.enable_host'
+ elif action == JK_DISABLE:
+ self._command = 'taboot.modjk.disable_host'
+ elif action == JK_STOP:
+ self._command = 'taboot.modjk.stop_host'
+ else:
+ raise Exception("Undefined toggle action")
+
+ def _process_result(self, result):
+ t = TaskResult(self)
+ if len(result) > 0:
+ t.success = True
+ if self._action == JK_ENABLE:
+ verb = 'Enabled'
+ elif self._action == JK_DISABLE:
+ verb = 'Disabled'
+ elif self._action == JK_STOP:
+ verb = 'Stopped'
+
+ t.output = "%s AJP on the following balancer/worker " \
+ "pairs:\n" % verb
+ for balancer, worker in result:
+ t.output += "%s: %s\n" % (balancer, worker)
+ else:
+ t.success = False
+ t.output = "Failed to find worker host"
+ return t
+
+
+class JKBaseTask(BaseTask):
+ def __init__(self, proxies, action, **kwargs):
+ super(JKBaseTask, self).__init__(**kwargs)
+ from sys import modules
+ self.proxies = proxies
+ self.jkaction = getattr(modules[self.__module__], "JK_%s" %
+ action.upper())
+
+ def run(self, runner):
+ output = ""
+ success = True
+ for proxy in self.proxies:
+ toggler = ToggleHost(self.jkaction, self._host, host=proxy)
+ result = toggler.run(runner)
+ output += "%s:\n" % proxy
+ output += "%s\n" % result.output
+ if result.success == False:
+ success = False
+ break
+ return TaskResult(self, success=success, output=output)
+
+
+[docs]class OutOfRotation(JKBaseTask):
+ """
+ Remove an AJP node from rotation on a proxy via modjkapi access on
+ the proxy with func.
+
+ :Parameters:
+ - `proxies`: A list of URLs to AJP jkmanage interfaces
+ """
+ def __init__(self, proxies, action="stop", **kwargs):
+ super(OutOfRotation, self).__init__(proxies, action, **kwargs)
+
+
+[docs]class InRotation(JKBaseTask):
+ """
+ Put an AJP node in rotation on a proxy via modjkapi access on
+ the proxy with func.
+
+ :Parameters:
+ - `proxies`: A list of URLs to AJP jkmanage interfaces
+ """
+ def __init__(self, proxies, action="enable", **kwargs):
+ super(InRotation, self).__init__(proxies, action, **kwargs)
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009-2011, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks import BaseTask, TaskResult, FuncTask
+import taboot.errors
+import sys
+
+
+[docs]class NagiosBase(FuncTask):
+ """
+ All subsequent Nagios tasks are subclasses of this.
+
+ Code note: Because a `FuncTask` expects to make connections to
+ `self.host` we need to switch `nagios_url` with `self.host` and
+ pass the original `self.host` as an argument.
+
+ .. versionchanged:: 0.2.14
+
+ The previous version specified the `nagios_url` parameter as a
+ URL. To facilitate transitions we automatically correct URLs
+ into hostnames.
+
+ Previously the `service` key was defined as a scalar, like
+ "HTTP" or "JBOSS". This version accepts that key as a scalar OR
+ as a list and "does the right thing" in each case.
+ """
+
+ def _fix_nagios_url(self, nagios_url):
+ """
+ For backwards compatability we accept a Nagios URL that
+ identifies an HTTP resource.
+
+ This method will take a string like http://foo.com/nagios/cmd.cgi
+ and return just the hostname component ("foo.com").
+ """
+ import re
+ return re.sub(r'(https?://)([^/]+)(.*)', r'\2', nagios_url)
+
+ def _process_result(self, result):
+ t = TaskResult(self)
+
+ if result.startswith("Fail: "):
+ t.success = False
+ else:
+ t.sucess = True
+ t.success = True
+ t.output = result
+ return t
+
+
+[docs]class DisableAlerts(NagiosBase):
+ """
+ Disable alerts for a host on a nagios instance
+ """
+
+ def __init__(self, nagios_url, **kwargs):
+ """
+ :Parameters:
+ - `nagios_url`: Hostname of the Nagios server.
+ """
+ target_host = kwargs['host']
+ kwargs['host'] = self._fix_nagios_url(nagios_url)
+ super(DisableAlerts, self).__init__(target_host, **kwargs)
+ self._command = 'nagios.disable_host_notifications'
+
+
+[docs]class EnableAlerts(NagiosBase):
+ """
+ Enable alerts for a host on a nagios instance
+ """
+
+ def __init__(self, nagios_url, **kwargs):
+ """
+ :Parameters:
+ - `nagios_url`: Hostname of the Nagios server.
+ """
+ target_host = kwargs['host']
+ kwargs['host'] = self._fix_nagios_url(nagios_url)
+ super(EnableAlerts, self).__init__(target_host, **kwargs)
+ self._command = 'nagios.enable_host_notifications'
+
+
+[docs]class ScheduleDowntime(NagiosBase):
+ """
+ Schedule downtime for services on a host in Nagios
+ """
+
+ def __init__(self, nagios_url, service='HOST', minutes=30, **kwargs):
+ """
+ :Parameters:
+ - `nagios_url`: Hostname of the Nagios server.
+ - `service`: Service or list of services to schedule down for.
+ - `minutes`: The number of minutes to schedule downtime
+ for. Default is 30.
+ """
+ import types
+ target_host = kwargs['host']
+ kwargs['host'] = self._fix_nagios_url(nagios_url)
+
+ if isinstance(service, types.StringTypes):
+ service = [service]
+
+ if not isinstance(minutes, types.IntType):
+ if isinstance(minutes, types.FloatType):
+ minutes = int(minutes)
+ else:
+ raise TypeError("Invalid data given for minutes.",
+ "Expecting int type.",
+ "Got '%s'." % minutes)
+
+ super(ScheduleDowntime, self).__init__(target_host, service,
+ minutes, **kwargs)
+
+ if service == 'HOST':
+ self._command = "nagios.schedule_host_downtime"
+ else:
+ self._command = 'nagios.schedule_svc_downtime'
+
+ def _process_result(self, result):
+ t = TaskResult(self)
+ t.success = True
+ for r in result:
+ if r.startswith("Fail: "):
+ t.success = t.success & False
+ else:
+ t.sucess = t.success & True
+ t.output = result
+ return t
+
+
+[docs]class SilenceHost(NagiosBase):
+ """
+ Silence all notifications for a given host
+ """
+
+ def __init__(self, nagios_url, **kwargs):
+ """
+ :Parameters:
+ - `nagios_url`: Hostname of the Nagios server.
+ """
+ target_host = kwargs['host']
+ kwargs['host'] = self._fix_nagios_url(nagios_url)
+ super(SilenceHost, self).__init__(target_host, **kwargs)
+ self._command = 'nagios.silence_host'
+
+ def _process_result(self, result):
+ t = TaskResult(self)
+ t.success = True
+ for r in result:
+ if r.startswith("Fail: "):
+ t.success = t.success & False
+ else:
+ t.sucess = t.success & True
+ t.output = result
+ return t
+
+
+[docs]class UnsilenceHost(NagiosBase):
+ """
+ Unsilence all notifications for a given host
+ """
+
+ def __init__(self, nagios_url, **kwargs):
+ """
+ :Parameters:
+ - `nagios_url`: Hostname of the Nagios server.
+ """
+ target_host = kwargs['host']
+ kwargs['host'] = self._fix_nagios_url(nagios_url)
+ super(UnsilenceHost, self).__init__(target_host, **kwargs)
+ self._command = 'nagios.unsilence_host'
+
+ def _process_result(self, result):
+ t = TaskResult(self)
+ t.success = True
+ for r in result:
+ if r.startswith("Fail: "):
+ t.success = t.success & False
+ else:
+ t.sucess = t.success & True
+ t.output = result
+ return t
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks import BaseTask
+from taboot.tasks import TaskResult
+import time
+
+
+[docs]class PollTask(BaseTask):
+ """
+ PollTask. A task that will poll a particular task until the task
+ succeeds or until max_attempts is reached.
+
+ :Parameters:
+ - `task` The task to poll.
+ - `sleep_interval` The number of seconds to wait before trying
+ the task again.
+ - `max_attempts` The maximum number of attempts that the task
+ should be run.
+ - `fail_task` The task to run when max_attempts has been exhausted.
+ If no fail_task is provided, then a simple TaskResult
+ indicating failure is returned.
+ """
+
+ def __init__(self, task, sleep_interval=5, max_attempts=6,
+ fail_task=None, **kwargs):
+ super(PollTask, self).__init__(**kwargs)
+ self._task = task
+ self._sleep_interval = sleep_interval
+ self._max_attempts = max_attempts
+ self._fail_task = fail_task
+
+ def run(self, runner):
+ for x in range(self._max_attempts):
+ result = runner.run_task(self._task)
+ if result.success:
+ return result
+ time.sleep(self._sleep_interval)
+
+ # exhausted max_attempts
+ if self._fail_task != None:
+ return runner.run_task(self._fail_task)
+ else:
+ # return a "failed" TaskResult, stop executing further tasks
+ return TaskResult(self, success=False,
+ output="Max attempts of %s reached running %s" %
+ (self._max_attempts, repr(self._task)))
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009-2011, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks import command, TaskResult
+import puppet
+
+
+[docs]class PuppetBase(command.Run):
+ """
+ Base class for puppet commands
+ """
+
+ def __init__(self, pcmd, **kwargs):
+ super(PuppetBase, self).__init__(pcmd, **kwargs)
+
+
+[docs]class Run(PuppetBase):
+ """
+ Run 'puppetd --test || true'
+
+ :Optional Parameters:
+ - `server`: Puppetmaster to run against
+ - `noop`: If this should be a noop run (Boolean)
+ - `safe`: Abort if puppet errors (Boolean)
+
+ See also: :py:meth:`taboot.tasks.Puppet.SafeRun`
+ """
+
+ def __init__(self, server="", noop=False, safe=False, **kwargs):
+ pcmd = "puppetd --test --color=false"
+ if server != "":
+ pcmd += " --server=%s" % server
+ if noop == True:
+ pcmd += " --noop"
+ if safe == False:
+ # If safe is False, ignore the return code of the puppet run
+ pcmd += " || true"
+ super(Run, self).__init__(pcmd, **kwargs)
+
+ def run(self, runner):
+ result = super(Run, self).run(runner)
+ return PuppetTaskResult(result.taskObj, result.success,
+ result.output, result.ignore_errors)
+
+
+[docs]class SafeRun(puppet.Run):
+ """
+ Run 'puppetd --test'.
+
+ How is this different from Run? Simple, it will abort everything
+ if puppet returns with a non-zero exit status.
+ """
+
+ def __init__(self, server="", **kwargs):
+ super(SafeRun, self).__init__(server, safe=True, **kwargs)
+
+
+[docs]class Enable(PuppetBase):
+ """
+ Run 'puppetd --enable'.
+ """
+
+ def __init__(self, **kwargs):
+ super(Enable, self).__init__('puppetd --enable', **kwargs)
+
+
+[docs]class Disable(PuppetBase):
+ """
+ Run 'puppetd --disable'.
+ """
+
+ def __init__(self, **kwargs):
+ super(Disable, self).__init__('puppetd --disable', **kwargs)
+
+
+[docs]class DeleteLockfile(PuppetBase):
+ """
+ Remove the puppet lock file.
+ """
+
+ def __init__(self, **kwargs):
+ PUPPET_LOCKFILE = "/var/lib/puppet/state/puppetdlock"
+ super(DeleteLockfile, self).__init__("rm -f %s" % PUPPET_LOCKFILE,
+ **kwargs)
+
+
+[docs]class PuppetTaskResult(TaskResult):
+ """
+ Wrapper around TaskResult to be able to differentiate in output class
+ """
+
+ def __init__(self, task, success=False, output='', ignore_errors=False):
+ super(PuppetTaskResult, self).__init__(task, success, output,
+ ignore_errors)
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009,2010, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks import command, TaskResult
+
+
+[docs]class RPMBase(command.Run):
+ """
+ Base class for rpm commands
+ """
+
+ def __init__(self, pcmd, **kwargs):
+ super(RPMBase, self).__init__(pcmd, **kwargs)
+
+
+[docs]class PreManifest(command.Run):
+ """
+ Gather list of installed RPMs. A later invocation of :class:`PostManifest`
+ is then used to output the RPMs changed during intermediate tasks.
+ """
+
+ def __init__(self, **kwargs):
+ super(PreManifest, self).__init__('rpm -qa | sort', **kwargs)
+
+[docs] def run(self, runner):
+ """
+ Override the default :class:`command.Run` to strip the output
+ from the result because we're really not interested in the
+ contents of the pre-manifest; we just want to collect it to
+ compare later on with PostManifest.
+ """
+
+ result = super(PreManifest, self).run(runner)
+ runner['rpm.PreManifest'] = result.output
+ result.output = ''
+ return result
+
+
+[docs]class PostManifest(command.Run):
+ """
+ Gather list of installed RPMs and compare against a previously
+ taken :class:`PreManifest`
+ """
+
+ from difflib import Differ as _Differ
+
+ def __init__(self, **kwargs):
+ super(PostManifest, self).__init__('rpm -qa | sort', **kwargs)
+
+[docs] def run(self, runner):
+ """
+ The runner that gets passed in contains state that can be
+ access via dict-like access. PreManifest uses this to write
+ to the rpm.Premanifest field. So we'll check to make sure the
+ pre-manifest is there by looking for that state.
+ """
+ try:
+ pre_manifest = runner['rpm.PreManifest']
+ except:
+ return TaskResult(self, success=False,
+ output="You must use PreManifest before PostManifest")
+
+ # ok, so now we have something to compare against so we get
+ # new state...
+ result = super(command.Run, self).run(runner)
+
+ old_list = pre_manifest.splitlines(1)
+ new_list = result.output.splitlines(1)
+
+ differ = self._Differ()
+ diff_output = list(differ.compare(old_list, new_list))
+ diff_output = [line for line in diff_output if line[0] in ('+', '-')]
+
+ result.output = ''.join(diff_output)
+
+ return RPMTaskResult(result.taskObj, result.success,
+ result.output, result.ignore_errors)
+
+
+[docs]class RPMTaskResult(TaskResult):
+ """
+ Wrapper around TaskResult to be able to differentiate in output class
+ """
+
+ def __init__(self, task, success=False, output='', ignore_errors=False):
+ super(RPMTaskResult, self).__init__(task, success, output,
+ ignore_errors)
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009,2011, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks import command
+
+
+
+[docs]class Start(ServiceBase):
+ """
+ Start a service.
+
+ Arguments:
+ - ``service`` - The service to start.
+ """
+
+ def __init__(self, service, **kwargs):
+ super(Start, self).__init__('service %s start' % service, **kwargs)
+
+
+[docs]class Stop(ServiceBase):
+ """
+ Stop a service.
+
+ Arguments:
+ - ``service`` - The service to stop.
+ """
+
+ def __init__(self, service, **kwargs):
+ super(Stop, self).__init__('service %s stop' % service, **kwargs)
+
+
+[docs]class Restart(ServiceBase):
+ """
+ Restart a service.
+
+ Arguments:
+ - ``service`` - The service to restart.
+ """
+
+ def __init__(self, service, **kwargs):
+ super(Restart, self).__init__('service %s restart' % service, **kwargs)
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2011, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks import BaseTask, TaskResult
+from termios import tcflush, TCIFLUSH
+import sys
+
+
+[docs]class SleepBase(BaseTask):
+ """
+ Base class for task-queue pausing classes.
+ """
+
+ def __init__(self, **kwargs):
+ super(SleepBase, self).__init__(**kwargs)
+
+
+[docs]class Seconds(SleepBase):
+ """
+ Halt task processing on a node for a certain number of seconds.
+
+ :Parameters:
+ - `seconds`: Number of seconds to halt execution for.
+ """
+
+ def __init__(self, seconds=60, **kwargs):
+ super(Seconds, self).__init__(**kwargs)
+ self._seconds = seconds
+
+ def run(self, runner):
+ import time
+ time.sleep(self._seconds)
+ return TaskResult(self, success=True,
+ output="Paused for %s seconds" %
+ self._seconds)
+
+
+[docs]class Minutes(SleepBase):
+ """
+ Halt task processing on a node for a certain number of minutes.
+
+ :Parameters:
+ - `minutes`: Number of minutes to halt execution for.
+ """
+
+ def __init__(self, minutes=1, **kwargs):
+ super(Minutes, self).__init__(**kwargs)
+ self._minutes = minutes
+ self._seconds = minutes * 60
+
+ def run(self, runner):
+ import time
+ time.sleep(self._seconds)
+ return TaskResult(self, success=True,
+ output="Paused for %s minutes" %
+ self._minutes)
+
+
+[docs]class WaitOnInput(SleepBase):
+ """
+ Halt task processing on a node until the user presses enter.
+
+ :Parameters:
+ - `message`: The message to prompt on the CLI.
+ """
+
+ def __init__(self, message="Press enter to continue\n", **kwargs):
+ super(WaitOnInput, self).__init__(**kwargs)
+ self._message = message
+ self.concurrentFriendly = False
+
+ def run(self, runner):
+ import time
+ start = time.time()
+ tcflush(sys.stdin, TCIFLUSH)
+ raw_input(self._message)
+ return TaskResult(self, success=True,
+ output="Paused for %s seconds" %
+ (time.time() - start))
+
+# -*- coding: utf-8 -*-
+# Taboot - Client utility for performing deployments with Func.
+# Copyright © 2009, Red Hat, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from taboot.tasks import command, BaseTask
+
+
+[docs]class YumBase(BaseTask):
+ """
+ Base class for all Yum-related tasks.
+ """
+
+ def __init__(self, packages):
+ if isinstance(packages, list):
+ self._packages = packages
+ self._packages_str = ' '.join(packages)
+ else:
+ self._packages = [packages]
+ self._packages_str = packages
+
+
+[docs]class Install(YumBase, command.Run):
+ """
+ Install one or more packages.
+ """
+
+ def __init__(self, packages, **kwargs):
+ """
+ :Parameters:
+ - `packages`: A list of packages to install
+ """
+ YumBase.__init__(self, packages)
+ command.Run.__init__(self, 'yum install -y %s' % self._packages_str,
+ **kwargs)
+
+
+[docs]class Update(YumBase, command.Run):
+ """
+ Update one or more packages.
+ """
+
+ def __init__(self, packages=[], **kwargs):
+ """
+ :Parameters:
+ - `packages`: A list of packages to update. If `packages` is empty,
+ update all packages on the system.
+ """
+ YumBase.__init__(self, packages)
+ command.Run.__init__(self, 'yum update -y %s' % self._packages_str,
+ **kwargs)
+
+
+[docs]class Remove(YumBase, command.Run):
+ """
+ Remove one or more packages.
+ """
+
+ def __init__(self, packages, **kwargs):
+ """
+ :Parameters:
+ - `packages`: A list of packages to remove.
+ """
+ YumBase.__init__(self, packages)
+ command.Run.__init__(self, 'yum remove -y %s' % self._packages_str,
+ **kwargs)
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim +placerat nibh, non feugiat risus varius vitae. Donec eu libero +lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in +magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, +dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus +mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae +luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis +ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, +rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies +tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis +egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna +sem. Donec arcu felis, faucibus et malesuada non, blandit vitae +metus. Fusce nec sapien dolor.
+Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, +pretium quis sapien. Duis felis metus, sodales sit amet gravida in, +pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin +eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, +suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada +molestie, nisi nunc placerat libero, vel vulputate elit tellus et +augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat +egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan +lorem eget leo dictum viverra.
+Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean +ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar +quam. Suspendisse nec massa vel augue laoreet ultricies in convallis +dolor. Mauris sodales porta enim, non ultricies dolor luctus +in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, +erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra +arcu sem a ante. Praesent nec metus vestibulum augue eleifend +suscipit. In feugiat, sem nec dignissim consequat, velit tortor +scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh +turpis. Proin ac nisi ligula, a pretium augue.
+In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed +ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, +eget lobortis mi magna sed metus. Cras justo est, tempus quis +adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et +luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae +nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc +sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet +lacus. Maecenas interdum viverra laoreet. Quisque elementum +sollicitudin ullamcorper.
+Pellentesque mauris sem, malesuada at lobortis in, porta eget +urna. Duis aliquet quam eget risus elementum quis auctor ligula +gravida. Phasellus et ullamcorper libero. Nam elementum ultricies +tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat +tristique lobortis. Suspendisse est enim, tristique eu convallis id, +rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin +hendrerit mi tincidunt dui fermentum placerat.
+The Taboot task library.
+Taboot was created as a framework to do code deployments which +require a repetitive set of tasks to be run in a certain order against +certain groups of hosts.
+The Runner, responsible for running a taboot job.
+| Parameters : |
|
+
|---|
TaskRunner is responsible for executing a set of tasks for a +single host in it’s own thread.
+| Parameters : |
|
+
|---|
Base Task. All tasks should inherit from this. It does the +pretty string representation of a task and allows setting of the +host attribute.
+Explicitly cause a func remote error by calling a bad command. +Used to verify func exception handling works as expected
+A Func-based task. All tasks that utilize Func should inherit +from this.
+Run the FuncTask.
+| Parameters : |
|
+
|---|
An encapsulation of the results of a task. This is passed to one +or more instances of output classes (derived from BaseOutput) in +order to display to the user.
+| Parameters : |
|
+
|---|
Disable alerts for a host on a nagios instance
+| Parameters : |
|
+
|---|
Enable alerts for a host on a nagios instance
+| Parameters : |
|
+
|---|
All subsequent Nagios tasks are subclasses of this.
+Code note: Because a FuncTask expects to make connections to +self.host we need to switch nagios_url with self.host and +pass the original self.host as an argument.
++Changed in version 0.2.14.
+Schedule downtime for services on a host in Nagios
+| Parameters : |
|
+
|---|
PollTask. A task that will poll a particular task until the task +succeeds or until max_attempts is reached.
+| Parameters : |
|
+
|---|
Wrapper around TaskResult to be able to differentiate in output class
+Run ‘puppetd –test || true’
+| Optional Parameters: | |
|---|---|
|
+|
See also: taboot.tasks.Puppet.SafeRun()
+Gather list of installed RPMs and compare against a previously +taken PreManifest
+ + +Gather list of installed RPMs. A later invocation of PostManifest +is then used to output the RPMs changed during intermediate tasks.
+ + +Restart a service.
+Base Class for system service tasks
+Halt task processing on a node for a certain number of minutes.
+| Parameters : |
|
+
|---|
Halt task processing on a node for a certain number of seconds.
+| Parameters : |
|
+
|---|
Install one or more packages.
+| Parameters : |
|
+
|---|
Remove one or more packages.
+| Parameters : |
|
+
|---|
Output a taboot.tasks.TaskResult to the command line +with pretty formatting and colors.
+Creates an instance of a file-like object.
+| Parameters : |
|
+
|---|
Output a taboot.tasks.TaskResult to a logfile.
+Creates an instance of a file-like object.
+| Parameters : |
|
+
|---|
Output a taboot.tasks.TaskResult to the command line +with pretty formatting and colors.
+Write a tasks result out to HTML. Handles enhanced stylizing +for task results that support such as:
+ +Creates an instance of a file-like object.
+| Parameters : |
|
+
|---|
Output a taboot.tasks.TaskResult to a logfile.
+Creates an instance of a file-like object.
+| Parameters : |
|
+
|---|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim +placerat nibh, non feugiat risus varius vitae. Donec eu libero +lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in +magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, +dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus +mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae +luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis +ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, +rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies +tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis +egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna +sem. Donec arcu felis, faucibus et malesuada non, blandit vitae +metus. Fusce nec sapien dolor.
+Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, +pretium quis sapien. Duis felis metus, sodales sit amet gravida in, +pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin +eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, +suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada +molestie, nisi nunc placerat libero, vel vulputate elit tellus et +augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat +egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan +lorem eget leo dictum viverra.
+Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean +ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar +quam. Suspendisse nec massa vel augue laoreet ultricies in convallis +dolor. Mauris sodales porta enim, non ultricies dolor luctus +in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, +erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra +arcu sem a ante. Praesent nec metus vestibulum augue eleifend +suscipit. In feugiat, sem nec dignissim consequat, velit tortor +scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh +turpis. Proin ac nisi ligula, a pretium augue.
+In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed +ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, +eget lobortis mi magna sed metus. Cras justo est, tempus quis +adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et +luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae +nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc +sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet +lacus. Maecenas interdum viverra laoreet. Quisque elementum +sollicitudin ullamcorper.
+Pellentesque mauris sem, malesuada at lobortis in, porta eget +urna. Duis aliquet quam eget risus elementum quis auctor ligula +gravida. Phasellus et ullamcorper libero. Nam elementum ultricies +tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat +tristique lobortis. Suspendisse est enim, tristique eu convallis id, +rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin +hendrerit mi tincidunt dui fermentum placerat.
+Taboot uses what is becoming a pretty standard and a quite simple +toolset.
+++
You can clone the repo via git through the following command::
+$ git clone git://git.fedorahosted.org/Taboot.git
+PEP 0008 should be followed. This outlines the highlights that we +require above and beyond. Your code must follow this (or note why it +can’t) before patches will be accepted.
++++
+- +
global variables should be in ALLCAPPS
+- +
attributes should be all lowercase
+- +
classes should be CamelCased, filenames should be lowercase.
+- +
functions and methods should be lowercase with spaces replaced with _’s:
+++def a_test_method(self): + pass +- +
classes should subclass object unless it subclasses a different object:
+++class Person(object): + pass + +class Steve(Person): + pass +- +
4 spaces per indent level
+- +
max length is 79 chars.
+- +
single quotes preferred over double quotes.
+- +
avoid from x import * imports unless a must use
+- +
modules, functions, classes, and methods all must have docstrings - doc strings should be descriptive of what objects, functions, and methods do
+- +
document any potentially confusing sections of code
+- +
functions and methods should be broken down in such a way as to be easily understood and self contained
+- +
use descriptive variable names, only use things like x, y, etc.. when doing integer loops and even then see if you can use more descriptive names
+
Note
+The Makefile included in the root of the source distribution +includes a target called pep8. Run make pep8 to +automatically scan the taboot/ subdirectory for violations.
+The best way to develop on Taboot is to branch feature sets. For +instance, if you were to add xml deserialization you would want to +branch locally and work on that branch.:
+ $ git branch
+* master
+ $ git status
+ # On branch master
+ nothing to commit (working directory clean)
+ $ git branch xmldeserialization
+ $ git checkout xmldeserialization
+Now we pretend you are all finished and have done at least one commit to the xmldeserialization branch.:
+$ git-format-patch master
+0001-created-initial-classes.patch
+0002-added-in-documentation.patch
+$
+You now have patch sets which you can send in for perusal and +acceptance. Open a new ticket in our issue tracker or attach them to +an existing ticket.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim +placerat nibh, non feugiat risus varius vitae. Donec eu libero +lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in +magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, +dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus +mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae +luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis +ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, +rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies +tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis +egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna +sem. Donec arcu felis, faucibus et malesuada non, blandit vitae +metus. Fusce nec sapien dolor.
+Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, +pretium quis sapien. Duis felis metus, sodales sit amet gravida in, +pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin +eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, +suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada +molestie, nisi nunc placerat libero, vel vulputate elit tellus et +augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat +egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan +lorem eget leo dictum viverra.
+Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean +ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar +quam. Suspendisse nec massa vel augue laoreet ultricies in convallis +dolor. Mauris sodales porta enim, non ultricies dolor luctus +in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, +erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra +arcu sem a ante. Praesent nec metus vestibulum augue eleifend +suscipit. In feugiat, sem nec dignissim consequat, velit tortor +scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh +turpis. Proin ac nisi ligula, a pretium augue.
+In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed +ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, +eget lobortis mi magna sed metus. Cras justo est, tempus quis +adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et +luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae +nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc +sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet +lacus. Maecenas interdum viverra laoreet. Quisque elementum +sollicitudin ullamcorper.
+Pellentesque mauris sem, malesuada at lobortis in, porta eget +urna. Duis aliquet quam eget risus elementum quis auctor ligula +gravida. Phasellus et ullamcorper libero. Nam elementum ultricies +tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat +tristique lobortis. Suspendisse est enim, tristique eu convallis id, +rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin +hendrerit mi tincidunt dui fermentum placerat.
+How to ansible
+See also
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim +placerat nibh, non feugiat risus varius vitae. Donec eu libero +lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in +magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, +dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus +mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae +luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis +ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, +rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies +tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis +egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna +sem. Donec arcu felis, faucibus et malesuada non, blandit vitae +metus. Fusce nec sapien dolor.
+Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, +pretium quis sapien. Duis felis metus, sodales sit amet gravida in, +pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin +eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, +suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada +molestie, nisi nunc placerat libero, vel vulputate elit tellus et +augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat +egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan +lorem eget leo dictum viverra.
+Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean +ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar +quam. Suspendisse nec massa vel augue laoreet ultricies in convallis +dolor. Mauris sodales porta enim, non ultricies dolor luctus +in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, +erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra +arcu sem a ante. Praesent nec metus vestibulum augue eleifend +suscipit. In feugiat, sem nec dignissim consequat, velit tortor +scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh +turpis. Proin ac nisi ligula, a pretium augue.
+In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed +ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, +eget lobortis mi magna sed metus. Cras justo est, tempus quis +adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et +luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae +nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc +sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet +lacus. Maecenas interdum viverra laoreet. Quisque elementum +sollicitudin ullamcorper.
+Pellentesque mauris sem, malesuada at lobortis in, porta eget +urna. Duis aliquet quam eget risus elementum quis auctor ligula +gravida. Phasellus et ullamcorper libero. Nam elementum ultricies +tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat +tristique lobortis. Suspendisse est enim, tristique eu convallis id, +rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin +hendrerit mi tincidunt dui fermentum placerat.
+Ansible is a extra-simple tool/API for doing ‘parallel remote things’ +over SSH – whether executing commands, running “modules”, or +executing larger ‘playbooks’ that can serve as a configuration +management or deployment system.
+While Func installation which I +co-wrote, aspired to avoid using SSH and have it’s own daemon +infrastructure, Ansible aspires to be quite different and more +minimal, but still able to grow more modularly over time. This is +based on talking to a lot of users of various tools and wishing to +eliminate problems with connectivity and long running daemons, or not +picking tool X because they preferred to code in Y. Further, playbooks +take things a whole step further, building the config and deployment +system I always wanted to build.
+Why use Ansible versus something else? (Fabric, Capistrano, +mCollective, Func, SaltStack, etc?) It will have far less code, it +will be more correct, and it will be the easiest thing to hack on and +use you’ll ever see – regardless of your favorite language of choice. +Want to only code plugins in bash or clojure? Ansible doesn’t care. +The docs will fit on one page and the source will be blindingly +obvious.
+Requirements are extremely minimal.
+If you are running python 2.6 on the overlord machine, you will +need:
+If you are running less than Python 2.6, you will also need
+On the managed nodes, to use templating, you will need:
+Contents:
+Taboot is in the Fedora package repositories. Installing it should be as simple as:
+sudo yum install python-taboot
+You’ll need these dependencies to build/install:
+++
Building documentation requires some more deps. These are required +if you’re building RPMs, and optional if you’re installing manually:
++++
+- python-sphinx
+- asciidoc
+- libxslt
+
This is the recommended installation method if you’re pulling Taboot +from source:
+make rpm
+sudo yum localinstall /path/to/rpm
+I don’t recommend this. But if you’re dead set on installing +directly from source you still can. This calls the python +distutils installer directly:
+sudo make install
+If you wish to build and install the optional documentation you’ll +need some additional packages so it can be built fully. Install the +documentation with this command:
+sudo make installdocs
+Uninstall everything with:
+sudo make uninstall
+ansible-modules — stock modules shipped with ansible
Ansible ships with a number of modules that can be executed directly on remote hosts or through +ansible playbooks.
Most modules other than command are idempotent, meaning they will seek to avoid changes +unless a change needs to be made. When using ansible playbooks, these modules can +trigger change events, as described in ansible-playbooks(5).
Unless otherwise noted, all modules support change hooks.
The command module takes the command name followed by a list of arguments, space delimited. +This is the only module that does not use key=value style parameters.
This module does not support change hooks.
Returns the return code from the program as well as timing information.
(Async command running and command execution time limits are in plan.)
The copy module moves a file on the local box to remote locations.
This module also returns md5sum information about the resultant file.
Runs the discovery program facter on the remote system, returning +JSON data that can be useful for inventory purposes.
Requires that facter and ruby-json be installed on the remote end.
This module is informative only - it takes no parameters & does not support change hooks, +nor does it make any changes on the system.
Ensures the ownership and permissions of files are as desired.
Use copy or template first if you need to make sure a file is on the box.
In plan.
Deploys software from git checkouts.
Similar to the facter module, this returns JSON inventory data. Ohai +data is a bit more verbose and nested than facter.
Requires that ohai be installed on the remote end.
This module is information only - it takes no parameters & does not +support change hooks, nor does it make any changes on the system.
A trivial test module, this module always returns the integer 1 on +successful contact.
This module does not support change hooks.
This module is informative only - it takes no parameters & does not +support change hooks, nor does it make any changes on the system.
Controls services on remote machines.
Writes a JSON file containing key/value data, for use in templating. +Call this once before using the template modules, usually as the very +first step in your playbook.
If facter or ohai are installed, variables from these programs will also +be snapshotted into the JSON file for usage in templating. These variables +are prefixed with facter_ and 'ohai_" so it’s easy to tell their source.
Templates a file out to a remote server. Call the setup module prior to usage.
This module also returns md5sum information about the resultant file.
To write your own modules, simply follow the convention of those already available in +/usr/share/ansible. Modules must return JSON but can be written in any language. +To support change hooks, modules should return hashes, with a changed: True/False +element at the top level. Modules can also choose to indicate a failure scenario +by returning a top level failure element with a True value.
ansible-playbook — format and function of an ansible playbook file
Ansible ships with ansible-playbook, a tool for running playbooks. +Playbooks can represent frequent tasks, desired system configurations, +or deployment processes.
Here’s what playbook.yml (above) will do.
The first pattern will select all hosts. The patterns are the same +as supported by /usr/bin/ansible.
First, it will run all the modules specified in base.yml. Includes can +be used to implement classes of things, and if you wanted, a playbook +could consist of nothing but include files. This is an example of an +include.
After processing base.yml, on each host we’ll write for +a JSON file into /etc/ansible/setup on each remote system with the +values max_clients and http_port.
Next, we’ll use a Jinja2 template locally residing at +/srv/templates/httpd.j2 to write the Apache config file on each host, +using the previous values in that setup file.
Next, We’ll ensure that apache is running if stopped.
The template task set up a notifier, which means if the configuration +file actually changed, we have a named handler, in this case, restart apache +to run. In this case, all the notifiers come from handlers.yml, though it’s +also ok to express handlers directly in the main yaml file too. Using +the include promotes reuse.
What does the handler say? If and only if the config file changed, note that we need to restart +apache at the end of the run, otherwise, don’t bother because we +already know it is running.
Playbooks are executed top down and can contain multiple references to +patterns. For instance, a playbook could do something to all +webservers, then do something to all database servers, then do +something different to all webservers again.
For each pattern, the tasks in the tasks list are executed in order +for all hosts in the host file matching the pattern.
For each task, a name/action pair describes what the task is and what +ansible module to use to accomplish the task, along with any +arguments. Additional fields like comment: can be added and will +be ignored, so feel free to take notes in the file.
Most modules accept key=value format arguments.
Handlers are like tasks, but are conditionally executed. If a module +reports a change, it can notify one or more handler by name. If +notified, it will run only for hosts that changed.
If a host has a failure, the host will be ignored for the remainder +of the playbook execution.
ansible — run a command somewhere else
See ansible --help for additional options.
Ansible stores the hosts it can potentially operate on in an inventory +file. The syntax is one host per line. Groups headers are allowed and +are included on their own line, enclosed in square brackets.
The following environment variables may specified.
ANSIBLE_HOSTS — Override the default ansible hosts file
ANSIBLE_LIBRARY — Override the default ansible module library path
Ansible was originally written by Michael DeHaan. See the AUTHORS file +for a complete list of contributors.
Ansible home page: https://github.com/mpdehaan/ansible/
ansible-modules(5)
ansible-playbook(5)
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim +placerat nibh, non feugiat risus varius vitae. Donec eu libero +lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in +magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, +dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus +mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae +luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis +ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, +rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies +tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis +egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna +sem. Donec arcu felis, faucibus et malesuada non, blandit vitae +metus. Fusce nec sapien dolor.
+Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, +pretium quis sapien. Duis felis metus, sodales sit amet gravida in, +pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin +eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, +suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada +molestie, nisi nunc placerat libero, vel vulputate elit tellus et +augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat +egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan +lorem eget leo dictum viverra.
+Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean +ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar +quam. Suspendisse nec massa vel augue laoreet ultricies in convallis +dolor. Mauris sodales porta enim, non ultricies dolor luctus +in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, +erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra +arcu sem a ante. Praesent nec metus vestibulum augue eleifend +suscipit. In feugiat, sem nec dignissim consequat, velit tortor +scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh +turpis. Proin ac nisi ligula, a pretium augue.
+In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed +ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, +eget lobortis mi magna sed metus. Cras justo est, tempus quis +adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et +luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae +nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc +sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet +lacus. Maecenas interdum viverra laoreet. Quisque elementum +sollicitudin ullamcorper.
+Pellentesque mauris sem, malesuada at lobortis in, porta eget +urna. Duis aliquet quam eget risus elementum quis auctor ligula +gravida. Phasellus et ullamcorper libero. Nam elementum ultricies +tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat +tristique lobortis. Suspendisse est enim, tristique eu convallis id, +rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin +hendrerit mi tincidunt dui fermentum placerat.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim +placerat nibh, non feugiat risus varius vitae. Donec eu libero +lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in +magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, +dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus +mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae +luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis +ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, +rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies +tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis +egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna +sem. Donec arcu felis, faucibus et malesuada non, blandit vitae +metus. Fusce nec sapien dolor.
+Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, +pretium quis sapien. Duis felis metus, sodales sit amet gravida in, +pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin +eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, +suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada +molestie, nisi nunc placerat libero, vel vulputate elit tellus et +augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat +egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan +lorem eget leo dictum viverra.
+Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean +ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar +quam. Suspendisse nec massa vel augue laoreet ultricies in convallis +dolor. Mauris sodales porta enim, non ultricies dolor luctus +in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, +erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra +arcu sem a ante. Praesent nec metus vestibulum augue eleifend +suscipit. In feugiat, sem nec dignissim consequat, velit tortor +scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh +turpis. Proin ac nisi ligula, a pretium augue.
+In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed +ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, +eget lobortis mi magna sed metus. Cras justo est, tempus quis +adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et +luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae +nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc +sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet +lacus. Maecenas interdum viverra laoreet. Quisque elementum +sollicitudin ullamcorper.
+Pellentesque mauris sem, malesuada at lobortis in, porta eget +urna. Duis aliquet quam eget risus elementum quis auctor ligula +gravida. Phasellus et ullamcorper libero. Nam elementum ultricies +tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat +tristique lobortis. Suspendisse est enim, tristique eu convallis id, +rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin +hendrerit mi tincidunt dui fermentum placerat.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In dignissim +placerat nibh, non feugiat risus varius vitae. Donec eu libero +lectus. Ut non orci felis, eget mattis mauris. Etiam ut tellus in +magna porta venenatis. Quisque scelerisque, sem non ultrices bibendum, +dolor diam rutrum lectus, sed luctus neque neque vitae eros. Vivamus +mattis, ipsum ut bibendum gravida, lectus arcu venenatis elit, vitae +luctus diam leo sit amet ligula. Nunc egestas justo in nulla sagittis +ut suscipit sapien gravida. Morbi id dui nibh. Nullam diam massa, +rhoncus a dignissim non, adipiscing vel arcu. Quisque ultricies +tincidunt purus ut sodales. Quisque scelerisque dapibus purus quis +egestas. Maecenas sagittis porttitor adipiscing. Duis eu magna +sem. Donec arcu felis, faucibus et malesuada non, blandit vitae +metus. Fusce nec sapien dolor.
+Aenean ac fermentum nisl. Integer leo sem, rutrum nec dictum at, +pretium quis sapien. Duis felis metus, sodales sit amet gravida in, +pretium ut arcu. Nulla ligula quam, aliquam sit amet sollicitudin +eget, molestie tincidunt ipsum. Nulla leo nunc, mattis sed auctor at, +suscipit ut metus. Suspendisse hendrerit, justo sagittis malesuada +molestie, nisi nunc placerat libero, vel vulputate elit tellus et +augue. Phasellus tempor lectus ac nisi aliquam faucibus. Donec feugiat +egestas nibh id mattis. In hac habitasse platea dictumst. Ut accumsan +lorem eget leo dictum viverra.
+Quisque egestas lorem sit amet felis tincidunt adipiscing. Aenean +ornare fermentum accumsan. Aenean eu mauris arcu, id pulvinar +quam. Suspendisse nec massa vel augue laoreet ultricies in convallis +dolor. Mauris sodales porta enim, non ultricies dolor luctus +in. Phasellus eu tortor lectus, vel porttitor nulla. Mauris vulputate, +erat id scelerisque lobortis, nibh ipsum tristique elit, ac viverra +arcu sem a ante. Praesent nec metus vestibulum augue eleifend +suscipit. In feugiat, sem nec dignissim consequat, velit tortor +scelerisque metus, sit amet mollis nisl sem eu nibh. Quisque in nibh +turpis. Proin ac nisi ligula, a pretium augue.
+In nibh eros, laoreet id interdum vel, sodales sed tortor. Sed +ullamcorper, sem vel mattis consectetur, nibh turpis molestie nisl, +eget lobortis mi magna sed metus. Cras justo est, tempus quis +adipiscing ut, hendrerit convallis sem. Mauris ullamcorper, sapien et +luctus iaculis, urna elit egestas ipsum, et tristique enim risus vitae +nunc. Vivamus aliquet lorem eu urna pulvinar hendrerit malesuada nunc +sollicitudin. Cras in mi rhoncus quam egestas dignissim vel sit amet +lacus. Maecenas interdum viverra laoreet. Quisque elementum +sollicitudin ullamcorper.
+Pellentesque mauris sem, malesuada at lobortis in, porta eget +urna. Duis aliquet quam eget risus elementum quis auctor ligula +gravida. Phasellus et ullamcorper libero. Nam elementum ultricies +tellus, in sagittis magna aliquet quis. Ut sit amet tellus id erat +tristique lobortis. Suspendisse est enim, tristique eu convallis id, +rutrum nec lacus. Fusce iaculis diam non felis rutrum lobortis. Proin +hendrerit mi tincidunt dui fermentum placerat.
+| + t | ||
| + | + taboot | + |
| + | + taboot.output | + |
| + | + taboot.runner | + |
| + | + taboot.tasks | + |
| + | + taboot.tasks.command | + |
| + | + taboot.tasks.mod_jk | + |
| + | + taboot.tasks.nagios | + |
| + | + taboot.tasks.poller | + |
| + | + taboot.tasks.puppet | + |
| + | + taboot.tasks.rpm | + |
| + | + taboot.tasks.service | + |
| + | + taboot.tasks.sleep | + |
| + | + taboot.tasks.yum | + |
+ Please activate JavaScript to enable the search + functionality. +
++ From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +
+ + +All the built-in tasks are documented here.
+The command module is used to execute arbitrary commands on a +remote host. The command module has one callable class, that is +the Run class.
+Syntax:
+
---
+ tasks:
+ # Normal form
+ - command.Run:
+ command: command-to-run
+
+ # Abbreviated form
+ - command.Run: {command: command-to-run}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - command.Run: {command: yum -y install httpd}
+The service module provides interface classes to the system +service command.
+Syntax:
+---
+ tasks:
+ # Normal form
+ - service.Start:
+ service: service-to-start
+
+ # Abbreviated form
+ - service.Start: {service: service-to-start}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - service.Start: {service: httpd}
+Syntax:
+---
+ tasks:
+ # Normal form
+ - service.Stop:
+ service: service-to-stop
+
+ # Abbreviated form
+ - service.Stop: {service: service-to-stop}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - service.Stop: {command: httpd}
+Syntax:
+---
+ tasks:
+ # Normal form
+ - service.Restart:
+ service: service-to-restart
+
+ # Abbreviated form
+ - service.Restart: {service: service-to-restart}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - service.Restart: {command: httpd}
+The puppet module provides a uniform way interact with the puppet +service. This includes like enabling/disabling the daemon and manually +forcing a catalog run.
+Note
+See the YAML Basics document for notes on +specifying boolean values.
+The Run class triggers a manual catalog run. This is equivalent to +puppetd --test. This will not abort the release if puppet +returns with a non-zero exit code. You should check out the SafeRun +class if you’re paranoid about that.
+Syntax:
+---
+ tasks:
+ - puppet.Run
+
+ # Run against a different puppet master
+ - puppet.Run: {server: my.puppet.server}
+ # No operation run
+ - puppet.Run: {noop: true}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - puppet.Run
+
+---
+- hosts:
+ - www*
+ tasks:
+ - puppet.Run: {noop: true, server: puppetmaster01.util.foobar.com}
++Changed in version 0.2.11: Absolutely will not abort the release if puppet returns +non-zero.
++Changed in version 0.4.0: Added server and noop keys.
+The SafeRun class triggers a manual catalog run. This is +equivalent to puppetd --test. This will abort the release if +puppet returns with a non-zero exit code on systems running puppet +2.6+. You should check out the Run class if you have reasons to +ignore possible puppet errors.
+Syntax:
+---
+ tasks:
+ - puppet.SafeRun
+
+ # Run against a different puppet master
+ - puppet.SafeRun: {server: my.puppet.server}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - puppet.SafeRun
++New in version 0.2.11.
+The Enable class reverses the effect of the disable +class. This removes the lockfile that prevented any automatic or +manual catalog runs from happening before. This is equivalent to +puppetd --enable.
+Syntax:
+---
+ tasks:
+ - puppet.Enable
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - puppet.Enable
+The Disable class creates a lockfile that prevents puppet from +performing any manual or automatic catalog runs. This is equivalent to +puppetd --disable.
+Syntax:
+---
+ tasks:
+ - puppet.Disable
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - puppet.Disable
+The DeleteLockfile class forcibly deletes a lockfile. You +shouldn’t normally need this but from time to time you may find it +necessary. Try and use the Enable class when at all possible.
+Syntax:
+---
+ tasks:
+ - puppet.DeleteLockfile
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - puppet.DeleteLockfile
+The nagios task lets you handle notification and set downtime +from your Taboot scripts.
++Changed in version 0.2.14: The nagios task has switched from a CURL backend using Kerberos +authentication to a pure Func backend. Significant changes include:
The host identified by the nagios_url key must be a registered +Func minion and it must have the new Func Nagios module installed. You +can download it from the Func git repo (in the func/minion/modules/ +directory) if it is missing from your installation.
+See also
+ +This class enables host alerts for the current host.
+Syntax:
+---
+ tasks:
+ # Normal form
+ - nagios.EnableAlerts:
+ nagios_url: nagios-hostname
+
+ # Abbreviated form
+ - nagios.EnableAlerts: {nagios_url: nagios-hostname}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - nagios.EnableAlerts: {nagios_url: nagios.example.com}
+This class disables host alerts for the current host.
+Syntax:
+---
+ tasks:
+ # Normal form
+ - nagios.DisableAlerts:
+ nagios_url: nagios-hostname
+
+ # Abbreviated form
+ - nagios.DisableAlerts: {nagios_url: nagios-hostname}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - nagios.DisableAlerts: {nagios_url: nagios.example.com}
++Changed in version 0.2.14: Default for the minutes key changed from 15 to 30 minutes.
+Syntax:
+---
+ tasks:
+ # Normal form
+ - nagios.ScheduleDowntime:
+ nagios_url: nagios-hostname
+ service: service-to-schedule
+ minutes: length-of-downtime
+
+ # Abbreviated form
+ - nagios.ScheduleDowntime: {nagios_url: nagios-hostname, service: service-to-schedule, minutes: length-of-downtime}
+Example #1:
+---
+- hosts:
+ - www*
+ tasks:
+ - nagios.ScheduleDowntime:
+ nagios_url: nagios.example.com
+ service: httpd
+ minutes: 60
+Example #2:
+---
+- hosts:
+ - www*
+ tasks:
+ - nagios.ScheduleDowntime:
+ nagios_url: nagios.example.com
+ service: [httpd, git, XMLRPC]
+ minutes: 60
+This class disables all host and service notifications for the current +host.
+Syntax:
+---
+ tasks:
+ # Normal form
+ - nagios.SilenceHost:
+ nagios_url: nagios-hostname
+
+ # Abbreviated form
+ - nagios.SilenceHost: {nagios_url: nagios-hostname}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - nagios.SilenceHost: {nagios_url: nagios.example.com}
++New in version 0.3.2.
+This class enables all host and service notifications for the current +host.
+Syntax:
+---
+ tasks:
+ # Normal form
+ - nagios.UnsilenceHost:
+ nagios_url: nagios-hostname
+
+ # Abbreviated form
+ - nagios.UnsilenceHost: {nagios_url: nagios-hostname}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - nagios.UnsilenceHost: {nagios_url: nagios.example.com}
++New in version 0.3.2.
+The sleep module is used to halt further task processing for a +specified period of time, or until the user presses enter (as in the +case of WaitOnInput).
+You might use this if you’ve rolled the services on a node and need to +let it build up or sync a cache before you put it back into rotation.
+WaitOnInput can be used when user verification needs to be performed +before proceeding on to another node.
+Syntax:
+---
+ tasks:
+ # Normal form
+ - sleep.Seconds:
+ seconds: number-of-seconds
+
+ # Abbreviated form
+ - sleep.Seconds: {seconds: number-of-seconds}
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - service.Restart: {service: jbossas}
+ - sleep.Seconds: {seconds: 300}
+Syntax:
+---
+ tasks:
+ # Normal form
+ - sleep.Minutes:
+ minutes: number-of-minutes
+
+ # Abbreviated form
+ - sleep.Minutes: {minutes: number-of-minutes}
+Example:
+---
+- hosts:
+ - java*
+ tasks:
+ - service.Restart: {service: jbossas}
+ - sleep.Minutes: {minutes: 5}
+Syntax:
+---
+ tasks:
+ # Normal form
+ - sleep.WaitOnInput:
+ message: message-to-prompt-user
+
+ # Abbreviated form
+ - sleep.WaitOnInput: {message: message-to-prompt-user}
+Example:
+---
+- hosts:
+ - java*
+ tasks:
+ - service.Restart: {service: jbossas}
+ - sleep.WaitOnInput
++New in version 0.3.2.
+The yum module lets you perform common tasks right in your +Taboot scripts.
+Syntax:
+---
+ tasks:
+ # Normal form
+ - yum.Install:
+ packages:
+ - package-name
+
+ # Abbreviated form
+ - yum.Install: {packages: [package-name]}
+Example 1:
+---
+- hosts:
+ - www*
+ tasks:
+ - yum.Install: {packages: [httpd, php5, screen]}
+Example 2:
+---
+- hosts:
+ - www*
+ tasks:
+ - yum.Install:
+ packages:
+ - httpd
+ - php5
+ - screen
+Syntax:
+---
+ tasks:
+ # Normal form
+ - yum.Remove:
+ packages:
+ - package-name
+
+ # Abbreviated form
+ - yum.Remove: {packages: [package-name]}
+Example 1:
+---
+- hosts:
+ - www*
+ tasks:
+ - yum.Remove: {packages: [httpd, php5, screen]}
+Example 2:
+---
+- hosts:
+ - www*
+ tasks:
+ - yum.Remove:
+ packages:
+ - httpd
+ - php5
+ - screen
+Syntax:
+---
+ tasks:
+ # Normal form
+ - yum.Update:
+ packages:
+ - package-name
+
+ # Abbreviated form
+ - yum.Update: {packages: [package-name]}
+Example 1:
+---
+- hosts:
+ - www*
+ tasks:
+ - yum.Update: {packages: [httpd, php5, screen]}
+Example 2:
+---
+- hosts:
+ - www*
+ tasks:
+ - yum.Update:
+ packages:
+ - httpd
+ - php5
+ - screen
+The RPM module provides two utility classes used to create a log +of any RPMs installed on the target system that were changed during +the Taboot run.
+The PreManifest class is best ran at the beginning of a tasks +block. When ran it saves the output of rpm -qa | sort on each of +the target machine locally. This is only useful if the +PostManifest class is called at the end of the Taboot script.
+Syntax:
+---
+ tasks:
+ - rpm.PreManifest
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - rpm.PreManifest
+ - puppet.Run
+ - rpm.PostManifest
+The PostManifest class is best ran at the end of a tasks +block. When ran it will show a diff of the packages installed between +when PreManifest was ran and when PostManifest is called.
+This is really useful for checking that planned updates are happening +in a Taboot script if they are supposed to be. There might be +package updates happening if you’re doing a manual puppet catalog run, +or are triggering some other kind of automatic package updating +utility. Maybe your script is as simple as a PreManifest, then a +command.Run that just runs yum -y update, and ends with a +PostManifest.
+Syntax:
+---
+ tasks:
+ - rpm.PostManifest
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - rpm.PreManifest
+ - puppet.Run
+ - rpm.PostManifest
+These classes might be described best by showing a complete example.
+Here is the YAML file (mercurial-update.yaml) that’s going to be +run:
+---
+- hosts:
+ - fridge
+ tasks:
+ - rpm.PreManifest
+ - yum.Update: {packages: [mercurial]}
+ - rpm.PostManifest
+This is what the output looks like. The last two lines show the +packages that changed during the Taboot run:
+[root@fridge yamls]# taboot mercurial-update.yaml
+fridge.bsb.local:
+2011-04-04 21:04:09 Starting Task[taboot.tasks.rpm.PreManifest('rpm -qa | sort',)]
+fridge.bsb.local:
+2011-04-04 21:04:12 Finished Task[taboot.tasks.rpm.PreManifest('rpm -qa | sort',)]:
+
+fridge.bsb.local:
+2011-04-04 21:04:12 Starting Task[taboot.tasks.yum.Update('yum update -y mercurial',)]
+fridge.bsb.local:
+2011-04-04 21:04:34 Finished Task[taboot.tasks.yum.Update('yum update -y mercurial',)]:
+
+# yum.Update output here...
+
+fridge.bsb.local:
+2011-04-04 21:04:34 Starting Task[taboot.tasks.rpm.PostManifest('rpm -qa | sort',)]
+fridge.bsb.local:
+2011-04-04 21:04:37 Finished Task[taboot.tasks.rpm.PostManifest('rpm -qa | sort',)]:
+- mercurial-1.7.5-1.fc14.x86_64
++ mercurial-1.8.1-2.fc14.x86_64
+The AJP module provides a uniform way to put nodes into and out of +rotation in a mod_jk AJP balancer. This module is a great +replacement for manually adding and removing nodes in a jkmanage +management panel.
+Note
+This module requires that the taboot-func package is installed +on the target AJP balancers.
+Note
+This module is very specific to the original authors needs and may +not work outside of that environment without customization.
+See also
+The InRotation class puts an AJP node back into rotation.
+Syntax:
+---
+ tasks:
+ - mod_jk.InRotation:
+ proxies:
+ - proxy-hostname
+Example:
+---
+- hosts:
+ - tomcat*.int.company.com
+ tasks:
+ - mod_jk.InRotation:
+ proxies:
+ - proxyjava01.web.prod.ext.example.com
+ - proxyjava02.web.prod.ext.example.com
+The OutOfRotation class takes an AJP node out of rotation.
+Syntax:
+---
+ tasks:
+ - mod_jk.OutOfRotation:
+ proxies:
+ - proxy-hostname
+Example:
+---
+- hosts:
+ - tomcat*.int.company.com
+ tasks:
+ - mod_jk.OutOfRotation:
+ proxies:
+ - proxyjava01.web.prod.ext.example.com
+ - proxyjava02.web.prod.ext.example.com
+The misc module has two simple tasks in it: Noop and +Echo. They are primarily intended for instruction and as +placeholders while testing scripts or major code changes.
+Syntax:
+---
+ tasks:
+ - misc.Noop
+Example:
+---
+- hosts:
+ - www*
+ tasks:
+ - misc.Noop
+This is a generic task that litterally does nothing.
+Syntax:
+---
+ tasks:
+ # Normal form
+ - misc.Echo:
+ input: string
+
+ # Abbreviated form
+ - misc.Echo: {input: string}
+Example 1:
+---
+- hosts:
+ - www*
+ tasks:
+ - misc.Echo: {input: "Taboot Rules!"}
+Example 2:
+---
+- hosts:
+ - www*
+ tasks:
+ - misc.Echo:
+ input: "Taboot Rules!"
++New in version 0.4.0.
+