Bug 695556 - Split RHUI documentation into installer v. manager
Summary: Split RHUI documentation into installer v. manager
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Update Infrastructure for Cloud Providers
Classification: Red Hat
Component: Documentation
Version: 2.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Lana Brindley
QA Contact: wes hayutin
URL:
Whiteboard:
Depends On: 697205 697213 697214 697215 701438
Blocks: 689309
TreeView+ depends on / blocked
 
Reported: 2011-04-12 00:22 UTC by Jay Dobies
Modified: 2013-10-23 23:21 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2011-07-29 04:40:53 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Jay Dobies 2011-04-12 00:22:27 UTC
The biggest change is that there are now two applications the user will interact with.

RHUI Installer - This is largely what the previous iteration of "RHUI Tools" was. It will look very similar to the previous setup: a series of questions for various files that ultimately produces configuration RPMs that are installed on each piece (RHUA, CDS, Load Balancer - all of those are the same). The amount of questions asked is significantly smaller since it's acting as much more of an installer than before. It's simply enough to get the pieces up and running (just not doing anything).

RHUI Manager* - This is brand new to RHUI and, well, large. It's an interactive shell that provides the ability to configure a running RHUI. Configuration includes:
- Red Hat content certificate upload (either initially or when we issue a new one with more entitlements)
- Red Hat repository import. Using the content cert as the basis, the user can select one or more products within to import and be managed by the RHUI.
- Custom repository creation. This is entirely new to RHUI itself and was never previously supported. Users can create repositories and upload their own content to them. Additionally, these repositories will be protected, requiring clients to use entitlement certificates in the same way they do to access Red Hat provided content.
- Content Delivery Server (CDS) management, including the registration, unregistration, and selection of which repos to deploy to which CDS instances.
- Creation of entitlement certificates, allowing both Red Hat provided repositories and any custom repositories to be included in their creation.
- Client configuration RPM creation.

* We're still deciding on the actual name, whether the overall umbrella for both apps is "RHUI Tools" which is then made up of Installer and Manager, or if we just call the manager piece "RHUI Tools". I'll update the bug when I get a final decision.

I'll leave it up to you to figure out the best way to split these up. There's probably a model for install v. usage that you follow for docs, which is what I think this would fall under.

Comment 1 Jay Dobies 2011-04-12 13:10:10 UTC
FYI, we decided the product names will be:

  RHUI Installer
  RHUI Manager

I think the other bugs are already using RHUI Manager, but just keep in mind in case you see something like "RHUI Management Tools" that it's actually called RHUI Manager.

Comment 2 Lana Brindley 2011-04-13 00:31:27 UTC
I think we can largely fit this in to the structure we created in the last version of the docs.

If you recall, we split the book into three parts, covering Installation, Configuration, and Use. The Installation part will now contain information about the RHUI Installer, and Configuration will now contain information about the RHUI Manager.

After watching your demo this morning, I think that we won't really need to change much in the way of structure at this stage. Depending on how big each section ends up, we might need to split the book up, but that would be for next release.

Let me know if I've got the wrong end of the stick anywhere here.

LKB

Comment 3 Kedar Bidarkar 2011-05-24 13:58:16 UTC
We have now different sections for RHUI Installer and RHUI Manager
Chapter 3 is RHUI Installer
Chapter 4 is RHUI Manager

Also 

	697205  chapter 6 ( RHUI Manager CDS screen)
        697213  chapter 6.1 (RHUI Manager CDS Repo screen)
        697214  chapter 8 (RHUI Manager: Sync status and schedule screen )
        697215  chapter 4.3 (RHUI Manager: CLI)
        701438  rhui-manager repo list (respositories) (RHUI Manager: typo bug , currently in NEW state will check against rhui 2.0.23 and update the bug)

Comment 4 Lana Brindley 2011-07-29 04:40:53 UTC
This book is now available at http://docs.redhat.com/docs/en-US/Red_Hat_Update_Infrastructure/2.0/html/Installation_Guide/index.html

Please raise a new bug for any further changes.

LKB


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