Skip to content

wattsworth / puppet

Go to a project
Commit 70ba4632 by John Donnal
Options

auto doc rebuild

parent f42a8775
Inline Side-by-side
Showing with 306 additions and 7 deletions
modules/docs/files/docs/_sources/index.rst.txt
......@@ -6,6 +6,32 @@
The Wattsworth Project
======================
.. raw:: html
<div class="alert alert-info">
See <a href="/joule">Joule</a> for information on the modular data processing framework
<br/>
See <a href="/web">Web</a> for information on the frontend user interface
</div>
Active Plugins
--------------
The following plugins are active on this machine.
Click the name of a plugin to view the documentation.
.. raw:: html
<table class="table">
<thead>
<tr><th>Name</th><th>Description</th></tr>
</thead>
<tbody id="plugins-table">
</tbody>
</table>
.. raw:: html
Installing the Software
-----------------------
......@@ -25,9 +51,30 @@ Use the Puppet repository to install the complete Wattsworth stack
$> cd puppet
$> sudo puppet apply --modulepath=./modules --verbose site.pp
Here is info about Joule and the Web Frontend
Another edit
System Configuration
--------------------
Make sure you set up data journaling on the nilmdb partition. This will prevent
data corruption if the computer looses power without properly shutting down.
Edit ``/etc/fstab`` and add the ``data=journal`` option to the parition with the
nilmdb database.
.. code-block:: bash
# /etc/fstab: static file system information.
#
# <file system> <mount point> <type> <options> <dump> <pass>
UUID=XXX / ext4 errors=remount-ro,data=journal 0 1
# add this --^
If the partition is the root partition you must add this option directly to the volume
as well, otherwise the system will not boot properly. For example if your
root partition is on ``/dev/sda2``:
.. code-block:: bash
$> sudo tune2fs -o journal_data /dev/sda2
.. toctree::
:maxdepth: 2
......@@ -41,3 +88,36 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _web: /web
.. _joule: /joule
.. raw:: html
<script type="text/javascript">
//hide the plugins section by default (in case plugins.txt is missing)
$("#active-plugins").hide();
var plugins="";
var nonce=new Date().getTime(); //so we force the browser to get new data
$.ajax({url: `_static/plugins.txt?nonce=${nonce}`, success:
function(result){
plugins = result.split('\n')
.reduce(function(acc,line){
if(line==""||line[0]=="#")
return acc;
acc.push(line.split(',').map(function(x){return x.trim()}));
return acc;
},[])
if(plugins.length>0)
$("#active-plugins").show();
plugins.map(function(plugin){
var link = plugin[2];
var name=`<a href="/${link}">${plugin[0]}</a>`;
var desc = plugin[1];
$("#plugins-table").append(`<tr><td>${name}</td><td>${desc}</td></tr>`)
})
}});
</script>
modules/docs/files/docs/_static/css/custom.css 0 → 100644
.alert-info {
color: #31708f;
background-color: #d9edf7;
border-color: #bce8f1;
font-size: larger;
line-height: 2;
}
.alert {
padding: 5px;
margin-bottom: 20px;
border: 1px solid;
border-radius: 4px;
}
/* Bootstrap table styling */
table {
background-color: transparent;
}
caption {
padding-top: 8px;
padding-bottom: 8px;
color: #777777;
text-align: left;
}
th {
text-align: left;
}
.table {
width: 100%;
max-width: 100%;
margin-bottom: 20px;
}
.table>thead>tr>th, .table>tbody>tr>th, .table>tfoot>tr>th, .table>thead>tr>td, .table>tbody>tr>td, .table>tfoot>tr>td {
padding: 8px;
line-height: 1.42857143;
vertical-align: top;
border-top: 1px solid #ddd;
}
.table>thead>tr>th {
vertical-align: bottom;
border-bottom: 2px solid #ddd;
}
.table>caption+thead>tr:first-child>th, .table>colgroup+thead>tr:first-child>th, .table>thead:first-child>tr:first-child>th, .table>caption+thead>tr:first-child>td, .table>colgroup+thead>tr:first-child>td, .table>thead:first-child>tr:first-child>td {
border-top: 0;
}
.table>tbody+tbody {
border-top: 2px solid #ddd;
}
.table .table {
background-color: #fff;
}
.table-condensed>thead>tr>th, .table-condensed>tbody>tr>th, .table-condensed>tfoot>tr>th, .table-condensed>thead>tr>td, .table-condensed>tbody>tr>td, .table-condensed>tfoot>tr>td {
padding: 5px;
}
.table-bordered {
border: 1px solid #ddd;
}
.table-bordered>thead>tr>th, .table-bordered>tbody>tr>th, .table-bordered>tfoot>tr>th, .table-bordered>thead>tr>td, .table-bordered>tbody>tr>td, .table-bordered>tfoot>tr>td {
border: 1px solid #ddd;
}
.table-bordered>thead>tr>th, .table-bordered>thead>tr>td {
border-bottom-width: 2px;
}
.table-striped>tbody>tr:nth-of-type(odd) {
background-color: #f9f9f9;
}
.table-hover>tbody>tr:hover {
background-color: #f5f5f5;
}
table col[class*="col-"] {
position: static;
float: none;
display: table-column;
}
table td[class*="col-"], table th[class*="col-"] {
position: static;
float: none;
display: table-cell;
}
.table>thead>tr>td.active, .table>tbody>tr>td.active, .table>tfoot>tr>td.active, .table>thead>tr>th.active, .table>tbody>tr>th.active, .table>tfoot>tr>th.active, .table>thead>tr.active>td, .table>tbody>tr.active>td, .table>tfoot>tr.active>td, .table>thead>tr.active>th, .table>tbody>tr.active>th, .table>tfoot>tr.active>th {
background-color: #f5f5f5;
}
.table-hover>tbody>tr>td.active:hover, .table-hover>tbody>tr>th.active:hover, .table-hover>tbody>tr.active:hover>td, .table-hover>tbody>tr:hover>.active, .table-hover>tbody>tr.active:hover>th {
background-color: #e8e8e8;
}
.table>thead>tr>td.success, .table>tbody>tr>td.success, .table>tfoot>tr>td.success, .table>thead>tr>th.success, .table>tbody>tr>th.success, .table>tfoot>tr>th.success, .table>thead>tr.success>td, .table>tbody>tr.success>td, .table>tfoot>tr.success>td, .table>thead>tr.success>th, .table>tbody>tr.success>th, .table>tfoot>tr.success>th {
background-color: #dff0d8;
}
.table-hover>tbody>tr>td.success:hover, .table-hover>tbody>tr>th.success:hover, .table-hover>tbody>tr.success:hover>td, .table-hover>tbody>tr:hover>.success, .table-hover>tbody>tr.success:hover>th {
background-color: #d0e9c6;
}
.table>thead>tr>td.info, .table>tbody>tr>td.info, .table>tfoot>tr>td.info, .table>thead>tr>th.info, .table>tbody>tr>th.info, .table>tfoot>tr>th.info, .table>thead>tr.info>td, .table>tbody>tr.info>td, .table>tfoot>tr.info>td, .table>thead>tr.info>th, .table>tbody>tr.info>th, .table>tfoot>tr.info>th {
background-color: #d9edf7;
}
.table-hover>tbody>tr>td.info:hover, .table-hover>tbody>tr>th.info:hover, .table-hover>tbody>tr.info:hover>td, .table-hover>tbody>tr:hover>.info, .table-hover>tbody>tr.info:hover>th {
background-color: #c4e3f3;
}
.table>thead>tr>td.warning, .table>tbody>tr>td.warning, .table>tfoot>tr>td.warning, .table>thead>tr>th.warning, .table>tbody>tr>th.warning, .table>tfoot>tr>th.warning, .table>thead>tr.warning>td, .table>tbody>tr.warning>td, .table>tfoot>tr.warning>td, .table>thead>tr.warning>th, .table>tbody>tr.warning>th, .table>tfoot>tr.warning>th {
background-color: #fcf8e3;
}
.table-hover>tbody>tr>td.warning:hover, .table-hover>tbody>tr>th.warning:hover, .table-hover>tbody>tr.warning:hover>td, .table-hover>tbody>tr:hover>.warning, .table-hover>tbody>tr.warning:hover>th {
background-color: #faf2cc;
}
.table>thead>tr>td.danger, .table>tbody>tr>td.danger, .table>tfoot>tr>td.danger, .table>thead>tr>th.danger, .table>tbody>tr>th.danger, .table>tfoot>tr>th.danger, .table>thead>tr.danger>td, .table>tbody>tr.danger>td, .table>tfoot>tr.danger>td, .table>thead>tr.danger>th, .table>tbody>tr.danger>th, .table>tfoot>tr.danger>th {
background-color: #f2dede;
}
.table-hover>tbody>tr>td.danger:hover, .table-hover>tbody>tr>th.danger:hover, .table-hover>tbody>tr.danger:hover>td, .table-hover>tbody>tr:hover>.danger, .table-hover>tbody>tr.danger:hover>th {
background-color: #ebcccc;
}
.table-responsive {
overflow-x: auto;
min-height: 0.01%;
}
modules/docs/files/docs/_static/nplugins.txt 0 → 100644
# append plugins to the list below, separate entries with commas
# name, description, documentation_folder
LabJack, Acquire data from UE9 devices, labjack
NILM, Non-Intrusive Load Monitoring, nilm
SmartEE, Connect to Smart Plugs, smartee
modules/docs/files/docs/_static/plugins.txt 0 → 100644
# append plugins to the list below, separate entries with commas
# name, description, documentation_folder
#LabJack, Acquire data from UE9 devices, labjack
#NILM, Non-Intrusive Load Monitoring, nilm
#SmartEE, Connect to Smart Plugs, smartee
modules/docs/files/docs/genindex.html
......@@ -11,6 +11,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
......
modules/docs/files/docs/index.html
......@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
......@@ -43,6 +44,21 @@
<div class="section" id="the-wattsworth-project">
<h1>The Wattsworth Project<a class="headerlink" href="#the-wattsworth-project" title="Permalink to this headline"></a></h1>
<div class="alert alert-info">
See <a href="/joule">Joule</a> for information on the modular data processing framework
<br/>
See <a href="/web">Web</a> for information on the frontend user interface
</div><div class="section" id="active-plugins">
<h2>Active Plugins<a class="headerlink" href="#active-plugins" title="Permalink to this headline"></a></h2>
<p>The following plugins are active on this machine.
Click the name of a plugin to view the documentation.</p>
<table class="table">
<thead>
<tr><th>Name</th><th>Description</th></tr>
</thead>
<tbody id="plugins-table">
</tbody>
</table></div>
<div class="section" id="installing-the-software">
<h2>Installing the Software<a class="headerlink" href="#installing-the-software" title="Permalink to this headline"></a></h2>
<p>All of the software repositories are available at
......@@ -58,8 +74,26 @@ $&gt; <span class="nb">cd</span> puppet
$&gt; sudo puppet apply --modulepath<span class="o">=</span>./modules --verbose site.pp
</pre></div>
</div>
<p>Here is info about Joule and the Web Frontend
Another edit</p>
</div>
<div class="section" id="system-configuration">
<h2>System Configuration<a class="headerlink" href="#system-configuration" title="Permalink to this headline"></a></h2>
<p>Make sure you set up data journaling on the nilmdb partition. This will prevent
data corruption if the computer looses power without properly shutting down.</p>
<p>Edit <code class="docutils literal"><span class="pre">/etc/fstab</span></code> and add the <code class="docutils literal"><span class="pre">data=journal</span></code> option to the parition with the
nilmdb database.</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># /etc/fstab: static file system information.</span>
<span class="c1">#</span>
<span class="c1"># &lt;file system&gt; &lt;mount point&gt; &lt;type&gt; &lt;options&gt; &lt;dump&gt; &lt;pass&gt;</span>
<span class="nv">UUID</span><span class="o">=</span>XXX / ext4 <span class="nv">errors</span><span class="o">=</span>remount-ro,data<span class="o">=</span>journal <span class="m">0</span> <span class="m">1</span>
<span class="c1"># add this --^</span>
</pre></div>
</div>
<p>If the partition is the root partition you must add this option directly to the volume
as well, otherwise the system will not boot properly. For example if your
root partition is on <code class="docutils literal"><span class="pre">/dev/sda2</span></code>:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$&gt; sudo tune2fs -o journal_data /dev/sda2
</pre></div>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
......@@ -71,7 +105,33 @@ Another edit</p>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
<script type="text/javascript">
//hide the plugins section by default (in case plugins.txt is missing)
$("#active-plugins").hide();
var plugins="";
var nonce=new Date().getTime(); //so we force the browser to get new data
$.ajax({url: `_static/plugins.txt?nonce=${nonce}`, success:
function(result){
plugins = result.split('\n')
.reduce(function(acc,line){
if(line==""||line[0]=="#")
return acc;
acc.push(line.split(',').map(function(x){return x.trim()}));
return acc;
},[])
if(plugins.length>0)
$("#active-plugins").show();
plugins.map(function(plugin){
var link = plugin[2];
var name=`<a href="/${link}">${plugin[0]}</a>`;
var desc = plugin[1];
$("#plugins-table").append(`<tr><td>${name}</td><td>${desc}</td></tr>`)
})
}});
</script></div>
</div>
......@@ -82,7 +142,9 @@ Another edit</p>
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The Wattsworth Project</a><ul>
<li><a class="reference internal" href="#active-plugins">Active Plugins</a></li>
<li><a class="reference internal" href="#installing-the-software">Installing the Software</a></li>
<li><a class="reference internal" href="#system-configuration">System Configuration</a></li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
......
modules/docs/files/docs/search.html
......@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
......
modules/docs/files/docs/searchindex.js
Search.setIndex({docnames:["index"],envversion:52,filenames:["index.rst"],objects:{},objnames:{},objtypes:{},terms:{"while":0,Use:0,about:0,all:0,anoth:0,appli:0,apt:0,arm:0,avail:0,base:0,bash:[],been:0,best:0,bit:0,block:[],board:0,clone:0,code:[],complet:0,comput:0,edit:0,frontend:0,get:0,git:0,has:0,here:0,http:0,index:0,info:0,intel:0,joul:0,linux:0,modul:0,modulepath:0,modules_path:[],net:0,nuc:0,page:0,possibl:0,puppet:0,raspberri:0,repositori:0,run:0,search:0,singl:0,site:0,stack:0,sudo:0,system:0,test:0,ubuntu:0,updat:0,verbos:0,web:0,work:0,x86:0},titles:["The Wattsworth Project"],titleterms:{The:0,document:[],indic:0,instal:0,project:0,softwar:0,tabl:0,wattsworth:0,welcom:[]}})
\ No newline at end of file
Search.setIndex({docnames:["index"],envversion:52,filenames:["index.rst"],objects:{},objnames:{},objtypes:{},terms:{"static":0,"while":0,For:0,Use:0,add:0,all:0,appli:0,apt:0,arm:0,avail:0,base:0,been:0,best:0,bit:0,board:0,boot:0,click:0,clone:0,complet:0,comput:0,corrupt:0,data:0,databas:0,dev:0,directli:0,document:0,down:0,dump:0,edit:0,error:0,etc:0,exampl:0,ext4:0,file:0,follow:0,framework:0,frontend:0,fstab:0,get:0,git:0,has:0,http:0,index:0,inform:0,intel:0,interfac:0,joul:0,journal:0,journal_data:0,linux:0,loos:0,machin:0,make:0,modul:0,modular:0,modulepath:0,mount:0,must:0,name:0,namedescript:0,net:0,nilmdb:0,nuc:0,option:0,otherwis:0,page:0,parit:0,partit:0,pass:0,point:0,possibl:0,power:0,prevent:0,process:0,properli:0,puppet:0,raspberri:0,remount:0,repositori:0,root:0,run:0,sda2:0,search:0,see:0,set:0,shut:0,singl:0,site:0,stack:0,sudo:0,sure:0,test:0,thi:0,tune2f:0,type:0,ubuntu:0,updat:0,user:0,uuid:0,verbos:0,view:0,volum:0,web:0,well:0,without:0,work:0,x86:0,xxx:0,you:0,your:0},titles:["The Wattsworth Project"],titleterms:{The:0,activ:0,configur:0,indic:0,instal:0,plugin:0,project:0,softwar:0,system:0,tabl:0,wattsworth:0}})
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment