A Minimal StackTach.v3 deployment
+The bare minimum StackTach.v3 deployment has the following components:
+-
+
- a queuing system, like RabbitMQ, that contains the notifications. +
- a MySQL database +
- something to generate source notifications +
- a yagi-event process to read the notifications and get them into winchester +
- a winchester pipeline-worker process to do processing on ready streams +
If you have a machine with MySQL and RabbitMQ on it, the stacktach-sandbox repo does the rest. The sandbox will set up a python virtual environment, install all the required components and run everything under a screen session.
+
+ The sandbox sets up seven screen pages that contain:
+-
+
- The REST API server, via the gunicorn web server, quincy WSGI application and quince API implementation. Quince uses winchester to talk to the database. +
- A bash shell for running the klugman command line tool. +
- Two yagi-event workers. One per screen page. +
- Two pipeline-worker workers. One per screen page. +
- The notigen notification simulator. +
You can see the flow of data in the diagram above:
+-
+
- OpenStack Nova notifications are simulated by notagen and pumped into RabbitMQ via the notabene library. With the sandbox, there is no need to stand up a full OpenStack deployment. +
- The yagi-event workers consume notifications from RabbitMQ, archives them via shoebox, distills them into events and stuffs them into streams via winchester +
- The pipeline-worker workers look for ready streams and does pipeline processing on them. +
- The user can use the klugman cmdline tool to talk to the REST API to perform stream and event operations/queries +
In order to do all this, there are a number of configation files required. Refer to the general documentation here or the particular libaries README file for configuration details. The main configuration files include:
+-
+
- yagi.conf - the configuration file that tells yagi how to connect to the quque and what to do with the notifications consumed. +
- winchester.yaml - the master configuration file for winchester. It specifies the pipeline configuration to use, the stream definitions and the triggering rules. +
- triggers.yaml - the detailed stream definitions and pipeline triggering rules +
- pipelines.yaml - the pipeline handler definitions +
Where each of these files is used is illustrated in the diagram below:
+ +
+
+ This will get you going for a minimal StackTach.v3 installation. Especially handy for dev environments. Read up on the "build" command, below, for instructions on For larger deployments, you may want to look at how we deploy StackTach.v3 within Rackspace Public Cloud, below:
+How StackTach.v3 is deployed at Rackspace
For Rackspace Public Cloud, OpenStack is deployed in many different regions and each region is comprised of many cells.
diff --git a/docs/sandbox-1.gif b/docs/sandbox-1.gif new file mode 100644 index 0000000..459e363 Binary files /dev/null and b/docs/sandbox-1.gif differ diff --git a/docs/sandbox-2.gif b/docs/sandbox-2.gif new file mode 100644 index 0000000..afeb80e Binary files /dev/null and b/docs/sandbox-2.gif differ