|Oracle® Communications Converged Application Server Administration Guide
Part Number E17647-03
This chapter describes how to configure and manage Oracle Communications Converged Application Server deployments:
Converged Application Server is based on Oracle WebLogic Server 11g release 1 patch set 2, and many system-level configuration tasks are the same for both products. This guide addresses only those system-level configuration tasks that are unique to Converged Application Server, such as tasks related to network and security configuration and cluster configuration for the engine and SIP data tiers.
HTTP server configuration and other basic configuration tasks such as server logging are addressed in the Oracle WebLogic Server documentation. See Oracle Fusion Middleware Getting Started With Installation for Oracle WebLogic Server to get started.
The SIP Servlet container, SIP data tier replication, and Diameter protocol features of Converged Application Server are implemented in the Oracle WebLogic Server 10g Release 3 product as custom resources. A pair of custom resources,
datatier, implement the engine tier SIP Servlet container functionality and SIP data tier replication functionality. In production deployments, both resources are generally installed. Specialized deployments may use only the
sipserver resource in conjunction with a SIP-aware load balancer, as described in "Alternate Configurations" in "Overview of the Converged Application Server Architecture".
Another custom resource,
diameter, provides Diameter base protocol functionality, and is required only for deployments that utilize one or more Diameter protocol applications.
The Converged Application Server custom resource assignments are visible in the domain configuration file,
config.xml, and should not be modified. Example 2-1 shows the definitions for each resource. Note that the
datatier resources must each be targeted to the same servers or clusters; in Example 2-1, the resources are deployed to both the engine tier and SIP data tier cluster.
<custom-resource> <name>sipserver</name> <target>ORA_DATA_TIER_CLUST,ORA_ENGINE_TIER_CLUST</target> <descriptor-file-name>custom/sipserver.xml</descriptor-file-name> <resource-class>com.bea.wcp.sip.management.descriptor.resource.SipServerResource</resource-class> <descriptor-bean-class>com.bea.wcp.sip.management.descriptor.beans.SipServerBean</descriptor-bean-class> </custom-resource> <custom-resource> <name>datatier</name> <target>ORA_DATA_TIER_CLUST,ORA_ENGINE_TIER_CLUST</target> <descriptor-file-name>custom/datatier.xml</descriptor-file-name> <resource-class>com.bea.wcp.sip.management.descriptor.resource.DataTierResource</resource-class> <descriptor-bean-class>com.bea.wcp.sip.management.descriptor.beans.DataTierBean</descriptor-bean-class> </custom-resource> <custom-resource> <name>diameter</name> <target>ORA_ENGINE_TIER_CLUST</target> <deployment-order>200</deployment-order> <descriptor-file-name>custom/diameter.xml</descriptor-file-name> <resource-class>com.bea.wcp.diameter.DiameterResource</resource-class> <descriptor-bean-class>com.bea.wcp.diameter.management.descriptor.beans.ConfigurationBean</descriptor-bean-class> </custom-resource>
The Converged Application Server custom resources utilize the basic domain resources defined in
config.xml, such as network channels, cluster and server configuration, and Java EE resources. However, Converged Application Server-specific resources are configured in separate configuration files based on functionality:
sipserver.xml configures SIP container properties and general Converged Application Server engine tier functionality.
datatier.xml identifies servers that participate as replicas in the SIP data tier, and also defines the number and layout of SIP data tier partitions.
diameter.xml configures Diameter nodes and Diameter protocol applications used in the domain.
approuter.xml configures Default Application Router (DAR).
The domain configuration file,
config.xml, defines all of the Managed Servers available in the domain. The
diameter.xml configuration files included in the
sipserver application determine the role of each server instance, such as whether they behave as SIP data tier replicas, engine tier nodes, or Diameter client nodes.
Configuration changes to SIP Servlet container properties can be applied dynamically to a running server by using the Administration Console or from the command line using the WLST utility. (Some SIP Servlet container properties may display a Restart may be required icon, meaning that you may be required to restart the server to make the change take effect.) Configuration for SIP data tier nodes cannot be changed dynamically, so you must reboot SIP data tier servers in order to change the number of partitions or replicas.
The Diameter protocol implementation is implemented as a custom resource separate from the SIP Servlet container functionality. The Diameter configuration file configures one or more Diameter protocol applications to provide Diameter node functionality. Converged Application Server provides the Diameter protocol applications to support the following node types:
Diameter Sh interface client node (for querying a Home Subscriber Service)
Diameter Rf interface client node (for offline charging)
Diameter Ro interface client node (for online charging)
Diameter relay node
HSS simulator node (suitable for testing and development only, not for production deployment)
The Diameter custom resource is deployed only to domains having servers that function as Diameter client nodes or relay agents, or to servers providing HSS simulation capabilities. The actual function of the server instance depends on the configuration defined in the
See "Chapter 24, "Configuring Diameter Client Nodes and Relay Agents" for instructions on configuring the Diameter Web Application in an Converged Application Server domain.
See "Using the Diameter Sh Interface Application" in Converged Application Server Diameter Application Development Guide for more information about using the Sh profile API.
Converged Application Server provides several mechanisms for changing the configuration of the SIP Servlet container:
Converged Application Server provides Administration Console extensions that allow you to modify and SIP Servlet container, SIP Servlet domain, and Diameter configuration properties using a graphical user interface. The Administration Console extensions for Converged Application Server are similar to the core console available in Oracle WebLogic Server 11g. All Converged Application Server configuration and monitoring is provided through these nodes in the left pane of the console:
SipServer: configures SIP Servlet container properties and other engine tier functionality. This extension also enables you to view (but not modify) SIP data tier partitions and replicas. See "Overview of SIP Container Configuration" for more information about configuring the SIP Servlet container using the Administration Console.
Diameter: configures Diameter nodes and applications.
To learn more about using the Administration Console, see the chapters on using the console in the Oracle WebLogic Server documentation.
The WebLogic Scripting Tool (WLST) enables you to perform interactive or automated (batch) configuration operations using a command-line interface. WLST is a JMX tool that can view or manipulate the MBeans available in a running Converged Application Server domain. "Overview of SIP Container Configuration" in Chapter 8, "Configuring Engine Tier Container Properties" provides instructions for modifying SIP Servlet container properties using WLST.
For more information, see the following documents in the WebLogic Server documentation:
For information about WLST, see Oracle WebLogic Scripting Tool.
For information about WLST commands, see WebLogic Scripting Tool Command Reference.
Most Converged Application Server configuration is performed using either the Administration Console or WLST. The methods described in the following sections may also be used for certain configuration tasks.
You may also edit
approuter.xml manually by following the respective schemas for each configuration file. See Part V, "Converged Application Server Configuration File Reference" in this document for more information.
If you edit configuration files manually, you must reboot all servers to apply the configuration changes.
Converged Application Server properties are represented by JMX-compliant MBeans. You can therefore program JMX applications to configure SIP container properties using the appropriate Converged Application Server MBeans.
The general procedure for modifying Converged Application Server MBean properties using JMX is described in "Configuring Container Properties Using WLST (JMX)" in Chapter 8, "Configuring Engine Tier Container Properties" (WLST itself is a JMX-based application). For more information about the individual MBeans used to manage SIP container properties, see the Converged Application Server JavaDocs.
You can set log levels by manually editing the
logging.xml file, by setting the
(String loggerName, String logLevel) MBean, or through Oracle Enterprise Manager.
General administration and maintenance of Converged Application Server requires that you manage both WebLogic Server configuration properties and Converged Application Server container properties. These common configuration tasks are summarized in Table 2-1.
Configuring SIP Container Properties using the Administration Console
Using WLST to perform batch configuration
Assigning Converged Application Server instances to the SIP data tier partitions
Replicating call state using multiple SIP data tier instances
Configuring WebLogic Server network channels to handling SIP and HTTP traffic
Setting up multi-homed server hardware
Configuring load balancers for use with Converged Application Server
Configuring the LDAP Digest Authentication Provider
Configuring a trusted host list
Configuring logging Servlets to record SIP requests and responses.
Defining log criteria for filtering logged messages
Maintaining Converged Application Server log files