Bug 1473585

Summary: typo in man heketi-cli
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Elvir Kuric <ekuric>
Component: heketiAssignee: Michael Adam <madam>
Status: CLOSED ERRATA QA Contact: Prasanth <pprakash>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: rhgs-3.0CC: aos-bugs, aos-storage-staff, hchiramm, jsafrane, madam, mliyazud, pprakash, rhs-bugs, rreddy, storage-qa-internal
Target Milestone: ---   
Target Release: CNS 3.6   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: aos-scalability-36
Fixed In Version: heketi-5.0.0-7 rhgs-volmanager-docker-5.0.0-9 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-10-11 07:07:22 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:
Bug Depends On:    
Bug Blocks: 1445448    

Description Elvir Kuric 2017-07-21 08:14:57 UTC
Description of problem:

man heketi-cli has typo in 

heketi-cli volume create --cluster section.

-- part from man page -- 

 heketi-cli volume create --cluster=<CLUSTER-ID> --disperse-data=<DISPERSION-VALUE> --durability=<TYPE> --name=<VOLUME-NAME> --redundancy=<REDUNDENCY-VALUE> --replica=<REPLICA-
       VALUE> --size=<VOLUME-SIZE> --snapshot-factor=<SNAPSHOT-FACTOR-VALUE>
              Create a GlusterFS volume

                  Options

                      --clusters=""


--- ---- --- 

there is "cluster" and "clusters", valid / working is "clusters"



Version-Release number of selected component (if applicable):
rpm -qa | grep heketi
heketi-5.0.0-2.el7rhgs.x86_64
python-heketi-5.0.0-2.el7rhgs.x86_64
heketi-client-5.0.0-2.el7rhgs.x86_64

How reproducible:
always 

Steps to Reproduce:
try to create volume using 

# heketi-cli volume create --cluster=cluster_id --size=1 

Actual results:

it will fail 

# heketi-cli volume create --cluster=78645dbaa6ce5f16c2162ef6ead4082a --size=1
Error: unknown flag: --cluster

with "clusters" it will work. 


Expected results:

Comment 1 Jan Safranek 2017-07-21 08:22:45 UTC
It's not an OpenShift bug, shifting to Gluster team. Please set the right version, I am really not sure.

Comment 9 Prasanth 2017-09-07 09:22:21 UTC
Verified in man page:

################
   Volume Commands
       heketi-cli volume create --clusters=<CLUSTER-IDS> --disperse-data=<DISPERSION-VALUE> --durability=<TYPE> --name=<VOLUME-NAME> --redundancy=<REDUNDENCY-VALUE> --replica=<REPLICA-
       VALUE> --size=<VOLUME-SIZE> --snapshot-factor=<SNAPSHOT-FACTOR-VALUE>
              Create a GlusterFS volume

                  Options

                      --clusters=""

                         Optional: Comma separated list of cluster ids where this volume
                         must be allocated. If omitted, Heketi will allocate the volume
                         on any of the configured clusters which have the available space.
                         Providing a set of clusters will ensure Heketi allocates storage
                         for this volume only in the clusters specified.
################

Comment 10 errata-xmlrpc 2017-10-11 07:07:22 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.

https://access.redhat.com/errata/RHEA-2017:2879