x/stacktach-sandbox
Code Issues Proposed changes

More docs: install guide, contributing and screencasts.

Browse Source 
Still need the terminology section.

Change-Id: Ic3976231ad9fbf2eb16ea708011aa906d5c5e781
This commit is contained in:
Sandy Walsh 2015-02-26 13:43:04 -08:00
parent 74fd693f51
commit f0a178b54c
5 changed files with 274 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
docs/contribute.html Normal file
View File

@ -0,0 +1,75 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="StackTach.v3">
<meta name="author" content="Sandy Walsh">
<link rel="icon" href="../../favicon.ico">
<title>StackTach.v3</title>
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css">
<link href="stv3-narrow.css" rel="stylesheet">
<!-- Optional theme -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap-theme.min.css">
<!-- Latest compiled and minified JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/js/bootstrap.min.js"></script>
<style>
.bottom_padding {
padding-bottom: 20px;
}
</style>
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="header bottom_padding">
<nav>
<ul class="nav nav-pills pull-right">
<li role="presentation"><a href="index.html">Home</a></li>
<li role="presentation"><a href="about.html">Docs</a></li>
<li role="presentation"><a href="install.html">Getting Started</a></li>
<li role="presentation"><a href="#">API</a></li>
<li role="presentation"><a href="screencasts.html">Screencasts</a></li>
<li role="presentation" class="active"><a href="contribute.html">Contribute</a></li>
</ul>
</nav>
<img src="StackTach_160x70.png"/>
</div>
<div class="row marketing">
<div class="col-lg-12">
<h3>Contributing to StackTach.v3</h3>
<p>StackTach.v3 is licensed under the Apache 2.0 license</p>
<p>All the source repos for StackTach.v3 (and .v2) are available on <a href='https://github.com/stackforge?query=stacktach'>SourceForge</a>. Details on contributing to StackForge projects are available <a href='https://wiki.openstack.org/wiki/How_To_Contribute'>here</a></p>
<p>The core developers are available on Freenode IRC in the <code>#stacktach</code> channel</p>
<p>These docs are available in the Sandbox repo. Patches welcome!</p>
<footer class="footer">
<p>&copy; Dark Secret Software Inc. 2014</p>
</footer>
</div> <!-- /container -->
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
<script src="../../assets/js/ie10-viewport-bug-workaround.js"></script>
</body>
</html>

BIN
docs/deploy_diagram.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 47 KiB

4
docs/index.html
View File

@ -47,8 +47,8 @@
<li role="presentation"><a href="about.html">Docs</a></li>
<li role="presentation"><a href="install.html">Getting Started</a></li>
<li role="presentation"><a href="#">API</a></li>
<li role="presentation"><a href="#">Screencasts</a></li>
<li role="presentation"><a href="#">Contribute</a></li>
<li role="presentation"><a href="screencasts.html">Screencasts</a></li>
<li role="presentation"><a href="contribute.html">Contribute</a></li>
</ul>
</nav>
<img src="StackTach_160x70.png"/>

94
docs/install.html Normal file
View File

@ -0,0 +1,94 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="StackTach.v3">
<meta name="author" content="Sandy Walsh">
<link rel="icon" href="../../favicon.ico">
<title>StackTach.v3</title>
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css">
<link href="stv3-narrow.css" rel="stylesheet">
<!-- Optional theme -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap-theme.min.css">
<!-- Latest compiled and minified JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/js/bootstrap.min.js"></script>
<style>
.bottom_padding {
padding-bottom: 20px;
}
</style>
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="header bottom_padding">
<nav>
<ul class="nav nav-pills pull-right">
<li role="presentation"><a href="index.html">Home</a></li>
<li role="presentation"><a href="about.html">Docs</a></li>
<li role="presentation" class="active"><a href="install.html">Getting Started</a></li>
<li role="presentation"><a href="#">API</a></li>
<li role="presentation"><a href="screencasts.html">Screencasts</a></li>
<li role="presentation"><a href="contribute.html">Contribute</a></li>
</ul>
</nav>
<img src="StackTach_160x70.png"/>
</div>
<div class="row marketing">
<div class="col-lg-12">
<h3>How StackTach.v3 is deployed at Rackspace</h3>
<p>For Rackspace Public Cloud, OpenStack is deployed in many different regions and each region is comprised of many cells.</p>
<img src='deploy_diagram.gif' class="img-rounded"/>
<p>In this deployment scenario, we have a set of "worker" boxes that run the <code>yagi-event</code> workers (to consume notifications from RabbitMQ). We run one yagi-event worker per OpenStack cell. We also run the Winchester pipeline-workers on this box. The pipeline-worker manages pipeline processing for ready streams. We run as many pipeline-workers as needed to keep each core busy. Both the yagi-event and pipeline-worker processes are single threaded so we spawn more to keep the host busy. We add more servers like these to handle the load in the pipeline processing and/or the source queues.</p>
<p>Additionally, we have servers for the API nodes and the MySQL database. Load balancing the API servers and making MySQL highly available is left to the deployer.</p>
<h3>The Ansible deployment scripts</h3>
<p>In the <a href='https://github.com/stackforge/stacktach-sandbox/tree/master/ansible'>StackTach Sandbox</a> repo, there is an ansible directory that contains roles for the workers, the API nodes and the database. There is a fourth "common" role that is used by the other roles.</p>
<p>These scripts assume a multi-cell deployment where there is one StackTach.v3 deployment per region (each with it's own API servers and database). If you are not running with cells, pretend it's a single cell.</p>
<h3>The Build script</h3>
<p>The <a href='https://github.com/stackforge/stacktach-sandbox'>StackTach Sandbox</a> repo is the umbrella repo for all the other StackTach modules. It:</p>
<ul>
<li>can create a local dev environment for anyone wanting to contribute to StackTach or just play around with it
<li>can package StackTach into a python virtual environment and tarball it up for larger scale deployment. The ansible scripts use this tarball approach.
<li>git clones all the dependent python modules so you can develop locally and see your changes immediately and easily.
</ul>
<p>The sandbox readme will get you started, but the gory details are in the <code>build.sh</code> script. There are essentially three options:</p>
<ul>
<li><code>./build.sh</code> - run the local StackTach.v3 dev environment in a screen session.
<li><code>./build.sh -t</code> - run the tests on all the StackTach.v3 repos.
<li><code>./build.sh -p</code> - install StackTach.v3 into the virtual env and package it up into a tarball for deployment.
<li><code>./build.sh -p -d</code> - package and deploy the tarball. Currently this just lists the ansible incantation required to do the deployment.
</ul>
<p>The <a href='screencasts.html'>screencasts</a> cover using the sandbox for local dev in more detail.</p>
<footer class="footer">
<p>&copy; Dark Secret Software Inc. 2014</p>
</footer>
</div> <!-- /container -->
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
<script src="../../assets/js/ie10-viewport-bug-workaround.js"></script>
</body>
</html>

103
docs/screencasts.html Normal file
View File

@ -0,0 +1,103 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="StackTach.v3">
<meta name="author" content="Sandy Walsh">
<link rel="icon" href="../../favicon.ico">
<title>StackTach.v3</title>
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css">
<link href="stv3-narrow.css" rel="stylesheet">
<!-- Optional theme -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap-theme.min.css">
<!-- Latest compiled and minified JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/js/bootstrap.min.js"></script>
<style>
.bottom_padding {
padding-bottom: 20px;
}
</style>
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="header bottom_padding">
<nav>
<ul class="nav nav-pills pull-right">
<li role="presentation"><a href="index.html">Home</a></li>
<li role="presentation"><a href="about.html">Docs</a></li>
<li role="presentation"><a href="install.html">Getting Started</a></li>
<li role="presentation"><a href="#">API</a></li>
<li role="presentation" class="active"><a href="screencasts.html">Screencasts</a></li>
<li role="presentation"><a href="contribute.html">Contribute</a></li>
</ul>
</nav>
<img src="StackTach_160x70.png"/>
</div>
<div class="row marketing">
<div class="col-lg-12">
<h3>The History of StackTach</h3>
<p>StackTach started as a tool for debugging OpenStack Nova deployments. Before we started on StackTach.v3 (a complete rewrite), we had plans to integrate with Ceilometer. This presentation from the Hong Kong summit gives a good overview of how StackTach has evolved over the years. It also gives great detail on the usage verification process as well as some of the key architectural concepts behind version 3.</p>
<iframe width="560" height="315" src="https://www.youtube.com/embed/c8zZtSL0t00" frameborder="0" allowfullscreen></iframe>
<h3>The StackTach.v3 Components</h3>
<p>An early screencast of the components of StackTach.v3 ... some things have changed since. Oahu has now been replaced with Winchester and all the repos have been moved to StackForge.</p>
<iframe width="560" height="315" src="https://www.youtube.com/embed/P8NA5FVrcEQ" frameborder="0" allowfullscreen></iframe>
<h3>The StackTach.v3 Sandbox</h3>
<p>An early screencast of the StackTach.v3 Sandbox. Shows how to launch the sandbox for local dev and how to navigate the various components. This video was done before packaging was added and before Winchester support was added. The Oahu config file is no longer required as we now use Winchester.</p>
<iframe width="560" height="315" src="https://www.youtube.com/embed/65BTMFuBQTY" frameborder="0" allowfullscreen></iframe>
<h3>The Notigen Event Simulator</h3>
<p>In order to play with StackTach.v3 you need a good source of notifications. To make this easier we don't want to require you stand up a full OpenStack environment. Instead, we use Notigen to simulate Nova-like notifications and publish these to RabbitMQ. This video explains how this works.</p>
<iframe width="560" height="315" src="https://www.youtube.com/embed/6cF0sTIeVd0" frameborder="0" allowfullscreen></iframe>
<h3>The REST API - Quincy and Quince</h3>
<p>How we separate the REST API from the implementation within StackTach.v3. If you decide you want to implement your own steam engine, but stay compatible with the StackTach.v3 API, these libraries make it easy to do so.</p>
<iframe width="560" height="315" src="https://www.youtube.com/embed/O8hjglIg57M" frameborder="0" allowfullscreen></iframe>
<h3>Klugman - client library/cmdline tool</h3>
<p>An early video of the Klugman cmdline tool and client library. A newer video is required to reflect the most recent changes, but this will get you started.<p>
<iframe width="560" height="315" src="https://www.youtube.com/embed/F-f4UEn2asA" frameborder="0" allowfullscreen></iframe>
<h3>Monasca and StackTach.v3 Integration</h4>
<p>Our joint-presentation with the Monasca team at the Paris OpenStack summit.</p>
<iframe width="560" height="315" src="https://www.youtube.com/embed/xHK5QylIdUs" frameborder="0" allowfullscreen></iframe>
<footer class="footer">
<p>&copy; Dark Secret Software Inc. 2014</p>
</footer>
</div> <!-- /container -->
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
<script src="../../assets/js/ie10-viewport-bug-workaround.js"></script>
</body>
</html>