From 6ebe637b4c34b6384b5d56700a3dd4c289fc4c2d Mon Sep 17 00:00:00 2001
From: Jedrzej Nowak <jnowak@mirantis.com>
Date: Mon, 30 Nov 2015 15:51:02 +0100
Subject: [PATCH] Added basic transports docs

---
 docs/index.rst             |  1 +
 docs/source/glossary.rst   | 19 +++++++++------
 docs/source/transports.rst | 47 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 60 insertions(+), 7 deletions(-)
 create mode 100644 docs/source/transports.rst

diff --git a/docs/index.rst b/docs/index.rst
index c8ad89b2..94499437 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,6 +14,7 @@ Contents:
    source/glossary
    source/resource
    source/orchestration
+   source/transports
    source/examples
 
 
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index 1f0581d9..4ca02f92 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -9,7 +9,9 @@ Solar Glossary
 Resource
 ========
 
-You can learn more about it in :ref:`Resource Details <resource_details>`
+.. seealso::
+
+    You can learn more about it in :ref:`Resource Details <resource_details>`
 
 .. _res-input-term:
 
@@ -51,13 +53,13 @@ Layer that responsible for action execution and tracking result.
 Transport
 =========
 
-Used in handlers to communicate with managed by solar hosts. List of transports
-should be added to a node. Transports will be added to a resource by means
-of transports id.
+Used in handlers to communicate with managed by solar hosts.
+
+.. seealso::
+
+   :ref:`More details about transports <transports_details>`
 
-Two different types of transports are used: run and sync.
-Run transport - reponsible for running command on remote host.
-Sync transport - uploads required information.
+.. _location-id-term:
 
 location_id
 -----------
@@ -65,12 +67,15 @@ Used in transport layer to find ip address of a node. ::
 
   'location_id': '96bc779540d832284680785ecd948a2d'
 
+.. _transports-id-term:
+
 transports_id
 -------------
 Used to find transports array that will be used for transport selection. ::
 
   'transports_id': '3889e1790e68b80b4f255cf0e13494b1'
 
+
 BAT transport
 -------------
 According to preferences solar will choose best available transport for
diff --git a/docs/source/transports.rst b/docs/source/transports.rst
new file mode 100644
index 00000000..8cba4872
--- /dev/null
+++ b/docs/source/transports.rst
@@ -0,0 +1,47 @@
+.. _transports_details:
+
+
+Transports
+==========
+
+Transports are used by Solar to communicate with managed nodes.
+Transports are also resuorces, so they have all features of it.
+Transports should be added to a node, but if you need you can add different transports for different resources.
+
+
+How it works
+------------
+
+* Each resource in solar have randomly generated :ref:`transports-id-term`, when you connect resources together,
+* Solar will ensure that correct `transport_id` is passed around. then using this `transport_id` a correct real value is fetched.
+* Changing transports contents will not cause resource.update action for related resources.
+
+Sync transport
+--------------
+
+It uploads required information to target node.
+
+Currently there are following sync transports available:
+
+* ssh
+* rsync
+* solar_agent
+* torrent
+
+
+Run transport
+-------------
+
+It is responsible for running command on remote host.
+
+Currently there are following run transports available:
+
+* ssh
+* solar_agent
+
+
+
+BAT transport
+-------------
+
+A transport that will automaticaly select best available transport (BAT) that is available for given resource. Currently it's default enabled transport, so when you add more transports to your system, then everything happens automaticaly.