Command object docs: container, object

Change-Id: Ie3df543a28cbee0cc809310a05f431c97b2c7e70
This commit is contained in:
Dean Troyer 2014-12-23 17:04:12 -06:00 committed by Steve Martinelli
parent a24d6e7c6f
commit d5caa6a26b
4 changed files with 270 additions and 25 deletions

View File

@ -0,0 +1,105 @@
=========
container
=========
Object Store v1
container create
----------------
Create new container
.. program:: container create
.. code:: bash
os container create
<container-name> [<container-name> ...]
.. option:: <container-name>
New container name(s)
container delete
----------------
Delete container
.. program:: container delete
.. code:: bash
os container delete
<container> [<container> ...]
.. option:: <container>
Container(s) to delete
container list
--------------
List containers
.. program:: container list
.. code::bash
os container list
[--prefix <prefix>]
[--marker <marker>]
[--end-marker <end-marker>]
[--limit <limit>]
[--long]
[--all]
.. option:: --prefix <prefix>
Filter list using <prefix>
.. option:: --marker <marker>
Anchor for paging
.. option:: --end-marker <end-marker>
End anchor for paging
.. option:: --limit <limit>
Limit the number of containers returned
.. option:: --long
List additional fields in output
.. options:: --all
List all containers (default is 10000)
container save
--------------
Save container contents locally
.. program:: container save
.. code:: bash
os container save
<container>
.. option:: <container>
Container to save
container show
--------------
Show container details
.. program:: container show
.. code:: bash
os container show
[<container>]
.. option:: <container>
Container to display

View File

@ -0,0 +1,140 @@
======
object
======
Object Store v1
object create
-------------
Upload object to container
.. program:: object create
.. code:: bash
os object create
<container>
<filename> [<filename> ...]
.. option:: <container>
Container for new object
.. option:: <filename>
Local filename(s) to upload
object delete
-------------
Delete object from container
.. program:: object delete
.. code:: bash
os object delete
<container>
<object> [<object> ...]
.. option:: <container>
Delete object(s) from <container>
.. option:: <object>
Object(s) to delete
list object
-----------
List objects
.. program object list
.. code:: bash
os object list
[--prefix <prefix>]
[--delimiter <delimiter>]
[--marker <marker>]
[--end-marker <end-marker>]
[--limit <limit>]
[--long]
[--all]
<container>]
.. option:: --prefix <prefix>
Filter list using <prefix>
.. option:: --delimiter <delimiter>
Roll up items with <delimiter>
.. option:: --marker <marker>
Anchor for paging
.. option:: --end-marker <end-marker>
End anchor for paging
.. option:: --limit <limit>
Limit number of objects returned
.. option:: --long
List additional fields in output
.. options:: --all
List all objects in <container> (default is 10000)
.. option:: <container>
Container to list
object save
-----------
Save object locally
.. program:: object save
.. code:: bash
os object save
[--file <filename>]
[<container>]
[<object>]
.. option:: --file <filename>
Destination filename (defaults to object name)
.. option:: <container>
Download <object> from <container>
.. option:: <object>
Object to save
object show
-----------
Show object details
.. program:: object show
.. code:: bash
os object show
<container>
<object>
.. option:: <container>
Display <object> from <container>
.. option:: <object>
Object to display

View File

@ -27,7 +27,7 @@ from openstackclient.common import utils
class CreateContainer(lister.Lister):
"""Create a container"""
"""Create new container"""
log = logging.getLogger(__name__ + '.CreateContainer')
@ -35,9 +35,9 @@ class CreateContainer(lister.Lister):
parser = super(CreateContainer, self).get_parser(prog_name)
parser.add_argument(
'containers',
metavar='<container>',
metavar='<container-name>',
nargs="+",
help='Container name(s) to create',
help='New container name(s)',
)
return parser
@ -60,7 +60,7 @@ class CreateContainer(lister.Lister):
class DeleteContainer(command.Command):
"""Delete a container"""
"""Delete container"""
log = logging.getLogger(__name__ + '.DeleteContainer')
@ -70,7 +70,7 @@ class DeleteContainer(command.Command):
'containers',
metavar='<container>',
nargs="+",
help='Container name(s) to delete',
help='Container(s) to delete',
)
return parser
@ -157,7 +157,7 @@ class ListContainer(lister.Lister):
class SaveContainer(command.Command):
"""Save the contents of a container locally"""
"""Save container contents locally"""
log = logging.getLogger(__name__ + ".SaveContainer")
@ -166,7 +166,7 @@ class SaveContainer(command.Command):
parser.add_argument(
'container',
metavar='<container>',
help='Container name to save',
help='Container to save',
)
return parser
@ -179,7 +179,7 @@ class SaveContainer(command.Command):
class ShowContainer(show.ShowOne):
"""Show container information"""
"""Show container details"""
log = logging.getLogger(__name__ + '.ShowContainer')
@ -188,7 +188,7 @@ class ShowContainer(show.ShowOne):
parser.add_argument(
'container',
metavar='<container>',
help='Container name to display',
help='Container to display',
)
return parser

View File

@ -27,7 +27,7 @@ from openstackclient.common import utils
class CreateObject(lister.Lister):
"""Upload an object to a container"""
"""Upload object to container"""
log = logging.getLogger(__name__ + '.CreateObject')
@ -36,13 +36,13 @@ class CreateObject(lister.Lister):
parser.add_argument(
'container',
metavar='<container>',
help='Container to store new object',
help='Container for new object',
)
parser.add_argument(
'objects',
metavar='<object-name>',
metavar='<filename>',
nargs="+",
help='Local path of object(s) to upload',
help='Local filename(s) to upload',
)
return parser
@ -66,7 +66,7 @@ class CreateObject(lister.Lister):
class DeleteObject(command.Command):
"""Delete an object within a container"""
"""Delete object from container"""
log = logging.getLogger(__name__ + '.DeleteObject')
@ -75,11 +75,11 @@ class DeleteObject(command.Command):
parser.add_argument(
'container',
metavar='<container>',
help='Container that stores the object to delete',
help='Delete object(s) from <container>',
)
parser.add_argument(
'objects',
metavar='<object-name>',
metavar='<object>',
nargs="+",
help='Object(s) to delete',
)
@ -104,8 +104,8 @@ class ListObject(lister.Lister):
parser = super(ListObject, self).get_parser(prog_name)
parser.add_argument(
"container",
metavar="<container-name>",
help="List contents of container-name",
metavar="<container>",
help="Container to list",
)
parser.add_argument(
"--prefix",
@ -188,7 +188,7 @@ class ListObject(lister.Lister):
class SaveObject(command.Command):
"""Save an object locally"""
"""Save object locally"""
log = logging.getLogger(__name__ + ".SaveObject")
@ -197,17 +197,17 @@ class SaveObject(command.Command):
parser.add_argument(
"--file",
metavar="<filename>",
help="Downloaded object filename [defaults to object name]",
help="Destination filename (defaults to object name)",
)
parser.add_argument(
'container',
metavar='<container>',
help='Container name that has the object',
help='Download <object> from <container>',
)
parser.add_argument(
"object",
metavar="<object>",
help="Name of the object to save",
help="Object to save",
)
return parser
@ -222,7 +222,7 @@ class SaveObject(command.Command):
class ShowObject(show.ShowOne):
"""Show object information"""
"""Show object details"""
log = logging.getLogger(__name__ + '.ShowObject')
@ -231,12 +231,12 @@ class ShowObject(show.ShowOne):
parser.add_argument(
'container',
metavar='<container>',
help='Container name for object to display',
help='Display <object> from <container>',
)
parser.add_argument(
'object',
metavar='<object>',
help='Object name to display',
help='Object to display',
)
return parser