aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEzhilarasi <ezhrajam@in.ibm.com>2019-08-14 23:38:10 +0530
committerEzhilarasi R <ezhrajam@in.ibm.com>2019-08-16 09:25:30 +0000
commita0b7010ed18a04e4a1aa6a6db2d6b0a18072e955 (patch)
tree1d26e0cf55bee4a312793fe771aeff5a737b5150
parent615b5e183723bba51e0b3c134c7b5b954f99cac0 (diff)
Formatted Doc text
Formmated contents of Read the docs text Change-Id: I44ebf3894f55ad72c35600f263b58a3235880af4 Issue-ID: CCSDK-1453 Signed-off-by: Ezhilarasi <ezhrajam@in.ibm.com>
-rw-r--r--docs/datadictionary/restsourcecode.rst166
-rw-r--r--docs/datadictionary/sourcecapabilitycode.rst76
-rw-r--r--docs/datadictionary/sourcedefaultcode.rst13
-rw-r--r--docs/datadictionary/sourceinputcode.rst13
-rw-r--r--docs/datadictionary/sourceprimarydbcode.rst95
-rw-r--r--docs/index.rst11
-rw-r--r--docs/microservices/bluePrintsProcessorMS.rst26
7 files changed, 204 insertions, 196 deletions
diff --git a/docs/datadictionary/restsourcecode.rst b/docs/datadictionary/restsourcecode.rst
index 90b02986a..243a65ce9 100644
--- a/docs/datadictionary/restsourcecode.rst
+++ b/docs/datadictionary/restsourcecode.rst
@@ -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
diff --git a/docs/datadictionary/sourcecapabilitycode.rst b/docs/datadictionary/sourcecapabilitycode.rst
index a91767678..145bab738 100644
--- a/docs/datadictionary/sourcecapabilitycode.rst
+++ b/docs/datadictionary/sourcecapabilitycode.rst
@@ -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"
+
diff --git a/docs/datadictionary/sourcedefaultcode.rst b/docs/datadictionary/sourcedefaultcode.rst
index 243f87f09..89c5c2c7d 100644
--- a/docs/datadictionary/sourcedefaultcode.rst
+++ b/docs/datadictionary/sourcedefaultcode.rst
@@ -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"
diff --git a/docs/datadictionary/sourceinputcode.rst b/docs/datadictionary/sourceinputcode.rst
index b859272ea..c400a8c4c 100644
--- a/docs/datadictionary/sourceinputcode.rst
+++ b/docs/datadictionary/sourceinputcode.rst
@@ -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"
diff --git a/docs/datadictionary/sourceprimarydbcode.rst b/docs/datadictionary/sourceprimarydbcode.rst
index e2e0b2d76..949dee071 100644
--- a/docs/datadictionary/sourceprimarydbcode.rst
+++ b/docs/datadictionary/sourceprimarydbcode.rst
@@ -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
diff --git a/docs/index.rst b/docs/index.rst
index e80917bb2..183bbbf9f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -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
diff --git a/docs/microservices/bluePrintsProcessorMS.rst b/docs/microservices/bluePrintsProcessorMS.rst
index 3f308138f..bd0b6997d 100644
--- a/docs/microservices/bluePrintsProcessorMS.rst
+++ b/docs/microservices/bluePrintsProcessorMS.rst
@@ -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: