x/steth
Code Issues Proposed changes
Networking Debug Tool for OpenStack
141 Commits 1 Branch 6 Tags 676 KiB
Python 98.3%
Shell 1.7%
72159579dd
Go to file
Gerard Braad — 吉拉德 72159579dd Add message about contributing 
Change-Id: Ia82980c47aeed911dbfe98a05e938c6c01917718
2016-05-05 03:59:12 +00:00
docs Add table of contents 2016-04-21 02:19:52 +00:00
etc Change steth agent running user 2016-03-09 16:24:04 +08:00
steth Apply general code clean-up and fixes 2016-05-04 23:18:13 +00:00
.gitignore Upload steth doc 2016-01-19 10:35:20 +01:00
.gitreview Add .gitreview 2016-01-18 07:16:55 +01:00
LICENSE Initial commit 2015-12-21 12:19:11 +08:00
README.rst Add message about contributing 2016-05-05 03:59:12 +00:00
requirements.txt Apply general code clean-up and fixes 2016-05-04 23:18:13 +00:00
setup.cfg Restructure the docs for steth 2016-04-15 14:31:19 +08:00
setup.py use pbr replace setuptools 2016-01-12 11:29:40 +08:00
test-requirements.txt dhcp check and packet driver 2016-01-27 15:52:15 +08:00
tox.ini Make pep8 *the* linting interface 2016-02-10 22:25:38 +01:00

README.rst

Steth

A network inspection tool for OpenStack.

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.

Contributing

All kinds of contributions are welcomed, such as documentation, bug fixes and new features. If you have a new feature or idea, ask for feedback first before spending lots of time on something.

Please search issues and merge requests before adding something new to avoid duplicating efforts and conversations. Especially, when working on a bug you should assign it to yourself before starting to work on it.

You can also post message in the OpenStack Developer mailinglist, prefixed with [steth].