timmy/doc/source/specification.rst

1.4 KiB

Specification
  • The tool is based on https://etherpad.openstack.org/p/openstack-diagnostics
  • Should work fine on the following environments that were tested: 4.x, 5.x, 6.x, 7.0, 8.0
  • Operates non-destructively.
  • Can be launched on any host within admin network, provided the fuel node IP is specified and access is possible to Fuel and other nodes via ssh from local system.
  • Parallel launch, only on the nodes that are 'online'. Some filters for nodes are also available.
  • Commands (from ./cmds directory) are separated according to roles (detected automatically) by the symlinks. Thus, the command list may depend on release, roles and OS. In addition, there can be some commands that run everywhere. There are also commands that are executed only on one node according to its role, using the first node of this type they encounter.
  • Modular: possible to create a special package that contains only certain required commands.
  • Collects log files from the nodes using filters
  • Some archives are created - general.tar.bz2 and logs-*
  • Checks are implemented to prevent filesystem filling due to log collection, appropriate error shown.
  • Can be imported in other python scripts (ex. https://github.com/f3flight/timmy-customtest) and used as a transport and structure to access node parameters known to Fuel, run commands on nodes, collect outputs, etc. with ease.