recordsansible/ara
Code Issues Proposed changes

First commit

Browse Source
This commit is contained in:
David Moreau-Simard 2016-05-08 00:15:06 -04:00
parent ad09488bc2
commit 1eb171a732
30 changed files with 1695 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.gitignore vendored Normal file
View File

@ -0,0 +1,12 @@
**ansible.sqlite
*.pyc
__pycache__/
_build/
build/
*.egg
*.eggs
*.egg-info
dist
build
eggs
.tox/

202
LICENSE Normal file
View File

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

2
README.md
View File

@ -1,2 +0,0 @@
# ara
ara - Ansible Run Analysis

65
README.rst Normal file
View File

@ -0,0 +1,65 @@
ARA: Ansible Run Analysis
=========================
Important note
--------------
ARA is in very early development !
The documentation is definitely not thorough.
Please feel free to ask questions, provide feedback, comments, bugs, ideas,
suggestions or contributions !
tl;dr
-----
ARA_ is an attempt to make Ansible_ runs easier to visualize, understand and
troubleshoot.
It provides an Ansible callback to record playbook run data in a database and
a web interface built with Flask_ to browse that data.
.. _ARA: https://github.com/dmsimard/ara
.. _Ansible: https://www.ansible.com/
.. _Flask: http://flask.pocoo.org/
What it looks like
------------------
.. image:: docs/images/preview.png
Documentation
-------------
There is (limited) documentation available on `readthedocs.io`_.
.. _readthedocs.io: http://ara.readthedocs.io/en/latest/
Installing and Using ARA
------------------------
See the documentation_.
.. _documentation: http://ara.readthedocs.io/en/latest/installing.html
Author
======
David Moreau Simard
Contributors and special thanks
===============================
See contributors on GitHub_.
Special thanks to those who provided early feedback on the project.
.. _GitHub: https://github.com/dmsimard/ara/graphs/contributors
Copyright
=========
Copyright 2016 Red Hat, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

31
ara/__init__.py Normal file
View File

@ -0,0 +1,31 @@
# Copyright 2016 Red Hat, Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import os
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
DATABASE = os.path.expanduser('~/.ara/ansible.sqlite')
# TODO (dmsimard): Figure out the best place and way to initialize the
# database if it hasn't been created yet.
if not os.path.exists(os.path.dirname(DATABASE)):
os.makedirs(os.path.dirname(DATABASE))
app = Flask(__name__)
app.config['DATABASE'] = DATABASE
app.config['SQLALCHEMY_DATABASE_URI'] = "sqlite:///{0}".format(DATABASE)
db = SQLAlchemy(app)
from ara import views, models

131
ara/callback/ara.py Normal file
View File

@ -0,0 +1,131 @@
# 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 __future__ import (absolute_import, division, print_function)
import os
import datetime
import uuid
from ara import app, db, models
from ansible.plugins.callback import CallbackBase
try:
import simplejson as json
except ImportError:
import json
__metaclass__ = type
class CallbackModule(CallbackBase):
"""
Saves data from an Ansible run into an sqlite database
"""
CALLBACK_VERSION = 2.0
CALLBACK_TYPE = 'notification'
CALLBACK_NAME = 'ara'
DATABASE = app.config['DATABASE']
def __init__(self):
super(CallbackModule, self).__init__()
# TODO (dmsimard): Figure out the best place and way to initialize the
# database if it hasn't been created yet.
if not os.path.exists(os.path.dirname(self.DATABASE)):
os.makedirs(os.path.dirname(self.DATABASE))
db.create_all()
self.task = None
self.play = None
self.playbook = None
self.playbook_uuid = None
self.playbook_start = None
self.playbook_end = None
self.stats = None
self.task_start = None
def log_task(self, result):
duration = (result.task_end - result.task_start).total_seconds()
data = models.Tasks(**{
'playbook_uuid': self.playbook_uuid,
'host': result._host.name,
'play': self.play.name,
'task': self.task.name,
'start': str(result.task_start),
'end': str(result.task_end),
'duration': duration,
'result': json.dumps(result._result),
'changed': result._result['changed'],
'skipped': result._result['skipped'],
'failed': result._result['failed']
})
db.session.add(data)
def log_stats(self, stats):
hosts = sorted(stats.processed.keys())
for host in hosts:
host_stats = stats.summarize(host)
data = models.Stats(**{
'playbook_uuid': self.playbook_uuid,
'host': host,
'changed': host_stats['changed'],
'failures': host_stats['failures'],
'ok': host_stats['ok'],
'skipped': host_stats['skipped']
})
db.session.add(data)
def log_playbook(self):
duration = (self.playbook_end - self.playbook_start).total_seconds()
data = models.Playbooks(**{
'id': self.playbook_uuid,
'playbook': os.path.basename(self.playbook._file_name),
'start': str(self.playbook_start),
'end': str(self.playbook_end),
'duration': duration
})
db.session.add(data)
def v2_runner_on_ok(self, result, **kwargs):
self.task = result._task
result.task_start = self.task_start
result.task_end = datetime.datetime.now()
status_keys = ['changed', 'failed', 'skipped']
for status in status_keys:
if status not in result._result:
result._result[status] = False
self.log_task(result)
v2_runner_on_unreachable = v2_runner_on_ok
v2_runner_on_failed = v2_runner_on_ok
v2_runner_on_skipped = v2_runner_on_ok
def v2_playbook_on_task_start(self, task, is_conditional):
self.task_start = datetime.datetime.now()
def v2_playbook_on_start(self, playbook):
self.playbook = playbook
self.playbook_uuid = str(uuid.uuid4())
self.playbook_start = datetime.datetime.now()
def v2_playbook_on_play_start(self, play):
self.play = play
def v2_playbook_on_stats(self, stats):
self.playbook_end = datetime.datetime.now()
self.log_stats(stats)
self.log_playbook()
db.session.commit()

59
ara/models.py Normal file
View File

@ -0,0 +1,59 @@
# Copyright 2016 Red Hat, Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from ara import db
class Playbooks(db.Model):
id = db.Column('id', db.String, primary_key=True, nullable=False)
playbook = db.Column('playbook', db.String)
start = db.Column('start', db.String)
end = db.Column('end', db.String)
duration = db.Column('duration', db.String)
def __repr__(self):
return '<Playbook %r>' % self.playbook
class Tasks(db.Model):
id = db.Column('id', db.Integer, primary_key=True, nullable=False,
autoincrement=True)
playbook_uuid = db.Column('playbook_uuid', db.String)
host = db.Column('host', db.String)
play = db.Column('play', db.String)
task = db.Column('task', db.String)
start = db.Column('start', db.String)
end = db.Column('end', db.String)
duration = db.Column('duration', db.String)
result = db.Column('result', db.Text)
changed = db.Column('changed', db.Integer)
skipped = db.Column('skipped', db.Integer)
failed = db.Column('failed', db.Integer)
def __repr__(self):
return '<Task %r>' % self.task
class Stats(db.Model):
id = db.Column('id', db.Integer, primary_key=True, nullable=False,
autoincrement=True)
playbook_uuid = db.Column('playbook_uuid', db.String)
host = db.Column('host', db.String)
changed = db.Column('changed', db.Integer)
failures = db.Column('failures', db.Integer)
ok = db.Column('ok', db.Integer)
skipped = db.Column('skipped', db.Integer)
def __repr__(self):
return '<Stats %r>' % self.host

21
ara/run.py Normal file
View File

@ -0,0 +1,21 @@
# Copyright 2016 Red Hat, Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from ara import app, db
# TODO (dmsimard): Figure out the best place and way to initialize the
# database if it hasn't been created yet.
db.create_all()
app.run()

6
ara/static/css/bootstrap-theme.min.css vendored Normal file
View File

File diff suppressed because one or more lines are too long

6
ara/static/css/bootstrap.min.css vendored Normal file
View File

File diff suppressed because one or more lines are too long

7
ara/static/js/bootstrap.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

21
ara/templates/home.html Normal file
View File

@ -0,0 +1,21 @@
{% extends "layout.html" %}
{% block content %}
<div class="row">
<div class="col-md-12">
ARA is meant to make it easy to browse Ansible playbook runs.
<br>
How to use:
<ul>
<li>Browse hosts, tasks, plays and playbooks with the top menu</li>
<li>When browsing details:</li>
<ul>
<li>Click on timestamps to generate a link to this specific event</li>
<li>Click on a host in the table to go to this host's events</li>
<li>Click on a task in the table to see all events for this task</li>
<li>Click on a play in the table to see all events for this play</li>
<li>Click on a playbook in the table to see all events for this playbook</li>
</ul>
</ul>
</div>
</div>
{% endblock %}

47
ara/templates/host.html Normal file
View File

@ -0,0 +1,47 @@
{% extends "layout.html" %}
{% block content %}
<div class="row text-center">
<div class="col-md-12">
<h2>Playbook run for host: <span style="font-style: italic;">"{{ host }}"</span></h2>
</div>
</div>
<div class="row">
<div class="col-md-12 table-responsive">
<table class="table table-striped table-hover table-condensed table-bordered" style="margin: 0 auto !important; float;">
<thead>
<tr>
<th>Timestamp</th>
<th class="text-center">Status</th>
<th>Host</th>
<th>Playbook</th>
</tr>
</thead>
<tbody>
{% for row in data %}
<tr class="task">
<td id="{{ row.end |datetime }}" style="white-space: nowrap;">
<a href="#{{ row.end |datetime }}">{{ row.end |datetime }}</a>
</td>
<td class="text-center">
<label class="label {{ row |pick_status }}">{{ row |pick_status }}</label><br>
{{ row.duration |truncate(5) }}s
</td>
<td><a href="/host/{{ row.host }}">{{ row.host }}</a></td>
<td style="white-space: nowrap;">
<ul>
<li><a href="/play/{{ row.play }}">{{ row.play }}</a></li>
<ul>
<li><a href="/task/{{ row.task }}">{{ row.task }}</a></li>
</ul>
</ul>
</td>
</tr>
<tr class="results" style="display: none;">
<td colspan="4">{{ row.result |to_nice_json }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
</div>
{% endblock %}

124
ara/templates/layout.html Normal file
View File

@ -0,0 +1,124 @@
<!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">
<title>ARA - Ansible run analysis</title>
<link href="{{ url_for('static', filename='css/bootstrap.min.css') }}" rel="stylesheet">
<link href="{{ url_for('static', filename='css/bootstrap-theme.min.css') }}" rel="stylesheet">
<style>
.failed {
background-color: #a30000;
}
.skipped {
background-color: #047a7b;
}
.ok {
background-color: #3e7b04;
}
.changed {
background-color: #9d8000;
}
.unreachable {
background-color: #9d8000;
}
tr.results {
white-space: pre-wrap;
overflow-wrap: break-word;
word-wrap: break-word;
word-break: break-word;
}
</style>
</head>
<body>
<div class="container" style="border-bottom:1px dashed black;">
<nav class="navbar navbar-inverse">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">ARA - Ansible Run Analysis</a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
{% if hosts %}
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Hosts <span class="caret"></span></a>
<ul class="dropdown-menu">
{% for host in hosts %}
<li><a href="/host/{{ host }}">{{ host }}</a></li>
{% endfor %}
</ul>
</li>
{% endif %}
{% if tasks %}
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Tasks <span class="caret"></span></a>
<ul class="dropdown-menu">
{% for task in tasks %}
<li><a href="/task/{{ task }}">{{ task }}</a></li>
{% endfor %}
</ul>
</li>
{% endif %}
{% if plays %}
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Plays <span class="caret"></span></a>
<ul class="dropdown-menu">
{% for play in plays %}
<li><a href="/play/{{ play }}">{{ play }}</a></li>
{% endfor %}
</ul>
</li>
{% endif %}
{% if playbooks %}
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Playbooks <span class="caret"></span></a>
<ul class="dropdown-menu">
{% for playbook in playbooks %}
<li><a href="/playbook/{{ playbook }}">{{ playbook }}</a></li>
{% endfor %}
</ul>
</li>
{% endif %}
</ul>
</div>
</div>
</nav>
{% block content %}
{% endblock %}
<br>
</div>
<br>
<div class="container text-center">
ARA - Ansible run analysis is an open source project available on <a href="http://github.com/dmsimard/ara">Github</a>.
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.2/jquery.min.js"></script>
<script src="{{ url_for('static', filename='js/bootstrap.min.js') }}"></script>
<script>
$(document).ready(function(){
$(".task").click(function(){
ele = $(this).closest('tr').next('tr');
if (ele.css('display') == 'none')
ele.css('display', 'table-row');
else
ele.css('display', 'none');
});
$(".result").click(function(){
$(this).css('display', 'none');
});
});
</script>
</body>
</html>

47
ara/templates/play.html Normal file
View File

@ -0,0 +1,47 @@
{% extends "layout.html" %}
{% block content %}
<div class="row text-center">
<div class="col-md-12">
<h2>Playbook run for play: <span style="font-style: italic;">"{{ play }}"</span></h2>
</div>
</div>
<div class="row">
<div class="col-md-12 table-responsive">
<table class="table table-striped table-hover table-condensed table-bordered" style="margin: 0 auto !important; float;">
<thead>
<tr>
<th>Timestamp</th>
<th class="text-center">Status</th>
<th>Host</th>
<th>Playbook</th>
</tr>
</thead>
<tbody>
{% for row in data %}
<tr class="task">
<td id="{{ row.end |datetime }}" style="white-space: nowrap;">
<a href="#{{ row.end |datetime }}">{{ row.end |datetime }}</a>
</td>
<td class="text-center">
<label class="label {{ row |pick_status }}">{{ row |pick_status }}</label><br>
{{ row.duration |truncate(5) }}s
</td>
<td><a href="/host/{{ row.host }}">{{ row.host }}</a></td>
<td style="white-space: nowrap;">
<ul>
<li><a href="/play/{{ row.play }}">{{ row.play }}</a></li>
<ul>
<li><a href="/task/{{ row.task }}">{{ row.task }}</a></li>
</ul>
</ul>
</td>
</tr>
<tr class="results" style="display: none;">
<td colspan="4">{{ row.result |to_nice_json }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
</div>
{% endblock %}

81
ara/templates/playbook.html Normal file
View File

@ -0,0 +1,81 @@
{% extends "layout.html" %}
{% block content %}
<div class="row text-center">
<div class="col-md-12">
<h2>Playbook run for playbook: <span style="font-style: italic;">"{{ playbook }}"</span></h2>
</div>
</div>
<br>
<div class="row" style="display: flex; align-items: center;">
<div class="col-md-1 text-center">
<h2>Stats</h2>
</div>
<div class="col-md-11">
<table class="table table-striped table-hover table-condensed table-bordered" style="margin: 0 auto !important; float;">
<thead>
<tr>
<th class="text-center">Host</th>
<th class="text-center ok">Ok</th>
<th class="text-center changed">Changed</th>
<th class="text-center skipped">Skipped</th>
<th class="text-center failed">Failed</th>
</tr>
</thead>
<tbody>
{% for row in stats_data %}
<tr>
<td class="text-center">{{ row.host }}</td>
<td class="text-center">{{ row.ok }}</td>
<td class="text-center">{{ row.changed }}</td>
<td class="text-center">{{ row.skipped }}</td>
<td class="text-center">{{ row.failures }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
</div>
<div class="row text-center">
<div class="col-md-12">
<h2>Run information</h2>
<small class="text-center" style="font-style: italic">Click on a row to expand verbose output</small>
</div>
</div>
<div class="row">
<table class="table table-striped table-hover table-condensed table-bordered" style="margin: 0 auto !important; float;">
<thead>
<tr>
<th>Timestamp</th>
<th class="text-center">Status</th>
<th>Host</th>
<th>Playbook</th>
</tr>
</thead>
<tbody>
{% for row in task_data %}
<tr class="task">
<td id="{{ row.end |datetime }}" style="white-space: nowrap;">
<a href="#{{ row.end |datetime }}">{{ row.end |datetime }}</a>
</td>
<td class="text-center">
<label class="label {{ row |pick_status }}">{{ row |pick_status }}</label><br>
{{ row.duration |truncate(5) }}s
</td>
<td><a href="/host/{{ row.host }}">{{ row.host }}</a></td>
<td style="white-space: nowrap;">
<ul>
<li><a href="/play/{{ row.play }}">{{ row.play }}</a></li>
<ul>
<li><a href="/task/{{ row.task }}">{{ row.task }}</a></li>
</ul>
</ul>
</td>
</tr>
<tr class="results" style="display: none;">
<td colspan="4">{{ row.result |to_nice_json }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
{% endblock %}

47
ara/templates/task.html Normal file
View File

@ -0,0 +1,47 @@
{% extends "layout.html" %}
{% block content %}
<div class="row text-center">
<div class="col-md-12">
<h2>Playbook run for task: <span style="font-style: italic;">"{{ task }}"</span></h2>
</div>
</div>
<div class="row">
<div class="col-md-12 table-responsive">
<table class="table table-striped table-hover table-condensed table-bordered" style="margin: 0 auto !important; float;">
<thead>
<tr>
<th>Timestamp</th>
<th class="text-center">Status</th>
<th>Host</th>
<th>Playbook</th>
</tr>
</thead>
<tbody>
{% for row in data %}
<tr class="task">
<td id="{{ row.end |datetime }}" style="white-space: nowrap;">
<a href="#{{ row.end |datetime }}">{{ row.end |datetime }}</a>
</td>
<td class="text-center">
<label class="label {{ row |pick_status }}">{{ row |pick_status }}</label><br>
{{ row.duration |truncate(5) }}s
</td>
<td><a href="/host/{{ row.host }}">{{ row.host }}</a></td>
<td style="white-space: nowrap;">
<ul>
<li><a href="/play/{{ row.play }}">{{ row.play }}</a></li>
<ul>
<li><a href="/task/{{ row.task }}">{{ row.task }}</a></li>
</ul>
</ul>
</td>
</tr>
<tr class="results" style="display: none;">
<td colspan="4">{{ row.result |to_nice_json }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
</div>
{% endblock %}

77
ara/utils.py Normal file
View File

@ -0,0 +1,77 @@
# Copyright 2016 Red Hat, Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import datetime
import json
from ara import app, models
# Jinja filters
@app.template_filter('datetime')
def jinja_date_formatter(timestamp, format='%Y-%m-%d-%H:%M:%S.%f'):
""" Reformats a datetime timestamp from str(datetime.datetime)"""
datetime_format = "%Y-%m-%d %H:%M:%S.%f"
timestamp = datetime.datetime.strptime(timestamp, datetime_format)
return timestamp.strftime(format)[:-3]
@app.template_filter('truncate')
def jinja_truncate_string(string, length=40):
""" Truncates a string to max length """
return string[:length]
@app.template_filter('to_nice_json')
def jinja_to_nice_json(result):
""" Formats a result """
result = json.loads(result)
return json.dumps(result, indent=4, sort_keys=True)
@app.template_filter('pick_status')
def jinja_pick_status(row):
""" Returns the status of a row """
if row.changed:
return 'changed'
if row.skipped:
return 'skipped'
if row.failed:
return 'failed'
return 'ok'
def default_data():
data = {
'hosts': [],
'tasks': [],
'plays': [],
'playbooks': []
}
task_data = models.Tasks.query.all()
for row in task_data:
if row.host not in data['hosts']:
data['hosts'].append(row.host)
if row.task not in data['tasks']:
data['tasks'].append(row.task)
if row.play not in data['plays']:
data['plays'].append(row.play)
playbook_data = models.Playbooks.query.all()
for row in playbook_data:
if row.playbook not in data['playbooks']:
data['playbooks'].append(row.playbook)
return data

63
ara/views.py Normal file
View File

@ -0,0 +1,63 @@
# Copyright 2016 Red Hat, Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from flask import render_template
from ara import app, models, utils
# Routes
@app.route('/')
def main():
""" Returns the home page """
default_data = utils.default_data()
return render_template('home.html', **default_data)
@app.route('/host/<host>')
def host(host):
default_data = utils.default_data()
data = models.Tasks.query.filter_by(host=host)
return render_template('host.html', host=host, data=data, **default_data)
@app.route('/task/<task>')
def task(task):
default_data = utils.default_data()
data = models.Tasks.query.filter_by(task=task)
return render_template('task.html', task=task, data=data, **default_data)
@app.route('/play/<play>')
def play(play):
default_data = utils.default_data()
data = models.Tasks.query.filter_by(play=play)
return render_template('play.html', play=play, data=data, **default_data)
@app.route('/playbook/<playbook>')
def playbook(playbook):
default_data = utils.default_data()
playbook_data = models.Playbooks.query.filter_by(playbook=playbook).first()
playbook_uuid = playbook_data.id
task_data = models.Tasks.query.filter_by(playbook_uuid=playbook_uuid)
stats_data = models.Stats.query.filter_by(playbook_uuid=playbook_uuid)
return render_template('playbook.html', playbook=playbook,
playbook_data=playbook_data, task_data=task_data,
stats_data=stats_data, **default_data)

192
docs/Makefile Normal file
View File

@ -0,0 +1,192 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/rpm-versiontracker.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/rpm-versiontracker.qhc"
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/rpm-versiontracker"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/rpm-versiontracker"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

287
docs/conf.py Normal file
View File

@ -0,0 +1,287 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# ara documentation build configuration file
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
import shlex
import sphinx_rtd_theme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'ara'
copyright = '2016, Red Hat Inc'
author = 'David Moreau Simard'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
#html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'ara'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
# Latex figure (float) alignment
#'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'ara.tex', 'ARA Documentation',
'David Moreau Simard', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'ara', 'ARA Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'ara', 'ARA Documentation',
author, 'ARA', 'ARA - Ansible Run Analysis',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

BIN
docs/images/preview.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 88 KiB

18
docs/index.rst Normal file
View File

@ -0,0 +1,18 @@
Welcome to the ARA documentation!
=================================
Important note
--------------
ARA is in very early development !
The documentation is definitely not thorough.
Please feel free to ask questions, provide feedback, comments, bugs, ideas,
suggestions or contributions !
Table of Contents
=================
.. toctree::
:maxdepth: 2
What is ARA: tl;dr <tldr>
Installing and using ARA <installing>

50
docs/installing.rst Normal file
View File

@ -0,0 +1,50 @@
Installing and using ARA
========================
Clone the source and install it
-------------------------------
::
git clone https://github.com/dmsimard/ara
cd ara
pip install .
*ARA is on `PyPi`_ but is not currently kept up-to-date with the fast paced early development.*
.. _PyPi: https://pypi.python.org/pypi/ara
Set up the callback
-------------------
To use ARA, you'll first need to set up Ansible to use the ARA callback_.
The callback is provided when installing ARA but you need to let Ansible know
where to look for.
Set up your `ansible.cfg`_ file to seek that callback in the appropriate
directory, for example::
[defaults]
callback_plugins = /usr/lib/python2.7/site-packages/ara/callback:$VIRTUAL_ENV/lib/python2.7/site-packages/ara/callback
.. _callback: https://github.com/dmsimard/ara/blob/master/callback.py
.. _ansible.cfg: http://docs.ansible.com/ansible/intro_configuration.html#configuration-file
*That's it!*
The next time you run Ansible, ARA will generate a sqlite database at the
default path in ``~/.ara/ansible.sqlite``.
This is the database that the web application will use.
To modify the path at which the database is stored and read, modify the
configuration in ``site-packages/ara/__init__.py``.
**Note**: *The configuration of the database path will be made less awkward eventually.*
Set up the web application
--------------------------
Set this up like `any other Flask application`_, it's nothing special (yet).
To run the development webserver, you can run::
python ara/run.py
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
.. _any other Flask application: http://flask.pocoo.org/docs/0.10/deploying/uwsgi/

15
docs/tldr.rst Normal file
View File

@ -0,0 +1,15 @@
tl;dr
=====
ARA_ is an attempt to make Ansible_ runs easier to visualize, understand and
troubleshoot.
It provides an Ansible callback to record playbook run data in a database and
a web interface built with Flask_ to browse that data.
.. _ARA: https://github.com/dmsimard/ara
.. _Ansible: https://www.ansible.com/
.. _Flask: http://flask.pocoo.org/
What it looks like
------------------
.. image:: images/preview.png

3
requirements.txt Normal file
View File

@ -0,0 +1,3 @@
Flask
Flask-SQLAlchemy
pbr>=1.6

39
setup.cfg Normal file
View File

@ -0,0 +1,39 @@
[metadata]
name = ara
summary = ARA - Ansible run analysis
description-file =
README.rst
author = David Moreau Simard
author-email = dms@redhat.com
home-page = https://github.com/dmsimard/ara
classifier =
License :: OSI Approved :: Apache Software License
Development Status :: 3 - Alpha
Intended Audience :: Developers
Intended Audience :: System Administrators
Intended Audience :: Information Technology
Programming Language :: Python :: 2.7
Topic :: Utilities
[global]
setup-hooks =
pbr.hooks.setup_hook
[files]
packages =
ara
[build_sphinx]
source-dir = docs
build-dir = docs/build
all_files = 1
[upload_sphinx]
upload-dir = docs/html
[wheel]
universal = 1
[pbr]
skip_authors = True
skip_changelog = True

19
setup.py Normal file
View File

@ -0,0 +1,19 @@
# Copyright 2016 Red Hat, Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import setuptools
setuptools.setup(
setup_requires=['pbr'],
pbr=True)

3
test-requirements.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx
sphinx-rtd-theme
flake8

22
tox.ini Normal file
View File

@ -0,0 +1,22 @@
[tox]
minversion = 1.6
envlist = py27,pep8
skipdist = True
[testenv]
sitepackages=True
usedevelop = True
install_command = pip install -U {opts} {packages}
setenv = VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/test-requirements.txt
[testenv:docs]
commands = python setup.py build_sphinx
[testenv:pep8]
commands = flake8 ara
[flake8]
ignore = E402,F401
show-source = True
exclude = .venv,.tox,docs,*egg,*settings.py