User guide documentation for data router

Change-Id: If28014e4f937c9036e22f2db7599fd8568f0c13f
Signed-off-by: Emmett Cox <emmett.cox@ericsson.com>
Issue-ID: DMAAP-552

diff --git a/docs/data-router/DataRouterUserGuide.rst b/docs/data-router/DataRouterUserGuide.rst
new file mode 100644 (file)
index 0000000..8f7b9ef
--- /dev/null
+++ b/docs/data-router/DataRouterUserGuide.rst
@@ -0,0 +1,25 @@
+===========================
+Data Router (DR) User Guide
+===========================
+
+Standalone Mode
+---------------
+
+Installation
+============
+
+1. Find the datarouter project on the gerrit website: https://gerrit.onap.org/r/#/admin/projects/dmaap/datarouter
+
+2. Clone the repo onto your server using the clone command found on the datarouter page on gerrit.
+
+3. cd into the docker-compose directory and run docker-compose up.
+
+Configurations
+==============
+
+Using the Data Router
+---------------------
+
+For information on how to use the Data Router refer to the Data Router API guide at:
+
+    :ref:`data_router_api_guide`
\ No newline at end of file

diff --git a/docs/data-router/administration.rst b/docs/data-router/administration.rst
new file mode 100644 (file)
index 0000000..b050a1f
--- /dev/null
+++ b/docs/data-router/administration.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Administration
+==============
+
+
+Processes
+---------
+NA
+
+Actions
+-------
+NA

diff --git a/docs/data-router/architecture.rst b/docs/data-router/architecture.rst
new file mode 100644 (file)
index 0000000..b18f7bb
--- /dev/null
+++ b/docs/data-router/architecture.rst
@@ -0,0 +1,25 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Architecture
+============
+
+
+Capabilities
+------------
+Data Router is a RESTful web service used for the transfer of data across networks any larger than a Message Router message (> 1Mb).
+
+Usage Scenarios
+---------------
+    Data Router endpoints are used to create/view/delete Feeds, Subscribers and Published files. Clients can use the Data Router endpoints
+    to publish a file to a feed and subscribe to this feed to receive the file.
+
+Interactions
+------------
+Data Router REST service uses the Data Router API to allow users to publish to and subscribe to a feed, in order to send and receive files.
+
+
+
+   |image0|
+
+   .. |image0| image:: dr_arch.png

diff --git a/docs/data-router/configuration.rst b/docs/data-router/configuration.rst
new file mode 100644 (file)
index 0000000..2a7096a
--- /dev/null
+++ b/docs/data-router/configuration.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Configuration
+=============
+
+NA
\ No newline at end of file

diff --git a/docs/data-router/consumedapis.rst b/docs/data-router/consumedapis.rst
new file mode 100644 (file)
index 0000000..aa1a8bd
--- /dev/null
+++ b/docs/data-router/consumedapis.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Consumed APIs
+=============
+
+Data Router does not consume any API

diff --git a/docs/data-router/data-router.rst b/docs/data-router/data-router.rst
index ecce209..aaee385 100755 (executable)
--- a/docs/data-router/data-router.rst
+++ b/docs/data-router/data-router.rst
@@ -1,10 +1,15 @@
+.. _data_router_api_guide:\r
+\r
 ==========================\r
 Data Router (DR) API Guide\r
 ==========================\r
 Introduction\r
 ------------\r
 \r
-The DataRouter(DR) provisioning API is an HTTPS-based, REST-like API for creating and managing DR feeds and subscriptions. The Data Routing System project is intended to provide a common framework by which data producers can make data available to data consumers and a way for potential consumers to find feeds with the data they require.\r
+The DataRouter(DR) provisioning API is an HTTPS-based, REST-like API for creating and managing DR feeds\r
+and subscriptions. The Data Routing System project is intended to provide a common framework by which\r
+data producers can make data available to data consumers and a way for potential consumers to find feeds\r
+with the data they require.\r
 \r
 \r
 HTTP Service APIs\r

diff --git a/docs/data-router/delivery.rst b/docs/data-router/delivery.rst
new file mode 100644 (file)
index 0000000..775841a
--- /dev/null
+++ b/docs/data-router/delivery.rst
@@ -0,0 +1,32 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Delivery
+==============
+
+Data Router is comprised of a datarouter-provisioning container, a datarouter-node container and a mariadb container.
+
+.. blockdiag::
+
+
+   blockdiag layers {
+   orientation = portrait
+   MARIADB -> DR-PROV;
+   DR-PROV -> DR-NODE;
+   group l1 {
+       color = blue;
+       label = "dr-prov Container";
+       DR-PROV;
+       }
+   group l2 {
+       color = yellow;
+       label = "dr-node Container";
+       DR-NODE;
+       }
+   group l3 {
+       color = orange;
+       label = "MariaDb Container";
+       MARIADB;
+       }
+
+   }

diff --git a/docs/data-router/dr_arch.png b/docs/data-router/dr_arch.png
new file mode 100644 (file)
index 0000000..1655eda
Binary files /dev/null and b/docs/data-router/dr_arch.png differ

diff --git a/docs/data-router/humaninterfaces.rst b/docs/data-router/humaninterfaces.rst
new file mode 100644 (file)
index 0000000..71a2b73
--- /dev/null
+++ b/docs/data-router/humaninterfaces.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Human Interfaces
+================
+
+Data Router does not have human interfaces
+
+
+

diff --git a/docs/data-router/logging.rst b/docs/data-router/logging.rst
new file mode 100644 (file)
index 0000000..ac6aa95
--- /dev/null
+++ b/docs/data-router/logging.rst
@@ -0,0 +1,25 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging
+=======
+
+
+Where to Access Information
+---------------------------
+Data Router uses logback framework to generate logs.
+
+Error / Warning Messages
+------------------------
+Currently Data Router does not have any unique error codes. However the following are the common HTTP error codes that
+could possibly occur in Data Router:
+
+    OK = 200 : The normal response from a successful update or get of a feed or subscription
+    CREATED = 201 : the normal response from successfully creating or subscribing to a feed.
+    NO_CONTENT = 204 : the normal response from a successful publish attempt and on successfully deleting a feed or subscription
+    MOVED_PERMANENTLY = 301 :the normal redirect response from prov to a publisher
+    BAD_REQUEST = 400: Usually indicates that either Json object in request body is incorrect in some way, or an Invalid parameter value was included in query string.
+    UNAUTHORIZED = 401 : Usually indicated either request was missing Authorization header, or indicates incorrect Username/password credentials
+    FORBIDDEN = 403 : Usually indicates the request originated from an unauthorized IP address, or that a client certificate was not a part of authorized list.
+    NOT_FOUND = 404 : Usually indicates an incorrect URI
+    METHOD_NOT_ALLOWED = 405 : Indicates an HTTP method is not accepted for given URI
\ No newline at end of file

diff --git a/docs/data-router/release-notes.rst b/docs/data-router/release-notes.rst
new file mode 100644 (file)
index 0000000..f69ea2c
--- /dev/null
+++ b/docs/data-router/release-notes.rst
@@ -0,0 +1,29 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Release-notes
+==============
+
+Version: 1.0.1
+--------------
+
+:Release Date: 2018-09-20
+
+
+New Features:
+
+ - Implements a RESTful HTTPS API for creating feeds to publish files to and subscribe to,
+   as well as perform CRUD operations on these feeds.
+ - Implements a RESTful HTTPS API for subscribing to feeds and perform CRUD operations on these subscriptions.
+ - Implements a RESTful HTTPS API for publishing to feeds and perform CRUD operations on these published files.
+
+
+
+Bug Fixes
+NA
+
+Known Issues
+NA
+
+Other
+NA
\ No newline at end of file

diff --git a/docs/index.rst b/docs/index.rst
index f7dae49..99f0f28 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,15 +14,24 @@ The DataRouter(DR)provisioning API is an HTTPS-based,REST-like API for creating
 HTTP Service APIs\r
 ------------------\r
 \r
-DMaaP Message Router utilizes an HTTP REST API to service all transactions. HTTP and REST standards are followed so\r
-clients as varied as CURL, Java applications and even Web Browsers will\r
-work to interact with the Data Router.\r
+DMaaP Data Router utilizes an HTTPS REST API to service all transactions. HTTPS and REST standards are followed so\r
+clients as varied as CURL, Java applications and even Web Browsers will work to interact with the Data Router.\r
 \r
 \r
 \r
 .. toctree::\r
-   :maxdepth: 3\r
+   :maxdepth: 1\r
    \r
-   data-router/data-router\r
+   data-router/data-router.rst\r
+   data-router/administration.rst\r
+   data-router/architecture.rst\r
+   data-router/configuration.rst\r
+   data-router/consumedapis.rst\r
+   data-router/DataRouterUserGuide.rst\r
+   data-router/delivery.rst\r
+   data-router/humaninterfaces.rst\r
+   data-router/logging.rst\r
+   data-router/release-notes.rst\r
+\r
 \r
 \r