summaryrefslogtreecommitdiffstats
path: root/docs/sections/services
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sections/services')
-rw-r--r--docs/sections/services/restconf/development_info.rst17
-rw-r--r--docs/sections/services/restconf/functionality.rst13
-rw-r--r--docs/sections/services/restconf/index.rst25
-rw-r--r--docs/sections/services/restconf/installation.rst47
-rw-r--r--docs/sections/services/serviceindex.rst1
5 files changed, 103 insertions, 0 deletions
diff --git a/docs/sections/services/restconf/development_info.rst b/docs/sections/services/restconf/development_info.rst
new file mode 100644
index 00000000..31e2ddbe
--- /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
index 00000000..15d42068
--- /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
index 00000000..ec98c959
--- /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
index 00000000..2f369873
--- /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 47649689..9825fe9a 100644
--- 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