Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 632424

Summary: Missing steps/notes under "Chapter 2 Start Console" section related to broker
Product: Red Hat Enterprise MRG Reporter: Trevor McKay <tmckay>
Component: Management_Console_Installation_GuideAssignee: Lana Brindley <lbrindle>
Status: CLOSED CURRENTRELEASE QA Contact: Jan Sarenik <jsarenik>
Severity: medium Docs Contact:
Priority: high    
Version: DevelopmentCC: jross, jsarenik, lbrindle, matt, mhideo
Target Milestone: 1.3   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2010-10-14 20:31:24 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Trevor McKay 2010-09-09 21:34:16 UTC
Description of problem:

The console installation guide as written seems to assume that a qpid broker will already be installed on the target machine.  This is not necessarily true nor necessarily desired.  However, if it is the intention to have a broker on the target machine then the installer should have a reminder to make sure that it is installed.  Additionally, if the broker is installed and started, it helps verify the console installation because the GUI can show data from the broker.

Version-Release number of selected component (if applicable):

This is for 1.3

How reproducible:


Steps to Reproduce:
1.
2.
3.
  
Actual results:

Steps are missing that give more complete information to the user.

Expected results:

Add steps like the following to the current Chapter 2, step 6 which deal with adding a user for cumin (numbering is relative):

7.  A broker is necessary for the Management Console to communicate with other parts of MRG.  The default installation assumes that a broker will be installed locally.  If this is your desired setup, check that the broker has been installed:

# rpm -qa qpid-cpp-server

  If the broker is missing, it can be installed in one of two ways:

  If the MRG Messaging component is installed, the broker will be included (see the Messaging Installation Guide).  

  If the MRG Messaging component will not be installed, the broker may be installed with the following yum command:

# yum install qpid-cpp-server

  Once the broker is installed, make sure that it is running with the service command:

# service qpidd status

  If it is not running, start it:

# service qpidd start

8.  Now start cumin with the service command:

# service cumin start

9.  To verify that the cumin web server is running, open a web browser and visit the following link:

http://localhost:45672

  This should bring up a login page for cumin.  Log in as the user created in step 6 above.

  If the broker was installed and started on the local machine, message data should be visible shortly under the Adminstrator->Overview tab.

Additional info:

Comment 1 Trevor McKay 2010-09-10 11:41:49 UTC
Note, more specifically this section is Chapter 2, Start Console, First Run.

Current steps 2-5 in this section should be replaced, BZ #630579 linked above relates to this.

The intention above is to give additional steps which follow the current step 6.

Comment 2 Trevor McKay 2010-09-10 11:47:02 UTC
Also, note that condor-qmf-plugins mentioned in step 1 is now condor-qmf.  BZ 630631 linked above relates to this.

Comment 3 Trevor McKay 2010-09-10 12:05:17 UTC
My apologies, this is based on revision 3.1 of the document.

Comment 4 Justin Ross 2010-09-10 20:12:27 UTC
I'm going to add to this ticket, since it's so far focused on the "Starting the MRG Management Console" section, and I have edits in that department.

In general:

  * Remove the command-line oriented config instructions; for example, remove the extra info about --addr, and the item about --port.

Section 1:

  * The addr param is now called "host", and it lives under the [web] section.  Note that you can set the port with the "port" param.

    Before:

      addr: 192.168.0.20

    After:

      [web]
      host: 192.168.0.20
      port: 1234

  * Add a note that using "0.0.0.0" as the host value will cause cumin to bind to all local interfaces.

Section 2:

  * Remove it entirely.  Our webserver impl changed how ssl work, and we haven't had time to retest it.

Sections 3 and 4:

  * No changes.

Section 5:

  * Remove it entirely.

Comment 5 Lana Brindley 2010-09-14 04:36:59 UTC
This section has mostly been removed from other BZs. Please review the 3.2 revision of the document on the stage (available within the next 24 hours) and let me know if any further changes are required.

Thanks,
LKB

Comment 6 Lana Brindley 2010-09-15 01:02:43 UTC
This has been updated again. Please look for revision 3.3, available shortly.

LKB

Comment 7 Jan Sarenik 2010-09-15 08:49:15 UTC
Still missing in Revision 3.4, as of Wed Sep 15 2010,
excuse me, Lana, I did not notice this when writing
the summary email today. I am glad for having found this.

Comment 8 Trevor McKay 2010-09-15 12:59:24 UTC
As of 3.4, some of the original notes still apply.  Restated here.

Since section 3 under "Starting the MRG Management Console" refers to qpidd, and since the screen shot in section 6 a little further down the page shows message traffic on the GUI, it seems that we should make sure the user has qpid installed.  I think this can go either under "First Run" or under "Starting the Management Console" before the current step three but I think it should be there.

To see if qpidd is installed:

$ rpm -qa qpid-cpp-server

if it isn't installed, it can be installed as part of Messaging, or it can be installed independently with:

$ yum install qpid-cpp-server

to start the qpidd service

$ /sbin/service qpidd start

Now with qpidd running, the screen shot in step 6 should be similar to what a user would see (perhaps after a short delay)

Comment 9 Trevor McKay 2010-09-15 13:12:11 UTC
Additionally, I think this has been noted elsewhere but the various "cumin-database-COMMAND" commands are now "cumin-database command".  In Chapter 2, first run, this applies to "cumin-database-install" which should be "cumin-database install".

Comment 10 Lana Brindley 2010-09-15 21:11:33 UTC
(In reply to comment #8)
> As of 3.4, some of the original notes still apply.  Restated here.
> 
> Since section 3 under "Starting the MRG Management Console" refers to qpidd,
> and since the screen shot in section 6 a little further down the page shows
> message traffic on the GUI, it seems that we should make sure the user has qpid
> installed.  I think this can go either under "First Run" or under "Starting the
> Management Console" before the current step three but I think it should be
> there.
> 
> To see if qpidd is installed:
> 
> $ rpm -qa qpid-cpp-server
> 
> if it isn't installed, it can be installed as part of Messaging, or it can be
> installed independently with:
> 
> $ yum install qpid-cpp-server
> 
> to start the qpidd service
> 
> $ /sbin/service qpidd start
> 
> Now with qpidd running, the screen shot in step 6 should be similar to what a
> user would see (perhaps after a short delay)

<listitem>
	<para>
		To use the &CONSOLE; with &RHM;, the broker needs to be installed. To check if the &RHM; broker is installed, use the <command>rpm</command> command:
	</para>
<screen>
$ rpm -qa qpid-cpp-server
</screen>
	<para>
		If the <command>qpid-cpp-server</command> package is not installed, it can be installed as part of &RHM;. For more information on installing &RHM;, see the <citetitle>&RHM; Installation Guide</citetitle>. Otherwise, the package can be installed independently using <command>yum</command> as the root user:
	</para>
<screen>
# yum install qpid-cpp-server
</screen>
	<para>
		Once the package is installed, start the service:
	</para>
<screen>
$ /sbin/service qpidd start
</screen>
</listitem>

Comment 11 Lana Brindley 2010-09-15 21:12:27 UTC
(In reply to comment #9)
> Additionally, I think this has been noted elsewhere but the various
> "cumin-database-COMMAND" commands are now "cumin-database command".  In Chapter
> 2, first run, this applies to "cumin-database-install" which should be
> "cumin-database install".

This was fixed after Jasan's email.

Thanks,
LKB

Comment 12 Jan Sarenik 2010-09-16 05:54:58 UTC
(In reply to comment #4)
> Section 2:
>
>  * Remove it entirely.  Our webserver impl changed how ssl work, and we
> haven't had time to retest it.

If above is still valid, the section is not removed in
Revision 3.7, as of Thu Sep 16 2010. Justin?

Comment 13 Justin Ross 2010-09-16 13:39:27 UTC
Jasan, quite right.  That section should still be removed.

Comment 14 Justin Ross 2010-09-16 13:52:25 UTC
I just wanted to add a friendly reminder about the edits in comment 8.  I know you're busy!

Comment 15 Trevor McKay 2010-09-16 14:04:03 UTC
Justin,

  Did you mean the edits in comment 8, or the edits in comment 4?  Comment 8 edits are in, but comment 4 edits are not.  My understanding is that they are awaiting confirmation on comment 4 edits.

Comment 16 Justin Ross 2010-09-16 14:35:43 UTC
Ah, Trevor, quite right!

Comment 17 Trevor McKay 2010-09-16 18:39:36 UTC
To restate/summarize Justin's changes against revision 3.7 of the document (confirmed with Justin)

Chapter 2, Starting the MRG Management Console section
-------------------------------------------------------

Section 1:

  *  This needs to change.  The wodring is a little ambiguous, and the syntax/semantics in cumin.conf have changed.  Users need to be instructed to modify the default values in the [web] section of the cumin.conf file.  Something like the following text will work:

 "By default, the web console is bound to the localhost network interface, which allows only local connections to be made. To make the MRG Management Console accessible to other machines on the network, specify the IP address of another network interface on the host in the configuration file.  Optionally, you may specify a different port as well (the default is 45672).  You can do this by editing the /etc/cumin/cumin.conf and modifying the [web] section"

  * The user should end up with a [web] section in cumin.conf that contains a host and optionally a port specification as follows.  There should already be a default [web] section in the file with lines commmented out with # so it should be easy for them to find:

      [web]
      host: 192.168.0.20
      port: 1234

  * Add a note that using "0.0.0.0" as the host value above will cause cumin to bind to all local network interfaces (ie, all IP addresses that the host has defined).

  * The remainder of section 1 referring to command line options should be removed:

"To set the host IP address using a command line option, run the following command as the cumin user:
# su cumin
$ cumin --addr 192.168.0.20"

Section 2: (deals with SSL)

  * Remove it entirely.  Our webserver impl changed how ssl work, and we
haven't had time to retest it.

Section 6: (starting cumin as an unprivileged user)

  * Remove it entirely.

Comment 18 Justin Ross 2010-09-16 18:45:10 UTC
Trevor's statement is a great deal clearer than mine.  Very nice, and all correct to boot.

Comment 19 Lana Brindley 2010-09-16 22:24:27 UTC
(In reply to comment #12)
> (In reply to comment #4)
> > Section 2:
> >
> >  * Remove it entirely.  Our webserver impl changed how ssl work, and we
> > haven't had time to retest it.
> 
> If above is still valid, the section is not removed in
> Revision 3.7, as of Thu Sep 16 2010. Justin?

It's gone now. Sorry for missing that one.

LKB

Comment 20 Lana Brindley 2010-09-16 22:35:54 UTC
(In reply to comment #17)
> To restate/summarize Justin's changes against revision 3.7 of the document
> (confirmed with Justin)
> 
> Chapter 2, Starting the MRG Management Console section
> -------------------------------------------------------
> 
> Section 1:
> 
>   *  This needs to change.  The wodring is a little ambiguous, and the
> syntax/semantics in cumin.conf have changed.  Users need to be instructed to
> modify the default values in the [web] section of the cumin.conf file. 
> Something like the following text will work:
> 
>  "By default, the web console is bound to the localhost network interface,
> which allows only local connections to be made. To make the MRG Management
> Console accessible to other machines on the network, specify the IP address of
> another network interface on the host in the configuration file.  Optionally,
> you may specify a different port as well (the default is 45672).  You can do
> this by editing the /etc/cumin/cumin.conf and modifying the [web] section"

<para>
	By default, the web console is bound to <filename>localhost</filename> network interface, which allows only local connections to be made. To make the &CONSOLE; accessible to other machines on the network, the IP address of another network interface on the host needs to be sepcified in the configuration file. Do this by editing the <filename>/etc/cumin/cumin.conf</filename> file and modifying the <parameter>[web]</parameter> section:
</para>

> 
>   * The user should end up with a [web] section in cumin.conf that contains a
> host and optionally a port specification as follows.  There should already be a
> default [web] section in the file with lines commmented out with # so it should
> be easy for them to find:
> 
>       [web]
>       host: 192.168.0.20
>       port: 1234
> 
>   * Add a note that using "0.0.0.0" as the host value above will cause cumin to
> bind to all local network interfaces (ie, all IP addresses that the host has
> defined).
> 
>   * The remainder of section 1 referring to command line options should be
> removed:
> 
> "To set the host IP address using a command line option, run the following
> command as the cumin user:
> # su cumin
> $ cumin --addr 192.168.0.20"

<listitem>
	<para>
		By default, the web console is bound to <filename>localhost</filename> network interface, which allows only local connections to be made. To make the &CONSOLE; accessible to other machines on the network, the IP address of another network interface on the host needs to be specified in the configuration file. Do this by editing the <filename>/etc/cumin/cumin.conf</filename> file and modifying the <parameter>[web]</parameter> section:
	</para>
	 <para>
		By default, the <parameter>[web]</parameter> section in the configuration file will have the following lines commented out. Remove the <parameter>#</command> symbol and edit them to contain the correct IP address:
	</para>
<programlisting>
[web]
host: <replaceable>192.168.0.20</replaceable>
port: <replaceable>1234</replaceable>
</programlisting>

	 <para>
		Using <parameter>0.0.0.0</parameter> as the IP address for this configuration parameter will make &CUMIN; bind to all local network interfaces that have been defined.
	</para>
</listitem>

> 
> Section 2: (deals with SSL)
> 
>   * Remove it entirely.  Our webserver impl changed how ssl work, and we
> haven't had time to retest it.

It's gone.

> 
> Section 6: (starting cumin as an unprivileged user)
> 
>   * Remove it entirely.

It's gone too.

LKB

Comment 21 Jan Sarenik 2010-09-27 10:31:19 UTC
Verified in Revision 3.10, as of Wed Sep 22 2010.