Bug 1480907
Summary: | Geo-rep help looks to have a typo. | |||
---|---|---|---|---|
Product: | [Red Hat Storage] Red Hat Gluster Storage | Reporter: | Ben Turner <bturner> | |
Component: | geo-replication | Assignee: | Shwetha K Acharya <sacharya> | |
Status: | CLOSED ERRATA | QA Contact: | Rahul Hinduja <rhinduja> | |
Severity: | low | Docs Contact: | ||
Priority: | low | |||
Version: | rhgs-3.2 | CC: | amukherj, avishwan, csaba, khiremat, rhs-bugs, sacharya, sheggodu, storage-qa-internal, tcarlin | |
Target Milestone: | --- | Keywords: | EasyFix, Rebase | |
Target Release: | RHGS 3.5.0 | |||
Hardware: | x86_64 | |||
OS: | All | |||
Whiteboard: | ||||
Fixed In Version: | glusterfs-6.0-4 | Doc Type: | If docs needed, set a value | |
Doc Text: | Story Points: | --- | ||
Clone Of: | ||||
: | 1652887 (view as bug list) | Environment: | ||
Last Closed: | 2019-10-30 12:19:37 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: | 1652887, 1696807 |
Description
Ben Turner
2017-08-12 20:15:57 UTC
With little formatting, we could see that geo replication help outputs something like below: # gluster v geo-replication help Usage: volume geo-replication [<VOLNAME>] [<SLAVE-URL>] { create [[ssh-port n] [[no-verify]|[push-pem]]] [force] |start [force] |stop [force] |pause [force] |resume [force] |config |status [detail] |delete [reset-sync-time] } [options...] # It looks like the format of the help command is interpreted wrongly and used. Am I missing something? Nope, yes your right. 'detail' is associated only with 'status' and is listed correctly. But I think there is issue with 'create' and 'config' options. It should have been as below. Usage: volume geo-replication [<VOLNAME>] [<SLAVE-URL>] {create {[ssh-port n] no-verify|push-pem}[force] |start [force] |stop [force] |pause [force] |resume [force] |config [key] [value] |status [detail] |delete [reset-sync-time] }[options...] So please validate following. 1. create options as mentioned above. Once create is used, either 'no-verify' or 'push-pem' should be used. 2. config takes either 'key' or 'value' 3. Checkout what options at the end refer to. I think that can be removed ? Upstream patch link: https://review.gluster.org/21711 (geo-rep: Geo-rep help text issue) Hi Shwetha, The o/p of help command on the latest build is as given below # gluster v geo-replication help Usage: volume geo-replication [<VOLNAME>] [<SLAVE-URL>] {\ create [[ssh-port n] [[no-verify] | [push-pem]]] [force] \ | start [force] \ | stop [force] \ | pause [force] \ | resume [force] \ | config [[[\!]<option>] [<value>]] \ | status [detail] \ | delete [reset-sync-time]} I think line 1 should read as volume geo-replication [<master-volume>] [<slave-ip>]::[<slave-volume>] {\ and then the rest of output As in RHGS docs elsewhere we have referred to geo-rep sessions as # gluster volume geo-replication MASTER_VOL SLAVE_HOST::SLAVE_VOL create push-pem [force] The changes need to be inline with existing documentation. Also in my opinion there is no need to print '\' at the end of each line as this pattern is not seen elsewhere in the docs, let me know what you think about it. Hi Anees, I agree that [<slave-ip>]::[<slave-volume>] is good to have. '\' is a convention used to say, whatever written after it are part of previous line itself. So, I think there is no harm in having it. (this help text was written line after line to avoid confusions or wrong interpretations of it) upstream link: https://review.gluster.org/#/c/glusterfs/+/22689/ 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-2019:3249 |