summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoe Heck <heckj@mac.com>2012-01-29 14:09:24 -0800
committerJoe Heck <heckj@mac.com>2012-01-29 14:09:24 -0800
commitef8b8f1d9b61ff527b223d69c52f35f25536b8dd (patch)
tree45eb3b3f703252b902d3e33527458d0c60e2fab4 /docs
parent1908a2d7ba14b830648078e6871fba0e6644fdf5 (diff)
updating formating for configuration page
Diffstat (limited to 'docs')
-rw-r--r--docs/source/configuration.rst133
1 files changed, 81 insertions, 52 deletions
diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
index e16d1892..410e7b1b 100644
--- a/docs/source/configuration.rst
+++ b/docs/source/configuration.rst
@@ -101,13 +101,14 @@ from the API call.
Invoking keystone-manage by itself will give you some usage information.
Available keystone-manage commands:
- db_sync: Sync the database.
- ec2: no docs
- role: Role CRUD functions.
- service: Service CRUD functions.
- tenant: Tenant CRUD functions.
- token: Token CRUD functions.
- user: User CRUD functions.
+
+* ``db_sync``: Sync the database.
+* ``ec2``: no docs
+* ``role``: Role CRUD functions.
+* ``service``: Service CRUD functions.
+* ``tenant``: Tenant CRUD functions.
+* ``token``: Token CRUD functions.
+* ``user``: User CRUD functions.
Tenants
-------
@@ -116,33 +117,42 @@ Tenants are the high level grouping within Keystone that represent groups of
users. A tenant is the grouping that owns virtual machines within Nova, or
containers within Swift. A tenant can have zero or more users, Users can be assocaited with more than one tenant, and each tenant - user pairing can have a role associated with it.
-* tenant create
+``tenant create``
+^^^^^^^^^^^^^^^^^
+
+keyword arguments
- keyword arguments
- * tenant_name
- * id (optional)
+* tenant_name
+* id (optional)
example::
+
keystone-manage --id-only tenant create tenant_name=admin
creates a tenant named "admin".
-* tenant delete
+``tenant delete``
+^^^^^^^^^^^^^^^^^
+
+keyword arguments
- keyword arguments
- * tenant_id
+* tenant_id
example::
+
keystone-manage tenant delete tenant_id=f2b7b39c860840dfa47d9ee4adffa0b3
-* tenant update
+``tenant update``
+^^^^^^^^^^^^^^^^^
+
+keyword arguments
- keyword arguments
- * description
- * name
- * tenant_id
+* description
+* name
+* tenant_id
example::
+
keystone-manage tenant update \
tenant_id=f2b7b39c860840dfa47d9ee4adffa0b3 \
description="those other guys" \
@@ -151,60 +161,74 @@ example::
Users
-----
-* user create
+``user create``
+^^^^^^^^^^^^^^^
- keyword arguments
- * name
- * password
- * email
+keyword arguments
+
+* name
+* password
+* email
example::
+
keystone-manage user --ks-id-only create \
name=admin \
password=secrete \
email=admin@example.com
-* user delete
+``user delete``
+^^^^^^^^^^^^^^^
- keyword arguments
+keyword arguments
-* user list
+``user list``
+^^^^^^^^^^^^^
- keyword arguments
+keyword arguments
-* user update_email
+``user update_email``
+^^^^^^^^^^^^^^^^^^^^^
- keyword arguments
+keyword arguments
-* user update_enabled
+``user update_enabled``
+^^^^^^^^^^^^^^^^^^^^^^^
- keyword arguments
+keyword arguments
-* user update_password
+``user update_password``
+^^^^^^^^^^^^^^^^^^^^^^^^
- keyword arguments
+keyword arguments
-* user update_tenant
+``user update_tenant``
+^^^^^^^^^^^^^^^^^^^^^^
- keyword arguments
+keyword arguments
Roles
-----
-* role create
+``role create``
+^^^^^^^^^^^^^^^
- keyword arguments
- * name
+keyword arguments
+
+* name
exmaple::
+
keystone-manage role --ks-id-only create name=Admin
-* role add_user_to_tenant
+``role add_user_to_tenant``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
- keyword arguments
- * role_id
- * user_id
- * tenant_id
+keyword arguments
+
+* role_id
+* user_id
+* tenant_id
example::
@@ -213,22 +237,27 @@ example::
user_id=08741d8ed88242ca88d1f61484a0fe3b \
tenant_id=20601a7f1d94447daa4dff438cb1c209
-* role remove_user_from_tenant
+``role remove_user_from_tenant``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-* role get_user_role_refs
+``role get_user_role_refs``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
Services
--------
-* service create
+``service create``
+^^^^^^^^^^^^^^^^^^
+
+keyword arguments
- keyword arguments
- * name
- * service_type
- * description
+* name
+* service_type
+* description
example::
- keystone-manage service create \
+
+ keystone-manage service create \
name=nova \
service_type=compute \
description="Nova Compute Service"