helm init --history-max 200 # To install tiller to target Kubernetes if not yet installed
helm serve &
helm repo add local http://127.0.0.1:8879

git clone https://gerrit.onap.org/r/oom
git checkout tags/$release-tag
cd oom/kubernetes
make common
make cds

helm install --name cds cds

Have the HEAT template along with the HEAT environment file.

or

Have the Helm chart along with the Values.yaml file

(CDS supports, but whether SO → Multicloud support for Helm/K8S is different story)

or

...

Have the configuration template to apply on the VNF.

XML for NETCONF

1. JSON / XML for RESTCONF
2. JSON for Ansible
3. etc...

Value will be given as input in the request.

Value will be defaulted in the model.

Use token based authentication

• token

Use basic authentication

• username
• password

Use SSL basic authentication

• keystore type
• truststore
• truststore password
• keystore
• keystore password

Value will be resolved through the execution of a script.

List of placeholders used for

• URI
• Payload

List of placeholders used for

• SQL statement

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

{
    "id": 4,
    "address": "192.168.10.2/32",
    "vrf": null,
    "tenant": null,
    "status": 1,
    "role": null,
    "interface": null,
    "description": "",
    "nat_inside": null,
    "created": "2018-08-30",
    "last_updated": "2018-08-30T14:59:05.277820Z"
}

{
    "tags" : "oam-local-ipv4-address",
    "name" : "create_netbox_ip",
    "property" : {
      "description" : "netbox ip",
      "type" : "string"
    },
    "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" : "primary-aai-data",
  "tags" : "primary-aai-data",
  "updated-by" : "Steve, Siani <steve.djissitchi@bell.ca>",
  "property" : {
    "description" : "primary-aai-data",
    "type" : "string"
  },
  "sources" : {
    "default": {
      "type": "source-default",
      "properties": {
      }
    },
    "input": {
      "type": "source-input",
      "properties": {
      }
    },
    "primary-aai-data" : {
      "type" : "source-rest",
      "properties": {
        "type": "JSON",
        "url-path": "$aai-port/aai/v14/network/generic-vnfs/generic-vnf/$vnf-id",
        "path": "",
        "input-key-mapping": {
          "aai-port": "port",
          "vnf-id": "vnf-id"
        },
        "output-key-mapping": {
        },
        "key-dependencies": [
          "port",
          "vnf-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": "Scripts/python/DescriptionExample.py",       
        "key-dependencies": [
          "vf-module-type"
        ]
      }
    }
  }
}

#  Copyright (c) 2019 Bell Canada.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.

from abstract_ra_processor import AbstractRAProcessor
from blueprint_constants import *
from java.lang import Exception as JavaException

class DescriptionExample(AbstractRAProcessor):

    def process(self, resource_assignment):
        try:
            # get key-dependencies value
            value = self.raRuntimeService.getStringFromResolutionStore("vf-module-type")
            
            # logic based on key-dependency outcome
            result = ""
            if value == "vfw":
                result = "This is the Virtual Firewall entity"
            elif value == "vsn":
                result = "This is the Virtual Sink entity"
            elif value == "vpg":
                result = "This is the Virtual Packet Generator"

            # set the value of resource getting currently resolved
            self.set_resource_data_value(resource_assignment, result)

        except JavaException, err:
          log.error("Java Exception in the script {}", err)
        except Exception, err:
          log.error("Python Exception in the script {}", err)
        return None

    def recover(self, runtime_exception, resource_assignment):
        print self.addError(runtime_exception.getMessage())
        return None

{
    "id": 4,
    "address": "192.168.10.2/32",
    "vrf": null,
    "tenant": null,
    "status": 1,
    "role": null,
    "interface": null,
    "description": "",
    "nat_inside": null,
    "created": "2018-08-30",
    "last_updated": "2018-08-30T14:59:05.277820Z"
}

{
  "version": "1.0.0",
  "description": "This is Netbox IP Data Type",
  "properties": {
    "address": {
      "required": true,
      "type": "string"
    },
    "id": {
      "required": true,
      "type": "integer"
    }
  },
  "derived_from": "tosca.datatypes.Root"
}

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

{
  "workflows": {
    "resource-assignment": {
      "steps": {
        "resource-assignment-process": {
          "description": "Resource Assign Workflow",
          "target": "resource-assignment-process"
        }
      },
      "inputs": {
        "template-prefix": {
          "required": true,
          "type": "string"
        },
        "resolution-key": {
          "required": true,
          "type": "string"
        },
        "resource-assignment-properties": {
          "description": "Dynamic PropertyDefinition for workflow(resource-assignment).",
          "required": true,
          "type": "dt-resource-assignment-properties"
        }
      },
      "outputs": {
        "meshed-template": {
          "type": "json",
          "value": {
            "get_attribute": [
              "SELF",
              "assignment-params"
            ]
          }
        }
      }
    }
  }
}

{
  "workflows": {
    "config-assign": {
      "steps": {
        "config-assign-process": {
          "description": "Config Assign Workflow",
          "target": "config-assign-process"
        }
      },
      "inputs": {
        "resolution-key": {
          "required": true,
          "type": "string"
        },
        "config-assign-properties": {
          "description": "Dynamic PropertyDefinition for workflow(config-assign).",
          "required": true,
          "type": "dt-config-assign-properties"
        }
      },
      "outputs": {
        "dry-run": {
          "type": "json",
          "value": {
            "get_attribute": [
              "SELF",
              "assignment-params"
            ]
          }
        }
      }
    }
  }
}

{
  "workflow": {
    "config-deploy": {
      "steps": {
        "config-deploy": {
          "description": "Config Deploy using Python (Netconf) script",
          "target": "config-deploy-process"
        }
      },
      "inputs": {
        "resolution-key": {
          "required": true,
          "type": "string"
        },
        "config-deploy-properties": {
          "description": "Dynamic PropertyDefinition for workflow(config-deploy).",
          "required": true,
          "type": "dt-config-deploy-properties"
        }
      }
    }
  }
}

resource-assignment-process

config-assign-process

config-deploy-process

├── CBA-archive-name                             # CBA Root Directory        
|   └── Definitions/        
│       └── CBA_configuration_file.json          # CBA configuration file (Mandatory)               
|   └── Environments/                            # All environment files contained in this folder are loaded in Blueprint processor run-time       
│       └── env-prod.properties                                             
│       └── env-test.properties        
|   └── Plans/        
│       └── CONFIG_DirectedGraphExample.xml      # Directed graph artifact        
|   └── Scripts/                                 # Script used for capability resource resolution
│       └── kotlin/          
│           └── script_kotlin.cba.kts
│       └── ansible/          
│           └── ansible_file.yaml
│       └── python/          
│           └── SamplePython.py                     
|   └── TOSCA-Metadata/        
│       └── TOSCA.meta                           # CBA entry point (Mandatory)                
|   └── Templates/        
│       └── example1-template.jinja              # Template file that will dynamic represent a payload in some execution node (Extensions supported: .vtl and .jinja)    
│       └── example1-mapping.json                # List of variables that will be resolved to fulfill the jinja template
│       └── example2-template.vtl                # Velocity Template file 
│       └── example2-mapping.json                # Mapping file for velocity template

"ansible-remote-endpoint" : {
   "type" : "token-auth",
   "url" : "http://ANSIBLE_IP_ADDRESS",
   "token" : "Bearer J9gEtMDqf7P4YsJ74fioY9VAhLDIs1"
}

"my-workflow1" : {
   "steps" : {
      "execute-script" : {
         "description" : "some description",
         "target" : "my-workflow-target-node-node-template",
         "activities" : [ {
            "call_operation" : ""
         } ]
      }
   },
   "inputs" : {
      "my-input" : {
         "required" : false,
         "type" : "string"
      }
   }
}

"my-workflow-target-node-node-template" : {
   "type" : "node-template-execution-type",
   "interfaces" : {
      "NodeTemplateInterface" : {
         "operations" : {
            "process" : {
               "implementation" : {
                  "primary" : "component-script"
               },
               "inputs" : {
                  "command" : "python SamplePython.py",
                  "packages" : [ {
                     "type" : "pip",
                     "package" : [ "pyaml" ]
                  } ],
                  "argument-properties" : "*remote-argument-properties",
                  "dynamic-properties" : "*remote-argument-properties"
               }
            }
         }
      }
   },
   "artifacts" : {
      "component-script" : {
         "type" : "artifact-script-python",
         "file" : "Scripts/python/SamplePython.py"
      }
   }
}

├── component-resource-resolution                             # CBA Root Directory        
|   └── Interface:        
│       ├── ResourceResolutionComponent                       # Component to resolve resources               
│           └── Resolution approaches:                        
│       	    ├── rr-processor-source-capability             # Resolve using Capability scripts such as jython or kotlin
│       		├── rr-processor-source-processor-db           # Resolve using database query
│       		├── rr-processor-source-default                # resolve by getting default value provided
│       		├── rr-processor-source-rest                   # Resolve using REST API request
├── component-jython-executor                                 # Component to execute Jython scripts
|   └── Interface:        
│       ├── ComponentJythonExecutor
├── component-remote-python-executor                          # Component to execute remote python scripts
|   └── Interface:        
│       ├── ComponentRemotePythonExecutor
├── component-restconf-executor                               # Component to execute Restconf operations 
|   └── Interface:        
│       ├── ComponentRestconfExecutor
├── component-netconf-executor                                # Component to execute netconf operations
|   └── Interface:        
│       ├── ComponentNetconfExecutor
├── component-cli-executor                                    # Cli component
|   └── Interface:        
│       ├── ComponentCliExecutor
├── component-remote-ansible-executor                         # Component to execute remote ansible playbook
|   └── Interface:        
│       ├── ComponentRemoteAnsibleExecutor

"my-workflow2" : {
   "steps" : {
      "execute-script" : {
         "description" : "some description here...",
         "target" : "my-workflow-target-node-template-with-DG",
         "activities" : [ {
            "call_operation" : ""
         } ]
      }
   },
   "inputs" : {
      "my-input" : {
         "required" : false,
         "type" : "string"
      }
   }
}

"my-workflow-target-node-template-with-DG" : {
   "type" : "dg-generic",
   "properties" : {
      "content" : {
         "get_artifact" : [ "SELF", "dg-my-workflow1-target-node-template-with-DG" ]
      },
      "dependency-node-templates" : [ "target-node-template1", "target-node-template2" ]
   },   
   "artifacts" : {
       "dg-my-workflow1-target-node-template-with-DG" : {
          "type" : "artifact-directed-graph",
          "file" : "Plans/CONFIG_DirectedGraphExample.xml"
       }
   }
}

<service-logic
  xmlns='http://www.onap.org/sdnc/svclogic'
  xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  xsi:schemaLocation='http://www.onap.org/sdnc/svclogic ./svclogic.xsd' module='CONFIG' version='1.0.0'>
    <method rpc='dg-operation' mode='sync'>
        <block atomic="true">
            <execute plugin="target-node-template1" method="process">
                <outcome value='failure'>
                    <return status="failure">
                    </return>
                </outcome>
                <outcome value='success'>
                    <execute plugin="target-node-template2" method="process">
                        <outcome value='failure'>
                            <return status="failure">
                            </return>
                        </outcome>
                        <outcome value='success'>
                            <return status='success'>
                            </return>
                        </outcome>
                    </execute>
                </outcome>
            </execute>
        </block>
    </method>
</service-logic>

TOSCA-Meta-File-Version: 1.0.0
CSAR-Version: 1.0
Created-By: Steve Siani <alphonse.steve.siani.djissitchi@ibm.com>
Entry-Definitions: Definitions/CBA_configuration_file_name.json
Template-Name: baseconfiguration
Template-version: 1.0.0
Template-Tags: Steve Siani, remote_ansible

├── CBA-archive-name                             # CBA Root Directory        
|   .
|   .
|   .               
|   └── Environments/                            # All environment files contained in this folder are loaded in Blueprint processor run-time       
│       └── env-prod.properties                                             
│       └── env-test.properties   
│       └── AdditionalApplications.properties      
|   .
|   .
|   . 

env-prod.ansible_ssh_user=<username>
env-prod.ansible_ssh_pass=<password>
env-prod.evi_id=<id>
env-prod.service_db_url=<service_db_url>
env-prod.topology_url=<topology_url>
env-prod.resource_allocator_url=<resource_allocator>
...

env-test.ansible_ssh_user=<username>
env-test.ansible_ssh_pass=<password>
env-test.evi_id=<id>
env-test.service_db_url=<service_db_url>
env-test.topology_url=<topology_url>
env-test.resource_allocator_url=<resource_allocator>
...

val username = blueprintRuntimeService.getNodeTemplateAttributeValue("BPP", "env-test.ansible_ssh_user").asText()

site_id: {{ site_id }}
tenant_name: {{ tenant_name }}
Interfaces:
{%- for interface in interfaces %}
    interface {{ interface.name }}
    description {{ interface.description }}
    ipv4 address {{ interface.ipv4 }}
    mtu {{ interface.mtu }}
{%- endfor %}

site_id: ${site_id}
tenant_name: ${tenant_name}
Interfaces:
#foreach( $interface in $interfaces )
    interface $interface.name
    description $interface.description
    ipv4 address $interface.ipv4
    mtu $interface.mtu
#end

[
	{
		"name": "environment",
		"input-param": true,
		"property": {
			"type": "string"
		},
		"dictionary-name": "input-source",
		"dictionary-source": "input",
		"dependencies": []
	},
	{
		"name": "site_id",
		"input-param": true,
		"property": {
			"type": "string"
		},
		"dictionary-name": "input-source",
		"dictionary-source": "input",
		"dependencies": []
	},
	{
		"name": "tenant_name",
		"input-param": true,
		"property": {
		  "type": "string"
		},
		"dictionary-name": "input-source",
		"dictionary-source": "input",
		"dependencies": []
	},
    {
		"name": "interfaces",
		"input-param": true,
		"property": {
		   "type": "list",
		   "entry_schema": {
		      "type": "string"
		   }
		},
		"dictionary-name": "properties-capability-source",
		"dictionary-source": "capability",
		"dependencies": ["environment"]
	}
]

    {
		"name": "interfaces",
		"input-param": true,
		"property": {
		   "type": "list",
		   "entry_schema": {
		      "type": "string"
		   }
		},
		"dictionary-name": "properties-capability-source",
		"dictionary-source": "capability",
		"dependencies": ["environment"]
	}

    {
       "name": "properties-capability-source",
       "updated-by": "Steve Alphonse Siani, alphonse.steve.siani.djissitchi@ibm.com",
       "tags": "properties-capability-source",
       "property" :{
           "description": "Data dictionary used to read properties.",
           "type": "string"
       },
       "sources": {
           "input": {
              "type": "source-input"
            },
           "default": {
              "type": "source-default",
              "properties": {}
           },
           "capability": {
              "type": "source-capability",
              "properties" : {
                 "script-type" : "jython",
                 "script-class-reference" : "Scripts/python/ResolvProperties.py"
              }
           }
       }
    }

from abstract_ra_processor import AbstractRAProcessor
from blueprint_constants import *

class ResolvProperties(AbstractRAProcessor):

    def process(self, resource_assignment):
        result = ""
        env = ""
        attribute = ""
        # get dependencies result
        value = self.raRuntimeService.getStringFromResolutionStore("environment")
        
        #logic based on dependency outcome
        env = "env-" + value

        if resource_assignment.name == "ansible_ssh_user":
            attribute = env + ".ansible_ssh_user"
        if resource_assignment.name == "ansible_ssh_pass":
            attribute = env + ".ansible_ssh_pass"
        if resource_assignment.name == "evi_id":
            attribute = env + ".evi_id"
        if resource_assignment.name == "service_db_url":
            attribute = env + ".service_db_url"
        if resource_assignment.name == "topology_url":
            attribute = env + ".topology_url"
        if resource_assignment.name == "resource_allocator_url":
            attribute = env + ".resource_allocator_url"

        result = self.raRuntimeService.getNodeTemplateAttributeValue("BPP", attribute).asText()

        # set value for resource getting currently resolved
        self.set_resource_data_value(resource_assignment, result)
        return None

    def recover(self, runtime_exception, resource_assignment):
        log.error("Exception in the script {}", runtime_exception)
        print self.addError(runtime_exception.cause.message)
        return None