Installing the Billing Adaptor (BOA) User s Guide. Revision: 1.10 Date: December 13th, 2016

Transcription

1 Installing the Billing Adaptor (BOA) User s Guide Revision: 1.10 Date: December 13th, 2016 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA USA Tel: NETS (6387) Fax:

2 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED "AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental. Adobe Systems, Inc. Adobe LiveCycle Data Services ES2.5, Copyright 2010, Adobe Systems, Inc. All Rights Reserved Oracle Copyright 2012, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Red Hat, Inc. Red Hat and Red Hat Enterprise Linux are trademarks of Red Hat, Inc., registered in the United States and other countries. Other product names, symbols, and phrases used throughout this document (if any) are property of their respective owners Cisco Systems, Inc. All rights reserved.

3 C O N T E N T S Revision History... 5 Purpose... 6 Hardware... 6 Prerequisites... 6 Additional Software needed for BST:... 6 Additional Software needed for Infinite Home:... 7 Additional Software needed for VBO:... 7 Additional Software needed for ECS VGS (UHE)/PowerKey:... 7 Interface Types... 9 Interface type: Synchronous Web Service Household WSDL... 9 Interface type: Synchronous Web Service Purchase WSDL... 9 Interface type: REST... 9 Interface type: RPC... 9 Installing BOA Install Prequisite Software as needed Install JDK Install/Configure Jboss Install Certification Certificates Install Jboss-configuration RPM for secure communications Install Consul client Install Vsftpd Install BillingAdaptor UI VBO Installation BillingAdaptor Installation Procedures Configuration Parameters (add additional parameters as needed): ECS Billing System Terminator (BST) Installation Installation Procedures Configuration Parameters (add additional parameters as needed): ECS VGS (UHE)/PowerKey Installation Installation Procedures Configuration Parameters (add additional parameters as needed): Infinite Home Installation... 19

4 Installation Procedures Heat Template Manual Installation Configuration Parameters (add additional parameters as needed): VCS Console Login Managing the Billing Adaptor Configuration Settings Defining the Billing Adaptor Routing Table Defining Offer Creation Defining the BOA User and BOA-Mgr User Group Modify the BOA Application Log Level Setting BillingAdaptor Logging Upgrade Billing Adaptor/BillingAdaptor UI BST Upgrade (BOA) RPM Upgrade (BOA) BST Upgrade (BOA UI) RPM Upgrade (BOA UI) Appendix A BOA OpenStack Heat Template - Parameters Parameters: BOA OpenStack Heat Template Default Appendix B Available Configuration Parameters: Explanation of the parameters: Commands

5 Revision History Version Date Description 1.0 May 16, 2015 Initial document for BOA 4.0 installation. LEA 1.1 May 28, 2015 Update document to move all configurations to the config.properties file. 1.2 July 2, 2015 Update document to make the configuration variable names match the config.properties file 1.3 Aug 7, 2015 Updated to add installs for all deployments. 1.4 December 10, 2015 Updated to include new configuration parameters for managing a default authorization and automatically trigger a TVOD purchase report 1.5 December 16, 2015 Changing ECS/VGS/UHE PowerKey configuration to support an rpm installation. Adding hardware requirements. 1.6 January 5, 2016 Updated configuration parameters for Vector installation. 1.7 March 4, 2016 Incorporate User/Configuration information. LEA 1.8 June 1, 2016 Added instructions for the BOA OpenStack HEAT template LEA. 1.9 June 17, 2016 Added new parameter descriptions for BEF connection, Consul connection, and location assignment 1.10 Nov 7, 2016 Rearranged document. Added support for SSL with necessary instructions. Added install/configuration for Consul client. Added BillingAdaptorUI installation instructions. Added support for BST. Removed cdvr instructions. Added upgrade instructions. 5

6 Overview Cisco's Business Support System/Operations Support System (BSS/OSS) Adaptor provides a unified interface to the back-end subscriber and billing systems typical of subscription-based service provider deployments. The BSS/OSS Adaptor (BOA) can be co-located with other back-end systems. This eliminates the need for a separate billing system interface for each control system. Purpose This document describes how to configure the BOA service for Cisco's Videoscape Control Suite (VCS) Version 4.0. Hardware Minimum hardware configuration: 2-vCPU/4GB RAM/4-GB HDD Prerequisites The following is a list of software that may be needed for BOA operations. Only install the software needed for the installation. ¾ VCS Version 4.0 or greater must be installed which include: o Required Jboss EAP x Java 1.8.x Additional Software needed for BST: VCSConsole 4.x.x BOA UI 4.x.x Component CSCOlabcerts 1.x.x VCS-service-config 1.x.x Consul-0.7.x or better Vsftpd 3.x.x or better Rpcbind 0.2.x 6

7 Additional Software needed for Infinite Home: HornetQ UPM or better (Mongo 2.6.x or better) Report Server BEF Additional Software needed for VBO: HornetQ Mongos UPM(Mongo) PPS (Mongo) HEP VVLA Splunk Forwarder Oracle: See below for others Additional Software needed for ECS VGS (UHE)/PowerKey : HornetQ UPM (Oracle) CCM NM CI BSM OASM RabbitMQ TUF 7

8

9 Installing the Billing Adaptor RPM File Interface Types There can be multiple BOA interfaces (described below) active simultaneously, but if a given interface is not going to be exercised, the associated features and configuration settings can and should be disabled or left empty. Interface type: Synchronous Web Service Household WSDL In deployment environments where the synchronous web service interface is utilized with the household WSDL, BOA is responsible for managing households, devices, and authorizations using an interface with UPM. This interface is household-centric. Interface type: Synchronous Web Service Purchase WSDL In deployment environments where the synchronous web service interface is utilized with the purchase WSDL, BOA is responsible for creating and deleting purchases and processing view start/stop events. This interface is householdcentric. In order to exercise the full set of purchase WSDL commands, the following configuration values are required. Make sure the Unified HeadEnd (UHE) components are installed prior to installing BOA: UPM, HEP, CMDC, PPS, and the purchase connections. If a reduced set of purchase WSDL commands are targeted for use, the configuration values may be a subset of that list. Interface type: REST In deployment environments where the BOA REST interface is utilized, BOA is responsible for managing households, devices, and authorizations using an interface with UPM. This interface is household-centric.. Purchase reporting commands are available in this interface, and if they are targeted for use, the Report Server configuration values need to be populated. Interface type: RPC In deployment environments where the RPC interface is utilized, BOA is responsible for forwarding BOSS commands received over RPC to either an EC or the ECS, depending on the command type. This interface is device-centric. Service discovery is required in this environment and the routing table must be populated.

10 Installing BOA Choose your Installation Environment from the options below and perform the installation procedures within the appropriate sections that follow. Installation Environment Instructions Video Back Office (VBO) Go to the VBO Installation section. Page 15 ECS Billing System Termination (BST) Installation Go to the ECS Billing System Termination (BST) Installation. Page 18 VGS(Unified HeadEnd (UHE))/PowerKey Go to the VGS(UHE)/PowerKey Installation section. Page 20 Infinite Home Go to Infinite Home Installation section, Page 22 Install Prerequisite Software as needed NOTE: If installing in an OpenStack environment, see Appendix A for the OpenStack templates for that installation. Install JDK 1. Install jdk. Example: yum install jdk8u102 Install/Configure Jboss 1. Install jboss-eap. Example: yum install jboss-eap Create a file in /etc/jboss-as/conf.d: Type: vi boa.conf Insert the following: JBOSS_CONFIG=standalone.xml JAVA_OPTS="-Xms2g -Xmx4g -XX:MaxPermSize=2g" JAVA_OPTS="$JAVA_OPTS -d64" JAVA_OPTS="$JAVA_OPTS -Djava.net.preferIPv4Stack=true" JAVA_OPTS="$JAVA_OPTS -Djava.awt.headless=true" JAVA_OPTS= $JAVA_OPTS -Djboss.bind.address= export JAVA_OPTS Note: Depending on the VM configuration, some systems may require the use of the actual IP of the node, rather than listen on all interfaces. 3. Do not insert the NOTE. 4. Save the file: :wq! 10

11 5. Change ownership to jboss:jboss. Type: chown jboss:jboss boa.conf 6. Restart the jboss process. Type: service jboss-as start Install Certificates 1. Install the CSCOlabcerts. Example: yum install CSCOlabcerts 2. Edit the security.properties file and make sure all of the parameters below are listed. a. vi /opt/cisco/vcs/security.properties b. paste in the following: SSLType=TwoWayAuthentication TrustStoreFile=/opt/cisco/vcs/certs/genericTruststore.jks KeyStoreFile=/opt/cisco/vcs/certs/genericKeystore.jks BasicAuthentication=true BasicUsername=restful BasicPasswd=conductor VerifyHostname=false IgnoreHttpsHost=true ProtocolVersion=TLSv1.1 c. Type: wq! To save the file. Install Jboss-configuration RPM for secure communications 1. Install vcs-services-config. Example: yum install vcs-services-config 2. Enable two-way secure communications via Jboss: Type: cd /opt/cisco/jboss-config./setup.sh - auth two-way - restart-jboss true 11

12 Install Consul client 1. Install consul. Example: yum install cisco-vcs-consul 2. Copy the consul client template file in place. a. Change directory to /etc/consul cd /etc/consul b. Copy the template file cp consul.json.template consul.json c. Edit the consul client file, change the parameter as follows: vi client.json { "server": false, "bind_addr": "<client ip>", "datacenter": "dc1", "pid_file": "/var/run/consul/consul.pid", "data_dir": "/opt/consul/data", "encrypt": "<output from consul keygen>", "log_level": "INFO", "enable_syslog": true, "disable_update_check": true, "retry_join": [ "<server_ip1>", "<server_ip2>", "<server_ip3>" ] } bind_addr: The VCS Console current IP encrypt: The key generated when the first consul server was installed retry_join: The list of consul servers separated by commas Do not change any other parameter 3. Save the changed file, :wq!. 4. Start the consul service: service consul start 12

13 Install Vsftpd In order to enable the transfer of PPV report files, an FTP user must be created and vsftpd must be installed. 1. Create the user: useradd -m dncsftp 2. Install vsftpd: yum install vsftpd 3. Add two settings to the vsftpd configuration in /etc/vsftpd/vsftpd.conf. a. Enter: vi /etc/vsftpd/vsftpd.conf b. Add these two lines: userlist_deny=no chroot_local_user=yes c. To save the changes, type :wq!. Install BillingAdaptor UI 1. Download the BillingAdaptorUI rpm. 2. Install the rpm. Example: rpm ivh BillingAdaptorUI.noarch-4.0.x-1.rpm 3. Configure the BillingAdaptorUI to support consul. a. Edit the /opt/cisco/billingadaptorui- 4.0.x/BillingAdaptorUI/WEB-INF/classes/sdconfig.properties Example: com.cisco.oss.foundation.directory.client.type=consul com.cisco.oss.foundation.directory.mydatacenter.name=dc1 com.cisco.oss.foundation.directory.server.fqdn=localhost com.cisco.oss.foundation.directory.server.port=8500 com.cisco.oss.foundation.directory.consul.local.agent=true com.cisco.oss.foundation.directory.consul.local.agent.port=8500 Client type can be dirserver or consul Mydatacenter will be the datacenter name, default is dc1. Server Full Qualified Domain Name, will be the host for Consul. (this should be Consul, the client should be installed on the localhost) Leave the remainder as they are above. 13

14 4. If using BillingAdaptor in a secure environment, edit this file: vi /opt/cisco/installed/billingadaptorui /billingadaptorui/web- INF/classes/consoleasservice.properties ##UI Plug In Configurations Console as Service. CAS_SERVICE_NAME=BillingAdaptorUI VCS_PORT=8080 VCS_PROTOCOL=http REGISTER_SERVICE_SLEEP=60000 VCS_PORT = Change the port from 8080 to VCS_PROTOCOL = Change the protocol from http to https. 5. To restart the BillingAdaptorUI, type the following: touch /opt/jboss-as/standalone/deployments/billingadaptorui.war.deployed 6. BillingAdaptorUI should register with Consul and display in VCSConsole. 7. Logout of VCSConsole and log back in and the BillingAdaptorUI should be available. VBO Installation In order to store purchase records, BOA uses the Mongo database. The BOA database and user must be created prior to the BOA install. Do not complete the DataStore parameters unless using the Mongo Database. Prerequisites 1. Install/Start the Mongo database Server. 2. Perform the following steps: a. Log on to the Mongo DB server. b. Execute mongo to enter the mongo command line: Type: mongo Type the following to create the BOA database and add the user/password, the user and password are examples only: use boa db.adduser( { user: "boauser", pwd: "Moon1234", roles: [ "readwrite", "dbadmin" ] } ) 3. Install all of the Unified HeadEnd (UHE) components if they are going to be used prior to installing BOA. IMPORTANT: 4. If the database already exists, the BOA Collections must be dropped before proceeding. To view the BOA collections, enter the following: use boa<cr> > show collections; <cr> BoaServiceConfiguration BoaServiceInstanceInfo system.indexes system.users 14

15 5. Drop the collections by using the following commands: > db.boaserviceconfiguration.drop() <cr> true(expected result) > db.boaserviceinstanceinfo.drop() <cr> true(expected result) Installation Procedures IMPORTANT: See each section below for specific prerequistes and configuration parameters. 1. Obtain the BOA rpm. 2. Install the RPM: a. Install: rpm ivh <BOA RPM> b. Upgrade: rpm Uvh <BOA RPM> 3. Edit the config.properties file as needed. 4. Change directory to /opt/cisco/billingadaptor/conf 5. Copy sample-config.properties to config.properties, type: cp sample-config.properties config.properties 6. Enter: vi config.properties Configuration Parameters (add additional parameters as needed): #Fri Apr 04 10:45:55 EDT 2014 db.password=password db.database=boa db.primarydbserverip= db.primarydbserverport=27017 db.user=boauser connections.upm.host= connections.upm.port=6040 connections.rs.host= connections.rs.port=6530 connections.vvla.host= connections.vvla.port=8010 connections.hep.host= connections.hep.port=6030 connections.cmdc.host= connections.cmdc.port=5600 connections.pps.host= connections.pps.port=8010 purchase.client.sdmp.host= purchase.client.sdmp.port=8900 purchase.client.sdmp.path=sdmp/service 15

16 purchase.client.flex.host= purchase.client.flex.port=8900 purchase.client.flex.path=flex/service purchase.retry.rateinseconds=30 purchase.retry.maxcount=3 svod.free.packagename=freepkg servicedirectory.requiredflag=false 1. To save the changes, type :wq!. 2. Change the ownership of the file to jboss:jboss: chown jboss:jboss config.properties 3. Start the BOA application: 4. Change directory to /opt/cisco/billingadaptor/bin 5. Enter:./billingadaptor.sh deploy NOTE: Any changes made to the configuration file (config.properties), BOA must be undeployed and redeployed for the changes to take effect. ECS Billing System Terminator (BST) Installation Installation Procedures 1. Obtain the BOA rpm. 2. Install the RPM: a. Install: yum install billingadaptor 3. Edit the config.properties file as needed. 4. Change directory to /opt/cisco/billingadaptor/conf. 5. Copy sample-config.properties to config.properties by entering the following: cp sample-config.properties config.properties 6. Enter: vi config.properties 16

17 Configuration Parameters (add additional parameters as needed): #Mon Nov 07 09:11:24 EST 2016 connections.consul.ip=localhost connections.consul.port=8500 connections.ecs.cpems.ip= connections.ecs.cpems.port=8443 connections.sync.soap.longtimeoutinseconds=10 sec.keystore.keystorepath=/opt/cisco/vcs/certs/keystore.jks sec.keystore.truststorepath=/opt/cisco/vcs/certs/client-truststore.jks sec.twowayauthenabled=true servicedirectory.datacenter=dc1 servicedirectory.ip=localhost servicedirectory.port=8500 servicedirectory.requiredflag=true servicedirectory.type=consul 7. To save the changes, type :wq!. 8. Change the ownership of the file to jboss:jboss: a. chown jboss:jboss config.properties 9. Start the BOA application: 10. Change directory to /opt/cisco/billingadaptor/bin 11. Enter: a../billingadaptor.sh deploy NOTE: Any changes made to the configuration file (config.properties), BOA must be undeployed and redeployed for the changes to take effect. 12. Install the VCS Console, refer to VCS Console Install/Upgrade Guide. 13. Install the BOA UI using the instruction on Page 14 of this document. 14. Populate the routing table in the VCS Console as described in the Defining the Billing Adaptor Routing Table section on Page 27 of this document. 17

18 ECS VGS (UHE)/PowerKey Installation Installation Procedures 1. Obtain the BOA rpm. 2. Install the RPM: a. Install: rpm ivh <BOA RPM> b. Upgrade: rpm Uvh <BOA RPM> 3. Edit the config.properties file as needed. 4. Change directory to /opt/cisco/billingadaptor/conf. 5. Copy sample-config.properties to config.properties by entering the following: cp sample-config.properties config.properties 6. Enter: vi config.properties Configuration Parameters (add additional parameters as needed): #Fri Apr 04 10:45:55 EDT 2016 servicedirectory.requiredflag=false connections.upm.host= connections.upm.port=6040 connections.ci.host= connections.ci.port=5155 region.validationflag=true region.ppv.value=ppvregionparamname region.subscription.value=subregionparamname caproduct.ppv.value=caproductidppv caproduct.subscription.value=caproductidsub business.rule.ppv.id=ppvbusinessruleid business.rule.subscription.id=subbusinessruleid connections.rabbitmq.host=rabbitmq.service.consul connections.rabbitmq.port=5672 connections.rabbitmq.username=admin connections.rabbitmq.password=admin connections.rabbitmq.timeoutinseconds=10 connections.rabbitmq.exchangename=tuf-transaction service.feature.trackflowflag=true service.feature.generaterequestidentifierflag=true 7. To save the changes, type :wq!. 8. Change the ownership of the file to jboss:jboss: 18

19 chown jboss:jboss config.properties 9. Start the BOA application: 10. Change directory to /opt/cisco/billingadaptor/bin 11. Enter:./billingadaptor.sh deploy NOTE: Any changes made to the configuration file (config.properties), BOA must be undeployed and redeployed for the changes to take effect. Infinite Home Installation Installation Procedures The Infinite Home software installation can be accomplished using the following methods: Heat Template Manual Installation Heat Template To install the Infinite Home software using the Heat template, refer to the Upgrade Billing Adaptor/BillingAdaptor UI BST Upgrade (BOA) 1. Type the following command: yum upgrade billingadaptor (This will stop and undeploy the service and install the new service) 2. Deploy the new service: a. Type: /opt/cisco/billingadaptor/bin/billingadaptor.sh deploy 3. Monitor the BillingAdaptor log file. a. Type: tail f /opt/jboss-as/standalong/log/billingadaptor.log 19

20 RPM Upgrade (BOA) 1. Download the new rpm. 2. Stop the BillingAdaptor application. a. Type: /opt/cisco/billingadaptor/bin/billingadaptor.sh undeploy 3. Install the new rpm: a. Type: rpm Uvh billingadaptor-x.x.x.rpm 4. Start the BillingAdaptor application. a. Type: /opt/cisco/billingadaptor/bin/billingadaptor.sh deploy 5. Monitor the BillingAdaptor log file. a. Type: tail f /opt/jboss-as/standalong/log/billingadaptor.log BST Upgrade (BOA UI) 1. Type the following command: yum upgrade BillingAdaptorUI 2. Deploy the new service: a. Type: touch /opt/jbossas/standalone/deployments/billingadaptorui.war.deployed 3. Monitor the BillingAdaptorUI log file. b. Type: tail f /opt/jbossas/standalong/log/billingadaptor/billingadaptorui.log RPM Upgrade (BOA UI) 1. Download the new rpm. 2. Install the new rpm: a. Type rpm Uvh billingadaptorui-x.x.x.rpm 3. Deploy the new service. a. Type: touch /opt/jbossas/standalone/deployments/billingadaptorui.war.deployed 4. Monitor the BillingAdaptorUI log file. c. Type: tail f /opt/jbossas/standalong/log/billingadaptor/billingadaptorui.log 20

21 Appendix A BOA OpenStack Heat Template - Parameters section of this guide. Manual Installation To install the Infinite Home software using the Heat template, complete the following: 1. Obtain the BOA rpm. 2. Install the RPM: a. Install: rpm ivh <BOA RPM> b. Upgrade: rpm Uvh <BOA RPM> 3. Edit the config.properties file as needed. 4. Change directory to /opt/cisco/billingadaptor/conf 5. Copy sample-config.properties to config.properties, type: cp sample-config.properties config.properties 6. Enter: vi config.properties 21

22 Configuration Parameters (add additional parameters as needed): #Fri Apr 04 10:45:55 EDT 2016 kd.sn.processingflag=true tvodreport.enableautotrigger.billingid=sms1, 1 enabledservices=purchase-tvod, LOCAL-PVR-ENABLED, IPTV connections.upm.host= connections.upm.port=6040 connections.rs.host= connections.rs.port=6530 connections.pps.host= connections.pps.port=6060 connections.bef.host= connections.bef.port=4321 connections.consul.host= connections.consul.port=123 servicedirectory.requiredflag=false #Enabling location assignment: service.feature.fipslookup=true/false service.name.get_eas_location=com.cisco.vcs.lcs.standalone.servic e.directory.endpoint.get_eas_location 1. To save the changes, type :wq!. 2. Change the ownership of the file to jboss:jboss: chown jboss:jboss config.properties 3. Start the BOA application. 4. Change directory to /opt/cisco/billingadaptor/bin 5. Enter:./billingadaptor.sh deploy NOTE: If the VCS Console is being installed for this deployment, the configuration parameters for service directory will need to be included. Also, any changes made to the configuration file (config.properties), BOA must be undeployed and redeployed for the changes to take effect. 22

23 Configure the BOA Service VCS Console Login 1 Open a supported browser. Notes: Internet Explorer, Firefox, and Chrome browsers are supported. The CP login page, displayed in the following step, cites the specific versions that are supported. 2 Enter the following command in the address bar: UI IP address]/ Example: Result: The management login page opens. 3 Enter the root or BOA user Username and Password and click Login to log in to the console.

24 Managing the Billing Adaptor Configuration Settings BOA uses the information defined on the Billing Adaptor Configuration UI page to connect to the various systems listed on this page. This information is defined initially during the BOA installation procedure. To manage these connections, perform the following steps: 1 Log in to the CP Management interface with a username that provides access to the Billing Adaptor Configuration page. 2 Select the Navigation bar to the left of the Cisco Logo with the arrow. 3 This will open up to the menus: 4 Then from the Control Plane menu, under Billing Adaptor: 5 Select Configuration. The Billing Adaptor Configuration page appears. The values shown in the Billing Adaptor Configuration page that follows are just examples. The System or Network Administrator should be able to provide the correct values if changes to the configuration are necessary. The settings in config.properties can alternatively be used to set the values in this screen. 24

25 6 Update as needed the values on this page and click Save. A message appears indicating that the updated values saved successfully. The new values will take effect immediately. Defining the Billing Adaptor Routing Table BOA uses the routing configuration data to determine the appropriate EC IP address (and DTACS IP address if DTACS is utilized) to send BOSS transactions. The routes are based upon the billing system that sends the transaction to the BOA. The Videoscape Control Suite Console interface provides a page that supports this BOA routing configuration. To define the BOA Routing Table configuration, complete the following steps: Note: The System or Network Administrator should be able to provide the IP address of the billing system's interface that communicates with the BOA. They should also be able to provide the IP address for the interface to the appropriate EC/DNCS/DTACS system, if not already known. 25

26 1 Log in to the Videoscape Control Suite Console interface with a username that provides access to the Billing Adaptor. 2 Choose the Right directional arrow, in the upper left corner of the Videoscape Control Suite Console this will display the Videoscape Control Suite Console menu from this menu under Billing Adaptor, select Routing Table and the Routing Table window will be displayed. Unlike the settings on the Configuration UI page, these settings cannot be made via the config.properties file so this screen is the only method. 3 Complete entries as required, then select Save. 4 View the Billing Adaptor Routings list in the Billing Adaptor Routing Table page. If you need to create a new billing adaptor route, click Create to define this new route. 5 Enter the IP address for the billing system, as well as for the EC/DNCS system and/or the DTACS system. 26

27 6 Click Save. The newly defined route configuration appears in the list, indicating that the new route is now in effect. Defining Offer Creation BOA uses the Offer Creation screen to set Region Validation, Region Paramater Names, CA Product Parameter Names, and Business Rule IDs. 1. Log in to the Videoscape Control Suite Console interface with a username that has access to the Billing Adaptor Offer Creation screen. 2. Choose the Right directional arrow, in the upper left corner of the Videoscape Control Suite Console this will display the Videoscape Control Suite Console menu from this menu under Billing Adaptor, select Offer Creation and the Offer Creation window will be displayed. The settings in this screen can alternatively be set by editing the config.properties file. 3. Complete entries as required, then select Save. 4. Select the Home symbol to return to the main screen. 27

28 Defining the BOA User and BOA-Mgr User Group The Videoscape Control Suite Console interface supports role-based user login functionality for the various applications installed, including BOA. The Videoscape Control Suite Console interface provides pages that support the creation of a BOA-specific username and password, membership in various user groups, and customized service configuration access permissions for specific tasks. To define a BOA user with customized access permissions, complete the following steps: 1 Log into the Videoscape Control Suite Console interface as the root user. 2 Choose User Administration > Users, Roles & AAA. 3 Choose Users and Accounts from the list of options on the left side of the page. The Users page appears. 4 From the Users menu select the plus (+) symbol, the following menu will be displayed: 28

29 5 Enter a new BOA username and password. 6 Check the BOA-Mgr check box to assign this new BOA user to the BOA-Mgr group. 7 Click Save. The Add User successfully message should appear. 8 Choose User Groups from the list of options on the left side of the page. The User Groups page appears. 9 Confirm that the new BOA user that you just created in the previous few steps is listed as a Member of the BOA-MGR group. 10 Choose BOA-Mgr from the list of Group Names on the left. The Group Detail: BOA-Mgr page appears. 11 Assign Task Permissions, as needed, to the new BOA user by checking the appropriate check box. Then, click Submit. The User Group saved successfully message should appear. 12 Verify the new BOA user, user group, and access permissions by logging out of the CP Management system, and then logging back in as the new user. Check that the new user can access those pages for which permission was assigned. 29

30 Modify the BOA Application Log Level Setting The BOA application log level setting in the CP Management window provides the operator with the ability to change the BOA log message output to different levels of detail. To adjust the BOA application log levels, complete the following steps: 1 Log in to the CP Management interface with a username that provides access to the Billing Adaptor Dashboard page. 2 Under Billing Adaptor, choose Dashboard. The Billing Adaptor Dashboard page appears. 3 In the Billing Adaptor Log Setting area, click the drop-down arrow to view the different log levels. 4 Select the new, desired log level that is different from the current level. 5 Click Save. A confirmation message appears. The new log level becomes active. BillingAdaptor Logging Logging path: /opt/jboss-as/standalone/log/billingadaptor.log Upgrade Billing Adaptor/BillingAdaptor UI BST Upgrade (BOA) 4. Type the following command: yum upgrade billingadaptor (This will stop and undeploy the service and install the new service) 5. Deploy the new service: a. Type: /opt/cisco/billingadaptor/bin/billingadaptor.sh deploy 6. Monitor the BillingAdaptor log file. a. Type: tail f /opt/jboss-as/standalong/log/billingadaptor.log 30

31 RPM Upgrade (BOA) 6. Download the new rpm. 7. Stop the BillingAdaptor application. a. Type: /opt/cisco/billingadaptor/bin/billingadaptor.sh undeploy 8. Install the new rpm: a. Type: rpm Uvh billingadaptor-x.x.x.rpm 9. Start the BillingAdaptor application. a. Type: /opt/cisco/billingadaptor/bin/billingadaptor.sh deploy 10. Monitor the BillingAdaptor log file. a. Type: tail f /opt/jboss-as/standalong/log/billingadaptor.log BST Upgrade (BOA UI) 5. Type the following command: yum upgrade BillingAdaptorUI 6. Deploy the new service: a. Type: touch /opt/jbossas/standalone/deployments/billingadaptorui.war.deployed 7. Monitor the BillingAdaptorUI log file. b. Type: tail f /opt/jbossas/standalong/log/billingadaptor/billingadaptorui.log RPM Upgrade (BOA UI) 4. Download the new rpm. 5. Install the new rpm: a. Type rpm Uvh billingadaptorui-x.x.x.rpm 6. Deploy the new service. a. Type: touch /opt/jbossas/standalone/deployments/billingadaptorui.war.deployed 8. Monitor the BillingAdaptorUI log file. c. Type: tail f /opt/jbossas/standalong/log/billingadaptor/billingadaptorui.log 31

32 Appendix A BOA OpenStack Heat Template - Parameters To use the BOA OpenStack template, enter the following parameters into the template: Parameters: Enter the SubnetName associated with the SubnetID in the above OpenStack Internal Network. For example: "urn:com:cisco:vci:heat:stack:subnetid": default: 289b2301-bf de-0bae8dfb0ad2 description: Subnet Id for the Internal OpenStack Network Enter the SubnetName associated with the SubnetID in the above OpenStack Internal Network. For example: "urn:com:cisco:vci:heat:stack:subnetname": default: "lwr-lwrdevops9-private-subnet" description: Subnet Name (required parameter; not used in this template) Enter the Repository URL that will be used to install the BOA application. For example: "urn:com:cisco:vci:repo:url": default: " description: Repository URL (required parameter; not used in this template) Enter the Network ID for the OpenStack Internal Network. For example: "urn:com:cisco:vci:heat:stack:networkid": description: Network ID default: 3e528ade ba-97c7-9b039c29bc5f Enter the keypair that is configured for the OpenStack environment configured to support the installation. For example: "urn:com:cisco:vci:heat:stack:keypairid": label: keypair default: cisco description : Name of a key pair to enable SSH access to instances. Enter the SecurityGroup created in the OpenStack environment configured to support the installation. For example: "urn:com:cisco:vci:service:parameter:securitygroup": label: securitygroup description: Name of the security group to use default: default 32

33 Enter the name of the size of the BOA virtual machine that will be deployed in the OpenStack environment. Available sizes are as follows: Sizes available are: 1. m1.tiny 512MB RAM/1-GB HDD 2. m1.small 2-GB RAM/20GB HDD 3. m1.medium 4GB RAM/40GB HDD 4. m1.large 8GB RAM/80GB HDD 5. m1.xlarge -- 16GB RAM/160GB HDD For example: "boa.flavorname": description: Flavor to use for the servers constraints: - custom_constraint: nova.flavor default: m1.small "boa.flavorid": default: 2 description: Flavor Id used in instance creation Enter the name of the image to install onto the virtual machine in the OpenStack environment. For example: "boa.imagename": description: > Name or ID of the image to use for the servers. default: CentOS6.6 Enter the ID of the imageid to install onto the virtual machine. For example: "boa.imageid": default: 1 description: Image Id used in instance creation Enter the minimum number of BOA virtual machines to create during the deployment. For example: "boa.quantity:min": default: 1 description: Minimum quantity used in instance creation and scaling 33

34 Enter the maximum number of BOA virtual machines to create during the deployment. For example: "boa.quantity:max": default: 3 description: Maximum quantity used in instance creation and scaling Enter the location in which the virtual machine will boot from to become available. For example: "boa:zone.azname": default: nova description: Availability zone name for the main boa AZ Enter the default number of BOA virtual machines to create during the deployment into the OpenStack environment. For example: "boa.numinstances": default: 2 description: The number of instances to start initially in the scaling group Enter the BOA version to be installed during the OpenStack environment, this will be the base rpm name. For example: "urn:com:cisco:vci:service:parameter:boaversion": label: "Version of BOA to install" description: The version of BOA to be installed default: billingadaptor Enter the IP Address of the UPM virtual machine/host that the BOA virtual machine will use during the OpenStack deployment. For example: "urn:com:cisco:vci:service:parameter:upmip": label: "UPM IP Address" description: The IP address of the UPM service default: Enter the port for communications with the UPM virtual machine (the default port is 6040). For example: "urn:com:cisco:vci:service:parameter:upmport": label: "UPM Port Number" description: The port number of the UPM service default:

35 Enter the IP Address of the BEF virtual machine/host that the BOA virtual machine will use during the OpenStack deployment. urn: com:cisco:vci:service:parameter:connections:bef:host": label: "BEF IP Address" description: The IP address of the BEF service default: Enter the port for communicating with the BEF virtual machine. For example: "urn:com:cisco:vci:service:parameter:connections:bef:port": label: "BEF port number" description: The port number of the BEF service default: 4321 Enter the Directory Service virtual machine/host IP Address that the BOA virtual machine will use during the OpenStack deployment. For example: "urn:com:cisco:vci:service:parameter:sdip": label: "Service Directory IP Address" description: The IP address of the Service Directory default: Enter the port that BOA will use to communicate with the Directory Service application. For example: "urn:com:cisco:vci:service:parameter:sdport": label: "Service Directory Port Number" description: The port number of the Service Directory service default: 2013 Enter the flag to indicate whether BOA should register with the Directory Service application, in the Infinite Environment, the default is false. For example: "urn:com:cisco:vci:service:parameter:sdusedflag": label: "Service Directory Used Flag" description: Flag indicating whether the Service Directory should be used default: "false" Enter either true or false to enable/disable the KD Serial Number Mapping Flag. For example: "boa.kdsnflag": label: "KD Serial Number Mapping Flag" description: Flag indicating whether to use KD friendly device id vs. chip id. True = friendly device ID. default: "true" 35

36 Enter the IP Address for the Report Server host for the BOA application to use for the OpenStack deployment. For example: "urn:com:cisco:vci:service:parameter:connections:rs:host": label: "Report Server Host Address" description: The Report Server host address default: "" Enter the port for the Report Server that the BOA application will use in the OpenStack deployment. For example: "urn:com:cisco:vci:service:parameter:connections:rs:port": type: number label: "Report Server Port" description: The Report Server port default: 6530 Enter the IP Address for the Consul host for the BOA application to use for the OpenStack deployment. For example: "urn:com:cisco:vci:service:parameter:connections:consul:ip": label: "Consul IP Address (leader election)" description: The IP address of Consul default: localhost Enter the port for the Consul that the BOA application will use in the OpenStack deployment. For example: "urn:com:cisco:vci:service:parameter:connections:consul:port": type: number label: "Consul Port Number" description: The port number of the Consul service default: 8500 Enter the Billing IDs needed to Trigger TVOD report generation. For example: "urn:com:cisco:vci:service:parameter:tvodreport:enableautotrigger:billingi ds": label: "TVOD Report Trigger Billing Ids" description: The list of billing Ids to trigger TVOD report generation default: "" Enter the services that need to be Enabled for BOA. For example: "urn:com:cisco:vci:service:parameter:enabledservices": label: "Enabled Services" description: Optional set of allowable enabled services default: "" 36

37 Enter either true or false to indicate whether the deployment should clear all existing repositories. For example: "urn:com:cisco:vci:service:parameter:clearreposflag": label: "Clear Existing Repos Flag" description: Flag indicating whether the deployment should clear all existing repo configurations on the VM before configuring default: "false" Enter the timeout, in seconds, to wait for the BOA deployment to complete. For example: "urn:com:cisco:vci:service:parameter:waittimeout": type: number label: "Deployment Cycle Timeout" description: The maximum time, in seconds, between 10 and 60 minutes to wait for the deployment to complete default: 600 constraints: - range: { min: 600, max: 3600 } description: Timeout must be between 600 and 3600 seconds BOA OpenStack Heat Template Default The following is an example of the default BOA OpenStack Heat template. heat_template_version: description: > This template installs the BSS/OSS Adaptor on Openstack. parameters: "urn:com:cisco:vci:heat:stack:subnetid": default: "" description: Subnet Id "urn:com:cisco:vci:heat:stack:subnetname": default: "geosubnet" description: Subnet Name (required parameter; not used in this template). "urn:com:cisco:vci:repo:url": default: "" description: Repository URL (required parameter; not used in this template). "urn:com:cisco:vci:heat:stack:networkid": description: Network ID default: "" "urn:com:cisco:vci:heat:stack:keypairid": 37

38 label: keypair default: "" description : Name of a key pair to enable SSH access to instances. "urn:com:cisco:vci:service:parameter:securitygroup": label: securitygroup description: Name of the security group to use default: default # Must have these parameter names:.flavorid,.flavorname,.imageid,.imagename,.quantity:max/min,.azname,.fqdn,.floatingipid "boa.flavorname": description: Flavor to use for the servers. constraints: - custom_constraint: nova.flavor default: m1.small "boa.flavorid": type: number default: 2 description: Flavor Id used in instance creation. "boa.imagename": description: > Name or ID of the image to use for the servers. default: "" "boa.imageid": default: "" description: Image Id used in instance creation. "boa.quantity:min": type: number default: 1 description: Minimum quantity used in instance creation and scaling. "boa.quantity:max": type: number default: 3 description: Maximum quantity used in instance creation and scaling. "boa:zone.azname": default: nova description: Availability zone name for the main boa AZ. "boa.numinstances": type: number default: 2 description: The number of instances to start initially in the scaling group. "urn:com:cisco:vci:service:parameter:boaversion": 38

39 label: "Version of BOA to install" description: The version of BOA to be installed. default: billingadaptor "urn:com:cisco:vci:service:parameter:upmip": label: "UPM IP Address" description: The IP address of the UPM service. default: "urn:com:cisco:vci:service:parameter:upmport": type: number label: "UPM Port Number" description: The port number of the UPM service. default: 6040 "urn:com:cisco:vci:service:parameter:sdip": label: "Service Directory IP Address" description: The IP address of the Service Directory. default: "urn:com:cisco:vci:service:parameter:sdport": type: number label: "Service Directory Port Number" description: The port number of the Service Directory service. default: 2013 "urn:com:cisco:vci:service:parameter:sdusedflag": label: "Service Directory Used Flag" description: Flag indicating whether the Service Directory should be used. default: "false" "boa.kdsnflag": label: "KD Serial Number Mapping Flag" description: Flag indicating whether to use KD friendly device id vs. chip id. True = friendly device ID. default: "true" "urn:com:cisco:vci:service:parameter:connections:rs:host": label: "Report Server Host Address" description: The Report Server host address. default: "" "urn:com:cisco:vci:service:parameter:connections:rs:port": type: number label: "Report Server Port" description: The Report Server port. default:

40 "urn:com:cisco:vci:service:parameter:tvodreport:enableautotrigger:billingids": label: "TVOD Report Trigger Billing Ids" description: The list of billing Ids to trigger TVOD report generation. default: "" "urn:com:cisco:vci:service:parameter:enabledservices": label: "Enabled Services" description: Optional set of allowable enabled services. default: "" "urn:com:cisco:vci:service:parameter:clearreposflag": label: "Clear Existing Repos Flag" description: Flag indicating whether the deployment should clear all existing repo configurations on the VM before configuring. default: "false" "urn:com:cisco:vci:service:parameter:waittimeout": type: number label: "Deployment Cycle Timeout" description: The maximum time, in seconds, between 10 and 60 minutes to wait for the deployment to complete. default: 600 constraints: - range: { min: 600, max: 3600 } description: Timeout must be between 600 and 3600 seconds. resources: BOA-security: type: OS::Neutron::SecurityGroup properties: description: This specifically opens the needed port for BOA's RESTful interface. name: BOA-security rules: [ { remote_ip_prefix: /0, protocol: tcp, port_range_min: 8080, port_range_max: 8080, direction: egress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: tcp, port_range_min: 8080, port_range_max: 8080, direction: ingress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: tcp, port_range_min: 80, port_range_max: 80, direction: egress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: tcp, port_range_min: 80, port_range_max: 80, direction: ingress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: tcp, port_range_min: 6040, port_range_max: 6040, direction: egress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: tcp, port_range_min: 6530, port_range_max: 6530, direction: egress, ethertype: IPv4 } ] BOACluster-DNS-group: type: OS::Neutron::SecurityGroup 40

41 properties: description: This is mandated by the VCI Orchestration Framework to provide the DNS through a Consul server. name: BOACluster-DNS-group rules: [ { remote_ip_prefix: /0, protocol: tcp, port_range_min: 8500, port_range_max: 8500, direction: egress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: tcp, port_range_min: 8500, port_range_max: 8500, direction: ingress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: tcp, port_range_min: 8400, port_range_max: 8400, direction: egress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: tcp, port_range_min: 8400, port_range_max: 8400, direction: ingress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: udp, port_range_min: 8600, port_range_max: 8600, direction: egress, ethertype: IPv4 }, { remote_ip_prefix: /0, protocol: udp, port_range_min: 8600, port_range_max: 8600, direction: ingress, ethertype: IPv4 } ] boa_resource_group: type: OS::Heat::ResourceGroup properties: count: { get_param: "boa.numinstances" } resource_def: type: OS::Nova::Server properties: name: str_replace: template: $instance_name-server-$index params: $instance_name: { get_param: "OS::stack_name" } $index: "%index%" key_name: { get_param: "urn:com:cisco:vci:heat:stack:keypairid" } image: { get_param: "boa.imagename" } flavor: { get_param: "boa.flavorname" } availability_zone: { get_param: "boa:zone.azname" } networks: - network: { get_param: "urn:com:cisco:vci:heat:stack:networkid" } security_groups: [ get_param: "urn:com:cisco:vci:service:parameter:securitygroup", get_resource: BOA-security, get_resource: BOACluster-DNS-group] user_data_format: RAW user_data: str_replace: template: #!/bin/bash -v date $vci_utility_scripts vciutil 41

42 registerservice $stack_prefix-boa-rest 8080 if [ $clearreposflag = "true" ]; then rm -f /etc/yum.repos.d/*.repo fi export HOST_IP=`/sbin/ifconfig eth0 grep 'inet addr:' cut -d: -f2 awk '{ print $1}'` export BOA_JBOSS_CONFIG_FILE="/etc/jboss-as/conf.d/boa.conf" export APP_REPO_FILE="/etc/yum.repos.d/app-repo.repo" echo "[app-repo]" > $APP_REPO_FILE echo "name=app-repo" >> $APP_REPO_FILE echo "baseurl=$url" >> $APP_REPO_FILE yum -y -q --nogpgcheck install jdk-1.7.0_79 yum -y -q --nogpgcheck install jboss-as echo "JBOSS_CONFIG=standalone.xml" > $BOA_JBOSS_CONFIG_FILE echo "JAVA_OPTS=\"-Xms2g -Xmx4g -XX:MaxPermSize=2g\"" >> $BOA_JBOSS_CONFIG_FILE echo "STARTUP_WAIT=120" >> $BOA_JBOSS_CONFIG_FILE echo "SHUTDOWN_WAIT=60" >> $BOA_JBOSS_CONFIG_FILE echo "JAVA_OPTS=\"\$JAVA_OPTS -d64\"" >> $BOA_JBOSS_CONFIG_FILE echo "JAVA_OPTS=\"\$JAVA_OPTS -Djava.net.preferIPv4Stack=true\"" >> $BOA_JBOSS_CONFIG_FILE echo "JAVA_OPTS=\"\$JAVA_OPTS -Djava.awt.headless=true\"" >> $BOA_JBOSS_CONFIG_FILE echo "JAVA_OPTS=\"\$JAVA_OPTS -Djboss.bind.address=$HOST_IP\"" >> $BOA_JBOSS_CONFIG_FILE echo "export JAVA_OPTS" >> $BOA_JBOSS_CONFIG_FILE echo "$HOST_IP "`hostname` >> /etc/hosts chkconfig --level 2345 jboss-as on service jboss-as start yum -y -q --nogpgcheck install $boaversion echo -e "connections.upm.host=$upmip\nconnections.upm.port=$upmport" > /opt/cisco/billingadaptor/conf/config.properties echo -e "servicedirectory.ip=$sdip\nservicedirectory.port=$sdport\nservicedirectory.requiredflag= $sdreqflag" >> /opt/cisco/billingadaptor/conf/config.properties echo -e "kd.sn.processingflag=$kdsnflag" >> /opt/cisco/billingadaptor/conf/config.properties if [ -n "$rshostaddr" ]; then echo -e "connections.rs.host=$rshostaddr\nconnections.rs.port=$rshostport\n" >> /opt/cisco/billingadaptor/conf/config.properties fi if [ -n "$tvodtriggerids" ]; then echo -e "tvodreport.enableautotrigger.billingid=$tvodtriggerids\n" >> /opt/cisco/billingadaptor/conf/config.properties fi if [ -n "$enabledsvcs" ]; then echo -e "enabledservices=$enabledsvcs\n" >> /opt/cisco/billingadaptor/conf/config.properties fi 42