Bug 670617 - Include Configuration Instructions for putting wallaby components on separate broker
Summary: Include Configuration Instructions for putting wallaby components on separate...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise MRG
Classification: Red Hat
Component: Management_Console_Installation_Guide
Version: 1.3
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: 1.3.2-RC2
: ---
Assignee: Alison Young
QA Contact: Jan Sarenik
URL:
Whiteboard:
Depends On: 670614
Blocks: 663805
TreeView+ depends on / blocked
 
Reported: 2011-01-18 20:23 UTC by Trevor McKay
Modified: 2011-02-14 01:56 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2011-02-14 01:56:34 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Trevor McKay 2011-01-18 20:23:05 UTC
Description of problem:

Start up of wallaby consoles in the default configuration can cause a lot of temporary traffic to cumin.  As an option, we need instructions that show a user how to configure wallaby to run on a different broker.  This is a scale concern for cumin, so the notes belong in the Management Console Installation Guide.

Comment 1 Trevor McKay 2011-01-18 20:24:07 UTC
Set the needinfo flag.  I need to create draft content for this.

Comment 2 Robert Rati 2011-01-20 18:31:10 UTC
For remote configuration (on each condor node):
1) Need 1.3.2 package installed
2) Set CONFIGD.QMF_BROKER_* params, where * is one (or all) of:
QMF_BROKER_HOST - Broker IP/host
QMF_BROKER_PORT - Broker Port
QMF_BROKER_AUTH_MECHANISM - Broker authentication methods
3) condor_reconfig

Should probably be set in a file in /etc/condor/config.d

alt 2) This is easier for the user, but more difficult to document:
2a) Add QMF broker information for the remote configuration feature: condor_configure_store -a -p CONFIGD.QMF_BROKER_HOST,CONFIGD.QMF_BROKER_PORT,CONFIGD.QMF_BROKER_AUTH_MECHANISM

Configure the params thusly:
name: CONFIGD.QMF_BROKER_HOST
type: string
default: ''
description: 'The hostname where a QMF broker is running that communicates with the configuration store'
conflicts: []
depends: []
level: 0
must_change: true
restart: false

name: CONFIGD.QMF_BROKER_PORT
type: string
default: ''
description: 'The port on CONFIGD.QMF_BROKER_HOST that the QMF broker is listening on'
conflicts: []
depends: []
level: 0
must_change: false
restart: false

name: CONFIGD.QMF_BROKER_AUTH_MECHANISM
type: string
default: ''
description: 'The authentication mechanisms to use when communicating with the QMF broker CONFIGD.QMF_BROKER_HOST'
conflicts: []
depends: []
level: 0
must_change: false
restart: false

2b) Add the parameters to the Master feature:
condor_configure_store -e -f Master

Add to the map of params:
CONFIGD.QMF_BROKER_HOST: '<broker ip/host for use with remote configuration>'

Optionally add:
CONFIGD.QMF_BROKER_PORT: '<port>'
CONFIGD.QMF_BROKER_AUTH_MECHANISM: '<methods>'

Save the changes.

Use the default value for parameter "COLLECTOR_NAME" in feature "Master"? [Y/n] Y
Use the default value for parameter "CONDOR_HOST" in feature "Master"? [Y/n] Y

2c) Activate the new changes:
condor_configure_pool --activate


alt 2 does not require step 3 and is the preferred method, but also currently has a bug in wallaby that prevents it from working (BZ671185).

Comment 4 Trevor McKay 2011-01-24 21:13:59 UTC
Note, this content is needed as part of BZ 663782.  The configuration of Wallaby to run on a separate broker is specifically an issue for MRG Console scale.

Comment 6 Trevor McKay 2011-02-01 20:54:33 UTC
Added comments on 4.7 of the Console Guide to BZ663782 related to this, sorry.  I should have put them here.  I'll paste a copy.

--------

Version 4.7 from the stage, Section 3.2.3 on remote configuration tools.

1) Introduction:  Personally, I would add a few more words here to make it very
explicit that this is a brief section that contains only essential information.
 For users already familier with wallaby it may be enough.  For everyone else,
it is almost certain that they will need to rely heavily on Chapter 4 of the
MRG Grid User Guide.  Currently we say "For more information about the remote
configuration feature and how to use it, see the MRG Grid User Guide" but I'm
not sure that is enough. 

2) Subparagraph 1 needs more verbage, currently says "Ensure the 1.3.2 package
is installed".  This should say something like the following:

"Ensure that the condor-wallaby-client package is installed and is up to date
with the latest version.  As root:

# yum install condor-wallaby-client
"

3) Subparagraph 2 needs a few more words and some formatting.  I would add
something like the following instead of just "Configure parameters thusly":

"The condor_configure_store command will invoke a text editor for setting
metadata about the new parameters.  For more information about editing
medtadata, see the MRG Grid User Guide chapter on remote configuration. 
Metadata for these parameters should be set as follows:"

As for formatting, each of these "key: value" pairs need to be a single line. 
The Console Guide as it stands is missing line breaks.  For instance, the
key/value pairs for CONFIGD.QMF_BROKER_HOST need to look just like this:

name: CONFIGD.QMF_BROKER_HOST
type: string
default: ''
description: 'The hostname where a QMF broker is running that communicates with
the configuration store'
conflicts: []
depends: []
level: 0
must_change: true
restart: false

4)  Subparagraph 2, looks like line breaks were lost here as well.  Lines
should be as follows.

Add to the map of params:
CONFIGD.QMF_BROKER_HOST: '<broker ip/host for use with remote configuration>'

Optionally add:
CONFIGD.QMF_BROKER_PORT: '<port>'
CONFIGD.QMF_BROKER_AUTH_MECHANISM: '<methods>'


5) Additionally, in the snippet above, I think we need more words around "Add
to the map of params".  What map of params?  What does it look like?  How do I
find it?  Rob Rati can make some suggestions here.

Comment 7 Lana Brindley 2011-02-02 01:23:07 UTC
		 <section id="sect-Management_Console_Installation_Guide-Configuring_the_CONSOLE_for_Medium_Scale_Deployment-Configuring_the_Remote_Configuration_Feature_for_a_Separate_RHM_Broker">
			<title>Configuring the Remote Configuration Feature for a Separate &RHM; Broker</title>
			 <para>
				If the remote configuration feature is being used to configure a &GRID; deployment, the configuration tools can be set up to use a different &RHM; broker. Doing this will decrease message traffic when the configuration tools are in use.
			</para>
			 <para>
				Additional brokers can be run on the same or different hosts. For instructions on running multiple brokers on a single host, see the <citetitle>&RHM; Installation Guide</citetitle>.
			</para>
			 <para>
				For more information about the remote configuration feature and how to use it, see the <citetitle>&GRID; User Guide</citetitle>.
			</para>
			 <orderedlist id="orde-Management_Console_Installation_Guide-Configuring_the_Remote_Configuration_Feature_for_a_Separate_RHM_Broker-Remotely_Configuring_each_Condor_Node">
				<title>Remotely Configuring each Condor Node</title>
				 <listitem>
					<para>
						Install the <command>condor-wallaby-client</command> package using the <command>yum</command> command as the root user:
					</para>
					
<screen>
# yum install condor-wallaby-client
</screen>

				</listitem>
				 <listitem>
					<para>
						Configure the store by running the <command>condor_configure_store</command> command:
					</para>
					
<screen>
$ condor_configure_store
</screen>
					<para>
						The <command>condor_configure_store</command> command will invoke the default text editor so that the configuration file can be edited. For more information about editing metadata, see the <citetitle pubwork="chapter">Remote Configuration</citetitle> chapter in the <citetitle pubwork="book">&GRID; User Guide</citetitle>. You could also use the alternative configuration directions.
					</para>
				</listitem>
				<listitem>
					<para>
						Locate the <command>CONFIGD.QMF_BROKER_*</command> parameters, and update them as follows:
					</para>
					
<programlisting>
QMF_BROKER_HOST - <replaceable>Broker IP/host</replaceable>
QMF_BROKER_PORT - <replaceable>Broker Port</replaceable>
QMF_BROKER_AUTH_MECHANISM - <replaceable>Broker authentication methods</replaceable></programlisting>
					 <para>
						Save the configuration file, and run the <command>condor_reconfig</command> command to pick up the changes:
					</para>
					
<screen>
$ condor_reconfig
</screen>
				</listitem>
				<listitem>
					<para>
						This is an alternative method for configuring the QMF broker. This method is longer, but simpler for most use cases. Use the method that best suits your individual setup.
					</para>
					 <para>
						Locate the following parameters in the configuration file:
					</para>
					
<programlisting>
condor_configure_store -a -p
CONFIGD.QMF_BROKER_HOST,CONFIGD.QMF_BROKER_PORT,CONFIGD.QMF_BROKER_AUTH_MECHANISM
</programlisting>
					 <para>
						Change the parameters as follows:
					</para>
					 
<programlisting>
name: CONFIGD.QMF_BROKER_HOST
type: string
default: ''
description: 'The hostname where a QMF broker is running that communicates with the configuration store'
conflicts: []
depends: []
level: 0
must_change: true
restart: false
</programlisting>
					 
<programlisting>
name: CONFIGD.QMF_BROKER_PORT
type: string
default: ''
description: 'The port on CONFIGD.QMF_BROKER_HOST that the QMF broker is listening on'
conflicts: []
depends: []
level: 0
must_change: false
restart: false
</programlisting>
					 
<programlisting>
name: CONFIGD.QMF_BROKER_AUTH_MECHANISM
type: string
default: ''
description: 'The authentication mechanisms to use when communicating with the QMF broker CONFIGD.QMF_BROKER_HOST'
conflicts: []
depends: []
level: 0
must_change: false
restart: false
</programlisting>
					 <para>
						Add the parameters to the <parameter>Master</parameter> feature, by using the <parameter>Master</parameter> switch with the <command>condor_configure_store</command> command:
					</para>
					
<programlisting>
condor_configure_store -e -f Master
</programlisting>
					 <para>
						The <command>condor_configure_store</command> command will invoke the default text editor so that the configuration file can be edited. For more information about editing metadata, see the <citetitle pubwork="chapter">Remote Configuration</citetitle> chapter in the <citetitle pubwork="book">&GRID; User Guide</citetitle>.
					</para>
					 <para>
						Locate the <command>CONFIGD.QMF_BROKER_*</command> parameters, and update them as follows:
					</para>
					
<programlisting>
CONFIGD.QMF_BROKER_HOST: '&lt;<replaceable>broker ip/host for use with remote configuration</replaceable>&gt;'
</programlisting>
					 <para>
						Optionally, add the following parameters:
					</para>
					
<programlisting>
CONFIGD.QMF_BROKER_PORT: '&lt;<replaceable>port</replaceable>&gt;'
CONFIGD.QMF_BROKER_AUTH_MECHANISM: '&lt;<replaceable>methods</replaceable>&gt;'
</programlisting>
					 <para>
						When the changes are saved, the tool will prompt you as follows:
					</para>
					
<programlisting>
Use the default value for parameter "COLLECTOR_NAME" in feature "Master"? [Y/n] Y
Use the default value for parameter "CONDOR_HOST" in feature "Master"? [Y/n] Y
</programlisting>
					<para>
						Answer <parameter>Y</parameter> to both questions to use the default values.
					</para>

				</listitem>
				 <listitem>
					<para>
						Activate the changes using the <command>condor_configure_pool</command> command:
					</para>
					
<programlisting>
condor_configure_pool --activate
</programlisting>

				</listitem>

			</orderedlist>


Revision 4-8

LKB

Comment 8 Robert Rati 2011-02-02 15:10:57 UTC
1) We need to clarify here that the condor-wallaby-client package needs to be installed on all nodes to be managed (those running MRG-Grid/condor).

Also, in the past we've not made it a point to call out a specific version but here the feature/ability was added in the 1.3.2 set of packages.  I feel we should add some note to state that the condor-wallaby-client package should be the latest version, otherwise the changes documented here won't work.

Remove steps 2 and 3.  Those were from an alternate, and more time consuming, way to do this.  We just want to document the wallaby method.

4) The text here is wrong.  It should say something like "Add QMF broker information for the remote configuration feature:"  Remove "This is an alternative method for configuring the QMF broker. This method is longer, but simpler for most use cases. Use the method that best suits your individual setup.
Locate the following parameters in the configuration file" and replace with just stated text.

"by using the Master switch with the condor_configure_store command" -> "by editing the Master feature with the condor_configure_store command"

"Locate the CONFIGD.QMF_BROKER_* parameters, and update them as follows: " -> Incorrect, as the params will not be a part of the feature.  Earlier in the step we added the params to the store, now we are adding them to the Master feature.  Instead, should state something like "Add to the map of parameters associated with the Master feature":


On a separate note, I think we should break up the steps a bit.  Something like:
1) Insure condor-wallaby-client is installed on all MRG Grid nodes
2) Add QMF Broker information for the remote configuration feature
3) Add the parameters to the Master feature
4) Activate the changes

Comment 9 Lana Brindley 2011-02-02 23:49:03 UTC
This will be handled as part of the 1.3.2 tech review.

LKB

Comment 10 Alison Young 2011-02-07 08:22:08 UTC
Change made in revision 4.9, build: Red_Hat_Enterprise_MRG-Management_Console_Installation_Guide-1.3-web-en-US-4-9.el5

Comments: I removed the steps requested and split step 4 so that list more closely resembles the steps above.

Code snippet:
<orderedlist id="orde-Management_Console_Installation_Guide-Configuring_the_Remote_Configuration_Feature_for_a_Separate_RHM_Broker-Remotely_Configuring_each_Condor_Node">
  <title>Remotely Configuring each Condor Node</title> 
  <remark>steps 1, 4 refined; step 2, 3 removed from original list. Split previous step 4 into 2 steps. See code snippets at https://bugzilla.redhat.com/show_bug.cgi?id=670617</remark>
				
<listitem>
<para>
  Install the <command>condor-wallaby-client</command> package using the <command>yum</command> command as the root user:
</para>
					 
<screen>
# yum install condor-wallaby-client
<para>
  The <command>condor-wallaby-client</command> package needs to be installed on all nodes running &GRID; to be managed. 
</para>

<important>
  <title>Important</title>
  <para>
    Ensure that the <command>condor-wallaby-client</command> package is the latest version, 1.3.2, so the changes documented below work.
  </para>
</important>
				
</listitem>

<listitem>
<para>
  Add QMF broker information for the remote configuration feature:
</para>
					 
<programlisting>
condor_configure_store -a -p
CONFIGD.QMF_BROKER_HOST,CONFIGD.QMF_BROKER_PORT,CONFIGD.QMF_BROKER_AUTH_MECHANISM
</programlisting>
<para>
  Change the parameters as follows:
</para>
					 
<programlisting>
name: CONFIGD.QMF_BROKER_HOST
type: string
default: ''
description: 'The hostname where a QMF broker is running that communicates with the configuration store'
conflicts: []
depends: []
level: 0
must_change: true
restart: false
</programlisting>
					 
<programlisting>
name: CONFIGD.QMF_BROKER_PORT
type: string
default: ''
description: 'The port on CONFIGD.QMF_BROKER_HOST that the QMF broker is listening on'
conflicts: []
depends: []
level: 0
must_change: false
restart: false
</programlisting>
					 
<programlisting>
name: CONFIGD.QMF_BROKER_AUTH_MECHANISM
type: string
default: ''
description: 'The authentication mechanisms to use when communicating with the QMF broker CONFIGD.QMF_BROKER_HOST'
conflicts: []
depends: []
level: 0
must_change: false
restart: false
</programlisting>
</listitem>

<listitem>
<para>
  Add the parameters to the <parameter>Master</parameter> feature, by editing the <parameter>Master</parameter> feature with the <command>condor_configure_store</command> command:
</para>
					 
<programlisting>
condor_configure_store -e -f Master
</programlisting>
<para>
  The <command>condor_configure_store</command> command will invoke the default text editor so that the configuration file can be edited. For more information about editing metadata, see the <citetitle pubwork="chapter">Remote Configuration</citetitle> chapter in the <citetitle pubwork="book">&GRID; User Guide</citetitle>.
</para>
<para>
  Add to the map of parameters associated with the <parameter>Master</parameter> feature:
</para>
					 
<programlisting>
CONFIGD.QMF_BROKER_HOST: '&lt;<replaceable>broker ip/host for use with remote configuration</replaceable>&gt;'
</programlisting>
<para>
  Optionally, add the following parameters:
</para>
					 
<programlisting>
CONFIGD.QMF_BROKER_PORT: '&lt;<replaceable>port</replaceable>&gt;'
CONFIGD.QMF_BROKER_AUTH_MECHANISM: '&lt;<replaceable>methods</replaceable>&gt;'
</programlisting>
<para>
  When the changes are saved, the tool will prompt you as follows:
</para>
					 
<programlisting>
Use the default value for parameter "COLLECTOR_NAME" in feature "Master"? [Y/n] Y
Use the default value for parameter "CONDOR_HOST" in feature "Master"? [Y/n] Y
</programlisting>
<para>
  Answer <parameter>Y</parameter> to both questions to use the default values.
</para>
</listitem>

<listitem>
<para>
  Activate the changes using the <command>condor_configure_pool</command> command:
</para>
					 
<programlisting>
condor_configure_pool --activate
</programlisting>

</listitem>

</orderedlist>

Comment 11 Jan Sarenik 2011-02-10 13:40:46 UTC
There should not be any newline between
---
condor_configure_store -a -p
CONFIGD.QMF_BROKER_HOST,CONFIGD.QMF_BROKER_PORT,CONFIGD.QMF_BROKER_AUTH_MECHANISM
---

or it should be changed to (note the extra backslash)
---
condor_configure_store -a -p \
CONFIGD.QMF_BROKER_HOST,CONFIGD.QMF_BROKER_PORT,CONFIGD.QMF_BROKER_AUTH_MECHANISM
---

BTW, I installed the suggested package and still have no
condor_configure_store command so I am probably missing
something not mentioned in the manual.

Comment 12 Trevor McKay 2011-02-10 14:38:31 UTC
This section already contains a reference to the MRG Grid User Guide for more information, and a note that only essentials are included.  

However, it may help remove confusion to add the following notes or something similar (please tweak as necessary, just a suggestion)

Append to subparagraph 2

"2. Add QMF broker information for the remote configuration feature.  Note, condor_configure_store is part of the condor-wallaby-tools package and should be run from a remote configuration administration machine:"

Append to subparagraph 3

"3. Activate the changes using the condor_configure_pool command.  Note, condor_configure_pool is part of the condor-wallaby-tools package and should be run from a remote configuration administration machine:"

Comment 13 Alison Young 2011-02-11 04:59:11 UTC
Change made in revision 4-12, build:
Red_Hat_Enterprise_MRG-Management_Console_Installation_Guide-1.3-web-en-US-4-12.el5

Code snippets:

Comment 11
I tried putting all the text on the same line and in the HTML versions of the page it looked the same as before. Hence I've opted for the addition of the backslash.

<programlisting>
condor_configure_store -a -p \  CONFIGD.QMF_BROKER_HOST,CONFIGD.QMF_BROKER_PORT,CONFIGD.QMF_BROKER_AUTH_MECHANISM
</programlisting>

Comment 12

<para>
  Add QMF broker information for the remote configuration feature. Note, <command>condor_configure_store</command> is part of the <command>condor-wallaby-tools</command> package and should be run from a remote configuration administration machine:
</para>

<para>
  Activate the changes using the <command>condor_configure_pool</command> command. Note, <command>condor_configure_pool</command> is part of the <command>condor-wallaby-tools</command> package and should be run from a remote configuration administration machine:
</para>


Note You need to log in before you can comment on or make changes to this bug.