[OpenStack-docs] How to document CLI depending on the used API?

Andreas Jaeger aj at suse.com
Tue Jun 30 12:41:47 UTC 2015


On 06/30/2015 01:16 PM, Christian Berendt wrote:
> At the moment we have the problem with python-glanceclient that some
> positional arguments in help messages only appear when running
> python-glanceclient against a "real" cloud (reachable connection
> parameters).
>
> It looks like we have the same problem with python-openstackclient. At
> the moment I am testing Keystone v3 API and when setting
> OS_IDENTITY_API_VERSION=3 I have some more commands (for example
> openstack domain) and some more parameters (for example --domain
> <domain> when creating new projects or users).
>
> At the moment I am not sure how we should document the CLIs when the
> generated documentation depends on environment parameters.

For some commands, we run the help twice and show both
For example, cinder is run once without special options and once with
  OS_VOLUME_API_VERSION=2.

But this doesn't work in this case.

I added the glance folks to the reviews, so far no reply, we might need 
to ping them directly and discuss,

Andreas
-- 
  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
    GF: Felix Imendörffer, Jane Smithard, Dilip Upmanyu, Graham Norton,
        HRB 21284 (AG Nürnberg)
     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the OpenStack-docs mailing list