Registering and Configuring HA for Oracle GlassFish Message Queue

This procedure describes how to use the Oracle Solaris Cluster maintenance commands to register and configure HA for Oracle GlassFish Message Queue.

To perform this procedure, you need the following information about your configuration.

• The name of the resource type for HA for Oracle GlassFish Message Queue is SUNW.s1mq.

• The names of the cluster nodes that can master the data service.

• The network resource that clients use to access the HA for Oracle GlassFish Message Queue.

• The port where Oracle GlassFish Message Queue listens.

Setting HA for Oracle GlassFish Message Queue Extension Properties

The section that follows contains instructions for registering and configuring HA for Oracle GlassFish Message Queue resources. For information about the extension properties, see Appendix A, HA for Oracle GlassFish Message Queue Extension Properties. The Tunable entry indicates when you can update a property.

See the r_properties(5) man page for details on all the Oracle Solaris Cluster resource properties.

To set an extension property of a resource, include the following option in the clresource(1CL) command that creates or modifies the resource:

-p property=value 

-p property

Identifies the extension property that you are setting.

value

Specifies the value to which you are setting the extension property.

You can also use the procedures in Chapter 2, Administering Data Service Resources, in Oracle Solaris Cluster Data Services Planning and Administration Guide to configure resources after the resources are created.

How to Register and Configure HA for Oracle GlassFish Message Queue as a Failover Data Service

Perform the following steps to complete your configuration.

1. On a cluster member, become superuser or assume a role that provides solaris.cluster.modify and solaris.cluster.adminRBAC authorization.
2. Add the resource group for Oracle GlassFish Message Queue if you have not performed the steps in Configuring and Activating Network Resources.

   # clresourcegroup create [-n node-list] resource-group

3. Add the logical hostname resource to the resource group if you have not performed the steps in Configuring and Activating Network Resources.

   # clreslogicalhostname create -g resource group -h logical-hostname logical-hostname

   ---

   Note - If you require a fully qualified hostname, you must specify the fully qualified name with the -h option and you cannot use the fully qualified form in the resource name.

   ---

4. Register the SUNW.s1mq resource type for the data service.

   # clresourcetype register SUNW.s1mq

5. If the Smooth_Shutdown extension property is set to TRUE, create a file named scs1mqconfig in the $IMQ_VARHOME/instances/broker/ directory. Add the following line to the file you have created.

   Password password

   See Appendix A, HA for Oracle GlassFish Message Queue Extension Properties for a description of the Smooth_Shutdown extension property.

6. Add the Oracle GlassFish Message Queue resource instance to the failover resource group.

   ---

   Note - Use of the Bin_dir property requires a minimum of Oracle GlassFish Message Queue 4.4.

   ---

   [If Smooth_Shutdown will be set to FALSE (the default):]
   # clresource create -g resource-group -t SUNW.s1mq \
   -p Confdir_list=$IMQ_VARHOME/instances/broker \
   -p Bin_dir=bin-directory
   -p Broker_Name=broker \
   -p Network_Resources_Used=logical hostname \
   -p Port_list=port/tcp[,port/tcp] resource

   [If Smooth_Shutdown is set to TRUE:]
   # clresource create -g resource-group -t SUNW.s1mq \ 
   -p Confdir_list=$IMQ_VARHOME/instances/broker \
   -p Bin_dir=bin-directory
   -p Broker_Name=broker \
   -p Broker_User=user \
   -p Network_resources_used=logical hostname \
   -p Port_list=port/tcp[,port/tcp] \ 
   -p Smooth_Shutdown=TRUE resource

   The resource is created in the enabled state.

   The resource group that contains the application resources is the same resource group that you created for your network resources in How to Configure and Activate Network Resources.

   -t SUNW.s1mq

   Specifies the type of resource to add.

   -p Confdir_list=$IMQ_VARHOME/instances/broker

   Specifies a path for your Oracle GlassFish Message Queue configuration directory. The Confdir_list extension property is required. The Confdir_list property must have exactly one entry.

   -p Bin_dir=bin-directory

   Specifies the location where the Oracle GlassFish Message Queue binaries, particularly imqbrokerd and imqcmd, are installed. Requires at least Oracle GlassFish Message Queue 4.4.

   -p Broker_Name=broker

   Specifies the name of the broker to monitor.

   -p Broker_User=user

   Specifies the user name of the managed broker.

   -p Network_resources_used=network-resource

   Specifies a comma-separated list of network resources (logical hostnames) in resource-group, which the Oracle GlassFish Message Queue application resource must use.

   -p Port_list=port-number/protocol

   Specifies a port number and the protocol to be used, for example, 80/tcp. The Port_list property must have one or two entries.

   -p Smooth_Shutdown=TRUE

   Used to shutdown the broker. Use of the impcmd command exposes the broker password in the imqcmd command string.

   resource

   Specifies the Oracle GlassFish Message Queue application resource name.

7. Bring the resource group online.

   # clresourcegroup online resource-group

   resource-group

   Specifies the name of the application resource group that is being enabled.

8. Verify that the resource group and application-server resource are online.

   # clresourcegroup status
   # ps -ef

Example 1-1 Registering and Configuring HA for Oracle GlassFish Message Queue

This example shows how to register HA for Oracle GlassFish Message Queue.

Cluster Information
Node names: phys-schost-1, phys-schost-2
Logical hostname: schost-1
Resource group: resource-group-1 (for all resources)
Resources: schost-1 (logical hostname),
SUNW.s1mq (Oracle GlassFish Message Queue application resource) 
 
(Create a failover resource group.)
# clresourcegroup create -n phys-schost-1,phys-schost-2 s1mq-rg
 
(Add a logical hostname resource to the resource group.)
# clreslogicalhostname -g s1mq-rg -h schost-1 schost-1
 
(Register the SUNW.s1mq resource type.)
# clresourcetype register SUNW.s1mq
 
(Create a Oracle GlassFish Message Queue resource and add it to the 
resource group.)
# clresource create -g s1mq-rg \
-t SUNW.s1mq \
-p Confdir_list=$IMQ_VARHOME/instances/hamq1 \
-p Bin_dir=/opt/mq/bin \
-p Broker_Name=hamq1 \
-p Network_resources_used=schost-1 \
-p Port_list=7676/tcp s1mq-rs

 (Enable the application resource group.)
# clresourcegroup online s1mq-rg

Example 1-2 Registering and Configuring HA for Oracle GlassFish Message Queue With Smooth_Shutdown Enabled

This example shows how to register HA for Oracle GlassFish Message Queue with Smooth_Shutdown enabled.

Cluster Information
Node names: phys-schost-1, phys-schost-2
Logical hostname: schost-1
Resource group: resource-group-1 (for all resources)
Resources: schost-1 (logical hostname),
    s1mq-1 (Oracle GlassFish Message Queue application resource) 
 
(Create a failover resource group.)
# clresourcegroup create -n phys-schost-1,phys-schost-2 s1mq-rg
 
(Add a logical hostname resource to the resource group.)
# clreslogicalhostname create -g s1mq-rg -h schost-1 schost-1
 
(Register the SUNW.s1mq resource type.)
# clresourcetype register SUNW.s1mq
 
(Create a Oracle GlassFish Message Queue resource and add it to the 
resource group.)
# clresource create -g s1mq-rg \
-t SUNW.s1mq \
-p Confdir_list=$IMQ_VARHOME/instances/hamq1 \
-p Broker_Name=hamq1 \
-p Broker_User=admin \
-p Network_resources_used=schost-1 \
-p Port_list=7676/tcp \
-p Smooth_Shutdown=TRUE s1mq-rs
 
(Enable the application resource group.)
# clresourcegroup online s1mq-rg