From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: reorganize existing documentation according to the new standard layout Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann --- doc/source/cli/command-objects/container.rst | 150 +++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 doc/source/cli/command-objects/container.rst (limited to 'doc/source/cli/command-objects/container.rst') diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst new file mode 100644 index 00000000..e68955ad --- /dev/null +++ b/doc/source/cli/command-objects/container.rst @@ -0,0 +1,150 @@ +========= +container +========= + +Object Storage v1 + +container create +---------------- + +Create new container + +.. program:: container create +.. code:: bash + + openstack container create + [ ...] + +.. describe:: + + New container name(s) + +container delete +---------------- + +Delete container + +.. program:: container delete +.. code:: bash + + openstack container delete + [-r] | [--recursive] + [ ...] + +.. option:: --recursive, -r + + Recursively delete objects in container before container delete + +.. describe:: + + Container(s) to delete + +container list +-------------- + +List containers + +.. program:: container list +.. code:: bash + + openstack container list + [--prefix ] + [--marker ] + [--end-marker ] + [--limit ] + [--long] + [--all] + +.. option:: --prefix + + Filter list using + +.. option:: --marker + + Anchor for paging + +.. option:: --end-marker + + End anchor for paging + +.. option:: --limit + + Limit the number of containers returned + +.. option:: --long + + List additional fields in output + +.. option:: --all + + List all containers (default is 10000) + +container save +-------------- + +Save container contents locally + +.. program:: container save +.. code:: bash + + openstack container save + + +.. describe:: + + Container to save + +container set +------------- + +Set container properties + +.. program:: container set +.. code:: bash + + openstack container set + [--property [...] ] + + +.. option:: --property + + Set a property on this container (repeat option to set multiple properties) + +.. describe:: + + Container to modify + +container show +-------------- + +Display container details + +.. program:: container show +.. code:: bash + + openstack container show + + +.. describe:: + + Container to display + +container unset +--------------- + +Unset container properties + +.. program:: container unset +.. code:: bash + + openstack container unset + [--property ] + + +.. option:: --property + + Property to remove from container (repeat option to remove multiple properties) + +.. describe:: + + Container to modify -- cgit v1.2.1