Bug 794362 (JBEPP-1406) - SSO documentation issues
Summary: SSO documentation issues
Keywords:
Status: CLOSED NEXTRELEASE
Alias: JBEPP-1406
Product: JBoss Enterprise Portal Platform 5
Classification: JBoss
Component: Documentation
Version: 5.2.0.GA
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 5.2.x
Assignee: Scott Mumford
QA Contact: ecs-bugs
URL: http://jira.jboss.org/jira/browse/JBE...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2011-11-28 09:20 UTC by mposolda
Modified: 2014-06-17 13:58 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2011-11-28 22:08:32 UTC
Type: Enhancement


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker JBEPP-1406 0 None None None Never

Description mposolda 2011-11-28 09:20:15 UTC
project_key: JBEPP

Looking at http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/5.2/html-single/Reference_Guide/index.html#sect-Reference_Guide-SSO_Single_Sign_On_ I am seeing these problems in SSO section.

1) I think that all things related to OpenSSO should be all in one section (in similar way like it is for CAS and JOSSO). Right now, they are divided into more sections:
17.7.5. OpenSSO
17.7.6. Modifying the OpenSSO server
17.7.7. Setup the OpenSSO Client
17.7.8. Setup the portal to redirect to OpenSSO

These all should be in one section "OpenSSO", which should be 17.7.5 . following section 17.7.6 should be about SPNEGO. See current GateIn reference guide how it is here right now.





2) SPNEGO part

2.1) Section "Clients" is duplicated. See section "17.7.9.2 Clients" and "17.7.9.4 Clients". I think that section 17.7.9.4 should be removed.

2.2) 17.7.9.3. JBoss Enterprise Portal Platform Configuration - All the paths and configuration files for SPNEGO section of EPP reference guide should be updated from GateIn reference guide. This is not the case right now. It seems that some sections (especially configuration files) were not correctly merged from GateIn documentation from commit https://source.jboss.org/viewrep/GateIn/portal/trunk/docs/reference-guide/en-US/modules/AuthenticationAndIdentity/SSO.xml?r1=8015&r2=8017 .

I am seeing it can be because in GateIn reference guide are all configuration files aded directly to SSO.xml documentation source file, where in EPP documentation it points to external files (like ../../extras/Authentication_Identity_SSO/default125.xml ). Things which should be updated from GateIn docs are:

2.2.1) deployers/jbossweb.deployer/META-INF/war-deployers-jboss-beans.xml configuration file in step 2 of "Procedure 17.21. Advanced SPNEGO Configuration"

2.2.2) deploy/gatein.ear/META-INF/gatein-jboss-beans.xml in step 4 of "Procedure 17.21. Advanced SPNEGO Configuration"

2.2.3) gatein.ear/02portal.war/WEB-INF/web.xml - Both part with authentication and part with HTTP filters are not correct in EPP docs. There is also some text missing in comparison to GateIn docs (about possibility to enable/disable fallback to FORM authentication)

2.2.4) In EPP startup command (Step 7) should be "-c default" instead of "-c spnego" as previous steps are editing configuration files in default configuration. 

It seems that some Paths to configuration files were also not updated correctly from GateIn docs in Spnego section. Please check GateIn reference guide and update paths according to it if possible.

Comment 1 Scott Mumford 2011-11-28 22:05:50 UTC
Thanks Marek

I moved the close-section tag that was to blame for the OpenSSO sub-sections being on-level with their parent.

I hadn't noticed the double up of the 'Clients' section. Not sure how I missed that. Fixed.

I updated all the paths and code samples in section 17.7.9.3.

In GateIn docs section 6.6.5.1: Configuration - Step 7, the docs refer to gatein.war file. There's no gatein.war file in the 5.2.0CR01 zip I have. There's a gatein.ear in that location, so I'm assuming this is a typo in the GateIn docs and am leaving it as gatein.ear in the EPP doc.

Also I changed the start up command to use PROFILE instead of either 'default' or 'spnego' as I try not to refer to specific configuration profiles (since we include six and users can create any number).

Reopen this issue if there's anything else I've missed.

Thanks for the awesome feedback.


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