This guide is geared to provide information regarding  how to do service design to automate instantiation and day0 configuration.

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

Design time

Bellow are the requirements to enable automation for a service within ONAP.

For instantiation, the goal is to be able to automatically resolve all the HEAT environment variables, called cloud parameters.

For post-instantiation, the goal is to configure the VNF with initial configuration.

Prerequisite

1. Gather what you need:

   Have the HEAT template along with the HEAT environment file.

   Have the configuration template to apply on the VNF.

   1. 
      
      1. XML for NETCONF
      2. JSON / XML for RESTCONF
      3. not supported yet - CLI
2. Identify which resources are static and dynamic

3. Create and fill-in the a table for all the dynamic values

   While doing so, identify the resources using the same process to be resolved; for instance, if two IPs has to be resolved through the same IPAM, the process the resolve the IP is the same.

   Here are the information to capture for each dynamic cloud parameters

   Resource name	How to resolve	Ingredients for resolution	Output of resolution
   Either the cloud parameters name or the placeholder given for the dynamic property.	Value will be given as input in the request. Value will be defaulted in the model. Value will be resolved by sending a query to the REST system Auth URL URI Payload VERB Supported Auth type Use token based authentication token Use basic authentication username password Use SSL basic authentication keystore type truststore truststore password keystore keystore password http(s)://<host>:<port> /xyz JSON formatted payload HTTP method Value will be resolved by sending a SQL statement to the DB system Type URL Query Username Password Only maria-db supported for now jdbc:mysql://<host>:<port>/db SQL statement	These are all the required parameters to process the resolution of that particular resources. List of placeholders used for URI Payload List of placeholders used for SQL statement	This is the expected result from the system, and you should know what value out of the response is of interest for you. If it's a JSON payload, then you should think about the json path to access to value of interest.

Data dictionary

For each unique identified dynamic resource, along with all their ingredients, we need to create a data dictionary.

See modeling concept to understand context: CDS Modeling Concepts#ResourceDefinitionakaDatadictionary

Bellow are examples for each resource source

{
    "tags": "unit-number",
    "name": "unit-number",
    "property": {
      "description": "unit-number",
      "type": "string"
    },
    "updated-by": "adetalhouet",
    "sources": {
      "input": {
        "type": "source-input"
      }
    }
  }

{
  "tags": "prefix-id",
  "name": "prefix-id",
  "property" :{
    "description": "prefix-id",
    "type": "integer"
  },
  "updated-by": "adetalhouet",
  "sources": {
    "default": {
      "type": "source-default",
      "properties": {
      }
    }
  }
}

{
    "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" : "/address",
          "input-key-mapping" : {
            "prefixId" : "prefix-id"
          },
          "output-key-mapping" : {
            "address" : "address"
          },
          "key-dependencies" : [ "prefix-id" ]
        }
      }
    }
  }

{
  "name": "vf-module-type",
  "tags": "vf-module-type",
  "property": {
    "description": "vf-module-type",
    "type": "string"
  },
  "updated-by": "adetalhouet",
  "sources": {
    "primary-db": {
      "type": "source-primary-db",
      "properties": {
        "type": "SQL",
        "query": "select sdnctl.demo.value as value from sdnctl.demo where sdnctl.demo.id=:vfmoduleid",
        "input-key-mapping": {
          "vfmoduleid": "vf-module-number"
        },
        "output-key-mapping": {
          "vf-module-type": "value"
        },
        "key-dependencies": [
          "vf-module-number"
        ]
      }
    }
  }
}

{
  "tags": "interface-description",
  "name": "interface-description",
  "property": {
    "description": "interface-description",
    "type": "string"
  },
  "updated-by": "adetalhouet",
  "sources": {
    "capability": {
      "type": "source-capability",
      "properties": {
        "script-type": "jython",
        "script-class-reference": "DescriptionExample",
        "instance-dependencies": [

        ]
      }
    }
  }
}

Workflows

The following workflows are contracts established between SO, SDNC and CDS to cover the instantiation and the post-instantiation use cases.

resource-assignment

This action is meant to assign resources needed to instantiate the service. The goal is to resolved all the HEAT environment variables.

This action is triggered by Generic-Resource-API (GR-API) within SDNC as part of the AssignBB orchestrated by SO. Hence it will be triggered for each VNF(s) and VF-Module(s).

In order to know for which entity the action is triggered, one input is required, that is the artifact prefix (see bellow for explanation).

artifacts

For each VNF and VF-Module comprising the service, a combinaison of a template and mapping is needed.

The requirement is as follow for VNF:

${vnf-name}-template
${vnf-name}-mapping

and as follow for VF-Module, where the vf-module-label is actually the name of the HEAT template file.

${vf-module-label}-template
${vf-module-label}-mapping

${vnf-name} and ${vf-module-label} is what we call the artifact prefix.

template

The template has to be a resource accumulator template; that be 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.

  RA resolved data Expand source

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

  RA capability payload Expand source

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

scripts

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

config-assign

This action is meant to assign all the resources and mesh the templates needed for the configuration to apply post-instantiation.

This action is triggered by SO during after the AssignBB has been executed for Service, VNF and VF-Module.

artifacts

Combinaison of templates with respective mappings

Scripts if needed

config-deploy

This action is meant to push the configuration templates defined during the config-assign step for the post-instantiation.

This action is triggered by SO during after the CreateBB has been executed for all the VF-Modules.

artifacts

Combinaison of templates with respective mappings

Scripts using Netconf or Restconf to push configure the network element