Skip Headers
Oracle® Communications WebRTC Session Controller Installation Guide
Release 7.0

E40974-02
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

9 WebRTC Session Controller Media Engine Post-Installation Tasks

This chapter provides instructions for Oracle Communications WebRTC Session Controller Media Engine (Media Engine) post-installation tasks.

Before you complete Media Engine post installation tasks, you must complete the tasks in the following chapters:

Overview of Media Engine Post-Installation Tasks

Before your Media Engine nodes are ready for use, you must complete the following post-installation tasks:

Configuring Users, Permissions, and Authorization

For more information on configuring user, permissions, and authorization objects and properties, see Oracle Communications OS-E System Administration Guide.

Deploying the Load Factor Application

The following sections describe the steps you must take to deploy the Media Engine load factor application.

About the Load Factor Application

To balance request loads between Signaling Engine nodes and Media Engine nodes, you must deploy a custom load factor application on each Media Engine node. The load factor application reports an appropriate cluster based load factor to a Signaling Engine, and Signalling Engine uses that load factor to choose which Media Engine to relay requests to. Signaling Engine favors less heavily loaded instances for new requests, balancing the load among multiple Media Engine nodes.

About Load Factor Application Virtual Host Deployment Scenarios

There are two ways you can configure the load factor application virtual host:

  • Host name virtual hosting

  • IP virtual hosting

When configuring hostname virtual hosting, you assign an IP address to the load factor web service application, and you provide a Domain Name System (DNS) hostname for the virtual host.

When configuring IP virtual hosting, you assign an IP address to the load factor web service and another IP address to the virtual host.

Note:

Hostname virtual hosting is the recommended Media Engine configuration scheme.

Configuring Host Name Virtual Hosting

To configure hostname virtual hosting:

  1. Navigate to the Media Engine login page:

    https://hostname

    The login page appears.

  2. Enter your administration Username and Password, and click Login.

    The Media Engine home page appears.

  3. Select the Configuration tab.

  4. Expand the cluster node and select the interface node of the box you want to configure.

  5. In the ip row of the configuration table, click Add ip.

  6. Enter a name for the Web service interface, configure the ip-address information as required, and click Create.

  7. Specify the HTTP transmission type, HTTP or HTTPS, as well as the Web service port number, and click Create.

  8. In the virtual-host row of the configuration table, click Add virtual-host.

  9. Enter the DNS hostname you have configured for the virtual host, make sure admin is set to enabled, and click Create.

Continue to "Configuring the Virtual Host web-app-config Object".

Configuring IP Name Virtual Hosting

To IP name virtual hosting:

  1. Navigate to the Media Engine login page:

    https://hostname

    The login page appears.

  2. Enter your administration Username and Password, and click Login.

    The Media Engine home page appears.

  3. Select the Configuration tab.

  4. Expand the cluster node and select the interface node of the box you want to configure.

  5. In the ip row of the configuration table, click Add ip.

  6. Enter a name for the Web service interface, configure the ip-address information as required, and click Create.

  7. Select the interface node again.

  8. In the ip row of the configuration table, click Add ip.

  9. Enter a name for the Web service interface, configure the ip-address information as required, and click Create.

  10. Select the ip object you created for the Web service, and in the web-service row of the Configuration table click Configure.

  11. Specify the HTTP transmission type, HTTP or HTTPS, as well as the Web service port number, and click Create.

  12. In the virtual-host row of the configuration table, click Add virtual-host.

  13. Enter the IP address you have assigned to the virtual host, make sure admin is set to enabled, and click Create.

Continue to "Configuring the Virtual Host web-app-config Object".

Configuring the Virtual Host web-app-config Object

Once you have created and configured the ip objects, you must add a web-app-config object that points to the load factor Web Archive (WAR) file, to the virtual host.

To configure the virtual host's web-app-config object:

  1. Log in to the Media Engine console using a secure shell (SSH), and copy loadfactor.war from the /cxc/ws/samples directory to the /cxc_common/webapps directory.

  2. Navigate to the Media Engine login page:

    https://hostname

    The login page appears.

  3. Enter your administration Username and Password, and click Login.

    The Media Engine home page appears.

  4. Select the Configuration tab.

  5. Expand the cluster node and select the interface node of the box you want to configure.

  6. Expand the ip object you created, expand web-service, and select the virtual-host object.

  7. In the web-app-config row of the configuration table, click Add web-app-config.

  8. Enter the path to the load factor application, /cxc_common/webapps/loadfactor.war and click Create.

  9. In the context-parameter row of the configuration table, click Add context-parameter.

  10. Enter meMgmtHost for the name, and the DNS name or IP address of the Web service for the value, and click Create.

  11. In the context-parameter row of the configuration table, click Add context-parameter.

  12. Enter meMgmtUsername for the name, and the hostname or IP address of the Web service for the value, and click Create.

Configuring Media Engine Communication with Signaling Engine

To enable communication between WebRTC Session Controller Media Engine (Media Engine) and Signaling Engine in your WebRTC Session Controller installation you must add the Media Engines to your Signaling Engine configuration and configure the Media Engine callback which specifies the load balancer endpoint for Media Engine nodes.

Adding Media Engines to Signaling Engine

To add Media Engines to Signaling Engine:

  1. Start your Signaling Engine servers if they are not already running. See "Starting the Signaling Engine Servers" for more information.

  2. Navigate to the WebRTC Session Controller Signaling Engine console and log in with your administrator username and password:

    http://hostname:port/wsc-console
    

    Note:

    The default Signaling Engine console port is 7001.
  3. Select the Configuration tab.

  4. Click Lock and Edit.

  5. In the Media Engine pane, enter the following information:

    • User: Enter the Media Engine administrative username.

    • Password: Enter the password for the administrative username.

  6. Click the Add button and enter the following information:

    • Address: Enter the hostname or IP address of the Media Engine Node.

    • Port: Enter the port of the Media Engine Node.

  7. Click OK to save the Media Engine Node. Add additional nodes as required.

  8. Click Commit to save your changes.

For more information on the Media Engine options, see Oracle Communications WebRTC Session Controller System Administrator's Guide.

Configuring the Media Engine Callback

To configure the Media Engine callback:

  1. Start your Signaling Engine servers if they are not already running. See "Starting the Signaling Engine Servers" for more information.

  2. Navigate to the WebLogic Server administration console and log in with your administrator user name and password:

    http://hostname:port/console
    

    Note:

    The default administration console port is 7001.
  3. In the Domain Structure pane, expand Environment, and select Servers.

  4. In the Summary of Servers pane, select the Configuration tab.

  5. Select your Signaling Engine server from the Servers table.

    Note:

    You will have to repeat this procedure for each Signaling Engine in a clustered environment.
  6. In the Settings for the Signaling Engine, select the Protocols tab.

  7. Select wsc-me-callback from the Network Channels table.

  8. If you need to override the default values for Listen Address and Listen Port, uncheck Enabled.

  9. Update the following information:

    • Listen Address and Listen Port: Enter the hostname or IP address and the port of the Signaling Engine which will serve as the primary endpoint for the Media Engine HTTP callbacks. You can only update this field if Enabled is unchecked.

    • External Listen Address and External Listen Port: Enter the hostname or IP address and port of the load balancer or the Signaling Engine which will serve as the backup endpoint for the Media Engine HTTP callbacks if the primary endpoint cannot be reached.

  10. If you have modified the default values for Listen Address or Listen port, check Enabled.

  11. Click Save.

  12. Log out of the administration interface.

Configuring Media Engine Anchoring

Table 9-1 describes the media anchoring options supported by WebRTC Session Controller.

Table 9-1 WebRTC Session Controller Routing Options

Scenario Description

Web to Web conditional anchoring

Dynamic Media Anchoring (DMA) is enabled. Browsers are allowed to stream media between each other directly. If they cannot directly reach each other (for instance if they are behind a Network Address Translation (NAT) firewall and no Traversal Using Relays around NAT (TURN) service is configured), media is relayed through Media Engine. Calls from WebRTC endpoints to and from non-WebRTC/SIP/PSTN endpoints are automatically supported.

Web to Web forced anchoring

DMA is enabled and all media is routed through Media Engine. Calls from WebRTC endpoints to and from non-WebRTC/SIP/PSTN endpoints are automatically supported.

Web to Web bypassing Media Engine

DMA is disabled, and nothing is passed through Media Engine. This should only be done for diagnostic purposes.


You can modify the anchoring behavior by modifying constants in the Signaling Engine GroovyScript library.

To change the Signaling Engine to Media Engine anchoring scheme:

  1. Start your Signaling Engine servers if they are not already running. See "Starting the Signaling Engine Servers" for more information.

  2. Navigate to the WebRTC Session Controller Signaling Engine console and log in with your administrator user name and password:

    http://hostname:port/wsc-console
    

    Note:

    The default Signaling Engine console port is 7001.
  3. Select the Script Library tab.

  4. Click Lock and Edit.

  5. Modify the script library as required:

    • For Web to Web conditional anchoring, set:

      public static final DMA_ENABLED = true
      public static final ME_CONFIG_NAME_DMA = web-to-web-anchor-conditional
      
    • For Web to Web forced anchoring, set:

      public static final DMA_ENABLED = true
      public static final ME_CONFIG_NAME_DMA = web-to-web-anchored
      
    • To bypass Media Engine instances for diagnostic purposes:

      public static final DMA_ENABLED = false
      

      Note:

      When DMA_ENABLED is set to false, the value of ME_CONFIG_NAME_DMA does not matter.
  6. Click Validate Library to ensure you introduced no errors. Fix any errors that are reported.

  7. Click Commit to save your changes.

Next Steps

If you have encountered any issues, see "Troubleshooting a WebRTC Session Controller Installation" for troubleshooting instructions; otherwise, you can perform additional tasks to set up your test or production system:

  • Set up WebRTC Session Controller system security.

    See the discussion about setting up and managing WebRTC Session Controller security in WebRTC Session Controller System Administrator's Guide and WebRTC Session Controller Security Guide.

  • Configure the WebRTC Session Controller system.

    See WebRTC Session Controller System Administrator's Guide.