Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 908848

Summary:	Quantum client documentation is lacking
Product:	Red Hat OpenStack	Reporter:	Gary Kotton <gkotton>
Component:	doc-Administration_User_Guide	Assignee:	Summer Long <slong>
Status:	CLOSED CURRENTRELEASE	QA Contact:	ecs-bugs
Severity:	medium	Docs Contact:
Priority:	medium
Version:	3.0	CC:	alyoung, breeler, hateya, sgordon, slong, yeylon
Target Milestone:	---	Keywords:	Documentation, Triaged
Target Release:	4.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2014-01-06 03:37:01 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:	1011085

Description Gary Kotton 2013-02-07 16:40:49 UTC

Description of problem:
The Quantum client has a number of ways of working. It would be great if we could document this. For example the client works as follows:
command <optional parameters> <required parameters> <specific API parameters>
The optional and required parameters are documented in the client help. The order of these is very importnat. The API parameters are not documented at all.
Things become tricky when one wants to update various parameters - for example fixed_ips.

Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.
  
Actual results:


Expected results:


Additional info:

Comment 3 Stephen Gordon 2013-03-07 16:51:22 UTC

9. For the client it may be useful if we provide some examples:
         quantum net-create private
         quantum subnet-create private 10.0.0.0/24

Comment 5 Summer Long 2013-09-23 23:15:38 UTC

The CLIs are being documented (automatically) in the End User Guide.

Comment 6 Summer Long 2013-10-11 06:25:22 UTC

Put under Admin Guide, CLI docs are there as well. API wrapper commands have all been documented. Not sure whether this requires QE?