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 defines a specifc resource that can be resolved using the bellow supported sources.
A data dictionary can support multiple sources.
The main goal of data dictionary is to define generic entity that could be shared accross services.
Resolution sources
Input
Default
SQL
Default (SDNC DB)
Generic
REST
Default (SDNC MDSAL)
Generic
Capability
Python
Kotlin
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