[Openstack-docs] Automated CLI Reference

Andreas Jaeger aj at suse.com
Tue Jan 21 09:18:06 UTC 2014


On 01/20/2014 11:06 PM, Anne Gentle wrote:
> 
> 
> 
> On Sun, Jan 19, 2014 at 4:33 PM, Shaun McCance <shaunm at gnome.org
> <mailto:shaunm at gnome.org>> wrote:
> 
>     To what extent could this reuse code from the automated config
>     reference? Is it also a matter of importing tons of stuff then
>     introspecting the modules?
> 
> 
> My original thinking was to reuse the bash completion script somehow... 
> https://raw.github.com/openstack/python-novaclient/master/tools/nova.bash_completion
> 
> Possible?

Brilliant idea! That should be easily doable.

The question is what do we want.

Right now, we show just the generic information, e.g.
http://docs.openstack.org/user-guide/content/nova_commands.html

Using bash-complete, we could also iterator over the subcommands and
document all the nova subcommands with something like below:

$ nova flavor-access-list
usage: nova flavor-access-list [--flavor <flavor>] [--tenant <tenant_id>]

Print access information about the given flavor.

Optional arguments:
  --flavor <flavor>     Filter results by flavor name or ID.
  --tenant <tenant_id>  Filter results by tenant ID.


$ nova host-meta
usage: nova host-meta <host> <action> <key=value> [<key=value> ...]

Set or Delete metadata on all instances of a host.

Positional arguments:
  <host>       Name of host.
  <action>     Actions: 'set' or 'delete'
  <key=value>  Metadata to set or delete (only key is necessary on delete)


I can give it a shot,

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the Openstack-docs mailing list