BBS Modeling

Table of Contents

Model Overview

BBS use case aims at using ONAP for the design, creation and activation of the High Speed Internet Access CFS.

Model Design

Representation in SDC

Resource Representations

Modeled Resource	SDC Representation	A&AI object	TOSCA file
ONT NNI	Connection Point	cp	ontNni.yaml & ontNni.json (for import)
PON UNI	Connection Point	cp	ponUni.yaml & ponUni.json (for import)
OLT NNI	Connection Point	cp	oltNni.yaml & oltNni.json (for import)
ODN Connection	VNF Virtual Link	N/A
Access Connectivity	Virtual Function Component	generic-vnf	accessConnectivity.yaml
Internet Profile	Virtual Function Component	generic-vnf	internetProfile.yaml
CPE (PNF)	Virtual Function Component	pnf	cpePnf.yaml

Composition of services

Service

Composed Of

HSIA CFS (BBS E2E Service)

CPE VF*
- CPE VFC

ONT-NNI CP

ODN Connection Vnf Virtual Link

PON-UNI CP

Access Connectivity VF
- Access Connectivity VFC

OLT-NNI CP

Internet Profile VF
- Internet Profile VFC

(*) with workaround to model PNF in SDC

Representation in A&AI

Representation in AAI for next releases R4+

Model Parameter Life-cycle

Table on information model 'storage' and discovery-inventory analysis for BBS use case parameters

BBS Parameter Table

ONAP Awareness	SDNC (Access Discovery)	SDC (Service Creation from Portal)	DCAE Registration PNF	SDN-C (Access Service)	DCAE CPE Auth	A&AI
Service (HSIA)
RG MAC Add		Input				Input
Service Type		Input				Input
Upstream Speed		Input				Input
Downstream Speed		Input				Input
Remote ID		Input (Optional)	Input		Input (used to find the CFS associated with PNF)	Input
Orch Status				Derived - Obtained from CFS associated with PNF in PNF Registration	Derived - Obtained from CFS associated w PNF and MAC Address	Input
HSIA Access
CPE/ONT PNF
PNF Name		Input (CorrelationID)	SourceName		SourceName	Input
MAC Address			Input		Input	Input
Manufacturer		Onboarded CSAR Artifact	Input			Input
Serial Number			Input			Input
Model			Input			Input
Type		Onboarded CSAR Artifact	Input			Input
SW Version			Input (Optional)		Input (Optional)	Input
Attachment Point (new field)			Input			Input
CPE Authentication State					Input (Used to derive the CFS orchestration status)
ONT NNI (PORT)				Input from response when access connectivity is created		Input
ODN Virtual Link				Input from response when access connectivity is created		Input
Access Connectivity
Service Type				Input (from CFS)
Upstream Speed				Input (from CFS)
Downstream Speed				Input (from CFS)
PON UNI
CVLAN		Input (Optional)	Input	Input when access connectivity is created or CFS if not in DCAE Reg		Input
Expected ONT ID		Input (Optional)		Input (from CFS)		Input
OLT Name	Input		Derived (Attachment Point)			Input
OLT PON Slot	Input		Derived (Attachment Point)			Input
OLT PON Port	Input		Derived (Attachment Point)			Input
OLT NNI
SVLAN	Input	Input (Optional)	Input	Input when access connectivity is created or CFS if not in DCAE Reg		Input
OLT Name	Input					Input
OLT NNI Slot	Input					Input
OLT NNI Port	Input					Input

BBS Parameter Table for next releases R4+

BBS Parameter Table

ONAP Awareness	SDNC (Access Discovery)	SDN-C (Edge Discovery)	SDC (Service Creation from Portal)	DCAE Registration PNF	SDN-C (Access Service)	DCAE CPE Auth	A&AI
Service (HSIA)
RG MAC Add			Input				Input
Service Type			Input				Input
Upstream Speed			Input				Input
Downstream Speed			Input				Input
Remote ID			Input (Optional)	Input		Input (used to find the CFS associated with PNF)	Input
Orch Status					Derived - Obtained from CFS associated with PNF in PNF Registration	Derived - Obtained from CFS associated w PNF and MAC Address	Input
HSIA Access
CPE/ONT PNF
PNF Name			Input (CorrelationID)	SourceName		SourceName	Input
MAC Address				Input		Input	Input
Manufacturer			Onboarded CSAR Artifact	Input			Input
Serial Number				Input			Input
Model				Input			Input
Type			Onboarded CSAR Artifact	Input			Input
SW Version				Input (Optional)		Input (Optional)	Input
Attachment Point (new field)				Input			Input
CPE Authentication State						Input (Used to derive the CFS orchestration status)
ONT NNI (PORT)					Input from response when access connectivity is created		Input
ODN Virtual Link					Input from response when access connectivity is created		Input
Access Connectivity
Service Type					Input (from CFS)
Upstream Speed					Input (from CFS)
Downstream Speed					Input (from CFS)
PON UNI
CVLAN			Input (Optional)	Input	Input when access connectivity is created or CFS if not in DCAE Reg		Input
Expected ONT ID			Input (Optional)		Input (from CFS)		Input
OLT Name	Input			Derived (Attachment Point)			Input
OLT PON Slot	Input			Derived (Attachment Point)			Input
OLT PON Port	Input			Derived (Attachment Point)			Input
OLT NNI
SVLAN	Input		Input (Optional)	Input	Input when access connectivity is created or CFS if not in DCAE Reg		Input
OLT Name	Input						Input
OLT NNI Slot	Input						Input
OLT NNI Port	Input						Input
HSIA Edge
Transport Connection		Input					Input (Just added after Edge/ Access Discovery)
BNG UNI		Input					Input

Service-instance-related information

See AAI-BBS Proposals for Dublin Release#BBSProposalsforDublinRelease-Item6.Specificdecisionsmadeforeachattribute

BBS Properties Per HSIA CFS Service Instance	Input Source	ONAP Components that must fetch the value from A&AI	Does it really need A&AI storage?	A&AI Metaname (for Metadata)
RG MAC Address	Service Order via Ext API It also comes in the CPE Authentication Event	bbs-event-processor DCAE microservice (it fetches existing value from A&AI to compare it with the new value coming from PNF CPE authentication event in order to deduce if there is any mismatch)	Yes, as metadata of CFS service instance	rgw-mac-address
Correlation ID (PNF-name)	Service Order via Ext API It also comes in the sourceName of the PNF registration event's commonEventHeader		Yes, as property of PNF object
Service Type	Service Order via Ext API	SO / bbs-apex-policy (during Access Connectivity and Internet Profile VFCs creation & update)	Yes, as metadata of CFS service instance	service-type
Access ID	PNF registration event	SDN-C or SO? / bbs-apex-policy (during Internet Profile VFC creation & update)	Yes, as metadata of CFS service instance	remote-id
Upstream Speed	Service Order via Ext API	SDN-C or SO? / bbs-apex-policy (during Internet Profile VFC creation & update)	Yes, as metadata of CFS service instance	up-speed
Downstream Speed	Service Order via Ext API	SDN-C or SO? / bbs-apex-policy (during Internet Profile VFC creation & update)	Yes, as metadata of CFS service instance	down-speed
OLT Name	PNF registration event (extracted from attachment point)
OLT PON port	PNF registration event (extracted from attachment point)
OLT PON slot	PNF registration event (extracted from attachment point)
CVLAN	PNF registration event Service Order via Ext API [optional - if not provided by Access SDN M&C]	SDN-C or SO? / bbs-apex-policy (during Internet Profile VFC creation & update)	Yes, as metadata of CFS service instance	cvlan
SVLAN	PNF registration event Service Order via Ext API [optional - if not provided by Access SDN M&C]	SDN-C or SO? / bbs-apex-policy (during Internet Profile VFC creation & update)	Yes, as metadata of CFS service instance	svlan
Expected ONT ID	Service Order via Ext API [optional]	SDN-C or SO? (for Access Connectivity VFC creation)	Yes, as metadata of CFS service instance	expected-ont-id
CPE Manufacturer	PNF registration event		Yes, as property of PNF object	Not Applicable
CPE Model	PNF registration event		Yes, as property of PNF object	Not Applicable
CPE Equipment Type	PNF registration event		Yes, as property of PNF object	Not Applicable
CPE Serial Number	PNF registration event		Yes, as property of PNF object	Not Applicable
CPE SW Version	PNF registration event (also present in CPE Authentication Event)		Yes, as property of PNF object	Not Applicable
Attachment Point (Not a real BBS modeling property, since its constituent parts are captured in other model properties)	PNF registration event	bbs-event-processor DCAE microservice (it fetches existing value from A&AI to compare it with the new value coming from PNF re-registration event in order to deduce if it is a true relocation)	Yes, as value of link-name property of a logical-link bridged to the PNF object	Not Applicable
ONT NNI Port	CPE PNF onboarding in SDC
OLT NNI Slot	PNF registration event
OLT NNI Port	PNF registration event

TOSCA Models

HSIA Access RFS : CPE

tosca_definitions_version: tosca_simple_yaml_1_0_0
node_types: 
  org.openecomp.resource.vfc.OntPnf: #we cannot use the namespace like "tosca.nfv.nodes" cause SDC's restriction
    derived_from: org.openecomp.resource.abstract.nodes.PNF
    properties:
      cpe_id:
        type: string
        required: true
      pnf_name:
        type: string
        required: true
      mac_addr:
        type: string
        required: true
      manufacturer:
        type: string
        required: true
      serial_num:
        type: string
        required: true
      model:
        type: string
        required: true
      attachment_point:
        type: string
        required: true
      is_pnf: # temporary parameter
        type: boolean
        required: true
        default: true
#      ont_type: reuse nf_type in Generic_PNF
#        type: string
#        required: true
#      ont_sw_version: reuse software_versions in Generic_PNF
#        type: string
#        required: true
    capabilities:
        virtual_binding:
          type: tosca.capabilities.nfv.VirtualBindable
          occurrences:
          - 1
          - UNBOUNDED

CpePnf.yml

HSIA Access RFS : AccessConnectivity

tosca_definitions_version: tosca_simple_yaml_1_0_0
node_types: 
  org.openecomp.resource.vfc.accessConnectivity: 
    derived_from: tosca.nodes.Root
    description: olt
    properties:
      service_type:
        type: string
        required: true
      upstream_speed:
        type: string
        required: true
      downstream_speed:
        type: string
        required: true
    capabilities:
        virtual_binding:
          type: tosca.capabilities.nfv.VirtualBindable
          occurrences:
          - 1
          - UNBOUNDED

access_connectivity.yml

HSIA Access RFS : OntNni

tosca_definitions_version: tosca_simple_yaml_1_0_0
node_types: 
  org.openecomp.resource.cp.OntNni: 
    derived_from: tosca.nodes.nfv.VduCp
    properties:
      ont_port:
        type: string
        required: true
    requirements:
        - virtual_link:
            capability: tosca.capabilities.nfv.VirtualLinkable
            relationship: tosca.relationships.nfv.VirtualLinksTo
            node: tosca.nodes.nfv.VnfVirtualLink
        - virtual_binding:
            capability: tosca.capabilities.nfv.VirtualBindable
            relationship: tosca.relationships.nfv.VirtualBindsTo
            node: org.openecomp.resource.vfc.OntPnf

OntNni.rar

HSIA Access RFS : PonUni

tosca_definitions_version: tosca_simple_yaml_1_0_0
node_types: 
  org.openecomp.resource.cp.PonUni: 
    derived_from: tosca.nodes.nfv.VduCp
    properties:
      expected_ont_id:
        type: string
        required: true
      cvlan_id:
        type: string
        required: true
      olt_name:
        type: string
        required: true
      olt_pon_port:
        type: string
        required: true
      olt_pon_slot:
        type: string
        required: true
    requirements:
        - virtual_link:
            capability: tosca.capabilities.nfv.VirtualLinkable
            relationship: tosca.relationships.nfv.VirtualLinksTo
            node: tosca.nodes.nfv.VnfVirtualLink
        - virtual_binding:
            capability: tosca.capabilities.nfv.VirtualBindable
            relationship: tosca.relationships.nfv.VirtualBindsTo
            node: org.openecomp.resource.vfc.accessConnectivity

PonUni.rar

HSIA Access RFS : OLTNNI

tosca_definitions_version: tosca_simple_yaml_1_0_0
node_types: 
  org.openecomp.resource.cp.OltNni: 
    derived_from: tosca.nodes.nfv.VduCp
    properties:
      olt_name:
        type: string
        required: true
      olt_nni_port:
        type: string
        required: true
      olt_nni_slot:
        type: string
        required: true
      svlan:
        type: string
        required: true        
    requirements:
        - virtual_link:
            capability: tosca.capabilities.nfv.VirtualLinkable
            relationship: tosca.relationships.nfv.VirtualLinksTo
            node: tosca.nodes.nfv.VnfVirtualLink
        - virtual_binding:
            capability: tosca.capabilities.nfv.VirtualBindable
            relationship: tosca.relationships.nfv.VirtualBindsTo
            node: org.openecomp.resource.vfc.accessConnectivity

OltNni.rar

HSIA Access RFS : InternetProfile

tosca_definitions_version: tosca_simple_yaml_1_0_0
node_types: 
  org.openecomp.resource.vfc.InternetProfile: 
    derived_from: tosca.nodes.Root
    properties:
      rg_mac_addr:
        type: string
        required: true
      service_type:
        type: string
        required: true
      upstream_speed:
        type: string
        required: true
      downstream_speed:
        type: string
        required: true
      remote_id:
        type: string
        required: true
    capabilities:
        virtual_binding:
          type: tosca.capabilities.nfv.VirtualBindable
          occurrences:
          - 1
          - UNBOUNDED

InternetProfile.yaml

HISA Edge RFS : BngUni

tosca_definitions_version: tosca_simple_yaml_1_0_0
node_types: 
  org.openecomp.resource.cp.BngUni: 
    derived_from: tosca.nodes.nfv.VduCp
    properties:
      svlan:
        type: string
        required: true
      bng_uni_port:
        type: string
        required: true
      bng_uni_slot:
        type: string
        required: true       
    requirements:
        - virtual_link:
            capability: tosca.capabilities.nfv.VirtualLinkable
            relationship: tosca.relationships.nfv.VirtualLinksTo
            node: tosca.nodes.nfv.VnfVirtualLink
        - virtual_binding:
            capability: tosca.capabilities.nfv.VirtualBindable
            relationship: tosca.relationships.nfv.VirtualBindsTo
            node: tosca.nodes.nfv.BNG //To Be Edited, depends on how to model BNG itself