x/python-don
Code Issues Proposed changes

Adding README file

Browse Source 
Change-Id: I46199cc05bacc4b6143d946350d86c73c852b18a
This commit is contained in:
Ramaraja 2016-08-01 11:06:25 +00:00
parent 508920a121
commit 7231d4be65
3 changed files with 65 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md Normal file
View File

@ -0,0 +1,63 @@
# DON: Diagnosing OpenStack Networking
> [Presented in the OpenStack Liberty Summit, Vancouver, May, 2015]
(https://www.openstack.org/summit/vancouver-2015/summit-videos/presentation/don-diagnosing-ovs-in-neutron "DON Presentation at OpenStack Liberty Summit, Vancouver, May 2015").
A lot has changed since Vancouver! _Support for multi-node OpenStack
installations and complete integrated with Horizon, Liberty release are among
the things to look forward to._
Neutron provides Networking-as-a-service in the OpenStack ecosystem. Networking
functionalities are provided by plugins that implement well-defined Neutron
APIs. Among many, the Open vSwitch plugin (OVS) is possibly the most widely
used. Any practical OpenStack installation has complicated networking
configuration and verifying it manually is time consuming and error prone.
DON, written primarily in Python, and **available as a dashboard in OpenStack
Horizon, Libery release**, is a network analysis and diagnostic system and provides a
completely automated service for verifying and diagnosing the
networking functionality provided by OVS. This service verifies (or points out
deviations) that the user configuration is indeed reflected in the underlying
infrastructure and presents the results in an intuitive graphical display.
As an example, given the following Neutron network topology:
![Neutron: Network Topology](/openstack_dashboard/don/ovs/static/net_topology.png "Neutron: Network Topology")
DON generates the following view of the networking internals,
![DON: Internal View](/openstack_dashboard/don/ovs/static/don_internal.png "DON: Internal View")
does OVS tests and ping tests,
![DON: Analysis](/openstack_dashboard/don/ovs/static/don_analysis.png "DON: Analysis")
and also allows the user to do ping tracing
![DON: Ping Tracer](/openstack_dashboard/don/ovs/static/don_ping_notworking.png "DON: Ping Tracer")
## How to Run:
### Prerequisites:
* Django version must be 1.7 or later. However, since OpenStack Horizon uses
Django, there is no need to separately install Django.
* The [Graphviz dot](http://www.graphviz.org/) utility. This is used for
drawing the visualization.
### Steps for DevStack:
0. You must have a [devstack setup running on a single VM](http://docs.openstack.org/developer/devstack/guides/single-vm.html).
1. [Download and source the project specific rc file](http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html).
2. Copy the DON source to Horizon directory.(/opt/stack/horizon/)
3. Restart Horizon by executing `sudo service apache2 restart`
### Steps for Multinode Openstack:
0. You must have Ansible (version 2.0 or later) installed in execution server
1. Clone DON source to execution server
2. Open shell promt and execute the below command from DON directory
3. `ansible-playbook don_playbook.yaml -i <inventory file path> --ask-pass`
## TODO/Known Issues:
Please look at issues in the github repo. If you have questions, bugs, or feature requests, file an issue or send email
to:
* Amit Saha (amisaha+don@cisco.com)

19
README.rst
View File

@ -1,19 +0,0 @@
===============================
python-don
===============================
Horizon dashboard to diagnose openstack
Please fill here a long description which must be at least 3 lines wrapped on
80 cols, so that distribution package maintainers can use it in their packages.
Note that this is a hard requirement.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/python-don
* Source: http://git.openstack.org/cgit/openstack/python-don
* Bugs: http://bugs.launchpad.net/python-don
Features
--------
* TODO

4
setup.cfg
View File

@ -2,7 +2,7 @@
name = python-don
summary = Horizon dashboard to diagnose openstack
description-file =
README.rst
README.md
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://www.openstack.org/
@ -48,4 +48,4 @@ output_file = openstack_dashboard/locale/openstack_dashboard.pot
[build_releasenotes]
all_files = 1
build-dir = releasenotes/build
source-dir = releasenotes/source
source-dir = releasenotes/source