x/steth

changzhi1990 a3f1f28545 Refactor iperf CLI

This patch contains these features:
1. add new param to iperf CLI
2. add "validate_ip" in agent
3. rename strutils.py into utils.py
4. move some common functions into utils.py
5. modify doc and configuration file

Change-Id: I993041b3d91bd42e9d732f07383d6d92b2f5d3d3

2016-01-26 17:25:42 +08:00

3.0 KiB

Raw Blame History

Welcome to Steth's developer documentation!

Steth is an inspection tool that can aid in pinpointing issues before deployment and during operation of an OpenStack environment.

Quick start

Steth is a network inspection tool for OpenStack.

It is modelled as agent(s)/client in which a controller interacts with agents deployed in your environment. Let me introduce how to use steth.

Download code

Download the latest code from git repository. And run python setup.py install to install steth. After running that, you can steth - -help to confirm Steth is installed correctly.

Deploy Steth Agent

Steth Agent listens in 0.0.0.0:9698 on any node you want. It will wait for RPC request. Currently we support CentOS 6.5, CentOS 7.0 and CentOS 7.1 only. In CentOS 6.5, you should run service steth-agent start to start steth-agent. In CentOS 7.0 and 7.1, you should run systemctl start steth to start steth-agent.

Deploy Steth Client

Steth Client is a stateless program. You can run steth - -help to show all steth commands that you can run.

Configuration File

On start the client will read a configuration file. By default the configuration file is located at /etc/steth/steth.conf. Here is an example about the configuration file: :

# (ListOpt) Order list of networks prefix.
# The first item is treated as a list.
# If multiple networks are used, we can be specified as s list.
# Specify the prefix of the networks to be used.
# The ending '.' -- specifier indicates the network range to be used.
# Example: "10.0.4.,192.168.10."
networks_prefix=127.0.0.,192.168.20.,1.1.1.

# (ListOpt) This is the identifier of the nodes in group of network nodes.
# Example: 64, 65, 66
network_agents_info=64,65,66

# (ListOpt) This is the identifier of the nodes in group of compute nodes.
# Example: 67, 68
compute_agents_info=67,68

# (StrOpt) Prefix to be used in naming every node. By default, this value
# is "server". We combine "node_name_prefix" with
# "network_agents_info", "compute_agents_info" to
# define nodes. Such as "server-64", "server-68" and so on.
# In every region, we give every node a specific name.
# Ensure that DNS can be resolved correctly.
# these names when doing iperf.
node_name_prefix=server-

3.0 KiB Raw Blame History