Bug 1175412

Summary: katello-installer --help typos
Product: Red Hat Satellite Reporter: Matt Reid <mreid>
Component: InstallationAssignee: Bill Yodlowsky <byodlows>
Status: CLOSED WONTFIX QA Contact: Ales Dujicek <adujicek>
Severity: low Docs Contact:
Priority: low    
Version: 6.0.4CC: adujicek, bkearney, byodlows, chrobert, cwelton, ehelms, rohoover, stbenjam
Target Milestone: UnspecifiedKeywords: Reopened, Triaged
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-09-04 17:44:49 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Matt Reid 2014-12-17 16:57:33 UTC
Description of problem:
There are typos and general clean-up that should happen with the output for katello-installer, I've added notes when necessary at the end of that line's description in [ ] brackets.

# katello-installer --help
--reset                       This option will drop the Katello database and clear all subsequent backend data stores.You will lose all data! Unfortunately we
                                  can't detect a failure at the moment so you should verify the success
                                  manually. e.g. dropping can fail when DB is currently in use. (default: false) [this is wrapped messily, needs a space after "data stores.", needs a comma after "at the moment"]
    --capsule-pulp-admin-password  passowrd for the Pulp admin user.It should be left blank so that random password is generated (default: "kpU2mLK9oBCpNpmMSGEz4jzJuopcEBhq") [password is spelled wrong, no space before next sentence]
    --certs-ca-expiration         Ca expiration attribute for managed certificates (default: "36500") [some CA references are capitalized, others aren't, acronyms should be capitalized in most cases]
--certs-deploy                Deploy the certs on the configured system. False means
                                  we want apply it on a different system (default: true) [missing to, should add it after "want"]
 --certs-log-dir               When the log files should go (default: "/var/log/certs") [When should be Where]
--certs-regenerate            Force regeneration of the certificates (excluding
                                  ca certificates) (default: false) [ca should be capitalized]
 --certs-regenerate-ca         Force regeneration of the ca certificate (default: false) [ca not capitalized]
 --certs-server-cert           Path to the ssl certificate for https
                                  if not specified, the default CA will generate one (default: nil) [capitalize ssl, these are separate thoughts, should use a period between them]
    --certs-server-cert-req       Path to the ssl certificate request for https (default: nil) [capitalize ssl, https]
    --certs-server-key            Path to the ssl key for https [acronyms should be capitalized, ssl and https]
    --foreman-authentication      Enable users authentication (default user:admin pw:changeme) (default: true) [should users be singular?]
    --foreman-configure-scl-repo  If disabled the the SCL repo will not be configured on Red Hat clone systems.
                                  (Currently only installs repos for CentOS and Scientific) (default: false) ["the" is repeated, should be a comma after disabled]
--foreman-custom-repo         No need to change anything here by default
                                  if set to true, no repo will be added by this module, letting you to
                                  set it to some custom location. (default: true) [can remove "to" after "letting you", probably should end "No need to change anything here by default" with a period]
--foreman-db-sslmode          Database 'production' ssl mode (default: nil) [capitalize ssl]
 --foreman-passenger-start-timeout  Amount of seconds to wait for Ruby application boot. (default: "600") ["Amount" should be "Number"]
 --foreman-selinux             when undef, foreman-selinux will be installed if SELinux is enabled
                                  setting to false/true will override this check (e.g. set to false on 1.1) (default: nil) [seems like these are separate thoughts, end "is enabled" with a period, other descriptions here start with a capital letter in the first word, we don't here]

Version-Release number of selected component (if applicable):
katello-utils-1.5.16-1.el6sat.noarch


Additional info:

Comment 1 RHEL Program Management 2014-12-17 17:24:09 UTC
Since this issue was entered in Red Hat Bugzilla, the release flag has been
set to ? to ensure that it is properly evaluated for this release.

Comment 3 Stephen Benjamin 2016-08-03 15:31:47 UTC
Created redmine issue http://projects.theforeman.org/issues/15963 from this bug

Comment 5 Bryan Kearney 2017-01-04 20:36:49 UTC
This is an older bug, which I dont expect to be fixed in the near future. I am closing this out. If you feel this is an issue, please feel free to re-open with additional information.

Comment 7 Satellite Program 2018-05-31 00:20:39 UTC
Moving this bug to POST for triage into Satellite 6 since the upstream issue http://projects.theforeman.org/issues/15963 has been resolved.

Comment 9 Satellite Program 2018-07-27 16:23:31 UTC
Upstream bug assigned to chrobert

Comment 13 Bryan Kearney 2018-09-04 17:44:49 UTC
Thank you for your interest in Satellite 6. We have evaluated this request, and we do not expect this to be implemented in the product in the foreseeable future. We are therefore closing this out as WONTFIX. If you have any concerns about this, please feel free to contact Rich Jerrido or Bryan Kearney. Thank you.