Bug 1017192 - [Doc Bug Fix] UX: Load balancing and HTTP connectors naming conflux and mismatch
Summary: [Doc Bug Fix] UX: Load balancing and HTTP connectors naming conflux and mismatch
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Enterprise Application Platform 6
Classification: JBoss
Component: Documentation
Version: 6.2.0
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ER2
: EAP 6.4.0
Assignee: Russell Dickenson
QA Contact: Michal Karm Babacek
Russell Dickenson
URL:
Whiteboard:
Depends On:
Blocks: 1015106
TreeView+ depends on / blocked
 
Reported: 2013-10-09 12:16 UTC by Michal Karm Babacek
Modified: 2015-10-20 12:44 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-10-20 12:44:35 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1090123 0 unspecified CLOSED [Doc Bug Fix] Naming in chapter "Install the Mod_jk Module Into the Apache HTTP Server (ZIP)" 2021-02-22 00:41:40 UTC

Internal Links: 1090123

Description Michal Karm Babacek 2013-10-09 12:16:05 UTC
Dear Docs guys,
the following spots in the documentation are examples of bad and confusing naming that has to be fixed accordingly to the guidelines that are being established on [BZ 1015106] - Apache HTTP Server and JBoss EAP naming conventions. Furthermore, the aforementioned bugzilla covers the topic of configuration paths, please, take a look and comment on it.


Snippets from the current documentation:

1)
Table 16.1. HTTP connector features and constraints
BUGS: Naming.


2)
16.1.4. Worker Node
HTTP connector node
JBoss EAP 6 can accept requests from its own HTTPD, the HTTPD shipped with JBoss Enterprise Web Server, Apache HTTPD, Microsoft IIS, or Oracle iPlanet Web Server (Formerly Netscape Web Server). 
BUGS: Naming.


3)
16.3.1. About the Stand-Alone HTTPD
JBoss EAP 6 is tested and supported with the Apache HTTPD which is included with certified versions of Red Hat Enterprise Linux 6. Apache HTTPD is also available for other configurations, such as Microsoft Windows Server. However, since Apache HTTPD is a separate product produced by the Apache Foundation, it used to be difficult to be sure that the version of Apache HTTPD a customer used was compatible with JBoss EAP. 
BUGS: Naming.


4)
Procedure 16.2. Install the Apache HTTPD
3.
Copy the httpd folder and place it inside the directory where you installed the JBoss EAP 6, commonly referred to as EAP_HOME.
Your HTTPD would now be located in EAP_HOME/httpd/ directory. You can now use this location for HTTPD_HOME, as found in other JBoss EAP 6 documentation.
BUGS: Naming. Paths.


5)
16.3.2. Install the Apache HTTPD included with JBoss EAP 6
BUGS: How about Windows? ./  won't do...


6)
16.3.3. mod_cluster Configuration on httpd
Note
There is no need to use ProxyPass directives because mod_cluster automatically configures the URLs that must be forwarded to JBossWEB.
BUGS: Naming. e.g. "JBossWEB".


7)
Table 16.3. mod_manager Derivatives
ManagerBalancerName 
The name of balancer to use when the JBoss AS/JBossWeb/Tomcat does not provide a balancer name.
BUGS: Naming.


8)
16.3.4. Use an External HTTPD as the Web Front-end for JBoss EAP 6 Applications
...After you have decided which HTTPD...
BUGS: Naming.


9)
Section 16.5.5, “Configure a mod_cluster Worker Node”.
16.1.4. Worker Node: HTTP connector node versus Cluster node
Section 16.7.2, “Install the Mod_proxy HTTP Connector Into Apache HTTPD”
BUGS: Naming. Mod_proxy -> mod_proxy


10)
Procedure 16.4.
Modify the HTTPD configuration.
The proxy list is configured on the worker, and contains all of the mod_cluster-enabled HTTPD servers the worker can talk to. 
BUGS: Naming.


11)
Procedure 16.4.
The mod_cluster configuration for the HTTPD server is typically located in /etc/httpd/ or the etc/httpd/ directory within the HTTPD installation, if it is installed in a non-standard location.
BUGS: Naming. Path substitution.


12)
Section 16.5.4, “Configure Server Advertisement Properties for Your mod_cluster-enabled HTTPD
BUGS: Naming.


13)
16.5.3. Install the mod_cluster Module Into Apache HTTPD or JBoss Enterprise Web Server HTTPD
To perform this task, you must be using Apache HTTPD installed in Red Hat Enterprise Linux 6, or JBoss Enterprise Web Server, or the stand-alone HTTPD included as a separate downloadable component of JBoss EAP 6.
If you need to install Apache HTTPD in Red Hat Enterprise Linux 6, use the instructions from the Red Hat Enterprise Linux 6 Deployment Guide, available from https://access.redhat.com/site/documentation/.
If you need to install the stand-alone HTTPD included as a separate downloadable component of JBoss EAP 6, refer to Section 16.3.2, “Install the Apache HTTPD included with JBoss EAP 6”.
If you need to install JBoss Enterprise Web Server, use the instructions from the JBoss Enterprise Web Server Installation Guide, available from https://access.redhat.com/site/documentation/. 
BUGS: Naming.


14)
Procedure 16.5. Install the mod_cluster Module
    Determine your HTTPD configuration location.
    Your HTTPD configuration location will be different depending on whether you are using Red Hat Enterprise Linux's Apache HTTPD, the stand-alone HTTPD included as a separate downloadable component with JBoss EAP 6, or the HTTPD available in JBoss Enterprise Web Server. It is one of the following three options, and is referred to in the rest of this task as HTTPD_HOME.
        Apache HTTPD - /etc/httpd/
        JBoss EAP 6 HTTPD - This location is chosen by you, based on the requirements of your infrastructure.
        JBoss Enterprise Web Server HTTPD - EWS_HOME/httpd/ 
BUGS: Naming. Paths.


15)
Procedure 16.5. Install the mod_cluster Module
6. Restart the HTTPD.
The way to restart the HTTPD depends on whether you are using Red Hat Enterprise Linux's Apache HTTPD or the HTTPD included in JBoss Enterprise Web Server. Choose one of the two methods below. 
BUGS: Paths. Naming.


16)
16.5.4. Configure Server Advertisement Properties for Your mod_cluster-enabled HTTPD
BUGS: Paths. Naming.



THX 4 looking into it :-)

Comment 1 Michal Karm Babacek 2014-11-06 13:34:42 UTC
Dear Doc guys, this one looks severely neglected :-( Could you look into it please?

Comment 2 Michal Karm Babacek 2015-01-20 13:46:24 UTC
Dear Tom, I would like to follow up on my comment 1 and ask you to update the status of this bugzilla to its proper state with respect to the current EAP 6.4 documentation build.

thX

Comment 9 Michal Karm Babacek 2015-08-03 05:45:30 UTC
THX :-)


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