Open Stack

I don't see a problem documenting different set of command options for different API versions. People who use the CLI should be aware that there are several APIs, that they can be selected with parameters or environment variables, and that they have different commands. 

The automatic documentation generator might have to be modified though.

By the way, without connection information (OS_AUTH_URL and credentials), I get:

$ openstack help
ERROR: openstack Authentication type must be selected with --os-auth-type

(that's in Juno; I don't have Kilo handy right now).

Bernd

-----Original Message-----
From: Christian Berendt [mailto:christian at berendt.io] 
Sent: Tuesday, June 30, 2015 8:17 PM
To: openstack-docs at lists.openstack.org
Subject: [OpenStack-docs] How to document CLI depending on the used API?

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.

Christian.

--
Christian Berendt
Cloud Computing Solution Architect
Mail: berendt at b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537

_______________________________________________
OpenStack-docs mailing list
OpenStack-docs at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs