Bug 874751 - man page for oo-accept-broker does not provide acceptable options for auth, storage, and dns switches
Summary: man page for oo-accept-broker does not provide acceptable options for auth, s...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Node
Version: 1.2.0
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: ---
Assignee: Luke Meyer
QA Contact: libra bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-11-08 18:53 UTC by Steve Reichard
Modified: 2017-03-08 17:34 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-01-31 20:32:21 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHSA-2013:0220 0 normal SHIPPED_LIVE Important: Red Hat OpenShift Enterprise 1.1 update 2013-02-01 01:23:24 UTC

Description Steve Reichard 2012-11-08 18:53:28 UTC
Description of problem:

The man  page for oo-accept-broker indictes the default for the specified switches, but does not indicated what the list of acceptable values are. I am using LDAP auth but do not know how to chose.


(appears the DNS option can not be selected)

Version-Release number of selected component (if applicable):
[root@Abroker2 ~]# yum list installed openshift-origin-broker-util
Loaded plugins: product-id, rhnplugin, security, subscription-manager
Updating certificate-based repositories.
Unable to read consumer identity
Installed Packages
openshift-origin-broker-util.noarch                             1.0.4-1.el6op                              @openshift_infrastructure
[root@Abroker2 ~]# 



How reproducible:

very

Steps to Reproduce:
1.
2.
3.
  
Actual results:


Expected results:


Additional info:

Comment 1 Brenton Leanhardt 2012-11-09 13:41:30 UTC
This will be fixed shortly after 1.0.

Comment 2 Luke Meyer 2012-11-18 19:29:28 UTC
I think the fix is to remove the man page reference and the script options, since they don't appear to affect anything functional. Plugins are detected automatically.

N.B. for auth plugin, the RemoteUser plugin is used (as opposed to Mongo auth), which basically means to use httpd auth (nonspecific). Whether you are doing basic auth, LDAP auth, Kerberos auth, or using some other httpd module, oo-accept-broker doesn't really check that the service is correct (it would be rather difficult, but perhaps something to consider), it just does some basic checks that the config has expected entries. You won't find out if your LDAP url is correct until you actually try to log in and look at the httpd error log.

Comment 4 Luke Meyer 2012-12-13 19:24:10 UTC
Those switches didn't affect anything but output, and the output was basically confusing. I removed all of it.

Comment 5 xjia 2012-12-17 10:30:44 UTC
It has not told user how to use the specified switches in man page.


Version:
OpenShiftEnterprise/1.1.x/2012-12-14.1/

Test:
oo-accept-broker(13 December 2012)          oo-accept-broker(13 December 2012)



NAME
       oo-accept-broker

SYNOPSIS
       oo-accept-broker [-hdv] [-a auth_service] [-s storage_service]
       [-d dns_service]


DESCRIPTION
       Verify an OpenShift broker is in in an known valid state, or "accepted"
       good state. This is most commonly run with no options on the broker.

OPTIONS
       -h     Display a simple help dialog.

       -v     Enable verbose output during the run of the script

       -d     Enable debugging mode (very verbose)

EXAMPLE
       $ oo-accept-broker

HINTS
       This command should return with the text ’PASS’ and return code 0, oth-
       erwise the reasons for failure will be output.

SEE ALSO
       oo-admin-ctl-district(8), oo-admin-move(8), oo-admin-chk(8), oo-accept-
       broker(8), oo-admin-ctl-app(8),  oo-admin-ctl-domain(8),  oo-admin-ctl-
       user(8), oo-register-dns(8)

AUTHOR
       Adam Miller <admiller> - man page written for OpenShift Ori-
       gin



                                            oo-accept-broker(13 December 2012)

Comment 6 Luke Meyer 2012-12-19 01:44:43 UTC
fixed with openshift-origin-broker-util-1.0.13-1.el6op

Comment 7 xjia 2012-12-19 08:40:15 UTC
Verify:

oo-accept-broker(18 December 2012)          oo-accept-broker(18 December 2012)



NAME
       oo-accept-broker

SYNOPSIS
       oo-accept-broker [-h] [-v] [-d]


DESCRIPTION
       Verify  an  OpenShift  broker  is in a known valid state, or "accepted"
       good state. This is most often run with no options on the broker.

OPTIONS
       -h     Display a simple usage message and exit.

       -v     Enable verbose (INFO) output during the run of the script

       -d     Enable debugging mode (display every command executed)

EXAMPLE
       $ oo-accept-broker

HINTS
       This command should finish with output ’PASS’ and return code 0; other-
       wise the reasons for failure will be printed.

SEE ALSO
       oo-admin-ctl-district(8), oo-admin-move(8), oo-admin-chk(8), oo-accept-
       broker(8), oo-admin-ctl-app(8),  oo-admin-ctl-domain(8),  oo-admin-ctl-
       user(8), oo-register-dns(8)

AUTHOR
       Adam Miller <admiller> - man page written for OpenShift Ori-
       gin



                                            oo-accept-broker(18 December 2012)


[root@broker ~]# oo-accept-broker -h
usage: /usr/sbin/oo-accept-broker [-h] [-v] [-d]

  -h) Display this simple usage message and exit.
  -v) Enable verbose (INFO) output during the run of the script
  -d) Enable debugging mode (display every command executed)


Version:

OSE 1.1.x/2012-12-18.1

Comment 9 errata-xmlrpc 2013-01-31 20:32:21 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

http://rhn.redhat.com/errata/RHSA-2013-0220.html


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