TOSCA based JSON formatted model: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html

Most of the TOSCA modeled entity presented in the bellow documentation can be found here: git link

Controller Blueprint Archived (.cba)

The Controller Blueprint Archived is the overall service design, fully model-driven, package needed to automate the resolution of resources for instantiation and any config provisioning operation, such as day0, day1 or day2 configuration.

The CBA is .zip file, comprised of the following folder structure, the files may vary:

.
├── Definitions
│   ├── blueprint.json							overall TOSCA modeled blueprint
│   ├── artifact_types.json 					(generated)
│   ├── data_types.json 						(generated)
│   ├── node_types.json 						(generated)
│   ├── policy_types.json 						(generated)
│   ├── relationship_types.json 				(generated)
│   ├── resources_definition_types.json 		(generated based on data dictionary)
│   └── *-mapping.json							one per template
├── Plans
│   ├── ResourceAssignment.xml					DG backing the resource-assignment Workflow (name is free for all)
│   ├── ConfigAssign.xml						DG backing the config-assign Workflow (name is free for all)
│   └── ConfigDeploy.xml						DG backing the config-deploy Workflow (name is free for all)
├── Scripts
│   └── python
│       ├── ConfigDeployExample.py				Python script using python Netconf client
│       ├── ResourceResolutionExample.py		Python script with logic to resolve a parameter
│       └── __init__.py
├── TOSCA-Metadata
│   └── TOSCA.meta								Meta-data of overall package
└── Templates
    └── *-template.vtl							one per template

Data dictionary

A data dictionary 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 data dictionary can have multiple sources to handle resolution in different ways.

The main goal of data dictionary is to define re-usable entity that could be shared across services.

Creation of data dictionaries is a standalone activity, separated from the blueprint design.

As part of modelling a data dictionary entry, the following generic information could be provided:

name
tags
updated-by
property
sources
- <type of source>: see resolution sources bellow
- properties
  - input-key-mapping: map of resources required to perform the request/query. The left hand-side is what is used within the query/request, the right hand side refer to a data dictionary instance.
  - output-key-mapping: name of the resource to be resolved mapped to the value resolved by the request/query.
  - key-dependencies: list of data dictionary instances to be resolved prior the resolution of this specific resource.
  - <query/request>: either SQL statement or REST URI

Property	Description	Scope
name	Data dictionary name	Mandatory
tags	Information related	Mandatory
updated-by	The creator

Example
vf-module-model-customization-uuid and vf-module-label are two data dictionaries. A SQL table, VF_MODULE_MODEL, exist to correlate them.

Here is how input-key-mapping, output-key-mapping and key-dependencies can be used:

vf-module-label data dictionary

{
  "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" ]
      }
    }
  }
}

Regardless the source used within a Data Dictionary, the resource value can be overridden through input.

Resource source

Defines the contract to resolve a resource.

A resource source is modeled, following TOSCA node_type definition, and derives from the tosca.nodes.Root

git link

tosca.nodes.ResourceSource

{
  "description": "TOSCA base type for Resource Sources",
  "version": "1.0.0",
  "derived_from": "tosca.nodes.Root"
}

ONAP defines common resource source definitions, derived by the tosca.nodes.ResourceSource

Input

Expects the value to be provided as input to the request.

git link

source-input

{
  "description": "This is Input Resource Source Node Type",
  "version": "1.0.0",
  "properties": {},
  "derived_from": "tosca.nodes.ResourceSource"
}

Default

Expects the value to be defaulted in the model itself.

git link

source-default

{
  "description": "This is Default Resource Source Node Type",
  "version": "1.0.0",
  "properties": {},
  "derived_from": "tosca.nodes.ResourceSource"
}

SQL (FIXME - To be tested)

Expects the SQL query to be modeled; that SQL query can be parameterized, and the parameters be other resources resolved through other means. If that's the case, this data dictionary definition will have to define key-dependencies along with input-key-mapping.

CDS is currently deployed along the side of SDNC, hence the primary database connection provided by the framework is to SDNC database.

git-link

Property	Description	Scope
type	Database type, only SQL supported for now	Mandatory
endpoint-selector	Specify which database to connect to	Optional
query	Statement to execute	Mandatory

source-primary-db

{
  "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"
}

Connection to a specific database can be expressed through the endpoint-selector property, which refers to a macro defining the information about the database the connect to. Understand TOSCA Macro in the context of CDS.

dynamic-db-source

"dsl_definitions": {
  "dynamic-db-source": {
    "type": "maria-db",
    "url": "jdbc:mysql://localhost:3306/sdnctl",
    "username": "sdnctl",
    "password": "sdnctl"
  }
}

REST

Expects the URI along with the VERB and the payload, if needed.

CDS is currently deployed along the side of SDNC, hence the default rest connection provided by the framework is to SDNC MDSAL.

git-link

Property	Description	Scope
type	Expected output value, only JSON supported for now	Optional
verb	HTTP verb for the request - default value is GET	Optional
payload		Optional
endpoint-selector	Specify which REST system to connect to	Optional
url-path	URI	Mandatory
path	JSON path to the value to fetch from the response	Mandatory
expression-type	Path expression type - default value is JSON_PATH	Optional

{
  "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"
}

Capability

Python

Kotlin

Re-usable macro

dsl_definitions

http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html#_Toc430015641

http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html#_Toc430015705

Actifacts

artifact-mapping-resource

artifact-template-velocity

artifact-directed-graph

Node type

component-resource-resolution

component-jython-executor

component-netconf-executor

component-restconf-executor

Data type

vnf-netconf-device

Resource assignment

Component executor

Workflow

A workflow defines an overall action to be taken for the service; it can be composed of a set of sub-actions to execute. Currently, workflows are backed by Directed Graph engine.

A CBA can have as many workflow as needed.

Template

A template is an artifact.

A template is parameterized and each parameter must be defined in a corresponding mapping file.

In order to know which mapping correlate to which template, the file name must start with an artifact-prefix, serving as identifier to the overall template + mapping.

The requirement is as follow:

${artifact-prefix}-template
${artifact-prefix}-mapping

Template

A template can represent anything, such as device config, payload to interact with 3rd party systems, resource-accumulator template, etc...

Mapping

Defines the contract of each resource to be resolved. Each placeholder in the template must have a corresponding mapping definition.

A mapping is comprised of:

name
required / optional
type (support complex type)
dictionary-name
dictionary-source
dependencies: this allows to make sure given resources get resolved prior the resolution of the resources defining the dependency.

The dictionary fields reference to a specific data dictionary.

Resource accumulator

In order to resolve HEAT environment variables, resource accumulator templates are being in used for Dublin.

These templates are specific to the pre-instantiation scenario, and relies on GR-API within SDNC.

It is composed of the following sections:

resource-accumulator-resolved-data: defines all the resources that can be resolved directly from the context. It expresses a direct mapping between the name of the resource and its value.
capability-data: defines what capability to use to create a specific resource, along with the ingredients required to invoke the capability and the output mapping.

Scripts

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 netconf-component-executor.

The client can be find here: https://github.com/onap/ccsdk-apps/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

Space shortcuts

Page tree

Controller Blueprint Archived (.cba)

Data dictionary

Resource source

Input

Default

SQL (FIXME - To be tested)

REST

Capability

Python

Kotlin

Re-usable macro

Actifacts

Node type

Data type

Resource assignment

Component executor

Workflow

Template

Template

Mapping

Resource accumulator

Scripts

Library

NetconfClient

ResolutionHelper

Space shortcuts

Page tree

CDS Concepts

Controller Blueprint Archived (.cba)

Data dictionary

Resource source

Input

Default

SQL (FIXME - To be tested)

REST

Capability

Python

Kotlin

Re-usable macro

Actifacts

Node type

Data type

Resource assignment

Component executor

Workflow

Template

Template

Mapping

Resource accumulator

Scripts

Library

NetconfClient

ResolutionHelper