0e03c7b64e
Basic setup for documentation. The infra jobs call this as: tox -evenv -- python setup.py build_sphinx Therefore add venv as tox.ini environment as well. Add sphinx as requirement to test-requirement so that docs can be build. Change-Id: Idbbc0406d438e7be24cdbde59cac5a5229318d92
2.3 KiB
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: :
[DEFAULT]
# Prefix of managed network in every agent. End of '.'
# Example: "10.0.4."
manage_network_prefix=127.0.0.
# Network nodes info. Just need sequence number.
# Example: 64, 65, 66
network_agents_info=64,65,66
# Compute nodes info. Just need sequence number.
# Example: 67, 68
compute_agents_info=67,68