Bug 1159099 - [Doc Bug Fix] Tables in the "Configure the Web Subsystem" need to be converted into a more easily-read format.
Summary: [Doc Bug Fix] Tables in the "Configure the Web Subsystem" need to be converte...
Keywords:
Status: CLOSED DEFERRED
Alias: None
Product: JBoss Enterprise Application Platform 6
Classification: JBoss
Component: Documentation
Version: 6.4.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: post-GA
: EAP 6.4.3
Assignee: Priyanka Nag
QA Contact: Radim Hatlapatka
URL:
Whiteboard:
: 1016080 1016107 1134162 (view as bug list)
Depends On:
Blocks: 1139526
TreeView+ depends on / blocked
 
Reported: 2014-10-31 00:37 UTC by Russell Dickenson
Modified: 2017-12-04 12:33 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Build Name: 22924, Administration and Configuration Guide-6.4-1 Build Date: 30-10-2014 18:57:18 Topic ID: 4759-687353 [Latest]
Last Closed: 2015-10-28 18:37:57 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 960372 0 unspecified CLOSED [Doc Feature] Document "jbossweb" system-properties 2021-02-22 00:41:40 UTC

Internal Links: 960372

Description Russell Dickenson 2014-10-31 00:37:54 UTC
Title: Configure the Web Subsystem

Describe the issue:

Having this content in tabular format makes it difficult to read and doesn't allow for content wrapping to suit other layouts (e.g. PDF).

Suggestions for improvement:

The tables in this section need to be removed and their content reformatted so that it is: more easily read and able to be restyled (e.g. lines wrapped as need to fit other published formats).

Comment 3 Radim Hatlapatka 2014-12-18 12:18:12 UTC
There isn't any Servlet/HTTP Subsystem in EAP.

Note that Web Console has mod_cluster and Web Services shown under Web subsystem which is incorrect. Those are separate subsystems in EAP.

Comment 4 Radim Hatlapatka 2014-12-18 12:40:39 UTC
Global Configuration Options
* Default for native attribute is 'true' not 'false'

JSP Configuration Options
* Check Interval - what 0 as default value means? 0 means that checks are disabled, see [1]
* Keep Generated - the name of CLI attribute is keep-generated
* X Powered By - I would change "advertised in x-powered-by" to "advertised using x-powered-by HTTP header"


* There still are not all options described, see /subsystem=web/configuration=jsp-configuration:read-resource-description




[1]
https://docs.jboss.org/jbossweb/7.0.x/config/jsp.html

Comment 5 Radim Hatlapatka 2014-12-18 16:05:54 UTC
Connector Options
* Protocol - HTTP vs AJP are possible protocols that is correct, here should be also added different possible implementations of those protocols, e.g. for HTTP there are JIO, NIO2 and APR protocols, the definition can be done either by defining only the API (HTTP/1.0 vs HTTP/1.1, ...) and server decides which implementation to use or by FQCN (e.g org.apache.coyote.http11.Http11Protocol for JIO or org.apache.coyote.http11.Http11NioProtocol for NIO2 or org.apache.coyote.http11.Http11AprProtocol for APR, note, APR is available only with natives enabled)

Comment 9 Radim Hatlapatka 2015-01-19 09:01:40 UTC
*** Bug 1134162 has been marked as a duplicate of this bug. ***

Comment 19 Radim Hatlapatka 2015-07-15 09:21:42 UTC
I have checked it with docs revision 6.4.0-34 and these are my findings:

Missing default value for "Error on Use Bean Invalid Class Attribute" (default value is false)

Next there is typo in FQCN for NIO2, where is missing org.: is apache.coyote.http11.Http11NioProtocol => should be org.apache.coyote.http11.Http11NioProtocol - this is being resolved as part of https://bugzilla.redhat.com/show_bug.cgi?id=1121137#c2


Next regarding APR:
there is no need to install Webserver Connectors Native package (that package contains modules for httpd and load balancing). You need to install Native Components package (which contains the APR, see https://documentation-devel.engineering.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html-single/Installation_Guide/index.html#Download_and_Install_Native_Components_and_Native_Utilities).


Regarding Virtual Servers Options two suggestions:
alias - "A list of hostnames which must match this virtual server" - wouldn't it be better "A list of hostnames supported by this virtual server" as this option means that if you access one of the hostnames in the alias, then options specific for that virtual server shall be used?

Default module - instead of "must be deployed" wouldn't it be better "will be deployed" ?

Comment 23 Radim Hatlapatka 2015-07-29 11:20:34 UTC
Checked with docs revision 6.4.0-35.

There was added example of CLI command showing how to read connector description [1]. This example is for standalone containing part of command line. This is inconsistent to the way other CLI examples are constructed e.g. Example 15.2. Create a New Connector contains command for server in domain mode without command line prompt prefix [2]. I believe this should be consistent.

MaxTime description typo:
there should be singular in word request and not plural ("Max time spent to process a requests." => "Max time spent to process a request.")

processingTime description typo:
should be "In milliseconds" and not "Im milli-seconds"




[1] [standalone@localhost:9999 /] /subsystem=web/connector=http:read-resource-description

[2] /profile=full-ha/subsystem=web/connector=ajp/:add(socket-binding=ajp,scheme=http,protocol=AJP/1.3,secure=false,name=ajp,max-post-size=2097152,enabled=true,enable-lookups=false,redirect-port=8433,max-save-post-size=4096)

Comment 24 Radim Hatlapatka 2015-07-29 11:24:23 UTC
Additionally changing Connector options names to those in CLI doesn't correspond to the way options for other parts are written (e.g. JSP configuration options).

Comment 26 Radim Hatlapatka 2015-07-30 06:24:46 UTC
access-log wasn't removed, It is child of the virtual server (one of configuration childs). It can be created via CLI command /subsystem=web/virtual-server=default-host/configuration=access-log:add()

It is similar for sso, which is also one of virtual server configuration childs
/subsystem=web/virtual-server=default-host/configuration=sso:add

Comment 28 Radim Hatlapatka 2015-08-04 11:43:06 UTC
*** Bug 1016107 has been marked as a duplicate of this bug. ***

Comment 29 Radim Hatlapatka 2015-08-04 11:45:22 UTC
*** Bug 1016080 has been marked as a duplicate of this bug. ***

Comment 32 Radim Hatlapatka 2015-09-11 06:58:13 UTC
I just checked trying to define HTTP protocol using API name "HTTP/1.0" and found out it is not possible, sorry if I confused you by Comment 5. 

On the contrary, it is possible to define the protocol as "http", which behaves the same as defining it to "HTTP/1.1".

Comment 33 Radim Hatlapatka 2015-09-11 07:06:22 UTC
Sentence just before describing connector options:
"AJP and HTTP connectors use mod_cluster, mod_jk, mod_proxy, ISAPI connector, and NSAPI connector for load balancing and HA clustering. "

shouldn't be there as AJP and HTTP connectors in Web subsystem have nothing to do with load balancers as are mod_cluster, mod_jk, mod_proxy, ...

The connectors just implement the specific protocol, which can be used during communication between load balancer and the server (worker).

Comment 34 Radim Hatlapatka 2015-09-11 07:09:36 UTC
Additionally there is missing:
default value for Maximum Save Post Size, which is 4096.
description of access-log attributes
description of SSO attributes

Comment 35 Radim Hatlapatka 2015-09-11 07:11:05 UTC
Verification was done against Administration and Configuration Guide, revision 6.4.0-37

Comment 43 Radim Hatlapatka 2015-09-29 12:08:24 UTC
Checked with docs Revision 6.4.0-39. There is still few more improvement which should be incorporated there.

The description of "resolve-hosts" attribute should contain info that it is also necessary to enable-lookups on the connector for "resolve-hosts=true" option to actually take any effect.

The description of rewrite attributes
* description of "flags" attribute is missing.
* description of "condition" - there is no condition attribute, there is condition child resource of rewrite, which can be defined as child of the rewrite and is used to limit the rewrite rule only to cases with matching conditions when the rewrite should occur.

Description of SSO attributes is missing info about default values, which is in case of http-only true.

Comment 47 Jean-frederic Clere 2015-10-09 06:56:46 UTC
The title looks weird... "Servlet/HTTP Configuration" why?

You should put the metrics separated from the attributes. (like  Bytes Received).

Comment 49 Jean-frederic Clere 2015-10-09 07:37:19 UTC
EAP7.0 uses undertow so the web subsystem docs have to be completely rewritten.

Comment 50 Radim Hatlapatka 2015-10-09 08:49:56 UTC
I agree with Jean-Frederic, having the metrics (runtime) attributes separately would make more sense.

Rewrite resource and its flag attribute description is not correct. In case of Web subsystem configuration, the flags are provided without the brackets.

Regarding SSO
* the sso configuration is either added or not, in default it is not added => no SSO.
* regarding comment 43 and its SSO part it mentions mainly missing specified default value for http-only attribute of the SSO configuration. So the default should be added to the http-only attribute description.

Comment 51 Radim Hatlapatka 2015-10-09 08:53:58 UTC
Note, which attributes are metrics can be easily found out from CLI's ":read-resource-description operation". Metrics attributes have defined "access-type" as "metric".

Comment 52 anrobert 2015-10-28 18:37:57 UTC
Work is ongoing to rewrite this information for 7.0. Work tracked in JIRA with the larger EAP project so I'm closing this BZ that was opened about a year ago.


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