summaryrefslogtreecommitdiffstats
path: root/docs/source
diff options
context:
space:
mode:
authorJoe Heck <heckj@mac.com>2012-02-06 20:43:24 +0000
committerJoe Heck <heckj@mac.com>2012-02-06 20:43:24 +0000
commit62a92c44baf533fe316016c1fa5be892fc85009c (patch)
tree51e09c0c6bc8fef54803fdec5097948f38418b83 /docs/source
parentcc371272f2f650765f39d03bd17c1afc80b0e561 (diff)
fixing grammar, noting broken enable, adding hacking with prefs for project
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/configuration.rst11
-rw-r--r--docs/source/configuringservices.rst44
-rw-r--r--docs/source/man/keystone-all.rst2
3 files changed, 43 insertions, 14 deletions
diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
index d4ea8868..8c998700 100644
--- a/docs/source/configuration.rst
+++ b/docs/source/configuration.rst
@@ -200,6 +200,11 @@ example::
password=secrete \
email=admin@example.com
+.. warning::
+ Until https://bugs.launchpad.net/keystone/+bug/927873 is resolved, the
+ keystone-manage cli doesn't allow the setting enabled to be False, making
+ this command partially broken at the moment.
+
``user delete``
^^^^^^^^^^^^^^^
@@ -249,6 +254,12 @@ example::
keystone-manage user update_enabled user=03c84b51574841ba9a0d8db7882ac645 enabled=False
+.. warning::
+ Until https://bugs.launchpad.net/keystone/+bug/927873 is resolved, the
+ keystone-manage cli doesn't allow the setting enabled to False, making
+ this command broken at the moment.
+
+
``user update_password``
^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/source/configuringservices.rst b/docs/source/configuringservices.rst
index 5ea75461..3777ce5e 100644
--- a/docs/source/configuringservices.rst
+++ b/docs/source/configuringservices.rst
@@ -31,11 +31,14 @@ or otherwise interact with Keystone.
In general:
* Clients making calls to the service will pass in an authentication token.
-* The Keystone middleware will look for and validate that token, taking the appropriate action.
-* It will also retrive additional information from the token such as user name, id, tenant name, id, roles, etc...
+* The Keystone middleware will look for and validate that token, taking the
+ appropriate action.
+* It will also retrive additional information from the token such as user
+ name, id, tenant name, id, roles, etc...
-The middleware will pass those data down to the service as headers. More details on the architecture of
-that setup is described in :doc:`middleware_architecture`
+The middleware will pass those data down to the service as headers. More
+details on the architecture of that setup is described in
+:doc:`middleware_architecture`
Setting up credentials
======================
@@ -45,7 +48,8 @@ Admin Token
For a default installation of Keystone, before you can use the REST API, you
need to define an authorization token. This is configured in ``keystone.conf``
-file under the section ``[DEFAULT]``. In the sample file provided with the keystone project, the line defining this token is
+file under the section ``[DEFAULT]``. In the sample file provided with the
+keystone project, the line defining this token is
[DEFAULT]
admin_token = ADMIN
@@ -58,7 +62,10 @@ to function correctly.
Setting up tenants, users, and roles
------------------------------------
-You need to minimally define a tenant, user, and role to link the tenant and user as the most basic set of details to get other services authenticating and authorizing with keystone. See doc:`configuration` for a walk through on how to create tenants, users, and roles.
+You need to minimally define a tenant, user, and role to link the tenant and
+user as the most basic set of details to get other services authenticating
+and authorizing with keystone. See doc:`configuration` for a walk through on
+how to create tenants, users, and roles.
Setting up services
===================
@@ -73,13 +80,24 @@ for the OpenStack Dashboard to properly function.
Here's how we define the services::
- keystone-manage service create name=nova service_type=compute description="Nova Compute Service"
- keystone-manage service create name=ec2 service_type=ec2 description="EC2 Compatibility Layer"
- keystone-manage service create name=glance service_type=image description="Glance Image Service"
- keystone-manage service create name=keystone service_type=identity description="Keystone Identity Service"
- keystone-manage service create name=swift service_type=object-store description="Swift Service"
-
-The endpoints for these services are defined in a template, an example of which is in the project as the file ``etc/default_catalog.templates``.
+ keystone-manage service create name=nova \
+ service_type=compute \
+ description="Nova Compute Service"
+ keystone-manage service create name=ec2 \
+ service_type=ec2 \
+ description="EC2 Compatibility Layer"
+ keystone-manage service create name=glance \
+ service_type=image \
+ description="Glance Image Service"
+ keystone-manage service create name=keystone \
+ service_type=identity \
+ description="Keystone Identity Service"
+ keystone-manage service create name=swift \
+ service_type=object-store \
+ description="Swift Service"
+
+The endpoints for these services are defined in a template, an example of
+which is in the project as the file ``etc/default_catalog.templates``.
Setting Up Middleware
=====================
diff --git a/docs/source/man/keystone-all.rst b/docs/source/man/keystone-all.rst
index 66d0ee4e..fc2d68d7 100644
--- a/docs/source/man/keystone-all.rst
+++ b/docs/source/man/keystone-all.rst
@@ -79,5 +79,5 @@ SEE ALSO
SOURCE
======
-* Keystone source in managed in GitHub `Keystone <http://github.com/openstack/keystone>`__
+* Keystone source is managed in GitHub `Keystone <http://github.com/openstack/keystone>`__
* Keystone bugs are managed at Launchpad `Launchpad Keystone <https://bugs.launchpad.net/keystone>`__