Bug 797273

Summary: System Engine 1.0: Need documentation update for new deployment URLs
Product: [Retired] CloudForms Common Reporter: Jordan OMara <jomara>
Component: Docs Installation GuideAssignee: Lana Brindley <lbrindle>
Status: CLOSED WONTFIX QA Contact: Katello QA List <katello-qa-list>
Severity: high Docs Contact:
Priority: urgent    
Version: 1.0.0CC: asv, athomas, dmacpher, gkhachik, jlaska, mhideo, mmccune, omaciel, scollier
Target Milestone: rcKeywords: Triaged
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
: 804875 (view as bug list) Environment:
Last Closed: 2012-03-21 18:25:03 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Bug Depends On:    
Bug Blocks: 804875    

Description Jordan OMara 2012-02-24 18:20:38 UTC
katello-configure now supports two additional --deployment flags, sam and cfse. This will publish the app to /sam and /cfse, respectively. The SAM & CFSE installation guide needs to be updated appropriately. Currently the default deployment is katello, and the SAM guide uses headpin.

For SAM, the usage is 

katello-configure --deployment=sam

SAM will be located @ https://$hostname/sam

For CFSE, the usage is

katello-configure --deployment=cfse

CFSE will be located @ https://$hostname/cfse

Comment 3 Dan Macpherson 2012-03-20 03:27:06 UTC
Package:
CloudForms-Installation_Guide-1.0-web-en-US-1-42.el6eng

Fix:
Added --deployment=cfse to instances of katello-configure
Link:
http://documentation-stage.bne.redhat.com/docs/en-US/CloudForms/1.0/html/Installation_Guide/sect-Installation_Guide-System_Engine_Installation-Configuring_Cloudforms_Systems_Engine.html

Fix:
Added changed entry point URL to cfse
Link:
http://documentation-stage.bne.redhat.com/docs/en-US/CloudForms/1.0/html/Installation_Guide/chap-Installation_Guide-System_Engine_Installation-Booting_Cloudforms_System_Engine.html

Duplicate bugs:
https://bugzilla.redhat.com/show_bug.cgi?id=800703
https://bugzilla.redhat.com/show_bug.cgi?id=802394

Notes:
* Need QA_ACK before passing this bug through the CDW
* Has this bug been cloned for SAM?

Comment 4 Dan Macpherson 2012-03-20 03:27:12 UTC
*** Bug 800703 has been marked as a duplicate of this bug. ***

Comment 5 Dan Macpherson 2012-03-20 03:27:16 UTC
*** Bug 802394 has been marked as a duplicate of this bug. ***

Comment 7 James Laska 2012-03-20 12:42:05 UTC
dan and mmccune: I'm concerned about this change...

 1. I feel there may be a lot of documentation throughout our product (online, README, man-pages etc...) that references the <default> "/katello" URL base

 2. The <default> is still "/katello" ... and since 'katello-configure --deployment' is not a *required* argument, I think most users will forget to add an additional katello-configure argument.

 3. I'm unclear what the motivation for this change is.  Is it an attempt to remove references to the upstream project name from the product?  If that's the case, this proposed change seems to only touch the surface.

Comment 8 James Laska 2012-03-20 19:41:06 UTC
Dan: Apologies for the late feedback.  Would you mind holding off on committing any official documentation changes for this issue until we can resolve the concerns comment#7?

I spoke with mmccune privately, and he has some options that he'll present to cloud-program@ for further discussion.  One of us will communicate any conclusions on the list, into this bug.

Thanks!

Comment 11 Bryan Kearney 2012-03-21 13:40:14 UTC
*** Bug 804108 has been marked as a duplicate of this bug. ***

Comment 13 James Laska 2012-03-21 18:05:46 UTC
Dan, apologies for the inconvenience... can you revert the proposed documentation change from comment#3?  The conclusion on the cloud-program@ list [1] is that the katello-configure --deployment option will remain in the code, but we will not document it's usage in the installation guide.

[1] http://post-office.corp.redhat.com/mailman/private/cloud-program/2012-March/msg00186.html

Comment 14 RHEL Program Management 2012-03-21 18:25:03 UTC
Quality Engineering Management has reviewed and declined this request.
You may appeal this decision by reopening this request.