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

Notions

Resource resolution

Component executor

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 (scripts)

Python

Kotlin script

Netconf (through Python)

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.

...

• 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.

  Code Block
  title RA resolved data collapse true
  "resource-accumulator-resolved-data": [ { "param-name": "service-instance-id", "param-value": "${service-instance-id}" }, { "param-name": "vnf_id", "param-value": "${vnf-id}" } ]

  
  

• 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.

  Code Block
  title RA capability payload collapse true
  { "capability-name": "netbox-ip-assign", "key-mapping": [ { "payload": [ { "param-name": "service-instance-id", "param-value": "${service-instance-id}" }, { "param-name": "prefix-id", "param-value": "${private-prefix-id}" }, { "param-name": "vf-module-id", "param-value": "${vf-module-id}" }, { "param-name": "external_key", "param-value": "${vf-module-id}-vpg_private_ip_1" } ], "output-key-mapping": [ { "resource-name": "vpg_private_ip_1", "resource-value": "${vpg_private_ip_1}" } ] } ] }

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.

scripts

If any of the mapping uses a source capabbility to resolve a parameters.

...

Scripts using Netconf or Restconf to push configure the network element.

Scripts

Python or Kotlin

Platform support ability to create scripts either for resource resolution or component executor.