Merge "Auto Rsc Mapping Service Kotlin change"
authorBrinda Santh Muthuramalingam <brindasanth@in.ibm.com>
Fri, 16 Aug 2019 14:10:18 +0000 (14:10 +0000)
committerGerrit Code Review <gerrit@onap.org>
Fri, 16 Aug 2019 14:10:18 +0000 (14:10 +0000)
docs/datadictionary/restsourcecode.rst
docs/datadictionary/sourcecapabilitycode.rst
docs/datadictionary/sourcedefaultcode.rst
docs/datadictionary/sourceinputcode.rst
docs/datadictionary/sourceprimarydbcode.rst
docs/designtime.rst
docs/index.rst
docs/microservices/bluePrintsProcessorMS.rst
docs/microservices/dynamicapi.rst
docs/microservices/enrichment.rst

index 90b0298..243a65c 100644 (file)
@@ -5,86 +5,86 @@
 Rest Source Code:
 =================
 
-{
-  "description": "This is Rest Resource Source Node Type",
-  "version": "1.0.0",
-  "properties": {
-    "type": {
-      "required": false,
-      "type": "string",
-      "default": "JSON",
-      "constraints": [
-        {
-          "valid_values": [
-            "JSON"
-          ]
-        }
-      ]
-    },
-    "verb": {
-      "required": false,
-      "type": "string",
-      "default": "GET",
-      "constraints": [
-        {
-          "valid_values": [
-            "GET", "POST", "DELETE", "PUT"
-          ]
-        }
-      ]
-    },
-    "payload": {
-      "required": false,
-      "type": "string",
-      "default": ""
-    },
-    "endpoint-selector": {
-      "required": false,
-      "type": "string"
-    },
-    "url-path": {
-      "required": true,
-      "type": "string"
-    },
-    "path": {
-      "required": true,
-      "type": "string"
-    },
-    "expression-type": {
-      "required": false,
-      "type": "string",
-      "default": "JSON_PATH",
-      "constraints": [
-        {
-          "valid_values": [
-            "JSON_PATH",
-            "JSON_POINTER"
-          ]
-        }
-      ]
-    },
-    "input-key-mapping": {
-      "required": false,
-      "type": "map",
-      "entry_schema": {
-        "type": "string"
-      }
-    },
-    "output-key-mapping": {
-      "required": false,
-      "type": "map",
-      "entry_schema": {
-        "type": "string"
-      }
-    },
-    "key-dependencies": {
-      "required": true,
-      "type": "list",
-      "entry_schema": {
-        "type": "string"
-      }
-    }
-  },
-  "derived_from": "tosca.nodes.ResourceSource"
-}
-
+.. code-block:: json
+   :linenos:
+   
+   "description": "This is Rest Resource Source Node Type",
+   "version": "1.0.0",
+   "properties": {
+     "type": {
+       "required": false,
+       "type": "string",
+       "default": "JSON",
+       "constraints": [
+         {
+           "valid_values": [
+             "JSON"
+           ]
+         }
+       ]
+     },
+     "verb": {
+       "required": false,
+       "type": "string",
+       "default": "GET",
+       "constraints": [
+         {
+           "valid_values": [
+             "GET", "POST", "DELETE", "PUT"
+           ]
+         }
+       ]
+     },
+     "payload": {
+       "required": false,
+       "type": "string",
+       "default": ""
+     },
+     "endpoint-selector": {
+       "required": false,
+       "type": "string"
+     },
+     "url-path": {
+       "required": true,
+       "type": "string"
+     },
+     "path": {
+       "required": true,
+       "type": "string"
+     },
+     "expression-type": {
+       "required": false,
+       "type": "string",
+       "default": "JSON_PATH",
+       "constraints": [
+         {
+           "valid_values": [
+             "JSON_PATH",
+             "JSON_POINTER"
+           ]
+         }
+       ]
+     },
+     "input-key-mapping": {
+       "required": false,
+       "type": "map",
+       "entry_schema": {
+         "type": "string"
+       }
+     },
+     "output-key-mapping": {
+       "required": false,
+       "type": "map",
+       "entry_schema": {
+         "type": "string"
+       }
+     },
+     "key-dependencies": {
+       "required": true,
+       "type": "list",
+       "entry_schema": {
+         "type": "string"
+       }
+     }
+   },
+   "derived_from": "tosca.nodes.ResourceSource"
\ No newline at end of file
index a917676..145bab7 100644 (file)
@@ -5,44 +5,38 @@
 Source Capability Code
 ======================
 
-{
-  "description": "This is Component Resource Source Node Type",
-  "version": "1.0.0",
-  "properties": {
-    "script-type": {
-      "required": true,
-      "type": "string",
-      "default": "kotlin",
-      "constraints": [
-        {
-          "valid_values": [
-            "kotlin",
-            "jython"
-          ]
-        }
-      ]
-    },
-    "script-class-reference": {
-      "description": "Capability reference name for internal and kotlin, for jython script file path",
-      "required": true,
-      "type": "string"
-    },
-    "instance-dependencies": {
-      "required": false,
-      "description": "Instance dependency Names to Inject to Kotlin / Jython Script.",
-      "type": "list",
-      "entry_schema": {
-        "type": "string"
-      }
-    },
-    "key-dependencies": {
-      "description": "Resource Resolution dependency dictionary names.",
-      "required": true,
-      "type": "list",
-      "entry_schema": {
-        "type": "string"
-      }
-    }
-  },
-  "derived_from": "tosca.nodes.ResourceSource"
-}
+.. code-block:: json
+   :linenos:
+
+   "description": "This is Component Resource Source Node Type",
+   "version": "1.0.0",
+   "properties": {
+     "script-type": {
+       "required": true,
+       "type": "string",
+       "default": "kotlin",
+       "constraints": [
+         {
+           "valid_values": [
+             "kotlin",
+             "jython"
+           ]
+         }
+       ]
+     },
+     "script-class-reference": {
+       "description": "Capability reference name for internal and kotlin, for jython script file path",
+       "required": true,
+       "type": "string"
+     },
+      "key-dependencies": {
+       "description": "Resource Resolution dependency dictionary names.",
+       "required": true,
+       "type": "list",
+       "entry_schema": {
+         "type": "string"
+       }
+     }
+   },
+   "derived_from": "tosca.nodes.ResourceSource"
+
index 243f87f..89c5c2c 100644 (file)
@@ -5,9 +5,10 @@
 Source Default code
 ===================
 
-{
-  "description": "This is Default Resource Source Node Type",
-  "version": "1.0.0",
-  "properties": {},
-  "derived_from": "tosca.nodes.ResourceSource"
-}
\ No newline at end of file
+.. code-block:: json
+   :linenos:
+
+   "description": "This is Default Resource Source Node Type",
+   "version": "1.0.0",
+   "properties": {},
+   "derived_from": "tosca.nodes.ResourceSource"
index b859272..c400a8c 100644 (file)
@@ -5,9 +5,10 @@
 Source Input code
 =================
 
-{
-  "description": "This is Input Resource Source Node Type",
-  "version": "1.0.0",
-  "properties": {},
-  "derived_from": "tosca.nodes.ResourceSource"
-}
\ No newline at end of file
+.. code-block:: json
+   :linenos:
+   
+   "description": "This is Input Resource Source Node Type",
+   "version": "1.0.0",
+   "properties": {},
+   "derived_from": "tosca.nodes.ResourceSource"
index e2e0b2d..949dee0 100644 (file)
@@ -5,50 +5,51 @@
 Source Primary DB Code:
 =======================
 
-{
-  "description": "This is Database Resource Source Node Type",
-  "version": "1.0.0",
-  "properties": {
-    "type": {
-      "required": true,
-      "type": "string",
-      "constraints": [
-        {
-          "valid_values": [
-            "SQL"
-          ]
-        }
-      ]
-    },
-    "endpoint-selector": {
-      "required": false,
-      "type": "string"
-    },
-    "query": {
-      "required": true,
-      "type": "string"
-    },
-    "input-key-mapping": {
-      "required": false,
-      "type": "map",
-      "entry_schema": {
-        "type": "string"
-      }
-    },
-    "output-key-mapping": {
-      "required": false,
-      "type": "map",
-      "entry_schema": {
-        "type": "string"
-      }
-    },
-    "key-dependencies": {
-      "required": true,
-      "type": "list",
-      "entry_schema": {
-        "type": "string"
-      }
-    }
-  },
-  "derived_from": "tosca.nodes.ResourceSource"
-}
\ No newline at end of file
+.. code-block:: json
+   :linenos:
+
+   "description": "This is Database Resource Source Node Type",
+   "version": "1.0.0",
+   "properties": {
+     "type": {
+       "required": true,
+       "type": "string",
+       "constraints": [
+         {
+           "valid_values": [
+             "SQL"
+           ]
+         }
+       ]
+     },
+     "endpoint-selector": {
+       "required": false,
+       "type": "string"
+     },
+     "query": {
+       "required": true,
+       "type": "string"
+     },
+     "input-key-mapping": {
+       "required": false,
+       "type": "map",
+       "entry_schema": {
+         "type": "string"
+       }
+     },
+     "output-key-mapping": {
+       "required": false,
+       "type": "map",
+       "entry_schema": {
+         "type": "string"
+       }
+     },
+     "key-dependencies": {
+       "required": true,
+       "type": "list",
+       "entry_schema": {
+         "type": "string"
+       }
+     }
+   },
+   "derived_from": "tosca.nodes.ResourceSource"
\ No newline at end of file
index 304a98e..20a03ef 100644 (file)
@@ -43,7 +43,7 @@ While doing so, identify the resources using the same process to be resolved; fo
 
 
 Services:
-=============
+=========
 
 .. toctree::
    :maxdepth: 1
index e80917b..183bbbf 100644 (file)
@@ -45,7 +45,6 @@ configuration file (configlet) to a VNF/PNF.
 |image1|
 
 
-
 Modeling Concept
 ----------------
 
@@ -90,9 +89,6 @@ Design tools
    CBA/index
    datadictionary/index
 
-
-
-
 Scripts
 -------
 
@@ -100,20 +96,21 @@ Library
 ~~~~~~~
 
 * NetconfClient
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
 
 In order to facilitate NETCONF interaction within scripts, a python NetconfClient binded to our Kotlin implementation is made available. This NetconfClient can be used when using the component-netconf-executor.
 
 The client can be find here: https://github.com/onap/ccsdk-cds/blob/master/components/scripts/python/ccsdk_netconf/netconfclient.py
 
 * ResolutionHelper
-~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~
 
 When executing a component executor script, designer might want to perform
 resource resolution along with template meshing directly from the script
 itself.
 
-The helper can be find here: https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py
+The helper can be found in below link: 
+https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py
 
 .. |image0| image:: media/tosca_model.jpg
    :width: 7.88889in
index 3f30813..bd0b699 100644 (file)
@@ -34,7 +34,9 @@ Check out the latest code from Gerrit: https://gerrit.onap.org/r/#/admin/project
 Build CDS locally:
 In the checked out directory, type
 
-    mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none
+.. code-block:: none
+   
+   mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none
        
 Create the needed Docker images:
 
@@ -42,27 +44,39 @@ The Blueprints Processor microservice project has a module, called distribution,
 
 The first step is to create any custom image needed, by building the distribution module.  From the CDS home directory (where the code was checked out), navigate to the module:
 
-    cd ms/blueprintsprocessor/distribution/
+.. code-block:: none
+
+   cd ms/blueprintsprocessor/distribution/
+   
 Build it using the Maven profile called Docker:
 
-    mvn clean install -Pdocker
+.. code-block:: none
+
+   mvn clean install -Pdocker
        
 Start Docker containers using docker-composer:
 ----------------------------------------------
 
 Navigate to the docker-compose file in the distribution module:
 
-    cd src/main/dc/
+.. code-block:: none
+    
+   cd src/main/dc/
        
 From there, start the containers:
 
-    docker-compose up -d
+.. code-block:: none
+
+   docker-compose up -d
+   
 This will spin the Docker containers declared inside the docker-compose.yaml file in the background.
 
 
 To verify the logs generated by docker-composer, type:
 
-    docker-compose logs -f
+.. code-block:: none
+
+   docker-compose logs -f
        
        
 Testing the environment:
index eaf9987..c732bd0 100644 (file)
@@ -19,6 +19,6 @@ Here is how the a generic request and response look like.
 
 |image0|
 
-.. |image0| image:: media/dynamicapi.jpg
+.. |image0| image:: media/dyanmicapi.jpg
    :height: 4.43750in
    :width: 7.88889in
\ No newline at end of file
index 1f94556..306cdbc 100644 (file)
@@ -13,13 +13,14 @@ Once the base CBA zip file is done, the enrichment process will complete the des
 The following shows 2 ways to run CBA enrichment
 
 REST API request:
-----------------
+-----------------
 
 |image0|
 
 
 CDS UI:
-------
+-------
+
 |image1|