Installing WebLogic SIP Server

WebLogic SIP Server Quick-Start Installation

This document summarizes the tasks required to install and configure a multiple-server installation of WebLogic SIP Server 2.1. It is intended for users who are already familiar with WebLogic Server installation and configuration, or for users who want to quickly set up a multiple-server configuration for demonstration or evaluation. If you are unfamiliar with installing BEA products or you want to perform automated or non-graphical installations, see to Installing WebLogic SIP Server instead.

This document contains the following sections:

Overview of Installation Steps

The quick-start installation involves performing the following steps:

Step 1: Install WebLogic SIP Server on All Machines. In this step, you use the BEA installation program to copy the WebLogic SIP Server product onto all server machines that will host a WebLogic SIP Server instance.
Step 2: Create an Administrative Domain. In this step, you create the administrative domain that will contain all of the servers and clusters in your WebLogic SIP Server installation.
Step 3: Configure Server Instances and Clusters. In this step, you create and configure servers and clusters in the WebLogic SIP Server domain.
Step 4: Configure Data Tier Partitions. In this step, you define which server instances participate in the WebLogic SIP Server data tier, and define the data tier partitions in which each server participates.
Step 5: Start the Administration Server and Managed Servers. In this step, you boot the Administration Server and then boot all other Managed Servers in your installation.

Step 1: Install WebLogic SIP Server on All Machines

The WebLogic SIP Server software must be available on all server machines that will run a WebLogic SIP Server instance. Follow these steps for the Administration Server machine and for all other machines that will run a Managed Server:

Execute the installation program for your operating system. To execute the Linux or Solaris binary installation program:

chmod a+x ./wlss210_linux32.bin

./wlss210_linux32.bin

(Substitute the appropriate filename name for the installation program you have obtained.)
To launch the Windows executable: wlss210_win32.exe
To launch the generic JAR file installation:

Ensure that the path to the bin directory of a supported Java VM is part of your PATH environment variable.

Launch the generic installer with:

java -jar ./wlss210_generic.jar

Follow the prompts to install WebLogic SIP Server on the local machine.

Exit the installation program.

See Installing WebLogic SIP Server for more information about using the installation program.

Step 2: Create an Administrative Domain

All related WebLogic SIP Server instances must be members of the same administrative domain. The Configuration Wizard provided with WebLogic SIP Server contains three templates that help you create different types of domains:

WebLogic SIP Server Examples Domain—This template creates a new, single-server domain with the findme example automatically deployed.
Replicated WebLogic SIP Server Domain—This template creates a new template domain having a having two data tier server instances, an engine tier server instance, and an Administration Server instance. Select this template for any multiple-server WebLogic SIP Server installation; you can modify this basic domain to add or remove servers as necessary.
Basic WebLogic SIP Server Domain creates an empty single-server domain that you can use for developing your own applications.

Follow these steps to install a new WebLogic SIP Server domain:

Access the server machine that will be used as the Administration Server. The domain directory and associated files for the domain will remain on the Administration Server machine. Other servers in the WebLogic SIP Server installation (data tier and engine tier servers) will obtain their configuration by connecting to the Administration Server at boot time.

Change to the WLSS_HOME\common directory, where WLSS201 is the directory in which you install WebLogic SIP Server 2.1 (for example, c:\bea\wlss210\common).

Execute the config.cmd or config.sh script to launch the Configuration Wizard.

Select Create a new WebLogic Configuration and click Next.

Select the WebLogic SIP Server template that you want to use and click Next. If you are configuring a production installation, select either the Basic or Replicated WebLogic SIP Server Domain templates.

Select Express and click Next.

Enter a username and password for the Administrator of the new domain, and click Next.

Select the startup mode and JDKs to use with the new domain, and click Next.

Enter a name for the new domain, and optionally change the directory location in which you want to create the domain. By default, the Configuration Wizard places new domains in the WLSS_HOME\user_projects\domains directory of the WebLogic SIP Server installation directory. Click Create to create the new domain.

Click Done to exit the Configuration Wizard.

Step 3: Configure Server Instances and Clusters

The WebLogic SIP Server instances you intend to use must be created within a single administrative domain, and servers in the engine and data tiers should be arranged into clusters to simplify deployment and management. If you used the Configuration Wizard to create a Replicated WebLogic SIP Server domain, the domain is automatically created with default engine tier servers and data tier servers arranged into clusters; you can simply modify this configuration to match the number of servers you want to use in your domain. See

If you used the Configuration Wizard to create a Basic WebLogic SIP Server domain, only a single server is configured. You will need to create engine and data tier servers and clusters by hand. See Creating Servers and Clusters by Hand.

Warning: When you configure a domain with multiple engine and data tier servers, you must accurately synchronize all server system clocks to a common time source (to within one or two milliseconds) in order for the SIP protocol stack to function properly. See Configuring NTP for Accurate SIP Timers in Configuring and Managing WebLogic SIP Server for more information.

Modifying the Default Replicated Domain

The default Replicated WebLogic SIP Server domain is preconfigured with four separate servers and two clusters.

Table 2-1 Summary of the Default Replicated Domain

Server	Cluster	Description
myserver	n/a	The Administration Server, myserver, is used only for administration. This server is not a member of either cluster, and it does not process SIP requests.
engine1	BEA_ENGINE_CLUST	The single engine tier server, engine1, can be used for hosting SIP applications and processing SIP messages.
replica1	BEA_DATA_TIER_CLUST	The two data tier servers, replica1 and replica2, are members of the same data tier partition. Each server manages the same copy of the application call state and can act as a backup should the other server fail.
replica2	BEA_DATA_TIER_CLUST

You may want to modify the default replicated domain if you want to add, remove, or rename servers in either of the clusters, or to configure the network settings of individual server instances. To modify the default configuration:

Start the Administration Server:

cd c:\bea\user_projects\domains\replicated

startAdminServer.cmd

Access the Administration Console by pointing a browser to http://localhost:7001/console

To add a new engine or data tier server:

Click the Servers node in the left pane.

Select the Clone icon to the right of a server you want to add. To add an engine tier server, clone the engine1 server instance. To add a data tier server, clone either replica1 or replica2.

Enter a new name for the cloned server.

Enter the Listen Address and Listen Port of the remote Managed Server machine on which the server will run.

Click the clone button.

To delete an existing engine or data tier server:

Click the Servers node in the left pane.

Click the trash can icon to the right of the server you want to delete.

Click Yes to delete the server configuration.

To rename an existing server or change its network listen address or port:

Expand the Servers node in the left pane.

Click the name of the server you want to modify.

On the Configuration->General tab, modify the Name, Listen Address, or Listen Port entries as necessary.

Click Apply to apply your changes.

Note: These quick-start instructions assume each managed server listens on a single network address. If you intend to run servers on multi-homed server hardware, or if you want to configure secure SIP transport protocols, see Managing WebLogic SIP Server Network Resources in Configuring and Managing WebLogic SIP Server.

Creating Servers and Clusters by Hand

If you used the Configuration Wizard to create a Basic WebLogic SIP Server domain, the domain contains a single WebLogic SIP Server instance that acts as the administration server and WebLogic SIP Server (with data and engine tier functionality combined). To move from the basic domain to a production domain, you will need to create all servers and clusters by hand, and move engine tier services off of the Administration Server instance. Follow these instructions:

Start the Administration Server:

cd c:\bea\user_projects\domains\replicated

startAdminServer.cmd

Access the Administration Console by pointing a browser to http://localhost:7001/console

Create a new engine tier server:

Click the Servers node in the left pane.

Select Configure a new Server...

Enter a new name for the server.

Enter the Listen Address and Listen Port of the remote Managed Server machine on which the server will run.

Click the Create button.

Select the Protocols->Channels tab.

Select Configure a new Network Channel...

Fill in the fields of the new channel as follows and click Create:

Name: Enter a name for the new channel.
Protocol: Select sip or sips transport. Note that all channels also support UDP transport.
Listen Address/Listen Port: If your Managed Server machine uses a single network interface, leave these fields blank. When left blank, the listen address and port of the server are used as defaults, unless you later configure a load balancer for the system.

If the machine uses multiple IP addresses (a multihomed machine), enter the IP address and port to use for a connections on one of the available NICs. Repeat the above three steps to create a separate channel for each NIC.

In the left pane of the console, right-click on the name of the newly-created engine tier server and select View Execute Queues.

Click Configure a New Execute Queue...

Enter a Name, Queue Length, Thread Priority, and Thread Count from Table 2-2 and click Create.

Table 2-2 Default Execute Queues

Name	Queue Length	Thread Priority	Thread Count
sip.timer.Default	1024	5	3
sip.tracing.domain	1024	5	1
sip.tracing.local	1024	5	1
sip.transport.Default	65536	5	15

Repeat the prior three steps in order to create each execute queue shown in Table 2-2.

Repeat the above step to add additional engine tier servers.

Create a new data tier server:

Click the Servers node in the left pane.

Select Configure a new Server...

Enter a new name for the server.

Enter the Listen Address and Listen Port of the remote Managed Server machine on which the server will run.

Click the Create button.

Repeat the above step to add additional data tier servers.

Create a new cluster for hosting the engine tier servers:

Select the Clusters tab in the left pane of the console.

Select Configure a new Cluster...

Fill in the fields of the Configuration->General tab as follows:

Name: Enter a name for the engine tier cluster.
Cluster Address: Enter a DNS name or a comma-separated list of IP addresses that maps to the individual server Listen Addresses you will add to the engine tier cluster.

Click Create to create the cluster

Select the Configuration->Multicast tab.

Enter an unused Multicast Address and Multicast Port to use for communication between servers in this cluster.

Click Apply

Select the Configuration->Servers tab.

Select the names of all engine tier servers in the Available column, and use the arrow to move the servers to the Chosen column.

Click apply.

Repeat the above step to create a new data tier cluster for hosting the data tier servers you created.

Click the Deployments tab in the left pane.

Select the sipserver application in the right pane.

Select the Targets tab.

Configure the application's targets as follows:

In the Independent Servers table, de-select myserver. The Administration Server should not provide SIP Servlet container or data replication functionality.

In the Clusters table, select the name of your engine tier cluster. Ensure that the All servers in the cluster option is selected (this is the default).

In the Clusters table, select the name of your data tier cluster. Ensure that the All servers in the cluster option is selected (this is the default).

Click apply to apply your changes

Shut down your Administration Server instance.

Step 4: Configure Data Tier Partitions

In the previous section you organized the data tier servers into a cluster for administration purposes. You must also configure the datatier.xml file to define how data tier servers are used to manage SIP application call state for your installation.

The data tier cluster can be arranged into one or more partitions. A partition consists of one or more data tier server instances that manage the same portion of the concurrent call state data. In a single-server WebLogic SIP Server installation, or in a two-server installation where one server resides in the engine tier and one resides in the data tier, all call state data is maintained in a single partition. Multiple partitions are required when the size of the concurrent call state exceeds the maximum size that can be managed by a single server instance. In most cases, the amount of call state that can be managed by a server corresponds to the Java Virtual Machine limit of approximately 1.6GB per server.

Additional servers can also be added within the same partition to manage copies of the call state data. When multiple servers are part of the same partition, each server manages a copy of the same portion of the call data, referred to as a replica of the call state. If any server in a partition fails or cannot be contacted due to a network failure, another replica in the same partition can supply the call state data to the engine tier.

Before modifying datatier.xml, read Configuring Data Tier Partitions and Replicas in Configuring and Managing WebLogic SIP Server to fully understand the role of the data tier and the format of the datatier.xml configuration file.

To modify datatier.xml for your domain:

Access the Administration Server machine for your domain.

Open the datatier.xml configuration file with a text editor. This file is part of the sipserver application that provides WebLogic SIP Server functionality, installed in the top level of your domain directory:

cd c:\bea\user_projects\domains\replicated\sipserver\config

notepad datatier.xml

If you installed the default replicated domain, the datatier.xml file contains the entries shown in Listing 2-1, which defines a single partition with two replicas.

Listing 2-1 Default datatier.xml for Replicated Domain

<st:data-tier xmlns:st="http://www.bea.com/ns/wlcp/wlss/210">

 <st:partition>

   <st:name>partition-0</st:name>

   <st:server-name>replica1</st:server-name>

þþþ<st:server-name>replica2</st:server-name>

</st:partition>

</st:data-tier>

Edit the file as necessary to configure partitions and server names for your domain.

Save your changes and exit the text editor.

Step 5: Start the Administration Server and Managed Servers

To start the fully-configured WebLogic SIP Server domain, first start the Administration Server, then start individual Managed Servers to connect to the Administration Server. The sections that follow provide server startup instructions.

Starting the Administration Server

To start the Administration Server:

Access the Administration Server machine.

Move to your domain directory:

cd c:\bea\user_projects\domains\replicated

Execute the start script for the Administration Server:

startAdminServer.cmd

Starting Managed Servers

Note: WebLogic SIP Server start scripts use default values for many JVM parameters that affect performance. For example, JVM garbage collection and heap size parameters may be omitted, or may use values that are acceptable only for evaluation or development purposes. In a production system, you must rigorously profile your applications with different heap size and garbage collection settings in order to realize adequate performance. See Tuning JVM Garbage Collection for Production Deployments in Configuring and Managing WebLogic SIP Server for suggestions about maximizing JVM performance in a production domain.

To start the Managed Servers in your domain:

Access one of the Managed Server machines.

Move to a subdirectory from which you will execute the Managed Server instance (creating a new subdirectory if necessary). For example:

mkdir c:\myManagedServer

cd c:\myManagedServer

Note: The Managed Server machines do not have a domain directory. Instead, they obtain their configuration by connecting to the Administration Server at startup.

Execute the Managed Server start script available in the WL_HOME\common\bin directory:

WL_HOME\common\bin\startManagedWebLogic.cmd server_name admin_url

where:

WL_HOME is the full path to the WebLogic SIP Server installation directory, and
server_name is the name of the Managed Server you are starting, and
admin_url is the url used to access the Administration Server for the domain.

For example: startManagedWebLogic.cmd replica1 t3://adminhost:7001

Repeat these steps to start other Managed Servers in the domain.

Where to Go From Here

After booting your domain, you may want to perform further administration procedures such as configuring network resources, enabling logging, or setting up security providers. For more information on these topics, see Configuring and Managing WebLogic SIP Server.