This chapter describes the steps required to create your Oracle Communications Converged Application Server domain.
Before continuing in this chapter, you need to understand the following:
WebLogic Server domains and clustering. See "Understanding Oracle WebLogic Server Domains" and "Understanding WebLogic Server Clustering" in Oracle Fusion Middleware Understanding Domain Configuration for Oracle WebLogic Server.
The domain topologies available for use with Converged Application Server. See "Understanding Converged Application Server Installation Topologies".
You must configure the domains of all servers in your Converged Application Server system. You can configure your domains by:
Using the WebLogic Server Configuration Wizard to configure each server in your installation.
Configuring the domain on the Administration Server and then using the pack and unpack commands provided by Oracle WebLogic Server to package the configuration data for copying to all the other servers. The Converged Application Server installer puts the pack and unpack commands in the Oracle_home/wlserver/common/bin directory. Oracle_home is the directory that serves as the repository for common files that are used by Oracle Communications products installed on the same machine, such as Converged Application Server and WebLogic Server.
For more information about packing and unpacking configurations, see Oracle Fusion Middleware Creating Templates and Domains Using the Pack and Unpack Commands.
Using the WebLogic Scripting Tool (WLST) to configure each domain. The WLST scripting environment is based on the Java scripting interpreter, Jython. See Oracle Fusion Middleware Understanding the WebLogic Scripting Tool for more information.
For more information about other methods available for domain creation, see "Additional Tools for Creating, Extending, and Managing WebLogic Domains" in Oracle Fusion Middleware Creating WebLogic Domains Using the Configuration Wizard.
Converged Application Server ships with default domain configuration templates for each type of deployment that Converged Application Server supports. You use one of these templates to configure your domain. These templates contain the basic configurations for setting up domains, but you may need to adjust some aspects of the domain during the domain configuration process.
Basic Domain
The Basic Domain template enables you to create a simple Converged Application Server domain. This domain configuration can be used during development where it is more convenient to deploy and test applications on a single server. The Basic Domain topology can also be used in deployments that do not have high-availability and scalability requirements.
This domain template is specified in oracle.communications.occas.basic.template.jar.
The domain configuration script for this domain type is occas-basic.py.
Replicated Domain
The Replicated Domain template enables you to create a replicated Converged Application Server domain. The Replicated Domain topology is designed for use with SIP applications that require high levels of scalability, availability, and performance.
This domain template is specified in oracle.communications.occas.combined. coherence.template.jar.
The domain configuration script for this domain type is occas-replicated.py.
Converged Application Server - Diameter Sh Domain
The Diameter Sh Domain template enables you to create a simple Diameter Converged Application Server domain. The Diameter Sh Domain topology supports the Diameter protocol over the TCP, TLS, and SCTP transport protocols.
Note:
This domain is not available through the Graphical Mode Domain Configuration Wizard. You install and configure the Diameter Sh Domain manually. For instructions, see "Configuring Diameter Client Nodes and Relay Agents" in Converged Application Server Administrator's Guide.This domain template is specified in diameterdomain.jar.
The domain configuration script for this domain type is occas-diameter.py.
Proxy Registrar - Basic Domain
The Proxy Registrar - Basic Domain template enables you to create a non-clustered (single-server) Converged Application Server domain with the Proxy Registrar component. The Proxy Registrar combines the functionality of a SIP proxy server and registrar. Its main tasks include registering subscribers, looking up subscriber locations, and proxying requests. The Proxy and Registrar functions are described in RFC 3261.
The Proxy Registrar - Basic Domain template creates a domain appropriate for development environments, or cases where high availability is not an important consideration.
This domain template is specified in oracle.communications.proxyregistar.basic.template.jar.
The domain configuration script for this domain type is occas-proxyregistrar.py, and the associated properties file is occas-proxyregistrar.properties.
Proxy Registrar - Replicated Domain
The Proxy Registrar - Replicated Domain template enables you to create a clustered (multi-server) Converged Application Server domain with the Proxy Registrar component. The Proxy Registrar Replicated Domain template creates a domain appropriate for production environments where high availability and scalability are crucial.
This domain template is specified in oracle.communications.proxyregistrar.combined.coherence.template.jar.
The domain configuration script for this domain type is occas-proxyregistrar-replicated.py, and the associated properties file is occas-proxyregistrar-replicated.properties.
The domain template JAR files for these domain types are located in the directory Oracle_home/wlserver/common/templates/wls.
The domain configuration scripts and property files are located in the directory Oracle_home/occas/common/templates/scripts/wlst.
To add Diameter support, extend an existing domain with Diameter components. The domain extension template is Oracle_home/wlserver/common/templates/wsl/diameterextension.jar.
To create a Converged Application Server domain:
If you are creating a replicated domain, perform the required preconfiguration steps.
Start the Configuration Wizard.
Answer the questions in each screen of the Configuration Wizard.
For more information about creating a WebLogic Server domain by using the Configuration Wizard, see "Creating a WebLogic Domain" in Oracle Fusion Middleware Creating Domains Using the Configuration Wizard.
If you are creating a Converged Application Server replicated domain, perform the following configuration steps:
Specify an explicit listener address for each machine in your cluster. This enables your machines to communicate with each other when the Coherence Cluster uses the default cluster mode.
If you do not want to specify an explicit listen address for each machine, change the Coherence cluster mode either to unicast addressing by using the Well Known Address (WKA) feature or to multicast addressing.
Keep the directory structures the same on each machine in the cluster to simplify deployment.
Install the Converged Application Server binaries on each machine in the cluster.
Install any required patches manually on each machine in the cluster; they are not distributed automatically.
Create the replicated domain on your Administration Server, and copy that domain to each of your cluster machines.
Note:
If the Administration Server is already started before you copy its domain to the cluster servers, delete the existing domains on each cluster server:
rm -rf Domain_home/servers/
Domain_home is the directory in which the Converged Application Server domain resides, located in Oracle_home/user_projects/domains.
For more information, see the following:
"Configuring and Managing Coherence Clusters" in Oracle Fusion Middleware Administering Clusters for Oracle WebLogic Server.
"Introduction to Coherence Clusters" in Oracle Fusion Middleware Developing Applications with Oracle Coherence.
"Relationship Between Coherence and WebLogic Server Clusters" in Oracle Fusion Middleware Understanding Oracle WebLogic Server.
If you selected the Automatically Launch the Configuration Wizard check box during Converged Application Server installation, the Domain Configuration Wizard starts automatically.
To start the Configuration Wizard manually:
Log in to the target system.
Go to the Oracle_home/wlserver/common/bin directory.
At a command prompt, enter one of the following:
Windows:
config.cmd
Linux or Solaris:
sh config.sh
The Configuration Wizard starts and the Configuration Type screen appears. Go to "Creating a Converged Application Server Domain in Graphical Mode" and follow the steps for configuring the domain.
The Configuration Wizard displays a sequence of screens in the order listed below. The screens that you see depend on the type of product configuration template that you use. To configure your domain, answer the questions in the following screens:
In the Configuration Type screen:
Select Create a new domain.
In the Domain Location field, specify your Domain_home directory. This directory must be empty.
Oracle recommends that you create your domain outside of the Oracle_home directory. This directory structure helps you avoid issues when you upgrade or reinstall your software.
Click Next.
The Templates screen appears.
For more information about:
The Domain_home directory, see "Choosing a Domain Home" in Oracle Fusion Middleware Planning an Installation of Oracle Fusion Middleware.
Other options on the Configuration Type screen, see "Configuration Type" in Oracle Fusion Middleware Creating WebLogic Domains Using the Configuration Wizard.
In the Templates screen:
Select Create Domain Using Product Templates.
This option offers you a set of domain templates. See "About Domains and Domain Configuration" for a description of the different templates.
In the Available Templates area, select one of the following Converged Application Server configuration templates:
Converged Application Server - Proxy Registrar Replicated Domain - 7.0.0.1.
Converged Application Server - Proxy Registrar Basic Domain - 7.0.0.1.
Converged Application Server - Replicated Domain - 7.0.0.1.
Converged Application Server - Basic Domain - 7.0.0.1.
Click Next.
The Administrator Account screen appears.
For more information about the options on the Templates screen, see "Templates" in Oracle Fusion Middleware Creating WebLogic Domains Using the Configuration Wizard.
In the Administrator Account screen:
In the Name field, enter the user name for the domain's default WebLogic Administrator account.
This user name is used for booting and connecting to the Administration Server. For setup and testing, Oracle recommends that you use weblogic.
User names are case-sensitive. Do not use commas or any characters in the following comma-separated list:
\t, < >, #, |, &, ?, ( ), { }
In the Password field, enter the main administrator password.
The password is case-sensitive and must contain a minimum of eight characters, at least one of which is not alphabetic.
In the Confirm Password field, re-enter your password.
Write down the user name and password. You need this information later to start and access the Administration Server.
Click Next.
The Domain Mode and JDK screen appears.
In the Domain Mode and JDK screen:
In the Domain Mode area, select the appropriate startup mode for your installation:
Development Mode
Production Mode
Production mode gives your environment a higher degree of security, requiring a user name and password to start the Administration Server.
For more information about startup modes, see "Development vs. Production Mode Default Tuning Values" in Oracle Fusion Middleware Performance and Tuning for Oracle WebLogic Server.
In the JDK area, select the JDK to use for the domain.
By default, the installer selects the JDK that was used when you installed Converged Application Server. Alternatively, you can specify a different JDK.
Click Next.
For Proxy Registrar domains, the JDBC Data Sources screen appears.
For non-proxy registrar domains, the Advanced Configuration screen appears. (See "Advanced Configuration Screen").
This screen appears only if you selected one of the Proxy Registrar domains.
Specify the connection information between Converged Application Server and the JDBC data sources (databases). A JDBC data source contains a pool of database connections that are created when the data source instance is created, when the data source is deployed or targeted, or at server startup. Applications look up a data source on the JNDI tree, and then request a connection.
In the JDBC Database Sources screen:
In the table, select the Location Source, Security Service, and User Service check boxes.
Edit the following fields to meet your system requirements:
Vendor: Select the database vendor.
Driver: Select the driver for your database type from the list.
DBMS/Service: Enter the name of the Converged Application Server database.
Host Name: Enter the name of the server that is hosting your Converged Application Server database. The default is localhost.
Port: Enter the port number for contacting the database. For Oracle, the default is 1521. For MySQL, the default is 3306.
Username: The Converged Application Server user name you created when you installed the database.
Password: The Converged Application Server password you created when you installed the database (it is not echoed on the screen).
Oracle RAC configuration for data sources: If you are using Real Application Cluster features, do one of the following:
To convert one or more data sources to GridLink Oracle RAC data sources, select Convert to GridLink.
To convert one or more data sources to Oracle RAC multi-data sources, select Convert to RAC multi data source.
To not convert the data sources, select Don't Convert.
Click Next.
The JDBC Data Sources Test screen appears.
This screen appears only if you selected one of the Proxy Registrar domains.
The JDBC Data Sources Test screen automatically tests your data source configurations:
A green check mark displayed in the Status column indicates that the configuration is valid.
A red circle indicates a problem.
The bottom of the screen shows a short error message to help you troubleshoot the problem. Fix the error and click Test Selected Connections to test your data source configurations again.
Click Next when you are ready to proceed to the next screen.
This screen appears only if you selected one of the Proxy Registrar domains.
The Database Scripts screen allows you to run scripts for creating your JDBC data source tables.
In the Database Scripts screen:
In the JDBC Data Sources area, select Location Service.
In the SQL Files area, the create service table script is selected by default.
From the DB Version list, select the database version: 10 or 11.
To configure the script to generate a log file, select the Enable Logging check box.
Click Run Scripts.
The script status is output to the Results area.
In the JDBC Data Sources area, select Security Service.
In the JDBC Data Sources area, select User Service.
Click Next.
The Advanced Configuration screen appears.
The Advanced Configuration screen allows you to perform advanced configuration on the listed items. If you approve of the current settings, keep all of the check boxes deselected and click Next.
In the Advanced Configuration Screen:
Select one or more of the following check boxes.
Administration Server
Node Manager
Managed Servers, Clusters and Coherence
Deployments and Services
Click Next.
The screens that appear next depend on the check boxes that you selected (see Table 6-1).
Table 6-1 Screens Displayed for Advanced Configuration
| Check Box Selected | Screens Displayed |
|---|---|
|
Administration Server |
|
|
Node Manager |
|
|
Managed Servers, Clusters and Coherence |
|
|
Deployments and Services |
In the Administration Server screen:
In the Server Name field, enter the name of your Administration Server.
In the Listen Address list, select an explicit listener address for your Administration Server. Using an explicit listener address enables your machines to communicate with each other when the Coherence Cluster uses the default cluster mode.
In the Listen Port field, enter a port number to use as a listening port for the Administration Server.
To enable the SSL listen port, select the Enable SSL check box and enter the port number to use for secure requests. The default port number is 7002.
Click Next.
In the Node Manager screen:
In the Node Manager Type area, select one of the following:
Per Domain Default Location. If you select this option, the Node Manager home is predefined within the domain as DomainName/nodemanager and you cannot edit the Node Manager home. The Node Manager for each domain can have a different configuration, as determined by the files in this directory.
Per Domain Custom Location. If you select this option, the Node Manager configuration files are created in a specific location for this domain. Specify the directory in the Node Manager Home field, or click Browse to navigate to the location. The specified directory must be empty. The nodemanager.properties and nodemanager.domains files are created in this directory.
Manual Node Manager Setup. If you select this option, Node Manager configuration for the domain is skipped. You must manually create and update the Node Manager configuration for the domain.
In the Node Manager Credentials area, enter the user name and password that is used to start the specified Node Manager.
Click Next.
Add or change connection information for your managed servers. You can add server instances now by clicking the Add or Clone buttons or add them later by using the Administration Console.
In the Managed Servers screen:
In the Server Name field, enter the name of the managed server.
In the Listen Address list, select an explicit listener address for your managed server. Using an explicit listener address enables your machines to communicate with each other when the Coherence Cluster uses the default cluster mode.
The values for the listener address can include alphanumeric characters, dots [.], and dashes [-] only.
In the Listen Port field, enter a port number to use as a listening port for the managed server.
To enable the SSL listen port, select the Enable SSL check box and enter the port number to use for secure requests.
Do not enable SSL unless you have a trusted key.
Click Next.
Clusters enable you to group managed servers such that they operate as a single unit for hosting applications and resources. You can add clusters by clicking the Add button.
In the Clusters screen:
In the Cluster Name field, enter the name of the cluster. The name of the cluster must be unique among all component names within the domain.
In the Cluster Address field, enter the addresses for identifying the managed servers in the clusters.
In the Frontend Host field, enter the IP address of the frontend host for the cluster.
In the Frontend HTTP Port field, enter the plain port (HTTP) of the frontend host for the cluster.
In the Frontend HTTPS field, enter the secure port (HTTPS) of the frontend host for the cluster.
Click Next.
Assign Servers to Clusters Screen
In the Assign Servers to Clusters screen:
In the Servers pane, select one or more managed servers.
In the Clusters pane, select the cluster to which you want to assign the managed servers.
Click the right arrow button.
Click Next.
In the Coherence Clusters screen:
In the Cluster Name field, enter the name of the Coherence cluster.
In the Unicast Listen Port field, enter the port number to use as the Coherence cluster unicast listen port.
Click Next.
Add or change information about the machines in your Converged Application Server system. In the context of WebLogic Server, a machine is the logical representation of the system that hosts one or more WebLogic Server instances, for the purposes of starting and stopping remote servers using the Node Manager. In a domain, machine definitions identify a particular, physical piece of hardware and are used to associate a computer with the managed servers it hosts.
For Linux and Solaris
In the Machines screen, select the Unix Machine tab.
To add machines to your Converged Application Server system, click Add.
In the Name field, enter the name of the machine.
The name does not have to match the network name for the machine. However, the name must be unique among all component names within the domain.
To enable a server running on this machine to bind to a UNIX group ID (GID) after it finishes all privileged startup actions, select the Enable Post Bind GID check box and enter the GID in the Post Bind GID field.
To enable a server running on this machine to bind to a UNIX user ID (UID) after it finishes all privileged startup actions, select the Enable Post Bind UID check box and enter the UID in the Post Bind UID field.
In the Node Manager Listen Address list, select the address that Node Manager uses to listen for connection requests.
In the Node Manager Listen Port list, select the port that Node Manager uses to listen for connection requests.
Click Next.
For Windows
In the Machines screen, select the Machine tab.
To add machines to your Converged Application Server system, click Add.
In the Name field, enter the name of the machine.
The name does not have to match the network name for the machine. However, the name must be unique among all component names within the domain.
In the Node Manager Listen Address list, select the address that Node Manager uses to listen for connection requests.
In the Node Manager Listen Port list, select the port that Node Manager uses to listen for connection requests.
Click Next.
Target applications and libraries for deployment on your server or cluster.
In the Deployments Targeting screen:
In the Deployments pane, select one or more libraries and applications to deploy.
In the Targets pane, select the cluster or server on which to deploy the application or library.
Click the right arrow button.
Click Next.
Target services for deployment on servers or clusters.
In the Services Targeting screen:
In the Services pane, select one or more services to deploy.
In the Targets pane, select the cluster or server on which to deploy the service.
Click the right arrow button.
Click Next.
The Configuration Summary screen lists the detailed configuration settings of your domain.
Click Create to accept the domain details and to start creating the domain.
The Configuration Progress screen displays a progress bar that indicates the status of the configuration process.
After the domain is created successfully, click Next.
The Configuration Success screen displays the name of your domain, the path to the domain files, and the URL for accessing the Administration Console.
Click Finish to end your configuration session.
To access the tools for managing your domain, start the necessary servers:
To start the Administration Server:
Go to the Domain_home/bin directory.
Enter the following command:
./startWebLogic.sh
If you selected a production startup mode, you are prompted for the login credentials of the Administrator user.
You can create a boot identity file to bypass the need to provide a user name and password when starting the Administration Server in production mode. For more information, see "Creating a Boot Identity File for an Administration Server" in Oracle Fusion Middleware Administering Server Startup and Shutdown for Oracle WebLogic Server.
For more information about starting the Administration Server, see "Starting and Stopping Administration Server" in Oracle Fusion Middleware Administering Oracle Fusion Middleware.
To start Node Manager:
Go to the Domain_home/bin directory.
Enter the following command:
./startNodeManager.sh
Oracle recommends that you install Node Manager to run as a startup service, which allows Node Manager to start up automatically each time the system restarts. For more information about installing a per domain Node Manager service, see "Running Node Manager as a Startup Service" in Oracle Fusion Middleware Administering Node Manager for Oracle WebLogic Server.
Before starting your managed servers for the first time, copy the Domain_home/security/SerializedSystemIni.dat file from the Administration Server to the same directory on each managed server.
To start a managed server:
Log in to the target system.
Go to the Domain_home/bin directory.
Enter the following command:
./startManagedWebLogic.sh managed_server_name admin_server_url
where:
managed_server_name is the name of the managed server you want to start.
admin_server_url is the full URL of the Administration Server.
The following shows sample commands for starting occas_server_1 and occas_server_2 on Solaris/Linux:
./startManagedWebLogic.sh occas_server_1 t3://host.example.com:7001 & ./startManagedWebLogic.sh occas_server_2 t3://host.example.com:7001 &
For more information about starting managed servers, see "Starting and Stopping Managed Servers" in Oracle Fusion Middleware Administering Oracle Fusion Middleware.
After you configure the Converged Application Server domain, complete the Converged Application Server post-installation tasks. See "Converged Application Server Post-Installation Tasks" for instructions.