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_Guide | Assignee: | Lana Brindley <lbrindle> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Jan Sarenik <jsarenik> |
| Severity: | medium | Docs Contact: | |
| Priority: | high | ||
| Version: | Development | CC: | 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
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. Also, note that condor-qmf-plugins mentioned in step 1 is now condor-qmf. BZ 630631 linked above relates to this. My apologies, this is based on revision 3.1 of the document. 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.
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 This has been updated again. Please look for revision 3.3, available shortly. LKB 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. 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) 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". (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> (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 (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? Jasan, quite right. That section should still be removed. I just wanted to add a friendly reminder about the edits in comment 8. I know you're busy! 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. Ah, Trevor, quite right! 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.
Trevor's statement is a great deal clearer than mine. Very nice, and all correct to boot. (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 (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 Verified in Revision 3.10, as of Wed Sep 22 2010. |