diff options
| author |   Hanoh Haim <hhaim@cisco.com> | 2015-06-24 14:03:29 +0300 |
|---|---|---|
| committer | Hanoh Haim <hhaim@cisco.com> | 2015-06-24 14:03:29 +0300 |
| commit | 8b52a31ed2c299b759f330c4f976b9c70f5765f4 (patch) | |
| tree | 9d6da5438b5b56b1d2d57e6c13494b4e65d000e7 /scripts/automation/trex_control_plane/doc/installation.rst | |
first version
Diffstat (limited to 'scripts/automation/trex_control_plane/doc/installation.rst')
| -rwxr-xr-x | scripts/automation/trex_control_plane/doc/installation.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/scripts/automation/trex_control_plane/doc/installation.rst b/scripts/automation/trex_control_plane/doc/installation.rst new file mode 100755 index 00000000..dda32f56 --- /dev/null +++ b/scripts/automation/trex_control_plane/doc/installation.rst @@ -0,0 +1,25 @@ +============
+Installation
+============
+
+Prerequisites
+-------------
+The T-Rex control plane is based on client-server model that interacts using JSON-RPC.
+
+In order to use the client-side API documented a T-Rex server daemon must be up and listening on the same host and port that the client tries to connect with.
+
+Compatibility
+-------------
+Both client and server side were developed for Linux platform.
+The client-side module is also compatible with windows python.
+
+The client side can be used with both Python 2 and Python 3 versions.
+However, the server side was desined to and best fits with Python 2.7.6 and on (all 2.x series, assuming > 2.6.9).
+
+
+Installation manual
+-------------------
+
+T-Rex Control Plane is a cross-platform, cross-operatin system APi to control and run T-Rex.
+
+The full, most updated manual (which refers to all programming languages) can be found under the `Automation API documentation <http://csi-wiki-01:8080/display/bpsim/Documentation>`_ .
\ No newline at end of file |