Once all the components needed for RCORD-Lite are up and running on your POD, you'll need to configure XOS with the proper configuration. Since this configuration is environment specific, you'll need to create your own, but the following can serve as a reference for it:
tosca_definitions_version: tosca_simple_yaml_1_0 imports: - custom_types/oltdevice.yaml - custom_types/switch.yaml - custom_types/switchport.yaml - custom_types/portinterface.yaml - custom_types/voltservice.yaml - custom_types/vrouterserviceinstance.yaml - custom_types/vrouterstaticroute.yaml description: Configures a full R-CORD POD topology_template: node_templates: # Fabric configuration switch#my_fabric_switch: type: tosca.nodes.Switch properties: driver: ofdpa3 ipv4Loopback: 192.168.0.201 ipv4NodeSid: 17 isEdgeRouter: True name: my_fabric_switch ofId: of:0000000000000001 routerMac: 00:00:02:01:06:01 # Setup the OLT switch port port#olt_port: type: tosca.nodes.SwitchPort properties: portId: 1 host_learning: false requirements: - switch: node: switch#my_fabric_switch relationship: tosca.relationships.BelongsToOne # Setup the OLT switch port interface interface#olt_interface: type: tosca.nodes.PortInterface properties: ips: 192.168.0.254/24 name: olt_interface requirements: - port: node: port#olt_port relationship: tosca.relationships.BelongsToOne # Setup the fabric switch port where the external # router is connected to port#vrouter_port: type: tosca.nodes.SwitchPort properties: portId: 31 requirements: - switch: node: switch#my_fabric_switch relationship: tosca.relationships.BelongsToOne # Setup the fabric switch port interface where the # external router is connected to interface#vrouter_interface: type: tosca.nodes.PortInterface properties: name: vrouter_interface vlanUntagged: 40 ips: 10.231.254.2/29 requirements: - port: node: port#vrouter_port relationship: tosca.relationships.BelongsToOne # Add a vRouter (ONOS) vrouter#my_vrouter: type: tosca.nodes.VRouterServiceInstance properties: name: my_vrouter # Add a static route to the vRouter (ONOS) route#my_route: type: tosca.nodes.VRouterStaticRoute properties: prefix: "0.0.0.0/0" next_hop: "10.231.254.1" requirements: - vrouter: node: vrouter#my_vrouter relationship: tosca.relationships.BelongsToOne # Setup the OLT service service#volt: type: tosca.nodes.VOLTService properties: name: volt must-exist: true # Setup the OLT device olt_device: type: tosca.nodes.OLTDevice properties: name: volt-1 device_type: openolt host: 10.90.0.114 port: 9191 switch_datapath_id: of:0000000000000001 switch_port: "1" outer_tpid: "0x8100" uplink: "128" requirements: - volt_service: node: service#volt relationship: tosca.relationships.BelongsToOne
For instructions on how to push TOSCA, please refer to this guide
Once the POD has been configured, you can create a subscriber, please refer to the RCORD Service guide for more informations.
To create a subscriber in CORD you need to retrieve some informations:
We'll focus on the first two as the others are pretty self-explaining.
Find the ONU Serial Number
Once your POD is set up and the OLT has been pushed and activated in VOLTHA, XOS will discover the ONUs available in the system.
You can find them trough:
vOLT > ONUDeviceshttp://<pod-id>:<chameleon-port|30006>/xosapi/v1/volt/onudevicesIf you are connected to the VOLTHA CLI you can use the command:
(voltha) devices Devices: +------------------+--------------+------+------------------+-------------+-------------+----------------+----------------+------------------+----------+-------------------------+----------------------+------------------------------+ | id | type | root | parent_id | admin_state | oper_status | connect_status | parent_port_no | host_and_port | vendor_id| proxy_address.device_id | proxy_address.onu_id | proxy_address.onu_session_id | +------------------+--------------+------+------------------+-------------+-------------+----------------+----------------+------------------+----------+-------------------------+----------------------+------------------------------+ | 0001941bd45e71d8 | openolt | True | 000100000a5a0072 | ENABLED | ACTIVE | REACHABLE | | 10.90.0.114:9191 | | | | | | 00015698e67dc060 | broadcom_onu | True | 0001941bd45e71d8 | ENABLED | ACTIVE | REACHABLE | 536870912 | | BRCM| 0001941bd45e71d8 | 1 | 1 | +------------------+--------------+------+------------------+-------------+-------------+----------------+----------------+------------------+----------+-------------------------+----------------------+------------------------------+
to list all the existing devices, and locate the correct ONU, then:
(voltha) device 00015698e67dc060 (device 00015698e67dc060) show Device 00015698e67dc060 +------------------------------+------------------+ | field | value | +------------------------------+------------------+ | id | 00015698e67dc060 | | type | broadcom_onu | | root | True | | parent_id | 0001941bd45e71d8 | | vendor | Broadcom | | model | n/a | | hardware_version | to be filled | | firmware_version | to be filled | | images.image | 1 item(s) | | serial_number | BRCM22222222 | +------------------------------+------------------+ | adapter | broadcom_onu | | admin_state | 3 | | oper_status | 4 | | connect_status | 2 | | proxy_address.device_id | 0001941bd45e71d8 | | proxy_address.onu_id | 1 | | proxy_address.onu_session_id | 1 | | parent_port_no | 536870912 | | vendor_id | BRCM | | ports | 2 item(s) | +------------------------------+------------------+ | flows.items | 5 item(s) | +------------------------------+------------------+
to find the correct serial number.
Find the UNI Port Id
From the VOLTHA CLI, in the device command prompt execute:
(device 00015698e67dc060) ports Device ports: +---------+----------+--------------+-------------+-------------+------------------+-----------------------------------------------------+ | port_no | label | type | admin_state | oper_status | device_id | peers | +---------+----------+--------------+-------------+-------------+------------------+-----------------------------------------------------+ | 100 | PON port | PON_ONU | ENABLED | ACTIVE | 00015698e67dc060 | [{'port_no': 16, 'device_id': u'0001941bd45e71d8'}] | | 16 | uni-16 | ETHERNET_UNI | ENABLED | ACTIVE | 00015698e67dc060 | | +---------+----------+--------------+-------------+-------------+------------------+-----------------------------------------------------+
and locate the ETHERNET_UNI port. The port_no for that port is the value you are looking for.
Push a subscriber into CORD
Once you have the informations you need about your subscriber, you can create it by customizing this TOSCA:
tosca_definitions_version: tosca_simple_yaml_1_0 imports: - custom_types/rcordsubscriber.yaml description: Create a test subscriber topology_template: node_templates: # A subscriber my_house: type: tosca.nodes.RCORDSubscriber properties: name: My House c_tag: 111 onu_device: BRCM1234 # Serial Number of the ONU Device to which this subscriber is connected uni_port_id: 16 # UNI PORT ID in VOLTHA mac_address: 00:AA:00:00:00:01 # subscriber mac address ip_address: 10.8.2.1 # subscriber IP
For instructions on how to push TOSCA, please refer to this guide
This feature, also referred to as "bottom-up provisioning" enables auto-discovery of subscriber and their validation through an external OSS.
Here is the expected workflow:
ServiceInstance chain for this particular subscriber and configure the POD to give him connectivityIf you want to enable the "Zero touch provisioning" feature you'll need to deploy and configure some extra pieces in the system before attaching subscribers:
Kafka
To enable this feature XOS needs to receive events from onos-voltha so a kafka bus needs to be deployed. To deploy it please follow this instructions
OSS Service
This is the piece of code that is responsible to enable the communication between CORD and you OSS Database. For reference we are providing a sample implemetation, available here: hippie-oss
Note: This implementation currently validates any subscriber that comes online.
To deploy the hippie-oss service you can look here.
Once the chart has come online, you'll need to add it to your service graph, and you can use this TOSCA for that:
tosca_definitions_version: tosca_simple_yaml_1_0 imports: - custom_types/hippieossservice.yaml - custom_types/servicedependency.yaml - custom_types/voltservice.yaml description: Create an instance of the OSS Service and connect it to the vOLT Service topology_template: node_templates: # Reference the VOLTService service#volt: type: tosca.nodes.VOLTService properties: name: volt must-exist: true # Reference the HippieOSSService service#oss: type: tosca.nodes.HippieOSSService properties: name: hippie-oss kind: oss # blacklist: BRCM1234, BRCM4321 # this is an optional list of ONUs that you don't want to validate # Create a ServiceDependency between the two service_dependency#oss_volt: type: tosca.nodes.ServiceDependency properties: connect_method: None requirements: - subscriber_service: node: service#oss relationship: tosca.relationships.BelongsToOne - provider_service: node: service#volt relationship: tosca.relationships.BelongsToOne
For instructions on how to push TOSCA, please refer to this guide