Skip navigation.
Downloads | Product Documentation | Support

Using WebLogic Server Clusters

# Understanding Cluster Configuration and Application Deployment

This following sections explain how the information that defines the configuration of a cluster is stored and maintained, and the methods you can use to accomplish configuration tasks:

- Cluster Configuration and config.xml
- Role of the Administration Server
- How Dynamic Configuration Works
- Application Deployment Topics
- Methods of Configuring Clusters

Note: Much of the information in this section also pertains to the process of configuring a WebLogic domain in which the server instances are not clustered.

# Cluster Configuration and config.xml

The `config.xml` file is an XML document that describes the configuration of a WebLogic Server domain. The content and structure of the `config.xml` is defined in the associated Document Type Definition (DTD), `config.dtd`.

`config.xml` consists of a series of XML elements. The Domain element is the top-level element, and all elements in the Domain descend from the Domain element. The Domain element includes child elements, such as the Server, Cluster, and Application elements. These child elements may have children of their own. For example, the Server element includes the child elements WebServer, SSL and Log. The Application element includes the child elements EJBComponent and WebAppComponent.

Each element has one or more configurable attributes. An attribute defined in `config.dtd` has a corresponding attribute in the configuration API. For example, the Server element has a `ListenPort` attribute, and likewise, the `weblogic.management.configuration.ServerMBean` has a `ListenPort` attribute. Configurable attributes are readable and writable, that is, `ServerMBean` has a `getListenPort` and a `setListenPort` method.

To learn more about `config.xml`, see BEA WebLogic Server Configuration Reference.

# Role of the Administration Server

The Administration Server is the WebLogic Server instance that configures and manages the WebLogic Server instances in its domain.

A domain can include multiple WebLogic Server clusters and non-clustered WebLogic Server instances. Strictly speaking, a domain could consist of only one WebLogic Server instance—however, in that case that sole server instance would be an Administration Server, because each domain must have exactly one Administration Server.

There are a variety of ways to invoke the services of the Administration Server to accomplish configuration tasks, as described in Methods of Configuring Clusters. Whichever method is used, the Administration Server for a cluster must be running when you modify the configuration.

When the Administration Server starts, it loads the `config.xml` for the domain. It looks for `config.xml` in the current directory. Unless you specify another directory when you create a domain, `config.xml` is stored in:

`BEA_HOME/``user_projects/`mydomain

where mydomain is a domain-specific directory, with the same name as the domain.

Each time the Administration Server starts successfully, a backup configuration file named `config.xml.booted` is created in the domain directory. In the unlikely event that the `config.xml` file should be corrupted during the lifetime of the server instance, it is possible to revert to this previous configuration.

The following figure shows a typical production environment that contains an Administration Server and multiple WebLogic Servers instances. When you start the server instances in such a domain, the Administration Server is started first. As each additional server instance is started, it contacts the Administration Server for its configuration information. In this way, the Administration Server operates as the central control entity for the configuration of the entire domain.

Figure 3-1 WebLogic Server Configuration

## What Happens if the Administration Server Fails?

The failure of an Administration Server for a domain does not affect the operation of Managed Servers in the domain. If an Administration Server for a domain becomes unavailable while the server instances it manages—clustered or otherwise—are up and running, those Managed Servers continue to run. If the domain contains clustered server instances, the load balancing and failover capabilities supported by the domain configuration remain available, even if the Administration Server fails.

Note: If an Administration Server fails because of a hardware or software failure on its host machine, other server instances on the same machine may be similarly affected. However, the failure of an Administration Server itself does not interrupt the operation of Managed Servers in the domain.

For instructions on re-starting an Administration Server, see Restarting an Administration Server When Managed Servers are Running in Configuring and Managing WebLogic Server.

# How Dynamic Configuration Works

WebLogic Server allows you to change the configuration attributes of domain resources dynamically—while server instances are running. In most cases you do not need to restart the server instance for your changes to take effect. When an attribute is reconfigured, the new value is immediately reflected in both the current run-time value of the attribute and the persistent value stored in `config.xml`.

Not all configuration changes are applied dynamically. For example, if you change a Managed Server's `ListenPort` value, the new port will not be used until the next time you start the Managed Server. The updated value is stored in `config.xml`, but the runtime value is not affected. When the runtime value for a configuration attribute is different than the value in `config.xml`, the Administration Console displays an alert icon—a yellow triangular that contains an exclamation mark (!)—next to the attribute. This icon indicates that the server instance must be restarted for the configuration change to take effect.

The Administration Console validates attribute changes, checking for out-of-range errors and data type mismatch errors, and displays an error message for erroneous entries.

Once the Administration Console has been started, if another process captures the listen port assigned to the Administration Server, you should stop the process that captured the port. If you are not able to remove the process that captured the list port, edit the `config.xml` file to change the `ListenPort` value.

# Application Deployment Topics

This section is brief introduction to the application deployment process. For more information about deployment, see Deploying WebLogic Server Applications.

For instructions on how to perform common deployment tasks, see Deploy Applications.

## Deployment Methods

You can deploy an application to a cluster using following methods:

- WebLogic Server Administration Console

The Administration Console is a graphical user interface (GUI) to the BEA Administration Service.

- WebLogic Builder

WebLogic Builder is a graphical tool for assembling a J2EE component, creating and editing its deployment descriptors, and deploying it to a WebLogic Server.

- weblogic.Deployer

The weblogic.Deployer utility is a Java-based deployment tool that provides a command-line interface to the WebLogic Server deployment API.

These deployment tools are discussed in Deployment Tools Reference in Deploying WebLogic Server Applications.

Regardless of the deployment tool you use, when you initiate the deployment process you specify the components to be deployed, and the targets to which they will be deployed—your cluster, or individual server instances within the cluster or domain.

The Administration Server for the domain manages the deployment process, communicating with the Managed Servers in the cluster throughout the process. Each Managed Server downloads components to be deployed, and initiates local deployment tasks. The deployment state is maintained in the relevant MBeans for the component being deployed. For more information, see Deployment Management API.

Note: You must package components before you deploy them to WebLogic Server. For more information, see the packaging topics in Creating WebLogic Server Applications in Developing WebLogic Server Applications.

## Introduction to Two-Phase Deployment

In WebLogic Server 7.0 and later, applications are deployed in two phases. Before starting, WebLogic Server determines the availability of the Managed Servers in the cluster.

### First Phase of Deployment

During the first phase of deployment, application components are distributed to the target server instances, and the planned deployment is validated to ensure that the application components can be successfully deployed. During this phase, user requests to the application being deployed are not allowed.

Failures encountered during the distribution and validation process will result in the deployment being aborted on all server instances—including those upon which the validation succeeded. Files that have been staged will not be removed; however, container-side changes performed during the preparation will be reverted.

### Second Phase of Deployment

After the application components have been distributed to targets and validated, they are fully deployed on the target server instances, and the deployed application is made available to clients.

If a failure occurs during this process, deployment to that server instance will be cancelled. Such a failure on one Managed Server does not prevent successful deployment on other clustered server instances.

If a cluster member fails to deploy an application, it will fail at startup in order to ensure cluster consistency—as any failure of a cluster-deployed application on a Managed Server causes the Managed Server to abort its startup.

## Guidelines for Deploying to a Cluster

Ideally, all Managed Servers in a cluster should be running and available during the deployment process. Deploying applications while some members of the cluster are unavailable is not recommended. Before deploying applications to a cluster, ensure, if possible, that all Managed Servers in the cluster are running and reachable by the Administration Server.

In WebLogic Server 8.1, if you deploy an application to a Managed Server that is partitioned at the time of deployment—running but not reachable by the Administration Server—problems accessing the Managed Server can occur when that Managed Server rejoins the cluster. During the synchronization period, while other clustered Managed Servers re-establish communications with the previously partitioned server instance, user requests to the deployed applications and attempts to create secondary sessions on that server instance will fail. The risk of this circumstance occurring can be reduced by setting `ClusterConstraintsEnabled` , as described in Enforcing Cluster Constraints with Two-Phase Deployment in Deploying WebLogic Server Applications.

Note:

Cluster membership should not change during the deployment process. After initiating deployment, do not:

- add or remove Managed Servers to the target cluster
- shut down Managed Servers in the target cluster

### WebLogic Server 8.1 Supports "Relaxed Deployment" Rules

WebLogic Server 7.0 imposed these restrictions on deployment to clusters:

- No partial deployment—In WebLogic Server 7.0, if one or more of the Managed Servers in the cluster are unavailable, the deployment process is terminated, and an error message is generated, indicating that unreachable Managed Servers should be either restarted or removed from the cluster before attempting deployment.
- Pinned services cannot be deployed to multiple Managed Servers in a cluster—If an application is not deployed to the cluster, you can deploy it to one and only one Managed Server in the cluster.

In WebLogic Server 7.0 SP01, these deployment rules were relaxed, allowing user discretion in deployment practices. This behavior remains unchanged in WebLogic Server 8.1.

#### Deployment to a Partial Cluster is Allowed

By default, WebLogic Server allows deployment to a partial cluster. If one or more of the Managed Servers in the cluster are unavailable, the following message may be displayed:

>     Cannot deploy to the following server(s) because they are
>     unreachable: "managed_server_n". Make sure that these servers are
>     currently shut down. Deployment will continue on the remaining
>     servers in the cluster "clustering". Once deployment has commenced,
>     do not attempt to start or shutdown any servers until the
>     application deployment completes.

When the unreachable Managed Server becomes available, deployment to that server instance will be initiated. Until the deployment process is completed, the Managed Server may experience failures related to missing or out-of-date classes.

#### Deploying to Complete Clusters in WebLogic Server

You can ensure that deployment is only performed if all Managed Servers in the cluster are reachable by setting `ClusterConstraintsEnabled`. When `ClusterConstraintsEnabled` is set to "true", a deployment to a cluster succeeds only if all members of the cluster are reachable and all can deploy the specified files. See Enforcing Cluster Constraints with Two-Phase Deployment in Deploying WebLogic Server Applications.

#### Pinned Services can be Deployed to Multiple Managed Servers.

It is possible to target a pinned service to multiple Managed Servers in a cluster. This practice is not recommended. The load-balancing capabilities and scalability of your cluster can be negatively affected by deploying a pinned service to multiple Managed Servers in a cluster. If you target a pined service to multiple Managed Servers, the following message is printed to the server logs:

>     Adding server servername of cluster clustername as a target for
>     module modulename. This module also includes server servername that
>     belongs to this cluster as one of its other targets. Having multiple
>     individual servers a cluster as targets instead of having the entire
>     cluster as the target can result in non-optimal load balancing and
>     scalability. Hence this is not usually recommended.

# Methods of Configuring Clusters

There are several methods for configuring a clusters:

- Domain Configuration Wizard

The Domain Configuration Wizard is the recommended tool for creating a new domain or cluster. For a list of the tasks you can perform with the wizard, see Domain Configuration Wizard Capabilities later in this section.

- WebLogic Server Administration Console

The Administration Console is a graphical user interface (GUI) to the BEA Administration Service. It allows you to perform a variety of domain configuration and monitoring functions. For a list of the tasks you can perform with the console, see Administration Console Capabilities.

- WebLogic Server Application Programming Interface (API)

You can write a program to modify the configuration attributes, based on the configuration application programming interface (API) provided with WebLogic Server. This method is not recommended for initial cluster implementation.

- WebLogic Server command-line utility.

You can access the attributes of a domain with the WebLogic Server command-line utility. This utility allows you to create scripts to automate domain management. This method is not recommended for initial cluster implementation.

## Domain Configuration Wizard Capabilities

The Domain Configuration Wizard uses pre-configured domain templates to ease the process of creating a domain and its server instances. Using the wizard, you can select a domain template, and then supply key information, such as machine addresses, names, and port numbers for the server instances you wish to created.

Note: The Domain Configuration Wizard can install the appropriate directory structure and scripts for a domain on a Managed Server that is running on a remote machine from the Administration Server. This is helpful if you need to use a Managed Server as a backup Administration Server for a domain.

The wizard prompts you to select one of four typical domain configurations:

- Single Server—domain with a single WebLogic Server instance.
- Administration Server with Managed Servers—domain with an Administration Server, and one or more Managed Servers that are not clustered.
- Administration Server with clustered Managed Servers—domain with an Administration Server, and one or more Managed Servers that are clustered.
- Managed Server (Owning Administrative Configuration)

After you select the desired configuration type, the wizard prompts you to provide relevant details about the domain and its server instances.

For information on how to use the Domain Configuration Wizard, see Creating Domains, Administration Servers, and Managed Servers in Configuring and Managing WebLogic Server.

## Administration Console Capabilities

These sections in Administration Console Online Help list and describe the cluster-related configuration tasks you can perform using the WebLogic Server Administration Console.

- Servers
- Clusters
- Deploying Applications and Modules
- Monitoring a Server
- Monitoring a Cluster"