Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1265519 - Reference for all installation options of both katello-installer and capsule-installer
Summary: Reference for all installation options of both katello-installer and capsule-...
Keywords:
Status: CLOSED DEFERRED
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs Install Guide
Version: 6.1.2
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: Unspecified
Assignee: Hayley Hudgeons
QA Contact: David O'Brien
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-09-23 06:44 UTC by Fred van Zwieten
Modified: 2019-09-25 20:54 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-11-23 13:36:20 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Fred van Zwieten 2015-09-23 06:44:20 UTC
Document URL: 
https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/6.1/html/Installation_Guide/index.html

Section Number and Name: 

Describe the issue:
katello-installer and capsule-installer both have an intimidating and ever growing list of installation options. There should be a reference section on all these options. What do they mean? How do they interact? 

Suggestions for improvement:
Create an appendix in the installation guide and create a full reference for all these installation options.

Additional information:

Comment 1 David O'Brien 2015-10-15 23:12:35 UTC
Hi Fred

I agree the list of options is long and at first view a lot to take in. In the product doc we attempt to keep the list of options to those required for a typical installation (if there is such a thing :) )


Are you requesting that we include the output of (e.g.), katello-installer --help in the formal docs, as an appendix?

We generally don't include this type of information because:

a) it's available in its current form
b) changes to the command and its options are *usually* quickly reflected in the help pages
c) it's a lot of overhead to reproduce and keep up-to-date in the product docs

If there is more or different information that you'd like to see, that's not currently available, please let us know.

thanks

Comment 2 Fred van Zwieten 2015-11-23 12:14:34 UTC
Yeah, well ok. It's just that the help text if pretty short. And the different documented scenario's do not cover *all* options. It was something a customer was wondering (where is the reference on all these options?).

Comment 3 David O'Brien 2015-11-23 13:15:05 UTC
Granted, the help text can be brief, and we don't document all possible scenarios or options, we just don't have the resources.

If there are specifics that customers regular raise then I'm sure it make a bright spot on our radar, and either Hayley or Andrew will schedule something as soon as possible.

Thanks for the feedback.


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