steth/README.rst
hanchao dba214e251 Restructure the docs for steth
Reformat the README.md into README.rst. Reschedule the
directory of the docs. Add code blocks to emphasize the
commands in the quickstart.rst. Seperate the multi-node-
architecture section out of the README.rst, and put it
in the multi-node-architecture.rst.

Note: The multi-node-architecture.rst is not indicated in
the README.rst.

Change-Id: I05407cf75e4f140158c690d96a9ded5f39cf6bc8
Closes-Bug: #1569139
2016-04-15 14:31:19 +08:00

51 lines
1.4 KiB
ReStructuredText

=====
Steth
=====
A network inspection tool for OpenStack.
* License: Apache License, Version 2.0
* Source: https://git.openstack.org/cgit/openstack/steth
* Bugs: https://bugs.launchpad.net/steth
* Wiki: https://wiki.openstack.org/wiki/Steth
* Docs: http://steth.readthedocs.org/
-----------
Description
-----------
Steth is an inspection tool that can aid in pinpointing issues before deployment
and during operation of an OpenStack environment.
It is modelled as agent(s)/client in which a controller interacts with agents
deployed in your environment.
----------
Background
----------
OpenStack networking can be deloyed as different architectures, such as ML2 with
OVS(legacy and DVR), Linux bridge, OVN, Dragonflow and so forth. However, they
all need enviromental prerequisites. For instance, VLAN needs to be configured
as we expect; bandwidth should meet our requirements; connection between nodes
should be active, etc.
Besides, with some well-deployed architectures, troubleshooting for VM
networking is difficult. For instance, why VM cannot get an IP address; or why
it cannot connect to Internet, etc. Steth integrates useful scripts and third
party tools(like iperf, tcpdump, etc.) to help operators keep tracking on VM
networking.
-------
Mission
-------
Steth is an introspection tool for OpenStack networking. Only proved to be
working in ML2 with OVS for now.