Bug 1566636 - rbd create does not provide CLI help with available flags
Summary: rbd create does not provide CLI help with available flags
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Red Hat Ceph Storage
Classification: Red Hat
Component: RBD
Version: 3.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: 3.*
Assignee: Jason Dillaman
QA Contact: ceph-qe-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-04-12 16:23 UTC by John Wilkins
Modified: 2018-04-12 16:41 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-04-12 16:41:32 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description John Wilkins 2018-04-12 16:23:57 UTC
Description of problem:

According to the upstream docs here: http://docs.ceph.com/docs/master/start/quick-rbd/

There is a flag `--image-feature`. It is not included in the cli help. Additionally, common flags like --size are not included either. 

I will be happy to work with engineering to address this.

Comment 3 Jason Dillaman 2018-04-12 16:34:31 UTC
@John: I am probably misunderstanding the issue but here is the CLI help output and I see both are documented (the help is auto-generated programatically so we have to jump through hoops to not include something in the help):

$ rbd help create
2018-04-12 12:32:33.451 7f74253dfd80 -1 WARNING: all dangerous and experimental features are enabled.
2018-04-12 12:32:33.526 7f74253dfd80 -1 WARNING: all dangerous and experimental features are enabled.
usage: rbd create [--pool <pool>] [--image <image>] 
                  [--image-format <image-format>] [--new-format] 
                  [--order <order>] [--object-size <object-size>] 
                  [--image-feature <image-feature>] [--image-shared] 
                  [--stripe-unit <stripe-unit>] 
                  [--stripe-count <stripe-count>] [--data-pool <data-pool>] 
                  [--journal-splay-width <journal-splay-width>] 
                  [--journal-object-size <journal-object-size>] 
                  [--journal-pool <journal-pool>] 
                  [--thick-provision] --size <size> [--no-progress] 
                  <image-spec> 

Create an empty image.

Positional arguments
  <image-spec>              image specification
                            (example: [<pool-name>/]<image-name>)

Optional arguments
  -p [ --pool ] arg         pool name
  --image arg               image name
  --image-format arg        image format [1 (deprecated) or 2]
  --new-format              use image format 2
                            (deprecated)
  --order arg               object order [12 <= order <= 25]
  --object-size arg         object size in B/K/M [4K <= object size <= 32M]
  --image-feature arg       image features
                            [layering(+), exclusive-lock(+*), object-map(+*),
                            fast-diff(+*), deep-flatten(+-), journaling(*)]
  --image-shared            shared image
  --stripe-unit arg         stripe unit in B/K/M
  --stripe-count arg        stripe count
  --data-pool arg           data pool
  --journal-splay-width arg number of active journal objects
  --journal-object-size arg size of journal objects
  --journal-pool arg        pool for journal objects
  --thick-provision         fully allocate storage and zero image
  -s [ --size ] arg         image size (in M/G/T) [default: M]
  --no-progress             disable progress output

Image Features:
  (*) supports enabling/disabling on existing images
  (-) supports disabling-only on existing images
  (+) enabled by default for new images if features not specified


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