FlyScript
Welcome, this is the documentation for FlyScript.
Getting Started
- If you are new to Shark and Pilot or if you prefer reading background material to work "bottom up", begin with a brief introduction to the Shark architecture.
- If you don't have FlyScript installed, read about installing FlyScript
- If you are already familiar with Shark and want to start hacking, jump to a FlyScript tutorial.
- If you want to jump into the Profiler side of things, head to a Profiler FlyScript tutorial.
- If you have a specific question about how to use the FlyScript libraries, see the library reference
- Hopefully if none of the above apply, you'll find what you need among the other links.
FlyScript library reference
The documentation contained here covers public interfaces. The FlyScript implementation contains a number of private interfaces, these are all identified using the standard Python convention of a leading underscore character (_) in the names of modules, classes or functions.
The public interfaces documented here are intended to be stable -- we will do our best to keep them backward-compatible so that code written using these modules will continue to function even when new version of the libraries are released in the future. For these reasons, you should generally try to use the public modules. Nevertheless, the private modules are often useful as a reference to how the system works.
Class Hierarchy
All the FlyScript code resides in a top-level Python package called rvbd
.
The structure of sub-packages looks like this:
rvbd
: the top-level FlyScript packagervbd.common
: code for common functionality across Riverbed products (e.g., authentication, version queries, etc.)rvbd.shark
: code for interacting with Cascade Shark appliancesrvbd.profiler
: code for interacting Cascade Profilers