summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/CBA/index.rst12
-rw-r--r--docs/CDS_Architecture_Design.pptx (renamed from docs/CBA/CDS_Architecture_Design.pptx)bin1226310 -> 1226310 bytes
-rw-r--r--docs/CDS_architecture.JPG (renamed from docs/media/CDS_architecture.JPG)bin140539 -> 140539 bytes
-rw-r--r--docs/bluePrintsProcessorMS.rst (renamed from docs/bluePrintsProcessor.rst)0
-rw-r--r--docs/controllerBlueprintStudioProcessorMS.rst (renamed from docs/controllerBlueprintStudioProcessor.rst)0
-rw-r--r--docs/datadictionary/complexResponse.rst20
-rw-r--r--docs/datadictionary/create_netbox_ip_address.rst36
-rw-r--r--docs/datadictionary/dt-netbox-ip.rst22
-rw-r--r--docs/datadictionary/index.rst46
-rw-r--r--docs/datadictionary/resourceDefinitionCode.rst48
-rw-r--r--docs/image0.jpg (renamed from docs/media/image0.jpg)bin84320 -> 84320 bytes
-rw-r--r--docs/index.rst8
-rw-r--r--docs/installation.rst63
13 files changed, 204 insertions, 51 deletions
diff --git a/docs/CBA/index.rst b/docs/CBA/index.rst
index 43317e6e5..27d69b086 100644
--- a/docs/CBA/index.rst
+++ b/docs/CBA/index.rst
@@ -93,13 +93,6 @@ Steps
3. cd cds ; mvn clean install ; cd ..
4. Open the cds-ui/client code for development
-Data Flow:
-==========
-|image1|
-
-.. |image1| image:: media/image1.jpg
- :width: 7.88889in
- :height: 4.43750in
Functional Decomposition:
=========================
@@ -109,8 +102,3 @@ Functional Decomposition:
:width: 7.88889in
:height: 4.43750in
-Controller design Studio Presentation:
-======================================
-
-Details about CDS Architecture and Design detail, Please click the link.
-:download:`CDS_Architecture_Design.pptx` \ No newline at end of file
diff --git a/docs/CBA/CDS_Architecture_Design.pptx b/docs/CDS_Architecture_Design.pptx
index a6c158d8d..a6c158d8d 100644
--- a/docs/CBA/CDS_Architecture_Design.pptx
+++ b/docs/CDS_Architecture_Design.pptx
Binary files differ
diff --git a/docs/media/CDS_architecture.JPG b/docs/CDS_architecture.JPG
index c8528ac1e..c8528ac1e 100644
--- a/docs/media/CDS_architecture.JPG
+++ b/docs/CDS_architecture.JPG
Binary files differ
diff --git a/docs/bluePrintsProcessor.rst b/docs/bluePrintsProcessorMS.rst
index 911f99945..911f99945 100644
--- a/docs/bluePrintsProcessor.rst
+++ b/docs/bluePrintsProcessorMS.rst
diff --git a/docs/controllerBlueprintStudioProcessor.rst b/docs/controllerBlueprintStudioProcessorMS.rst
index 5c67d6c1d..5c67d6c1d 100644
--- a/docs/controllerBlueprintStudioProcessor.rst
+++ b/docs/controllerBlueprintStudioProcessorMS.rst
diff --git a/docs/datadictionary/complexResponse.rst b/docs/datadictionary/complexResponse.rst
new file mode 100644
index 000000000..aa39ff235
--- /dev/null
+++ b/docs/datadictionary/complexResponse.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 IBM.
+
+complex Response code
+=====================
+
+{
+ "id": 4,
+ "address": "192.168.10.2/32",
+ "vrf": null,
+ "tenant": null,
+ "status": 1,
+ "role": null,
+ "interface": null,
+ "description": "",
+ "nat_inside": null,
+ "created": "2018-08-30",
+ "last_updated": "2018-08-30T14:59:05.277820Z"
+}
diff --git a/docs/datadictionary/create_netbox_ip_address.rst b/docs/datadictionary/create_netbox_ip_address.rst
new file mode 100644
index 000000000..5d9a9be87
--- /dev/null
+++ b/docs/datadictionary/create_netbox_ip_address.rst
@@ -0,0 +1,36 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 IBM.
+
+create_netbox_ip_address code
+=============================
+
+{
+ "tags" : "oam-local-ipv4-address",
+ "name" : "create_netbox_ip",
+ "property" : {
+ "description" : "netbox ip",
+ "type" : "dt-netbox-ip"
+ },
+ "updated-by" : "adetalhouet",
+ "sources" : {
+ "primary-config-data" : {
+ "type" : "source-rest",
+ "properties" : {
+ "type" : "JSON",
+ "verb" : "POST",
+ "endpoint-selector" : "ipam-1",
+ "url-path" : "/api/ipam/prefixes/$prefixId/available-ips/",
+ "path" : "",
+ "input-key-mapping" : {
+ "prefixId" : "prefix-id"
+ },
+ "output-key-mapping" : {
+ "address" : "address",
+ "id" : "id"
+ },
+ "key-dependencies" : [ "prefix-id" ]
+ }
+ }
+ }
+ } \ No newline at end of file
diff --git a/docs/datadictionary/dt-netbox-ip.rst b/docs/datadictionary/dt-netbox-ip.rst
new file mode 100644
index 000000000..9410580fb
--- /dev/null
+++ b/docs/datadictionary/dt-netbox-ip.rst
@@ -0,0 +1,22 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 IBM.
+
+dt-netbox-ip code
+=================
+
+{
+ "version": "1.0.0",
+ "description": "This is Netbox IP Data Type",
+ "properties": {
+ "address": {
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "derived_from": "tosca.datatypes.Root"
+}
diff --git a/docs/datadictionary/index.rst b/docs/datadictionary/index.rst
index 24050000e..64abdece0 100644
--- a/docs/datadictionary/index.rst
+++ b/docs/datadictionary/index.rst
@@ -13,12 +13,9 @@ A Resource definition models the how a specific resource can be resolved.
A resource is a variable/parameter in the context of the service. It can be anything, but it should not be confused with SDC or Openstack resources.
-A Resource definition can have multiple sources to handle resolution in different ways.
-
-The main goal of Resource definition is to define re-usable entity that could be shared.
-
-Creation of data dictionaries is a standalone activity, separated from the blueprint design.
+A Resource definition can have multiple sources to handle resolution in different ways. The main goal of Resource definition is to define re-usable entity that could be shared.
+Creation of Resource definition is a standalone activity, separated from the blueprint design.
As part of modelling a Resource definition entry, the following generic information should be provided:
@@ -28,7 +25,7 @@ As part of modelling a Resource definition entry, the following generic informat
:width: 7.88889in
:height: 4.43750in
-Bellow are properties that all the resource source have will have
+Below are properties that all the resource source have will have
The modeling does allow for data translation between external capability and CDS for both input and output key mapping.
@@ -45,33 +42,12 @@ vf-module-model-customization-uuid and vf-module-label are two data dictionaries
Here is how input-key-mapping, output-key-mapping and key-dependencies can be used:
-vf-module-label Resource definition
-
-{
- "name" : "vf-module-label",
- "tags" : "vf-module-label",
- "updated-by" : "adetalhouet",
- "property" : {
- "description" : "vf-module-label",
- "type" : "string"
- },
- "sources" : {
- "primary-db" : {
- "type" : "source-primary-db",
- "properties" : {
- "type" : "SQL",
- "query" : "select sdnctl.VF_MODULE_MODEL.vf_module_label as vf_module_label from sdnctl.VF_MODULE_MODEL where sdnctl.VF_MODULE_MODEL.customization_uuid=:customizationid",
- "input-key-mapping" : {
- "customizationid" : "vf-module-model-customization-uuid"
- },
- "output-key-mapping" : {
- "vf-module-label" : "vf_module_label"
- },
- "key-dependencies" : [ "vf-module-model-customization-uuid" ]
- }
- }
- }
-}
+.. toctree::
+ :maxdepth: 1
+
+resourceDefintionCode
+
+
Resource source:
@@ -81,7 +57,7 @@ Defines the contract to resolve a resource.
A resource source is modeled, following TOSCA_ node type definition and derives from the Resource_ source.
-Also please click below for detailed resource source details
+Also please click below for resource source available details
.. toctree::
:maxdepth: 1
@@ -89,4 +65,4 @@ Also please click below for detailed resource source details
resourcesource
.. _TOSCA: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html#DEFN_ENTITY_NODE_TYPE
-.. _Resource_: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource \ No newline at end of file
+.. _Resource: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource \ No newline at end of file
diff --git a/docs/datadictionary/resourceDefinitionCode.rst b/docs/datadictionary/resourceDefinitionCode.rst
new file mode 100644
index 000000000..a91767678
--- /dev/null
+++ b/docs/datadictionary/resourceDefinitionCode.rst
@@ -0,0 +1,48 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 IBM.
+
+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"
+}
diff --git a/docs/media/image0.jpg b/docs/image0.jpg
index dce3cee25..dce3cee25 100644
--- a/docs/media/image0.jpg
+++ b/docs/image0.jpg
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
index 5f3902687..ed558bf59 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -27,7 +27,7 @@ Tosca Model Reference:
|image0|
-.. |image0| image:: media/image0.jpg
+.. |image0| image:: image0.jpg
:width: 7.88889in
:height: 4.43750in
@@ -46,8 +46,8 @@ MicroServices:
:maxdepth: 1
:glob:
- controllerBlueprintStudioProcessor
- bluePrintsProcessor
+ controllerBlueprintStudioProcessorMS
+ bluePrintsProcessorMS
Architecture:
=============
@@ -58,7 +58,7 @@ The GUI handles direct user input and allows for displaying both design time and
|image0|
-.. |image0| image:: media/CDS_architecture.jpg
+.. |image0| image:: CDS_architecture.jpg
:height: 4.43750in
:width: 7.88889in
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 000000000..ac72b425f
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,63 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 IBM.
+
+Installation
+============
+
+ONAP is meant to be deployed within a Kubernetes environment. Hence, the de-facto way to deploy CDS is through Kubernetes.
+
+ONAP also package Kubernetes manifest as Chart, using Helm.
+
+Prerequisite
+============
+
+https://docs.onap.org/en/latest/guides/onap-developer/settingup/index.html
+
+Setup local Helm
+================
+
+helm repo
+
+* helm serve &
+* helm repo add local http://127.0.0.1:8879
+
+Get the chart
+=============
+
+Make sure to checkout the release to use, by replacing $release-tag in bellow command
+
+git clone https://gerrit.onap.org/r/oom
+git checkout tags/$release-tag
+cd oom/kubernetes
+make cds
+
+Install CDS
+===========
+
+helm install --name cds cds
+
+Result
+======
+
+$ kubectl get all --selector=release=cds
+NAME READY STATUS RESTARTS AGE
+pod/cds-blueprints-processor-54f758d69f-p98c2 0/1 Running 1 2m
+pod/cds-cds-6bd674dc77-4gtdf 1/1 Running 0 2m
+pod/cds-cds-db-0 1/1 Running 0 2m
+pod/cds-controller-blueprints-545bbf98cf-zwjfc 1/1 Running 0 2m
+NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
+service/blueprints-processor ClusterIP 10.43.139.9 <none> 8080/TCP,9111/TCP 2m
+service/cds NodePort 10.43.254.69 <none> 3000:30397/TCP 2m
+service/cds-db ClusterIP None <none> 3306/TCP 2m
+service/controller-blueprints ClusterIP 10.43.207.152 <none> 8080/TCP 2m
+NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
+deployment.apps/cds-blueprints-processor 1 1 1 0 2m
+deployment.apps/cds-cds 1 1 1 1 2m
+deployment.apps/cds-controller-blueprints 1 1 1 1 2m
+NAME DESIRED CURRENT READY AGE
+replicaset.apps/cds-blueprints-processor-54f758d69f 1 1 0 2m
+replicaset.apps/cds-cds-6bd674dc77 1 1 1 2m
+replicaset.apps/cds-controller-blueprints-545bbf98cf 1 1 1 2m
+NAME DESIRED CURRENT AGE
+statefulset.apps/cds-cds-db 1 1 2m \ No newline at end of file