Bug 794301 (JBEPP-1350)

Summary: Upgrade SSO documentation for SSO 1.1.0-GA
Product: [JBoss] JBoss Enterprise Portal Platform 5 Reporter: mposolda
Component: DocumentationAssignee: Scott Mumford <smumford>
Status: CLOSED NEXTRELEASE QA Contact: ecs-bugs
Severity: high Docs Contact:
Priority: high    
Version: 5.2.0.ER06CC: mposolda, smumford
Target Milestone: ---   
Target Release: 5.2.0.Docs.GA   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/JBEPP-1350
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-11-28 02:07:44 UTC Type: Enhancement
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description mposolda 2011-11-09 17:35:12 UTC
project_key: JBEPP

Upgrade sections for CAS, JOSSO and OpenSSO. It is backport of GTNPORTAL-2264 .

Comment 1 mposolda 2011-11-09 17:35:31 UTC
Link: Added: This issue relates to GTNPORTAL-2264


Comment 2 mposolda 2011-11-09 17:51:07 UTC
Hi Scott, please look at https://source.jboss.org/changelog/GateIn?cs=8015 and if possible, upgrade those sections into EPP docs as well.

Comment 3 mposolda 2011-11-09 17:59:42 UTC
BTW. As mentioned in comments in http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/5.2/html-single/Reference_Guide_eXo_JCR_1.14/index.html#sect-Reference_Guide_eXo_JCR_1.14-SSO_Single_Sign_On, sections with InitiateLoginServlet should really be deleted (point 5 for CAS and point 5 for JOSSO).

It seems that some parts are also already updated in EPP docs and some parts are probably not needed in EPP doc (like download location for SSO 1.1.0-GA.zip because this is packed with EPP.)


Comment 4 Scott Mumford 2011-11-10 02:04:49 UTC
Thanks Marek

I've incorporated changes from the changelog you linked. I've also removed the two sections mentioning InitiateLoginServlet.

Please review and confirm once a new version of the EPP Ref Guide is staged (will ping Portal list to advise).

Comment 5 mposolda 2011-11-10 16:33:00 UTC
Scott, it seems that in SSO docs are some references, which points to EPP running on Tomcat. These all are specific only to GateIn reference guide, but should be removed from EPP reference guide because EPP can't run on Tomcat. I thing what should be removed is at least:

1) Procedure 17.11. Setup the CAS client - part of step 2 with: "In Tomcat, edit GATEIN_HOME/conf/jaas.conf, uncomment on this section and comment other parts:". The snippet of jaas.conf file should be removed as well.

2) Procedure 17.20. Setup the OpenSSO client - Whole step 3 (Starting with sentence "If you are running JBoss Enterprise Portal Platform in Tomcat, ...") should be removed. 


Please note that some parts are still referencing Tomcat, because docs assumes that SSO server is running on Tomcat. That's fine. Problematic parts are only those, which are talking about EPP running on Tomcat.

Thanks

Comment 6 Scott Mumford 2011-11-10 21:54:24 UTC
Thank Marek,

I've commented the points you mentioned, but would it be possible for you to give me some guidance on removing references to Tomcat altogether? (if EPP doesn't run on it, it probably shouldn't be in the documentation)

There's some code snippets that reference tomcat, some URLs that seem Tomcat specific, notes on changing Tomcat port numbers and instructions to download and extract Tomcat.

Which of those can be changed and what should they be changed to?

Thanks

Comment 7 mposolda 2011-11-10 23:26:14 UTC
SSO is about communication between two servers:
1) Server 1 is EPP server. EPP is always running on JBoss EAP container
2) Sever 2 is SSO server (like CAS, JOSSO or OpenSSO) which is executed on Tomcat

Documentation for both GateIn and for EPP assumes that server (2) will be executed on Tomcat. That's fine and this informations still needs to remain in EPP guide.

Tricky part is for server 1. When you are using GateIn, you can run server 1 on both Tomcat or JBoss AS. But when using EPP, you don't want to have EPP running on Tomcat. So informations about running server 1 on Tomcat needs to be removed from EPP guide.

Instructions which you mentioned (port numbers and informations about download and extract Tomcat) are talking about server 2 and so these needs to retain in EPP guide. Only two points which I mentioned in comment https://issues.jboss.org/browse/JBEPP-1350?focusedCommentId=12641833&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-12641833 needs to be removed.

When seeing your commit https://source.jboss.org/browse/GateIn/epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/AuthenticationAndIdentity/SSO.xml?r2=8035&r1=8018 it seems that you comment these two sections, but you also comment one section talking about Tomcat for SSO server. So the very first part (paragraph starting with "In this tutorial, the SSO server is being installed in a Tomcat environment.") needs to remain uncommented.

Sorry if these technical SSO things are too confusing and complicated. And sorry for not being clear in my first comment :-/

Thanks again

Comment 8 Scott Mumford 2011-11-11 02:06:57 UTC
Ahh, I see.
Thanks MArek. That actually clears things up significantly.

Comment 9 Jared MORGAN 2011-11-11 02:11:26 UTC
Release Notes Docs Status: Added: Not Required