Document update (.rst) for Restconf

Issue-ID: DCAEGEN2-1502
Change-Id: I1da5819f45c44de3bc7e0ed12da327f6ce8dcb50
Signed-off-by: s00370346 <swarup.nayak1@huawei.com>

diff --git a/docs/sections/images/rcc_diag.png b/docs/sections/images/rcc_diag.png
new file mode 100644 (file)
index 0000000..cc1e0c4
Binary files /dev/null and b/docs/sections/images/rcc_diag.png differ

diff --git a/docs/sections/images/rcc_diag_interact.png b/docs/sections/images/rcc_diag_interact.png
new file mode 100644 (file)
index 0000000..b9e54ed
Binary files /dev/null and b/docs/sections/images/rcc_diag_interact.png differ

diff --git a/docs/sections/services/restconf/development_info.rst b/docs/sections/services/restconf/development_info.rst
new file mode 100644 (file)
index 0000000..31e2ddb
--- /dev/null
+++ b/docs/sections/services/restconf/development_info.rst
@@ -0,0 +1,17 @@
+Compiling RestConf Collector
+=============================
+
+RestconfCollector is a sub-project of dcaegen2/colletcors/ (https://gerrit.onap.org/r/dcaegen2/collectors/restconf).
+To build the Restconf Collector component, run the following maven command from within **collectors/restconf** directory
+`mvn clean install`   
+
+
+Maven GroupId:
+==============
+
+org.onap.dcaegen2.collectors.restconf
+
+Maven Parent ArtifactId:
+========================
+
+org.onap.oparen:oparent:1.2.0

diff --git a/docs/sections/services/restconf/functionality.rst b/docs/sections/services/restconf/functionality.rst
new file mode 100644 (file)
index 0000000..15d4206
--- /dev/null
+++ b/docs/sections/services/restconf/functionality.rst
@@ -0,0 +1,13 @@
+Functionality
+=============
+
+RestconfCollector interaction with DCAE components.
+
+.. image:: ../../images/rcc_diag.png
+
+RestconfCollector interaction with an external controller.
+
+.. image:: ../../images/rcc_diag_interact.png
+
+For more details about the Restconfcollector, visit 
+* https://wiki.onap.org/pages/viewpage.action?pageId=60891182

diff --git a/docs/sections/services/restconf/index.rst b/docs/sections/services/restconf/index.rst
new file mode 100644 (file)
index 0000000..ec98c95
--- /dev/null
+++ b/docs/sections/services/restconf/index.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
+
+=====================================
+RestConfCollector 
+=====================================
+
+.. contents::
+    :depth: 3
+..
+
+Overview
+========
+
+Restconf collector is a microservice in ONAP DCAE. It subscribes to external controllers
+and receives event data. After receiving event data it may modify it as per usecase's requirement and 
+produce a DMaaP event. This DMaap event usually consumed by VES mapper.
+Restconf Collector can subscribe multiple events from multiple controllers.
+
+.. toctree::
+   :maxdepth: 1
+
+   ./installation
+   ./functionality
+   ./development_info

diff --git a/docs/sections/services/restconf/installation.rst b/docs/sections/services/restconf/installation.rst
new file mode 100644 (file)
index 0000000..2f36987
--- /dev/null
+++ b/docs/sections/services/restconf/installation.rst
@@ -0,0 +1,47 @@
+Installation
+============
+
+Sample docker run command could be -
+.. code-block:: bash
+       docker run onap/org.onap.dcaegen2.collectors.restconfcollector
+
+For Dublin release, it will be a DCAE component that can dynamically be deployed via Cloudify blueprint installation.
+Steps to deploy are shown below
+
+- Transfer blueprint component file in DCAE bootstrap POD under /blueprints directory. Blueprint can be found in
+
+     https://git.onap.org/dcaegen2/collectors/restconf/tree/dpo/blueprints/k8s-rcc-policy.yaml-template?h=master
+
+- Enter the Bootstrap POD
+- Validate blueprint
+    .. code-block:: bash
+        
+        cfy blueprints validate /blueprints/k8s-rcc-policy.yaml
+- Upload validated blueprint
+    .. code-block:: bash
+        
+
+        cfy blueprints upload -b restconfcollector /blueprints/k8s-rcc-policy.yaml
+- Create deployment
+    .. code-block:: bash
+        
+
+        cfy deployments create -b restconfcollector restconfcollector
+- Deploy blueprint
+    .. code-block:: bash
+        
+
+        cfy executions start -d restconfcollector install
+
+To undeploy restconfcollector, steps are shown below
+
+- Uninstall running restconfcollector and delete deployment
+    .. code-block:: bash
+        
+
+        cfy uninstall restconfcollector
+- Delete blueprint
+    .. code-block:: bash
+        
+
+        cfy blueprints delete restconfcollector

diff --git a/docs/sections/services/serviceindex.rst b/docs/sections/services/serviceindex.rst
index 4764968..9825fe9 100644 (file)
--- a/docs/sections/services/serviceindex.rst
+++ b/docs/sections/services/serviceindex.rst
@@ -21,3 +21,4 @@ Service components under DCAE
    ./bbs-event-processor/index.rst
    ./sdk/index.rst
    ./son-handler/index.rst
+   ./restconf/index.rst