From e381bfda1003a03357ea450f398bffbbb916ec96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerard=20Braad=20=E2=80=94=20=E5=90=89=E6=8B=89=E5=BE=B7?= Date: Fri, 8 Apr 2016 02:49:52 +0000 Subject: [PATCH] Update README to contain project links Made the README easier to read from the command line by splitting lines at 80 chars. Added links to source, bugs and wiki page Rephrased some sentences Change-Id: Ia658b57a3b54cad49d960ceb28585da95dd0633a --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 41 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3ef8d8a..e4c0b9b 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,44 @@ A network inspection tool for OpenStack. -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. + * 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 + + +## 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. +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. -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. +Steth is an introspection tool for OpenStack networking. Only proved to be +working in ML2 with OVS for now. -## Multiple Node Architecture + +## Multi-node Architecture ``` note that steth does not save @@ -54,12 +77,20 @@ Steth is an introspection tool for OpenStack networking. Only proved to be worki +--------------------------+ +--------------------------+ +--------------------------+ ``` -In multiple nodes scenario, Steth is a steteless CLI and controller. It knows each steth agent and will read config files, interact with OpenStack, and following by sending signals to agents if it is needed. +In a scenario using multiple nodes, Steth is a stateless CLI and controller. +It knows each steth agent and will read config files, interact with OpenStack, +and sending instructions to agents when needed. + +Steth Agent is introduced to manage processes or run commands. It should be +installed in each compute and network node, and their IPs should be specified +in the config file of steth controller. -Steth Agent is introduced to manage processes or run commands. It should be installed in each compute and network node, and their IPs should be defined at config file of steth controller. ## Steth Agent -Linstening in 0.0.0.0:9698 and waiting for the rpc request. +Listening on 0.0.0.0:9698 and waiting for the rpc request. -Note: for get_interface() agent API, we use ifconfig to get full information. However, the output of ifconfig varies from a Linux distribution to another. The API has only been tested on CentOS 6.5 and 7.0, not any other distributions else. +Note: for get_interface() agent API, we use ifconfig to get full information. +However, the output of ifconfig varies from a Linux distribution to another. +The API has only been tested on CentOS 6.5 and 7.0. Any other distribution has +not been tested. If it works, please let us know.