Home | History | Annotate | Download | only in mgr
      1 #
      2 # CDDL HEADER START
      3 #
      4 # The contents of this file are subject to the terms of the
      5 # Common Development and Distribution License (the License).
      6 # You may not use this file except in compliance with the License.
      7 #
      8 # You can obtain a copy of the license at usr/src/CDDL.txt
      9 # or http://www.opensolaris.org/os/licensing.
     10 # See the License for the specific language governing permissions
     11 # and limitations under the License.
     12 #
     13 # When distributing Covered Code, include this CDDL HEADER in each
     14 # file and include the License file at usr/src/CDDL.txt.
     15 # If applicable, add the following below this CDDL HEADER, with the
     16 # fields enclosed by brackets [] replaced with your own identifying
     17 # information: Portions Copyright [yyyy] [name of copyright owner]
     18 #
     19 # CDDL HEADER END
     20 #
     21 
     22 #
     23 # Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
     24 # Use is subject to license terms.
     25 #
     26 #ident   "@(#)mgr_config 1.3     07/08/07 SMI"
     27 #
     28 # This file will be sourced in by mgr_register and the parameters
     29 # listed below will be used.
     30 #
     31 # These parameters can be customized in (key=value) form
     32 #
     33 #	+++ Required parameters +++
     34 #
     35 #          RS - name of the SC resource for the Queue Manager
     36 #          RG - name of the SC resource group to contain RS 
     37 #        QMGR - name of the Queue Manager
     38 #          LH - name of the SC LogicalHostname resource
     39 #      HAS_RS - name of the SC HAStoragePlus resource
     40 #      LSR_RS - name of the SC Listener resource
     41 #	        (Leave blank if the Queue Manager should not
     42 #	        be dependent on the Listener)
     43 #     CLEANUP - Cleanup IPC entries YES or NO 
     44 #		(Default CLEANUP=YES)
     45 #    SERVICES - WebSpehre MQ v6 only
     46 #               SERVICES=NO (Equivalent to strmqm -ns ${QMGR}
     47 #               SERVICES=YES (Equivalent to strmqm ${QMGR}
     48 #		(Default SERVICES=NO)
     49 #      USERID - name of the WebSphere MQ userid
     50 #		(Default USERID=mqm)
     51 #
     52 #	+++ Optional parameters +++
     53 #
     54 # DB2INSTANCE - name of the DB2 Instance name
     55 # ORACLE_HOME - name of the Oracle Home Directory
     56 #  ORACLE_SID - name of the Oracle SID
     57 #   START_CMD - pathname and name of the renamed strmqm program
     58 #    STOP_CMD - pathname and name of the renamed endmqm program
     59 #
     60 #       +++ Non-global (failover) zone parameters +++
     61 #       +++ Only required if WebSphere MQ should  +++
     62 #       +++ run within a Solaris 10 failover zone +++
     63 #
     64 #     RS_ZONE - name of the non-global (failover) zone managed by the
     65 #               Sun Cluster Data Service for Solaris Containers
     66 #     PROJECT - name for the Solaris Project to be used for this resource
     67 #               (Default PROJECT=default)
     68 #     TIMEOUT - stop timeout value
     69 #               (Default TIMEOUT=300)
     70 #
     71 # Note 1: Optional parameters
     72 #
     73 #	Null entries for optional parameters are allowed if not used.
     74 #
     75 # Note 2: XAResourceManager processing
     76 #
     77 #	If DB2 will participate in global units of work then set
     78 #	DB2INSTANCE=
     79 #
     80 #	If Oracle will participate in global units of work then set
     81 #	ORACLE_HOME=
     82 #	ORACLE_SID=
     83 #
     84 # Note 3: Renamed strmqm/endmqm programs
     85 #	
     86 #	This is only recommended if WebSphere MQ is deployed onto 
     87 #	Global File Systems for qmgr/log files. You should specify 
     88 #	the full pathname/program, i.e. /opt/mqm/bin/<renamed_strmqm>
     89 #
     90 # Note 4: Cleanup IPC
     91 #
     92 #	Under normal shutdown and startup WebSphere MQ manages it's
     93 #	cleanup of IPC resources with the following fix packs.
     94 #
     95 #	MQSeries v5.2 Fix Pack 07 (CSD07) or later
     96 #	WebSphere MQ v5.3 Fix Pack 04 (CSD04) or later
     97 #	WebSphere MQ v6.0 or later
     98 #
     99 #	Please refer to APAR number IY38428.
    100 #
    101 #	However, while running in a failover environment, the IPC keys
    102 #	that get generated will be different between nodes. As a result
    103 #	after a failover of a Queue Manager, some shared memory segments
    104 #	can remain allocated on the node although not used. 
    105 #
    106 #	Although this does not cause WebSphere MQ a problem when starting
    107 #	or stopping (with the above fix packs applied), it can deplete
    108 #	the available swap space and in extreme situations a node may 
    109 #	run out of swap space. 
    110 #
    111 #	To resolve this issue, setting CLEANUP=YES will ensure that 
    112 #	IPC shared memory segments for WebSphere MQ are removed whenever
    113 #	a Queue Manager is stopped. However IPC shared memory segments 
    114 #	are only removed under strict conditions, namely
    115 #
    116 #	- The shared memory segment(s) are owned by
    117 #		OWNER=mqm and GROUP=mqm
    118 #	- The shared memory segment has no attached processes
    119 #	- The CPID and LPID process ids are not running
    120 #	- The shared memory removal is performed by userid mqm
    121 #
    122 #	Setting CLEANUP=NO will not remove any shared memory segments.
    123 #
    124 #	Setting CLEANUP=YES will cleanup shared memory segments under the
    125 #	conditions described above.
    126 #
    127 # Note 5: Non-global (failover) zone parameters
    128 #
    129 #       These parameters are only required when WebSphere MQ should run
    130 #       within a failover zone managed by the Sun Cluster Data Service
    131 #       for Solaris Containers.
    132 #
    133 #       To use the Sun Cluster Data Service for WebSphere MQ together with
    134 #       the Sun Cluster Data Service for Solaris Containers, you must do
    135 #       the following,
    136 #
    137 #       1. Install the Sun Cluster Data Service for Solaris Containers.
    138 #
    139 #       2. Follow the Sun Cluster Data Service for Solaris Containers Guide
    140 #          for instructions on how to create and install a non-global zone
    141 #          in a failover configuration.
    142 #
    143 #	   The following text represents condensed documentation and shows the
    144 #	   required steps to install WebSphere MQ into a failover zone on a
    145 #	   two node Sun Cluster. 
    146 #
    147 #	   On all nodes within the cluster, ensure that "exclude lofs" is commented 
    148 #	   out within /etc/system and that patch 120590-03 or later is installed. 
    149 #	   
    150 #          In the examples below, WebSphere MQ is installed in the failover zone's
    151 #	   zonepath. /opt/mqm and /var/mqm are simply directories within the zone. 
    152 #
    153 #	   If a global or highly available local file system is required for WebSphere 
    154 #	   MQ in the failover zone, you must configure the "Mounts" parameter within the
    155 #	   sczcbt_config file in Step 3.
    156 #
    157 #          You must create a "whole root" failover zone for the installation of
    158 #          WebSphere MQ on both nodes of the cluster. Performing this tasks on both 
    159 #	   nodes of the cluster is required to ensure that the zone is "known" to 
    160 #          both nodes of the cluster, i.e. configured and installed.
    161 #
    162 #          node1# scrgadm -a -g zone1-rg
    163 #          node1# scrgadm -a -g zone1-rg -L -l zone1 -j zone-lh
    164 #          node1# scrgadm -a -g zone1-rg -t SUNW.HAStoragePlus -j zone1-has \
    165 #          node1# -x FileSystemMountPoints=<failover file system> 
    166 #          node1# 
    167 #          node1# scswitch -Z -g zone1-rg
    168 #          node1# scswitch -z -g zone1-rg -h node1
    169 #          node1# 
    170 #          node1# zonecfg -z zone1
    171 #          zone1: No such zone configured
    172 #          Use 'create' to begin configuring a new zone.
    173 #          zonecfg:zone1> create -b
    174 #          zonecfg:zone1> set zonepath=<failover file system>/zone1
    175 #          zonecfg:zone1> set autoboot=false
    176 #          zonecfg:zone1> add inherit-pkg-dir
    177 #          zonecfg:zone1:inherit-pkg-dir> set dir=/opt/SUNWscmqs
    178 #          zonecfg:zone1:inherit-pkg-dir> end
    179 #          zonecfg:zone1> exit
    180 #          node1# 
    181 #          node1# zoneadm -z zone1 install
    182 #          node1# scswitch -z -g zone1-rg -h node2
    183 #
    184 #          node2# cd <failover file system>
    185 #          node2# rm -r zone1
    186 #          node2# 
    187 #          node2# zonecfg -z zone1
    188 #          zone1: No such zone configured
    189 #          Use 'create' to begin configuring a new zone.
    190 #          zonecfg:zone1> create -b
    191 #          zonecfg:zone1> set zonepath=<failover file system>/zone1
    192 #          zonecfg:zone1> set autoboot=false
    193 #          zonecfg:zone1> add inherit-pkg-dir
    194 #          zonecfg:zone1:inherit-pkg-dir> set dir=/opt/SUNWscmqs
    195 #          zonecfg:zone1:inherit-pkg-dir> end
    196 #          zonecfg:zone1> exit
    197 #          node2# 
    198 #          node2# zoneadm -z zone1 install
    199 #          node2# zoneadm -z zone1 boot
    200 #        
    201 #          At this stage zone1 is configured and installed, but Solaris within 
    202 #	   zone1 is not yet configured. This needs to be done as follows,
    203 #
    204 #          node2# zlogin -C zone1
    205 #          zone1# ~.
    206 #          node2# zoneadm -z zone1 halt
    207 #
    208 #       3. Bring online the "whole root" non-global zone, so that it is now
    209 #          managed by the Sun Cluster Data Service for Solaris Containers.
    210 #
    211 #	   Edit sczbt_config and execute sczbt_register from /opt/SUNWsczone/sczbt/util
    212 #
    213 #          node2# cd /opt/SUNWsczone/sczbt/util
    214 #          node2# vi sczbt_config
    215 #          node2# ./sczbt_register 
    216 #          node2# 
    217 #          node2# scswitch -e -j <res>
    218 #
    219 #       4. Install WebSphere MQ in the "whole root" failover zone.
    220 #
    221 #          node2# zlogin zone1
    222 #          zone1# mkdir -p /opt/mqm /var/mqm
    223 #          zone1# groupadd -g <gid> mqm
    224 #          zone1# useradd -g <gid> -u <uid> -d <home dir> mqm
    225 #          zone1#   
    226 #          zone1# cd <mqm package directory>
    227 #          zone1# ./mqlicense.sh
    228 #          zone1# pkgadd -d .
    229 #	
    230 #	   Install the latest WebSphere MQ Fix Pack.
    231 #
    232 #       5. Create the WebSphere MQ Queue manager
    233 #
    234 #          node2# zlogin zone1
    235 #          zone1# su - mqm
    236 #          zone1# crtmqm qmgr1
    237 #   
    238 #       5. Provide values for the parameters below and include values for
    239 #          RS_ZONE and PROJECT.
    240 #
    241 #          The value for the RG= parameter should be the same SC resource group
    242 #     	   name that was used by the Sun Cluster Data Service for Solaris Containers
    243 #	   agent for the failover zone. 
    244 #
    245 #	   RS_zone should also be the same SC resource name that was used by the 
    246 #	   Sun Cluster Data Service for Solaris Containers agent for the failover zone.
    247 #
    248 #	   Refer to Example 2  Configuration parameters for deployment of WebSphere MQ
    249 #	                         within a Solaris 10 non-global (failover) zone.
    250 #
    251 #          node2# vi mgr_config
    252 #
    253 #       6. Register the SC resource using the mqr_register script.
    254 #
    255 #          node2# ./mgr_register
    256 #
    257 #       7. Bring online the SC resource that was registered.
    258 #
    259 # Example 1 - Configuration parameters for deployment of WebSphere MQ 
    260 #		within Solaris 10 global zone nodes or pre-Solaris 10 nodes.
    261 #	
    262 # 	+++ Required parameters +++
    263 #	RS=wmq1-qmgr1
    264 #	RG=wmq1-rg
    265 #	QMGR=qmgr1
    266 #	LH=wmq1-lh
    267 #	HAS_RS=wmq1-has
    268 #	LSR_RS=
    269 #	CLEANUP=YES
    270 #	SERVICES=NO
    271 #	USERID=mqm
    272 #	
    273 # 	+++ Optional parameters +++
    274 #	DB2INSTANCE=
    275 #	ORACLE_HOME=
    276 #	ORACLE_SID=
    277 #	START_CMD=
    278 #	STOP_CMD=
    279 #	
    280 # 	+++ Failover zone parameters +++
    281 #	RS_ZONE=
    282 #	PROJECT=default
    283 #
    284 # Example 2 - Configuration parameters for deployment of WebSphere MQ
    285 #		within a Solaris 10 non-global (failover) zone.
    286 #	
    287 # 	+++ Required parameters +++
    288 #	RS=zone1-qmgr1
    289 #	RG=zone1-rg
    290 #	QMGR=qmgr1
    291 #	LH=zone1-lh
    292 #	HAS_RS=zone1-has
    293 #	LSR_RS=
    294 #	CLEANUP=YES
    295 #	SERVICES=NO
    296 #	USERID=mqm
    297 #	
    298 # 	+++ Optional parameters +++
    299 #	DB2INSTANCE=
    300 #	ORACLE_HOME=
    301 #	ORACLE_SID=
    302 #	START_CMD=
    303 #	STOP_CMD=
    304 #	
    305 # 	+++ Failover zone parameters +++
    306 #	RS_ZONE=zone1-res
    307 #	PROJECT=default
    308 #	
    309 # +++ Required parameters +++
    310 RS=
    311 RG=
    312 QMGR=
    313 LH=
    314 HAS_RS=
    315 LSR_RS=
    316 CLEANUP=YES
    317 SERVICES=NO
    318 USERID=mqm
    319 
    320 # +++ Optional parameters +++
    321 DB2INSTANCE=
    322 ORACLE_HOME=
    323 ORACLE_SID=
    324 START_CMD=
    325 STOP_CMD=
    326 
    327 # +++ Failover zone parameters +++
    328 # These parameters are only required when WebSphere MQ should run
    329 #  within a failover zone managed by the Sun Cluster Data Service
    330 # for Solaris Containers.
    331 RS_ZONE=
    332 PROJECT=default
    333 TIMEOUT=300
    334