Skip to end of metadata
Go to start of metadata

On this page:

Cluster Configuration

You can create a new cluster configuration for the WRTC through the EMS. The cluster configuration can also be created from a template or cluster.

Perform the following tasks to create a cluster configuration for EMS-WRTC integration:

  1. Type https://<EMS ipaddress> in the supported web browser.
  2. Provide the username and password to login to the EMS.
  3. Click Cluster / VNF Management shortcut under Network Mgmnt. The Cluster/VNF Management window is displayed.
  4. Select the cluster for which you want to create configuration.

  5. Click Configuration tab.

  6. Click Create Configuration. The Select Configuration Option dialog box is displayed.

    Figure : Create Cluster Configuration

  7. Perform one of the following tasks:

    • Select Create from Template to create the configuration based on a template and select the template. The template would contain the default WRTC configuration.
    • Select Create from Existing Cluster to reuse the configuration in a cluster and select the cluster.
    • Click Create.

All window is displayed.

WRTC data model file is loaded based on the node type and node version. The node type and version determine the available configuration options. Multiple versions of the WRTC configuration schema can be used. The configuration is validated against the schema. The data model file is categorized in to Globals and Profiles. Some fields have default values.

The following is a sample configuration options for the selected cluster. For more information on WRTC data model configuration profiles, refer to WRTC Configuration Manager.

Table : Sample Cluster Configuration

WRTC Data Model Fields Configurations
Globals
EMS Management Server
  • You can select the management server port value as 443 and "Management Transport Type" as SECURE or NONSECURE. The default type is SECURE.
  • Click Save after modifying the transport type value.

Figure : EMS Management Server List

OAuth Server
  • You can select the OAuth server port as 443, the transport type as SECURE or NONSECURE. The default transport type is SECURE. Select the TLS profile name from the drop-down list.
  • You can delete an existing OAuth Server from the list by selecting delete  button and create a new OAuth Server by clicking New OAuth Server option.
  • Click Save after modifying the configured values.

Figure : OAuth Server

Figure : New OAuth Server

Websocket Server
  • You can select the Websocket Port value as 9080, the transport type as SECURE or NONSECURE. The default transport type is SECURE. Select the TLS profile name from the drop-down list.
  • You can delete an existing Websocket Server from the list by selecting delete  button and create a new Websocket Server by clicking New Websocket Server option.
  • Click Save after modifying the configured values.

Figure : Websocket Server List

Figure : New Websocket Server

OAuth Provider
  • To create a new OAuth Provider, select the OAuth Provider Name from the list that is, GOOGLE, FACEBOOK, or LINKEDIN. The OAuth Provider must be edited to match the ClientId, Client Secret, and Redirect URI specific to your node.
    For example, the redirect uri will be of the form https://<fqdnofyourwrtcnode>:443/callbackGoogle for Google. You can fetch the default clientid and client secret from the startup.json file that is shipped to you. For information on creating developer's account, refer to the OAuth Developer Account Creation.
  • Click Save after modifying the configured values.
  • You can copy an existing OAuth Provider from the OAuth Provider List by clicking the Copy OAuth Provider or delete an existing OAuth Provider from the list by selecting delete  button.

Figure : OAuth Provider List

Figure : OAuth Provider

Enterprise
  • You can configure the FQDN of your Enterprise domain under the Sonus Enterprise, or can create a new Enterprise by clicking on New Enterprise option.
  • To create a new Enterprise, provide the Enterprise name, mention the domain name attached to the enterprise in the "Enterprise Domain". Select the Route Order option to determine whether registry or routing table to be looked up first for WRTC client originated calls. Provide the Auth, CAC, Push Notification, SIP Signaling, Web Application, and Number Policy Profile that you have already created or can select the link as well to direct to the respective Profile List. Provide the default Application Policy profile. Media Policy profile is not mandatory. Provide the Administration Id and password, and Statistics Server URL configured to see the media-related statistics.
  • Click Save after modifying the configured values.
  • You can copy an existing Enterprise as well from the Enterprise List by clicking the Copy Enterprise or delete an existing Enterprise from the list by selecting delete button.

Enterprise Domain must be the FQDN of the domain name attached to the enterprise.

Figure : Enterprise Profile List

 

Figure : New Enterprise

If not configured, the statistics reporting is considered to be disabled.

Enterprise URL
  • Select New Enterprise URLs option. In the "Enterprise URL" column mention the domain name attached to the enterprise, and the enterprise name (as listed in the Enterprise List) in the "Enterprise" column.

     

  • Click Save. You can copy an existing Enterprise URLs as well from the Enterprise URLs List by clicking the Copy Enterprise URLs or delete an existing Enterprise URLs from the list by selecting delete button.

Figure : Enterprise URLs

Rest Server

You can select the rest server port value as 443 and "Transport Type" as SECURE or NONSECURE. The default transport type is SECURE.

Figure : Rest Server List

Http Server

You can select the http server port value as 443 and select the TLS profile name from the drop-down list.

Figure : HTTP Server List

Profiles

Authorization Profile
  • auth1 and auth2 are the default Authorization profiles. You can modify an existing Authorization profile or create a new Authorization profile by clicking on New Authorization Profile option, and then select the flags (True/False) to specify whether to enable authentication from a list of OAuth2 or LDAP providers. Click Save.
  • The Authorization Profile includes "OAUTH Providers" and "LDAP Providers". You can select the OAuth2 provider or the LDAP provider you want the authentication from. For example, to select the OAuth Provider as "FACEBOOK", you must first select the Authorization Profile from the drop-down menu and then, select "FACEBOOK" from the OAUTH Provider drop-down menu. Click Save.
  • You can copy an existing Authorization Profile from the Authorization Profile List by clicking the Copy Authorization Profile or delete an existing Profile from the list by selecting delete button.

For more information on Authentication and Authorization, refer to Authentication and Authorization.

Figure : Authorization Profile

Figure : New Authorization Profile

Figure : OAUTH Providers

Logging Profile The logging profile allows you to change log related information at each vertical. For more information on logging profile, see Logging Profile.
CAC Profile
  • cac1 and cac2 are the default CAC profiles. You can modify an existing CAC profile by configuring the enterprise and user session limits, application types, and by enabling or disabling audio, video, data calls.
    CAC policy can be applied at user level as well as enterprise level. Application list is also enabled as part of CAC.
  • You can also create a new CAC profile by clicking on New CAC Profile option. Provide the name, Enterprise Session Limits, User Session Limits, and List of applications. Click Save.

  • All types of calls are allowed by default.

    • If audio calls are disabled (by selection True), video calls are disabled automatically.

    • If video calls are enabled (by selecting False), audio calls are enabled automatically.

For more information on Call Admission Control Policy, refer to Call Admission Control Policy.

  • You can copy an existing CAC Profile from the CAC Profile List by clicking the Copy CAC Profile or delete an existing Profile from the list by selecting delete button.

Figure : CAC Profile

Figure : New CAC Profile

Number Profile
  • Select New Number Profile option to assign a number. Numbers can be assigned from Number pool for making browser to browser or browser to SIP call. You can assign maximum of 31 digits number.
    For "Anonymous" user, number can be assigned from the Guest Number pool.

    The default values do not have a range.
    Number pool range must be configured to assign numbers. Provide a profile name, assign a number to the profile name from the Number pool, and set "Use number as SIP Id" as True.
  • Click Save.

This configuration is required only for initial setup.

  • Figure : Number Profile

    You can copy an existing Number Profile from the Number Profile List by clicking the Copy Number Profile or delete an existing Profile from the list by selecting delete button.

Cluster Configuration for SIP Communication

To initiate voice or video call to a non-WebRTC user, WRTC routes the call through SBC. For SIP Signaling interworking, you can update the cluster configuration as follows:

  1. Select the cluster for which you want to update the cluster configuration for SIP communication.
  2. Click Edit Configuration button.
  3. Select the SIP Signaling Profile under Profiles object in "WRTC Data Model". You can modify an existing SIP Signaling Profile, or create a new one by clicking on SIP Signaling Profile option.  In the name column, provide a name for your profile, set the "SIP Registration Enabled" and "Use Telephone Number Towards SIP" values, and provide the value for Registration Duration. The default values of "SIP Registration Enabled" and "Use Telephone Number Towards SIP" are True.

    Figure : SIP Signalling Profile

     

    Click Save.

  4. Select the SIP Peer under Globals object in "WRTC Data Model". The SIP Peer List is displayed. You can modify an existing SIP Peer, or create a new one by clicking on New SIP Peer option.  In the "SIP Peer Name" column provide a name for your SIP peer (SBC), in the SIP IP address column mention the SIP SIG IP address of the SBC server, in the "SIP Peer Port" mention the port number of the SBC server, and the "SIP Peer Transport Type" such as UDP.

    Figure : SIP Peer

    Click Save to save the configuration. You can copy an existing SIP Peer from the SIP PeerList by clicking the Copy SIP Peer or delete an existing SIP Peer from the list by selecting delete  button.

  5. Select the Routing Label under Globals object in "WRTC Data Model" and then, click on New Routing Label. Provide a Routing Label Id and the Routing Label State as True.

    Click Save. You can copy an existing Routing Label from the Routing LabelList by clicking the Copy Routing Label or delete an existing Routing Label from the list by selecting delete  button.

     

    Select Data rows for Routing Label Route. To create a new data rows you must first select the Routing label from the drop-down, and then click the New Data rows for Routing Label Route option. Provide the Routing Label Name and in the SIP Peer column provide the SIP peer name (SBC) as mentioned in the SIP Peer.

    Figure : Routing Label

     

    Click Save. You can copy an existing Data rows for Routing Label Route from the Data rows for Routing Label RouteList by clicking the Copy Data rows for Routing Label Route or delete an existing Data rows for Routing Label Route from the list by selecting delete  button.

  6. Select the Route under Globals object in "WRTC Data Model" and then, click on New Route. Provide the Number Prefix which is the SIP end-point number, Domain, Enterprise, and Routing Label.

    Figure : Route

    Maximum of 30 digits number is supported for a SIP end-point.

    If WRTC is integrated with EMS, it is recommended to create a default route ( prefix * and suffix *) to the registered SBC, for sending REGISTER/falling back to the default route when match is not found.

  7. Click Save to route the call. You can copy an existing Route from the Route List by clicking the Copy Route or delete an existing Route from the list by selecting delete button.

  8. Select System Timers under Profiles object in "WRTC Data Model". You can edit an existing System Timers Profile with SIP Keep Alive Interval, and then click Save.

    The DBReconnectionInterval parameter is not used in this release.

    Figure : System Timers Profile

For more information on Browser to SIP Communication, refer to Browser-to-SIP Communication.

The SBC interworking with the WRTC must have the following configurations:

  • DTLS support for security.
  • ICE-Lite or Full-ICE configuration required for NAT traversal.
  • SMM Rules defined

For more information, refer to the SBC 5.0 documentation for Configuring SBC for WRTC.

Cluster Configuration for Multiple Point of Presence

  1. Select the cluster for which you want to update the cluster configuration to support the multiple point of presence.
  2. Click Edit Configuration button.
  3. Select the Application Profile under Profiles object in "WRTC Data Model". The Application Profile List is displayed.

    Figure : Application Profile List

  4. You can modify an existing application profile, or create a new one by clicking on New Application Profile option.  In the "Application Profile Name" column provide a name for your application, edit the Peer-to-Peer Conference Max. Participants and Group Chat Max. Participants with the number of available participants, select the Call Forking Type either Parallel or Sequential, the Call Forking Policy from the drop-down list, and Preferred Terminating Device Type from the drop-down list.

    For more information on Multiple point of presence feature, refer to Multiple Point of Presence Support.

    Figure : Creating a New Application Profile

    The Device Capability Based Filtering option is not used in the current release.

  5. Click Save. You can copy an existing Application Profile by clicking the Copy Application Profile or delete an existing application profile from the list by selecting delete  button.

Cluster Configuration for GCM Support in WRTC

  1. Select the cluster for which you want to update the cluster configuration to support the Google Cloud Messaging.
  2. Click Edit Configuration button.
  3. Select the Push Notification Profile under Profiles object in "WRTC Data Model". The Push Notification Profile List is displayed.

    Figure : Push Notification Profile List

  4. You can modify an existing Push Notification profile, or create a new one by clicking on New Push Notification Profile option.  In the "Name" column provide a name for your application, enter the "Sender ID" which is a unique numerical value created when the API project is configured (given as "Project Number" in the Google Developers Console). The sender ID is used in the registration process to identify the app server (WRTC gateway) that is permitted to send messages to the client app. Enter the API key obtained while configuring the API project, it is saved on the WRTC server and gives WRTC server authorized access to the Google services.

    Enable incoming call and message notification by selecting "True" from the given option.

    For more information on GCM feature, refer to Google Cloud Messaging Support in WRTC.

    Figure : Creating a New Push Notification Profile

  5. Click Save. You can copy an existing Push Notification Profile by clicking the Copy Push Notification Profile or delete an existing application profile from the list by selecting delete  button.

After configuring the WRTC cluster, click Save and Close to complete the configuration and to return to the parent page.

Figure : WRTC Cluster Configuration

To activate the configuration, click the Start button from 'Activate Configuration' section available at the bottom of the configuration screen. 

The EMS is now ready to push configuration data to the WRTC node. The configuration data can be pushed to the WRTC node immediately or you can schedule a date/time for the same.

Figure : Push the Configuration Data to WRTC Node

A cluster can have an active configuration and a candidate configuration. You cannot modify an active configuration but, candidate configuration can be modified.

  • If no candidate configuration exists, a candidate configuration can be created as a copy of the active configuration.
  • If a candidate configuration exists, you need to delete the candidate configuration to make a copy of the active configuration.

When a candidate configuration is converted to an active configuration:

  • The configuration on all WRTC nodes are updated in the cluster.
  • The original active configuration is archived.
  • The candidate configuration is deactivated.

The update operation fails on a WRTC node:

  • If the node is offline, the operation is initiated again when the node is Online.
  • If the node is online, the operation is initiated three times in the following intervals:
    • 15 seconds
    • 1 minute
    • 5 minutes

If the update operation fails even after three attempts, an alarm is raised.

WRTC Node Registration

After creating a WRTC cluster in the EMS and configuring the cluster to make it active, you can now register the WRTC cluster with the EMS server by performing the following tasks.

Refer to the Registering VNF Manager for detail information on EMS configuration for registering WRTC node.

Ensure the WRTC gateway is installed. For more information, refer to Installing Sonus WebRTC Gateway.

  1. Login to the WRTC server as linuxadmin user and su root. Refer to the Using WRTC Cluster Configuration on EMS for more information on initializing the WRTC node for the node registration.

     

    The wrtcnodeinit command performs the following: 

    • Starts the Cassandra database
    • Registers with EMS
    • Fetches the rest credentials

    • Downloads the tar.gz file from EMS which comprises of trustore.jks, keystore.jks and the config.xml file (having the cluster configuration information)

    • Get information on the other nodes registered with the cluster at that instant.

    • Fetched the cluster data

    • Starts the Sonus WebRTC application and sends instance up to the EMS.

The following sample wrtcCloudInputs file shows WRTC node registered with EMS successfully for VMware/KVM installation:

Figure : WRTCCloudInputs File

     2. After initializing the WRTC node you must login as wrtc user to start the WRTC server. For more information on starting and stopping WRTC server, see Starting and Stopping WRTC Server.

You can view the registered node, refer to the Viewing WRTC Registered Node for more information.

After the WRTC node is registered with EMS, the node can now obtain the configuration through push updates. You can as well view the WRTC performance statistics or alarms. For more information, refer to the Performance Management or Fault Management.

Configuration Backups

A configuration can be archived when it is replaced by an active configuration. This interval can be set. The history of the active cluster configurations for a cluster is kept, for a set duration (default is 30 days). You can view the contents of an archived configuration. You can restore an archived configuration and make it the active configuration immediately.