CIP Install Upgrade Guide

Overview

The Central Intelligence Platform (CIP) is a key architectural component of the Unified Communications Management Platform (UCMP). CIP enables a business partner or service integrator to provide managed services throughout their customer base through its multi-tenant application security and design. The CIP is a server cluster that is available in two models, the first of which is the most common model:

• A model provided by Nectar in a hosted data center family that is dedicated to a business partner or service integrator
• A custom model (or models) hosted in a partner data center or on premise, dedicated to that customer (or customers)

The CIP houses registration and communication proxy systems that enable a service provider to support its customers from a Network Operations Center (NOC) or Service Operations Center (SOC).

The CIP is capable of proactive and reactive notifications, based on thresholds, degradation, or infrastructure/service failures. The CIP provides these functions across customers. It provides secure connections to end-client deployed premise equipment (RIGs) and subscribes to information channels between the service provider responder and that location.

For large enterprise deployments, UCMP can also provide a hierarchical system comprised of multiple Enterprise Intelligence Portals (EIPs).

About this Guide

Each dedicated partner CIP is managed by Nectar from its initial installation and configuration to ongoing monitoring, software release management, and maintenance with the exception of the on-site premise-dedicated customer model(s). This guide provides high-level instructions for:

CIP Installation

CIP Upgrade

Audience

This guide is intended for Nectar Subject Matter Experts (SMEs) within a partner who have a strong working knowledge of the partner’s managed service offers, service delivery commitments, and SLA obligations. The Nectar SME generally has expertise in infrastructure management and monitoring, and/or Unified Communications (UC) with system administration access and a strong working knowledge of Nectar UCMP.

Supported Software Versions

• Nectar UCMP v8.7

CIP Installation

This section provides high-level instructions for installing a CIP in a Microsoft Windows environment.These steps are most often completed by a Nectar expert. A Nectar representative will be available to assist with your CIP installation in the secondary model of the partner-hosted or dedicated customer.

This section includes the following:

Information Collection

Required Transfer Files

Build Wayside Servers

Build Farm Servers

• 
  
  1. Information Collection

The items discussed in this section will be provided to the Business Partner before the install. Each Business Partner will have a unique setup using these tables to capture the required information.

CIP Root Login

Username is usually in the form of CIPAdmin. Gather your CIP Root Login credentials and enter here:

Wayside Server Names

The Wayside Server name is usually in the form of Wayside1. Each row represents one of your Wayside Servers:

Farm Server Names

The Farm Server name is usually in the form of Farm1. Each row represents one of your Farm Servers:

Farm Server 1 IP Addresses

Farm Server 2 IP Addresses

(Optional) Farm Server 3 IP Addresses

Required Transfer Files

Note

Perform these steps for each Wayside and Farm server.

To complete a CIP installation, the following files are required. You should access your Nectar- provided nsoftware location to download these files with the exception of the WaysideInstall.zip.

• WaysideInstall.zip - Contact Nectar to obtain this file.
• Create a temporary local directory on the server to be installed/upgraded and download the following files from the partner_directory/Public/UCF Software Distribution/

directory:

serverbundle.jar

• 
  
  • thirdpartybundle.jar (not available/required for post 5.6 releases)
  • bcprov-jdk*.jar (not available/required for post 5.6 releases)

serverLauncher.jar

• In the same temporary local directory, download the following files from the

partner_directory/Public/UCF Software Distribution//etc/store

directory:

maritime.jar

maritimeExtra.jar

maritiveNative.jar

• In the same temporary local directory, download the following file from the

partner_directory/UCF// directory:

maritimeBranding.jar

Build Wayside Servers

Execute the following steps on both Wayside Servers:

Modify rigWrapper.properties (Post 5.6 Versions Only)

Modify the classpath property in the apps\wayside\rigWrapper.properties file to:

1. Remove or comment out the following classpath settings if they exist:

classpath.1 = serverbundle.jar

• 
  
  • classpath.2 = bcprov-jdk*.jar (for example, bcprov-jdk15on-147.jar)

classpath.3 = thirdpartybundle.jar

classpath.4 = derby.jar

1. Remove or comment out the following launchClass setting if it exists:

launchClass = net.conet.server.ConetServer

1. If you have any other classpath entries, modify the sequence accordingly.

Before example:

• classpath.1 = serverbundle.jar
• classpath.2 = bcprov-jdk15on-147.jar
• classpath.3 = thirdpartybundle.jar
• classpath.4 = derby.jar

classpath.5 = foo.jar After example:

• #classpath.1 = serverbundle.jar
• #classpath.2 = bcprov-jdk15on-147.jar
• #classpath.3 = thirdpartybundle.jar
• #classpath.4 = derby.jar

classpath.1 = foo.jar

1. Add the following new setting:

executable.jar = serverbundle.jar

Wayside Primary Service

Modify server.properties

Modify the following server.properties parameters on each Farm server. The following values should be different on each Wayside server:

serverName

superuser

superpassword

Figure 2-1 Modify server.properties

Modify infospot.properties

The following parameters should be empty:

server

username

password

customer

description

Figure 2-2 Modify infospot.properties

Install the Wayside Service

Follow these steps to install the primary Wayside service:

1. Open a command-line prompt.
2. Change directory to the Apps\Wayside.
3. Execute this command:

server -install

License the Wayside Server

Contact the Nectar Help Desk to license the Wayside Server.

Backup Wayside Service

Modify server.properties.

Follow the same instructions as above.

serverName should be Wayside-backup.

Modify infospot.properties.

Follow the same instructions as above.

Install the Backup Service

Follow the same instructions as above.

Configure Wayside Communication

Modify the wayside-module.properties

1. Modify the wayside-module properties so that serverName is Wayside-backup.
2. Edit the Apps\Wayside\etc\wayside-module.properties file on each Wayside and change:
   • peerTarget (serverName of the other Wayside Server)
   • peerServer (internal IP address of the other Wayside Server)
3. Reset the Wayside Server by entering this command in a Maritime command line:

tools restart

Figure 2-3 Modify the wayside-module.properties

Verify Wayside Communication

1. Open a Maritime Terminal to each wayside.
2. Execute a wayside view command.
   • The Peer Status should be active.
   • The Server/Port/Target should match the configuration above.

Figure 2-4 Execute a wayside view

1. On the second Wayside Server, execute a wayside setServerAsSecondary to mark this server as the secondary.

Figure 2-5 Execute a wayside setServerAsSecondary

Build Farm Servers

Modify rigWrapper.properties (Post 5.6 Versions Only)

Modify the classpath property in the apps\farm\rigWrapper.properties file to:

1. Remove or comment out the following classpath settings if they exist:

classpath.1 = serverbundle.jar

• 
  
  • classpath.2 = bcprov-jdk*.jar (for example, bcprov-jdk15on-147.jar)

classpath.3 = thirdpartybundle.jar

classpath.4 = derby.jar

1. Remove or comment out the following launchClass setting if it exists:

launchClass = net.conet.server.ConetServer

1. If you have any other classpath entries, modify the sequence accordingly.

Before example:

• classpath.1 = serverbundle.jar
• classpath.2 = bcprov-jdk15on-147.jar
• classpath.3 = thirdpartybundle.jar
• classpath.4 = derby.jar

classpath.5 = foo.jar After example:

• #classpath.1 = serverbundle.jar
• #classpath.2 = bcprov-jdk15on-147.jar
• #classpath.3 = thirdpartybundle.jar
• #classpath.4 = derby.jar

classpath.1 = foo.jar

1. Add the following new setting:

executable.jar = serverbundle.jar

Modify server.properties

Modify the following server.properties parameters on each Farm server. The following values should be different on each Farm server:

serverName

superuser

superpassword

Figure 2-6 Modify server.properties

Modify cluster-module.properties

Set the following parameters:

• localExternalAddress – external IP address of this server
• localInternalAddress – internal IP address of this server
• username – CIP Root username
• password – CIP Root password
• serverName1 – internal IP address of the first Wayside Server
• serverName2 – internal IP address of the second Wayside Server
• targetServer1 – serverName of Wayside 1
• targetServer2 – serverName of Wayside 2

Figure 2-7 Modify clustermodule.properties

Update Farm Servers

Follow these steps to update the Farm servers:

1. Update the serverbundle.jar file to make sure the Farm Servers are at the latest version.
2. Upgrade the following files in /etc/store on each Farm Server:

maritime.jar

maritimeBranding.jar

Install the Farm Service

Note

These steps must be performed on each Farm server.

Follow these steps to install the Farm Service:

1. Change directory to the Farm Server install directory (Apps\Farm).
2. Execute this command:

server -install

1. Start the Farm Service by executing this command:

net start 

Figure 2-8 Install Farm Service

Verify Farm Connectivity

Note

Verify farm connectivity on all active Farm servers.

Navigate to Configure > Wayside on the CIP and make sure the Farm Server appears as shown here:

Figure 2-9 Verify Farm Connectivity

CIP Upgrade

This section provides high-level CIP upgrade instructions. These steps are most often completed by a Nectar expert. A Nectar representative will be available to assist on premises with your CIP upgrade in the secondary model of the partner-hosted or dedicated customer.

Note

The JCE package only needs to be modified when maintaining/upgrading your own CIP. You must have unlimited strength encryption enabled in the JCE. The installer will automatically update for RIGs and PAs.

Copy files into your JRE’s install directory. Links for JRE 6/7/8 are provided below:

• http://www.oracle.com/technetwork/java/javase/downloads/jce-6- download-429243.html
• http://www.oracle.com/technetwork/java/javase/downloads/jce-7- download-432124.html
• http://www.oracle.com/technetwork/java/javase/downloads/jce8- download-2133166.html

Note

Beginning with r7.1, the JRE was upgraded to 1.8.

For more information, see Steps 6 and 7 in the following sections:

• Shut Down Backup Wayside Server
• Shut Down Primary Wayside
• Upgrade Farms and Clients

Upgrading the CIP involves performing these steps:

Backout Procedure

Disable Email Notification from Both Waysides

Shut Down Backup Wayside Server

Start Backup Wayside Server (Now the Primary)

Shut Down Primary Wayside

Ensure SatelliteOffline Event Delay for New Primary Wayside

Ensure AggregateAlarm is Set

Start Primary Wayside Server (Now the Backup)

Upgrade Farms and Clients

Verify Updates from RIG

Re-Enable Email Notifications

Backout Procedure

WARNING: This is a special Backout Procedure that MUST BE followed BEFORE performing a CIP upgrade.

Perform this procedure when upgrading, if you want the ability to downgrade in the future.

• Passwords are encrypted during the server upgrade to v5.5.3. When you downgrade to a pre- v5.5.3 Client, the system assumes they are plain text and fails to authenticate.
• If you plan to return to a pre-v5.5.3 Client from v5.5.3 Client, then you must follow the

Downgrade procedure that follows.

• For CIP/EIP in complex environments, you need to backup/restore one additional file:

etc/clusterslave-module.properties

Before Upgrade (While Running a Pre-v5.5.3 Version)

Follow these steps to prepare to upgrade to v5.5.3:

1. Create a backup copy of righome/etc/server.properties file; place in a location other than righome.
2. Create a backup copy of righome/etc/infospot.properties file; place in a safe location other than righome.
3. Create a backup copy of righome/backup/etc/server.properties file; place in a safe location other than righome.
4. Create a backup copy of righome/backup/etc/infospot.properties file; place in a safe location other than righome.
5. Export the Permissions:Users table:
   1. Create an etc/excel directory, if it does not exist in the RIG install directory.
   2. Execute the following maritime command:

permission data exportcsv users users.csv

• 
  
  1. Save users.csv from righome/etc/excel directory to a safe location other than

righome.

Upgrade

Upgrade to v5.5.3; verify logins work, server connects, etc.

Downgrade

Follow these steps to downgrade to a pre-v5.5.3 system:

1. Shutdown the backup RIG.
2. Restore the righome/backup/etc/server.properties file from the safe location specified earlier.
3. Restore the righome/backup/etc/infospot.properties file from the safe location specified earlier.
4. Restore the righome/backup/serverbundle.jar file from the righome/rollback/backup/ serverbundle.jar file.
5. Restore the righome/backup/thirdpartybundle.jar file from the righome/rollback/ backup/thirdpartybundle.jar file.
6. Restart the backup RIG.
7. Shutdown the main RIG.
8. Restore the righome/etc/server.properties file from the safe location specified earlier.
9. Restore the righome/etc/infospot.properties file from the safe location specified earlier.
10. Restore the righome/serverbundle.jar file from the righome/rollback/ serverbundle.jar file.
11. Restore the righome/thirdpartybundle.jar file from the righome/rollback/ thirdpartybundle.jar file.
12. Create the righome/deleteTables.commands file with the following single line:

permission:users

1. Restart the main RIG.
2. Login to the RIG using superUser/superPassword from server.properties (or from CIP).
3. Restore the Permissions:Users table:
   1. Place users.csv (from the safe location specified earlier) into the righome/etc/excel

directory.

• 
  
  1. Execute the following maritime command:

permission data importcsv users users.csv

1. Restart the main RIG.

Validation

Validate that old user accounts work again.

Disable Email Notification from Both Waysides

Note

Ensure you have the required files.

For more information, see Required Transfer Files.

Follow these steps to disable email notifications from both Wayside servers:

1. Navigate to Configure > Email Setup > Configure.
2. Remove the server information or enter an invalid value in the Server field, so that email notification is stopped.
3. Click OK.

Shut Down Backup Wayside Server

Follow these steps to shut down the Backup Wayside server:

1. Access the Backup on the Backup Wayside server.
2. Open a command-line prompt and execute the following commands:

set PATH=%PATH%;c:\windows\system32 net stop “Nectar Wayside”

1. Copy the latest version of serverbundle.jar and serverlauncher.jar to the \apps\wayside

directory.

1. Modify the classpath property in the apps\wayside\rigWrapper.properties file to:
   1. Remove or comment out the following classpath settings if they exist:

classpath.1 = serverbundle.jar

• classpath.2 = bcprov-jdk*.jar (for example, bcprov-jdk15on-147.jar)

classpath.3 = thirdpartybundle.jar

classpath.4 = derby.jar

• 
  
  1. Remove or comment out the following launchClass setting if it exists:

launchClass = net.conet.server.ConetServer

• 
  
  1. If you have any other classpath entries, modify the sequence accordingly.

Note

These changes only apply to customers that have custom jars.

Before example:

• classpath.1 = serverbundle.jar
• classpath.2 = bcprov-jdk15on-147.jar
• classpath.3 = thirdpartybundle.jar
• classpath.4 = derby.jar

classpath.5 = foo.jar After example:

• #classpath.1 = serverbundle.jar
• #classpath.2 = bcprov-jdk15on-147.jar
• #classpath.3 = thirdpartybundle.jar
• #classpath.4 = derby.jar

classpath.1 = foo.jar

• 
  
  1. Add the following new setting:

executable.jar = serverbundle.jar

1. Extract the \Apps\Wayside\application.properties file from waysideInstall.zip file and copy to \Apps\Wayside folder.
2. Rename or delete the existing \Apps\Wayside\jre folder from the install location.
3. Extract the \Apps\Wayside\jre file from waysideInstall.zip file and copy to \Apps\Wayside

folder.

Start Backup Wayside Server (Now the Primary)

Follow these steps to start the Backup Wayside server (now the Primary):

1. Open a command-line prompt on the backup of the primary Wayside.
2. Execute the following commands:

set PATH=%PATH%;c:\windows\system32 net start “Nectar Wayside”

1. Ensure replication has finished by way of the Maritime terminal by typing the following;

WAYSIDE REPLICATIONSTATUS

1. When completed, the Add/Remove/Update rows will show 0 records as follows:

Figure 3-1 Replication Completed

Shut Down Primary Wayside

Follow these steps to shut down the Primary Wayside server:

1. Open a command line prompt on the backup of the primary Wayside.
2. Execute the following commands:

set PATH=%PATH%;c:\windows\system32 net stop “Nectar Wayside”

1. Copy the latest version of serverbundle.jar and serverlauncher.jar to the \apps\wayside

directory.

1. Modify the classpath property in the apps\wayside\rigWrapper.properties file to:
   1. Remove or comment out the following classpath settings if they exist:

classpath.1 = serverbundle.jar

• classpath.2 = bcprov-jdk*.jar (for example, bcprov-jdk15on-147.jar)

classpath.3 = thirdpartybundle.jar

classpath.4 = derby.jar

• 
  
  1. Remove or comment out the following launchClass setting if it exists:

launchClass = net.conet.server.ConetServer

• 
  
  1. If you have any other classpath entries, modify the sequence accordingly.

Note

These changes only apply to customers that have custom jars.

Before example:

• classpath.1 = serverbundle.jar
• classpath.2 = bcprov-jdk15on-147.jar
• classpath.3 = thirdpartybundle.jar
• classpath.4 = derby.jar

classpath.5 = foo.jar After example:

• #classpath.1 = serverbundle.jar
• #classpath.2 = bcprov-jdk15on-147.jar
• #classpath.3 = thirdpartybundle.jar
• #classpath.4 = derby.jar

classpath.1 = foo.jar

• 
  
  1. Add the following new setting:

executable.jar = serverbundle.jar

1. Extract the \Apps\Wayside\application.properties file from waysideInstall.zip file and copy to \Apps\Wayside folder.
2. Rename or delete the existing \Apps\Wayside\jre folder from the install location.
3. Extract the \Apps\Wayside\jre file from waysideInstall.zip file and copy to \Apps\Wayside

folder.

1. Wait until the Backup server (new Primary) becomes active. To check if it has become active, go to the Backup server and issue a Maritime command:

WAYSIDE VIEW

1. Notice that the Local Status should be Active as shown here:

Figure 3-2 Local Status: Active

1. It takes a few minutes for the old Backup server to become the new Primary server.

Ensure SatelliteOffline Event Delay for New Primary Wayside

Follow these steps to ensure that a SatelliteOffline event delay is set for the new primary Wayside server:

1. Navigate to Setup > Event Setup > Event Delay.
2. In the Alert field, select Critical using the drop-down.
3. In the Delay (Sec.) field, set the delay to 3600 seconds (or one hour) for the SatelliteOffline event.
4. Click Add.

Figure 3-3 SatelliteOffline Delay

Ensure AggregateAlarm is Set

Follow these steps to ensure the AggregateAlarm is set:

1. Navigate to Setup > Event Setup > Acknowlegments.
2. Validate that the AggregateAlarm is set to replace on deviceName and subDeviceName.

Figure 3-4 AggregateAlarm Set

Start Primary Wayside Server (Now the Backup)

Follow these steps to start the Primary Wayside server (now the Backup):

1. Open a command line prompt and move the rigDB:
   1. Execute this command:

mv rigDB rigDB-old

• 
  
  1. Change directories to the following directory:

\Apps\TLogs

• 
  
  1. Execute this command:

mv log log-old

1. Execute the following commands:

set PATH=%PATH%;c:\windows\system32 net start “Nectar Wayside”

1. Ensure replication has finished by way of the Maritime terminal by typing the following;

WAYSIDE REPLICATIONSTATUS

1. When completed, the Add/Remove/Update rows will show 0 records as follows:

Figure 3-5 Replication Completed

1. Notice that the Local Status should be Armed as shown here:

Figure 3-6 Local Status: Active

Upgrade Farms and Clients

Follow these steps to upgrade farms and clients. Perform for all Farm servers:

1. Open a command-line prompt on the Wayside server and access the Farm folder (\apps\farm).
2. Execute the following command to stop the farm server:

set PATH=%PATH%;c:\windows\system32 net stop “Nectar Farm 1”

1. Copy the latest version of serverbundle.jar and serverlauncher.jar to the \apps\farm

directory.

1. Modify the classpath property in the apps\farm\rigWrapper.properties file to:
   1. Remove or comment out the following classpath settings if they exist:

classpath.1 = serverbundle.jar

• classpath.2 = bcprov-jdk*.jar (for example, bcprov-jdk15on-147.jar)

classpath.3 = thirdpartybundle.jar

classpath.4 = derby.jar

• 
  
  1. Remove or comment out the following launchClass setting if it exists:

launchClass = net.conet.server.ConetServer

• 
  
  1. If you have any other classpath entries, modify the sequence accordingly.

Note

These changes only apply to customers that have custom jars.

Before example:

• classpath.1 = serverbundle.jar
• classpath.2 = bcprov-jdk15on-147.jar
• classpath.3 = thirdpartybundle.jar
• classpath.4 = derby.jar

classpath.5 = foo.jar After example:

• #classpath.1 = serverbundle.jar
• #classpath.2 = bcprov-jdk15on-147.jar
• #classpath.3 = thirdpartybundle.jar
• #classpath.4 = derby.jar

classpath.1 = foo.jar

• 
  
  1. Add the following new setting:

executable.jar = serverbundle.jar

1. Extract the \Apps\Farm\application.properties file from waysideInstall.zip file and copy to \Apps\Farm folder.
2. Rename or delete the existing \Apps\Farm\jre folder from the install location.
3. Extract the \Apps\Farm\jre file from waysideInstall.zip file and copy to \Apps\Farm folder.
4. If the client also needs to be upgraded, then copy the maritimeExtra.jar and maritime.jar files to the \apps\farm\etc\store.
5. To start the farm server, execute the following command:

net start “Nectar Farm 1”

1. To check the farm server status, log in the CIP and navigate to Configure > Wayside where all the farms will be displayed with their status and number of connections.

Verify Updates from RIG

Follow these steps to verify that Wayside has collected updates from each RIG,

1. Navigate to Configure > Distributed.
2. Verify the following:
   • RIGs are showing as online
   • ProcStat column is showing steady state changes.

Re-Enable Email Notifications

Follow these steps to re-enable email notifications from both Wayside servers:

1. Restart the RIG.
2. Navigate to Configure > Email Setup > Configure.
3. Restore the Server field to its original value.
4. Click OK.