summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/project-purge.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/project-purge.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
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 <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/project-purge.rst')
-rw-r--r--doc/source/cli/command-objects/project-purge.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/project-purge.rst b/doc/source/cli/command-objects/project-purge.rst
new file mode 100644
index 00000000..0ad0bbf9
--- /dev/null
+++ b/doc/source/cli/command-objects/project-purge.rst
@@ -0,0 +1,42 @@
+=============
+project purge
+=============
+
+Clean resources associated with a specific project.
+
+Block Storage v1, v2; Compute v2; Image v1, v2
+
+project purge
+-------------
+
+Clean resources associated with a project
+
+.. program:: project purge
+.. code:: bash
+
+ openstack project purge
+ [--dry-run]
+ [--keep-project]
+ [--auth-project | --project <project>]
+ [--project-domain <project-domain>]
+
+.. option:: --dry-run
+
+ List a project's resources
+
+.. option:: --keep-project
+
+ Clean project resources, but don't delete the project.
+
+.. option:: --auth-project
+
+ Delete resources of the project used to authenticate
+
+.. option:: --project <project>
+
+ Project to clean (name or ID)
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID). This can be
+ used in case collisions between project names exist.