TOSCA based JSON formatted model following standard: 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 ├── Environnments ├── 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
3rd party system
Interaction with 3rd party systems is made plug-able within the CDS design. A 3rd party system might be used by multiple resources, or by multiple scripts.
In order to share this information, TOSCA provide a way to create macro using dsl_definitions
, based on TOSCA:
- 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
Currently, this is used for resolving resources through REST or SQL, but it could be used for anything.
Artifact Type
Represents the type of a file, used to target according implementation.
The tosca.artifacts.Implementation
was created, derived from tosca.artifacts.Root
git-link
Based on the TOSCA artifact type: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html#_Toc430015686
Bellow is a list of supported artifact types.
artifact-mapping-resource
This type is meant to represent mapping files. Defines the contract of each resource to be resolved. Each placeholder in a template must have a corresponding mapping definition, see CDS Concepts. File must have .json extension.
git-link
artifact-template-velocity
Represents a velocity template. They allow to insert logic within any type of template/text. File must have .vtl extension.
A template can represent anything, such as device config, payload to interact with 3rd party systems, resource-accumulator template, etc...
Velocity reference document: http://velocity.apache.org/engine/1.7/user-guide.html
git-link
artifact-directed-graph
Represents a direct graph. File must have .json or .xml extension.
git-link
{ "description": "Directed Graph File", "version": "1.0.0", "file_ext": [ "json", "xml" ], "derived_from": "tosca.artifacts.Implementation" }
Node type
Represents a re-usable entity using to define a manageable software component.
TOSCA definition: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html#_Toc430015691
tosca.nodes.Component
This is the root level for all component functionalities.
tosca.nodes.component.Jython
Identifies the Jython component, used to process Python code through Java.
See more about Jython: https://www.jython.org/
tosca.nodes.component.Kotlin
Identifies the Koltin script component, used to process Kotlin script.
tosca.nodes.VNF
Identifies a VNF, can be used to correlate any type of VNF related information.
vnf-netconf-device
Represents the VNF information to establish a NETCONF communication.
tosca.nodes.ResourceSource
Identifies a resource source, used during resource resolution.
Data type
Represents the schema of a specific type of data.
TOSCA definition: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html#_Toc430015688
datatype-resource-assignment
Used to define CDS Concepts
That datatype represent an resource to be resolved.
Property | Description |
---|---|
input-param | Whether the resource can be provided as input. |
dictionary-name | Reference to the name of the data dictionary (see CDS Concepts). |
dictionary-source | Reference the source to use to resolve the resource (see Resource source). |
dependencies | List of dependencies required to resolve this resource. |
updated-date | Date when mapping was upload. |
updated-by | Name of the person that updated the mapping. |
Here is the model
Component
Represents a functionality.
component-resource-resolution
Used to perform resolution of resources.
Make use of CDS Concepts and CDS Concepts
Error rendering macro 'code': Invalid value specified for parameter 'com.atlassian.confluence.ext.code.render.InvalidValueException'{ "description": "This is Resource Assignment Component API", "version": "1.0.0", "attributes": { "assignment-params": { "required": true, "type": "string" } }, "capabilities": { "component-node": { "type": "tosca.capabilities.Node" } }, "interfaces": { "ResourceResolutionComponent": { "operations": { "process": { "inputs": { "resolution-key": { "description": "Key for service instance related correlation.", "required": false, "type": "string" }, "store-result": { "description": "Whether or not to store the output.", "required": false, "type": "boolean" }, "artifact-prefix-names": { "required": true, "description": "Template , Resource Assignment Artifact Prefix names", "type": "list", "entry_schema": { "type": "string" } }, "dynamic-properties": { "description": "Dynamic Json Content or DSL Json reference.", "required": false, "type": "json" } }, "outputs": { "resource-assignment-params": { "required": true, "type": "string" }, "status": { "required": true, "type": "string" } } } } } }, "derived_from": "tosca.nodes.Component" }
component-jython-executor
Use to execute python scripts.
component-netconf-executor
Use to execute NETCONF commands within a script.
component-restconf-executor
Use to execute RESTCONF commands within a script.
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, and uses CDS Concepts and artifact-template-velocity.
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
Resource accumulator
In order to resolve HEAT environment variables, resource accumulator templates are being in used in 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 component-netconf-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
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 should be provided:
Property | Description | Scope |
---|---|---|
name | Data dictionary name | Mandatory |
tags | Information related | Mandatory |
updated-by | The creator | Mandatory |
property | Defines type and description, as nested JSON | Mandatory |
sources | List of resource source | Mandatory |
Bellow are properties that all the resource source have will have:
Property | Description | Scope |
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. | Optional |
output-key-mapping | name of the resource to be resolved mapped to the value resolved by the request/query. | Optional |
key-dependencies | list of data dictionary instances to be resolved prior the resolution of this specific resource. | Optional |
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:
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
## TODO NODE TYPE
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
Default
Expects the value to be defaulted in the model itself.
git link
SQL
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 |
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.
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 |
Connection to a specific REST system can be expressed through the endpoint-selector
property, which refers to a macro defining the information about the REST system the connect to. Understand TOSCA Macro in the context of CDS.
Few ways are available to authenticate to the REST system:
TBD - The trustore and the keystore can be provide as environment through the Environment folder in the CBA.
"get_attribute": [
"BPP",
"trustore"
]
Capability
Excepts a script to be provided.
git-link
Property | Description | Scope |
---|---|---|
script-type | The type of the script - default value is Koltin | Optional |
script-class-reference | The name of the class to use to create an instance of the script | Mandatory |
instance-dependencies | Platform dependencies to be injected within the script instance. Available dependencies are:
| Optional |