This chapter describes the instructions for setting up Oracle Communications Network Service Orchestration.
Before you implement Network Service Orchestration, you must identify the required software, ensure that the required network infrastructure is available and ready, and identify the third-party software that you want to use. Your choices are based on the network services you want to deliver on your network.
Use the following list of tasks as a checklist to ensure that you have all the required components for a successful implementation of Network Service Orchestration:
Install and integrate the Network Service Orchestration components. See "Software Requirements" and "Installing and Integrating the Network Service Orchestration Components".
Integrate your Virtual Infrastructure Manager (VIM). See "Integrating the VIM with Network Service Orchestration".
Integrate the SDN controller if your network service requires configuration of network flows. See "Registering the SDN Controller".
Onboard Network Services and VNFs. See "Designing and Onboarding Network Services, VNFs, and PNFs".
Write extensions for extending the core functionality and integrate third-party software with Network Service Orchestration. See "Using Extension Points and Java Interface Extensions to Extend Network Service Orchestration".
Integrate client applications with Network Service Orchestration for using the RESTful APIs. For details about the RESTful APIs, see "Network Service Orchestration RESTful API Reference".
To implement Network Service Orchestration, you require the following software:
Oracle Communications Unified Inventory Management 7.3.4.
See UIM Installation Guide for installation instructions.
Oracle Communications Design Studio 7.3.4.1
See Design Studio Installation Guide for installation instructions.
To install and integrate the Network Service Orchestration components:
Install UIM on a WebLogic server. See UIM Installation Guide for installation instructions.
Navigate to the UIM_Home/cartridges/base directory and deploy the following UIM cartridges into UIM in the order they are listed:
ora_uim_baseextpts
ora_uim_basemeasurements
ora_uim_basetechnologies
ora_uim_basespecifications
ora_uim_baserulesets
OracleComs_NSO_BaseCartridge
See UIM Cartridge Guide for instructions about deploying cartridges into UIM.
(Optional) If you want to use the sample cartridges that are provided with Network Service Orchestration, navigate to the UIM_Home/cartridges/sample directory and deploy the sample cartridges into UIM.
Note:
Before deploying the sample cartridges, deploy the ora_uim_common cartridge.See "About the Sample Network Services" for more information about the sample cartridges provided with Network Service Orchestration.
See "Implementing the Sample Network Services" for information about implementing the sample network services.
(Optional) Integrate Network Service Orchestration with northbound applications for asynchronous communication. See "Integrating Network Service Orchestration With Northbound Applications for Asynchronous Communication".
Integrate the VIM with Network Service Orchestration. See "Integrating the VIM with Network Service Orchestration" for more information.
(Optional) Integrate the SDN controller with Network Service Orchestration. See "Registering the SDN Controller" for more information.
Some VNF and network service life cycle operations perform long-running processes. Network Service Orchestration supports integration with northbound applications in asynchronous communication for such life cycle operations.
With this integration, Network Service Orchestration provides the final and actual status of the following network service life-cycle actions so that northbound systems can perform and complete service fulfillment:
Instantiate a network service
Terminate a network service
Add one or more VNFs to network service
Delete one or more VNFs from a network service
Scale a VNF
Replace a VNF
Upgrade the software version of a VNF
To integrate Network Service Orchestration with northbound systems for asynchronous communication:
Configure your client applications to subscribe to the NSOResponseTopic topic in the WebLogic server. During installation, UIM creates the JMS Module and NSOResponseTopic.
You can implement a custom response topic and configure your applications to subscribe to it. See "Implementing a Custom Response Manager" for more information about implementing a custom response topic.
On the WebLogic server, in the JMS Module, create a Durable Subscriber to capture the messages.
Open the UIM_Home/config/nso.properties file and uncomment the following property:
#nso.ResponseManager.list.1=oracle.communications.inventory.nso.client.vnfm.NSOResponseTopicImpl
Network Service Orchestration supports OpenStack and provides integration points for integrating other third-party VIMs. See "Implementing a Custom VIM" for more information about implementing a custom VIM.
Before you integrate the VIM with Network Service Orchestration, ensure that you set up and configure the VIM to use with Network Service Orchestration. After your VIM infrastructure is set up, register the VIM and discover the VIM resources into Network Service Orchestration.
Note:
If you use multiple VIMs, register all of them with Network Service Orchestration and discover resources. In the properties file of the network service descriptor, specify the VIM that you want to use by default.Integrating the VIM with Network Service Orchestration involves the following tasks:
To register a VIM with Network Service Orchestration:
Ensure that UIM is started and running.
Ensure that the required Network Service Orchestration base cartridges are deployed into UIM.
Ensure that the VIM is running and that you have the IP address, username, password, and other details of the VIM instance.
In a RESTful API client, call the following RESTful API using the POST method:
POST http://nso_host:port/ocnso/1.1/vim
where:
nso_host is the IP address of the machine on which UIM is installed
port is the port number of the machine on which UIM is installed
Specify the VIM details in the request. For details about the request parameters, see "Register VIM".
The RESTful API client returns a response.
In UIM, verify that a custom object with the details of the VIM is created.
You discover VIM resources into UIM so that Network Service Orchestration contains information about the current status and availability of all the required virtual resources on the network. In UIM, VIMs are represented as custom objects.
When you discover VIM resources, the details of the following resources are populated into UIM:
Availability zone (OpenStack)
Flavor
Host
Networks and Subnets
To discover VIM resources into UIM:
In a RESTful API client, call the following RESTful API using the POST method:
POST http://nso_host:port/ocnso/1.1/vim/vimId/discovery?infoLevel=vim_information
where:
nso_host is the IP address or the domain name of the machine on which UIM is installed
port is the port number of the machine on which UIM is installed
vimId is the Id of the VIM that you registered with Network Service Orchestration and whose resources you want to discover
vim_information is the level of information about the VIM that you want to retrieve and view in the response. The available values are:
summary. Retrieves and displays a summary of the VIM resources.
details. Retrieves and displays complete details about all the VIM resources.
For more details about the request parameters, see "Discover VIM Resources".
The RESTful API client returns a response.
In UIM, verify that the following entities are created:
Availability zone
Flavor
Host
VDC
Network address domains
IP subnets
Note:
Whenever you add, upgrade, modify, or delete the compute, memory, and network resources in your NFV Infrastructure (NFVI), run the VIM discovery RESTful API to ensure that details about the currently available resources on your NFVI are reflected correctly in Network Service Orchestration.If your network service requires implementation of network flows, then you can set up Network Service Orchestration to use an SDN controller. SDN controllers are based on protocols, such as OpenFlow, that enable servers to instruct switches where to send network traffic. You should register the SDN controller with Network Service Orchestration to manage flow control in the network. Network Service Orchestration supports OpenDaylight and provides integration points for integrating other third-party SDN controllers. See "Implementing a Custom SDN Controller" for more information about implementing a custom SDN controller.
To register your SDN controller with Network Service Orchestration:
In UIM, create a custom object based on the SDN specification and specify the following details about the SDN controller that you want to use:
Host
Port number
Username of the SDN controller
Password of the SDN controller
Type of the SDN controller
Associate the VIM custom object as a parent custom object to the SDN controller custom object.
Network Service Orchestration provides the UIM_Home/config/nso.properties file that you use to specify properties for your implementation of Network Service Orchestration.
To set the properties, open the nso.properties file in a text editor and update the following parameters:
startIpAddress. Specify the subnet start IP address. By default, when Network Service Orchestration creates a network, the subnet IP address starts with 192.168.0.0.
NSO_HOST: IPv4address
where IPv4address is the host on which UIM is installed. By default, Network Service Orchestration considers the host on which the UIM server is running. If the server is running on a private network that is unavailable to external network, specify a reachable IP address for the server.
NSO_USERNAME: username
where username is the username of the UIM user.
NSO_PASSWORD: password
where password is the encrypted password of the UIM user.
To encrypt the password:
Create a text file and type the password.
Save and close the file.
In UIM, in the Administration group of the navigation section, click Execute Rulesets.
In the Ruleset list, select the EncryptText ruleset, and enter the path and file name of the text file that contains the password in plain text and click Process.
UIM displays the encrypted password. Copy the encrypted password and specify it in the nso.properties file.
You enable logging for Network Service Orchestration to log debug messages.
For more information about logging, see the chapter about improving UIM performance in UIM System Administrator's Guide.
To enable logging for Network Service Orchestration:
Open the UIM_Home/config/loggingconfig.xml file in a text editor.
Add the following text:
<logger name="oracle.communications.inventory.nso" additivity="false">
<level value="debug" />
<appender-ref ref="stdout"/>
<appender-ref ref="rollingFile"/>
</logger>
Save and close the file.
Network Service Orchestration supports some integrations by default, while others require customization. Network Service Orchestration supports the following southbound integrations:
For Virtual Infrastructure Management:
Integration to OpenStack Mitaka and Liberty releases
Integration to Oracle OpenStack for Oracle Linux Release 2
Sample integration to VMware vCloud Director
A framework for integration to other Virtual Infrastructure Managers
For Network and SDN controllers:
Integration to OpenStack Neutron (Mitaka and Liberty releases)
Sample integration to OpenDaylight
For VNF Management:
Network Service Orchestration includes a built-in VNF Manager that supports the lifecycle management of VNFs. The VNF manager calls the VIM to perform life-cycle actions. The in-built VNF Manager supports direct integration to the VNF or integration to an Element Management System (EMS) that manages the VNF.
A framework that supports integration to external VNF Managers