Page History

...

1. Gather what you need:

   Deck of Cards
   id prerequisite
   Card label instantiation Have the HEAT template along with the HEAT environment file. Card label post-instantiation Have the configuration template to apply on the VNF. XML for NETCONF JSON / XML for RESTCONF not supported yet - CLI

   
   

2. Identify which values 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.

   Card
   label instantiation
   Here are the information to capture for each dynamic cloud parameters Cloud Parameter Resource name How to resolve Input Ingredients for resolution Output of resolution Either the cloud parameters name or the placeholder given for the dynamic property. Deck of Cards Name as in the HEAT environment file Deck of Cards id how to resolve Card label Input Value will be given as input in the request. Card label Default Value will be defaulted in the model. Card label REST Value will be resolved by sending a query to the REST system Auth URL URI Payload VERB Supported Auth type Deck of Cards id auth Card label Token Use token based authentication token Card label Basic Use basic authentication username password Card label SSL Use SSL basic authentication keystore type truststore truststore password keystore keystore password http(s)://<host>:<port> /xyz JSON formatted payload HTTP method Card label SQL 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. Deck of Cards id input Card label REST List of placeholders used for URI Payload Card label DB 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.

...