diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
index 410e7b1bfe..782e9fb572 100644
--- a/docs/source/configuration.rst
+++ b/docs/source/configuration.rst
@@ -31,7 +31,7 @@ initializing data into keystone using the command line client.
Keystone Configuration File
===========================
-The keystone configuration file is an 'ini' file format with sections,
+The keystone configuration file is an 'ini' file format with sections,
extended from Paste_, a common system used to configure python WSGI based
applications. In addition to the paste config entries, general configuration
values are stored under [DEFAULT] and [sql], and then drivers for the various
@@ -44,7 +44,7 @@ The driver sections include:
* ``[policy]`` - the python module that drives the policy system for RBAC
* ``[ec2]`` - the python module providing the EC2 translations for OpenStack
-The keystone configuration file is expected to be named ``keystone.conf``.
+The keystone configuration file is expected to be named ``keystone.conf``.
When starting up Keystone, you can specify a different configuration file to
use with ``--config-file``. If you do **not** specify a configuration file,
keystone will look in the following directories for a configuration file, in
@@ -57,7 +57,7 @@ order:
Logging is configured externally to the rest of keystone, the file specifying
the logging configuration is in the [DEFAULT] section of the keystone conf
-file under ``log_config``. If you wish to route all your logging through
+file under ``log_config``. If you wish to route all your logging through
syslog, there is a ``use_syslog`` option also in the [DEFAULT] section that
easy.
@@ -81,20 +81,26 @@ Sample Configuration Files
Initializing Keystone
=====================
-Keystone must be running in order to initialize data within it. This is because
-the keystone-manage commands are all used the same REST API that other
+Keystone must be running in order to initialize data within it. This is
+because the keystone-manage commands are all used the same REST API that other
OpenStack systems utilize.
General keystone-manage options:
--------------------------------
* ``--id-only`` : causes ``keystone-manage`` to return only the UUID result
-from the API call.
-* ``--endpoint`` : allows you to specify the keystone endpoint to communicate with. The default endpoint is http://localhost:35357/v2.0'
+ from the API call.
+
+* ``--endpoint`` : allows you to specify the keystone endpoint to communicate
+ with. The default endpoint is http://localhost:35357/v2.0'
+
* ``--auth-token`` : provides the authorization token
-``keystone-manage`` is set up to expect commands in the general form of ``keystone-manage`` ``command`` ``subcommand``, with keyword arguments to provide additional information to the command. For example, the command
-``tenant`` has the subcommand ``create``, which takes the required keyword ``tenant_name``::
+``keystone-manage`` is set up to expect commands in the general form of
+``keystone-manage`` ``command`` ``subcommand``, with keyword arguments to
+provide additional information to the command. For example, the command
+``tenant`` has the subcommand ``create``, which takes the required keyword
+``tenant_name``::
keystone-manage tenant create tenant_name=example_tenant
@@ -137,7 +143,7 @@ creates a tenant named "admin".
keyword arguments
* tenant_id
-
+
example::
keystone-manage tenant delete tenant_id=f2b7b39c860840dfa47d9ee4adffa0b3
@@ -169,14 +175,14 @@ keyword arguments
* name
* password
* email
-
+
example::
keystone-manage user --ks-id-only create \
name=admin \
password=secrete \
email=admin@example.com
-
+
``user delete``
^^^^^^^^^^^^^^^
@@ -199,7 +205,7 @@ keyword arguments
``user update_password``
^^^^^^^^^^^^^^^^^^^^^^^^
-
+
keyword arguments
``user update_tenant``
@@ -220,7 +226,7 @@ keyword arguments
exmaple::
keystone-manage role --ks-id-only create name=Admin
-
+
``role add_user_to_tenant``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -236,7 +242,7 @@ example::
role_id=19d1d3344873464d819c45f521ff9890 \
user_id=08741d8ed88242ca88d1f61484a0fe3b \
tenant_id=20601a7f1d94447daa4dff438cb1c209
-
+
``role remove_user_from_tenant``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/source/images/305.svg b/docs/source/images/305.svg
deleted file mode 100644
index 7d79464e2b..0000000000
--- a/docs/source/images/305.svg
+++ /dev/null
@@ -1,158 +0,0 @@
-
-
-
-
diff --git a/docs/source/images/both.svg b/docs/source/images/both.svg
deleted file mode 100644
index d29872a4a6..0000000000
--- a/docs/source/images/both.svg
+++ /dev/null
@@ -1,135 +0,0 @@
-
-
-
-
diff --git a/docs/source/images/graphs_delegate_accept.svg b/docs/source/images/graphs_delegate_accept.svg
deleted file mode 100644
index 1d86cadfc6..0000000000
--- a/docs/source/images/graphs_delegate_accept.svg
+++ /dev/null
@@ -1,52 +0,0 @@
-
-
-
-
-
diff --git a/docs/source/images/graphs_separate.svg b/docs/source/images/graphs_separate.svg
deleted file mode 100644
index 376e59880a..0000000000
--- a/docs/source/images/graphs_separate.svg
+++ /dev/null
@@ -1,30 +0,0 @@
-
-
-
-
-
diff --git a/docs/source/images/graphs_standard_accept.svg b/docs/source/images/graphs_standard_accept.svg
deleted file mode 100644
index bddf4b5f16..0000000000
--- a/docs/source/images/graphs_standard_accept.svg
+++ /dev/null
@@ -1,51 +0,0 @@
-
-
-
-
-
diff --git a/docs/source/images/graphs_standard_reject.svg b/docs/source/images/graphs_standard_reject.svg
deleted file mode 100644
index 6020ad67a5..0000000000
--- a/docs/source/images/graphs_standard_reject.svg
+++ /dev/null
@@ -1,39 +0,0 @@
-
-
-
-
-
diff --git a/docs/source/images/graphs_together.svg b/docs/source/images/graphs_together.svg
deleted file mode 100644
index 1425a28baa..0000000000
--- a/docs/source/images/graphs_together.svg
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-
-
-
diff --git a/docs/source/images/layouts.svg b/docs/source/images/layouts.svg
deleted file mode 100644
index fdf61b7da7..0000000000
--- a/docs/source/images/layouts.svg
+++ /dev/null
@@ -1,215 +0,0 @@
-
-
-
-
diff --git a/docs/source/images/mapper.svg b/docs/source/images/mapper.svg
deleted file mode 100644
index b5a2b7b12f..0000000000
--- a/docs/source/images/mapper.svg
+++ /dev/null
@@ -1,237 +0,0 @@
-
-
-
-
diff --git a/docs/source/images/proxyAuth.svg b/docs/source/images/proxyAuth.svg
deleted file mode 100644
index f60b40d813..0000000000
--- a/docs/source/images/proxyAuth.svg
+++ /dev/null
@@ -1,238 +0,0 @@
-
-
-
-
diff --git a/keystone/catalog/backends/templated.py b/keystone/catalog/backends/templated.py
index 92c52574a2..e8290212ae 100644
--- a/keystone/catalog/backends/templated.py
+++ b/keystone/catalog/backends/templated.py
@@ -32,8 +32,11 @@ class TemplatedCatalog(kvs.Catalog):
name - the name of the service, most likely repeated for all services of
the same type, across regions.
+
adminURL - the url of the admin endpoint
+
publicURL - the url of the public endpoint
+
internalURL - the url of the internal endpoint
"""
diff --git a/keystone/common/cfg.py b/keystone/common/cfg.py
index fd79e1222d..9551ff7967 100644
--- a/keystone/common/cfg.py
+++ b/keystone/common/cfg.py
@@ -17,7 +17,7 @@
r"""
Configuration options which may be set on the command line or in config files.
-The schema for each option is defined using the Opt sub-classes e.g.
+The schema for each option is defined using the Opt sub-classes e.g.::
common_opts = [
cfg.StrOpt('bind_host',
@@ -28,7 +28,7 @@ The schema for each option is defined using the Opt sub-classes e.g.
help='Port number to listen on')
]
-Options can be strings, integers, floats, booleans, lists or 'multi strings':
+Options can be strings, integers, floats, booleans, lists or 'multi strings'::
enabled_apis_opt = \
cfg.ListOpt('enabled_apis',
@@ -43,7 +43,7 @@ Options can be strings, integers, floats, booleans, lists or 'multi strings':
default=DEFAULT_EXTENSIONS)
Option schemas are registered with with the config manager at runtime, but
-before the option is referenced:
+before the option is referenced::
class ExtensionManager(object):
@@ -59,7 +59,7 @@ before the option is referenced:
....
A common usage pattern is for each option schema to be defined in the module or
-class which uses the option:
+class which uses the option::
opts = ...
@@ -74,7 +74,7 @@ class which uses the option:
An option may optionally be made available via the command line. Such options
must registered with the config manager before the command line is parsed (for
-the purposes of --help and CLI arg validation):
+the purposes of --help and CLI arg validation)::
cli_opts = [
cfg.BoolOpt('verbose',
@@ -90,7 +90,7 @@ the purposes of --help and CLI arg validation):
def add_common_opts(conf):
conf.register_cli_opts(cli_opts)
-The config manager has a single CLI option defined by default, --config-file:
+The config manager has a single CLI option defined by default, --config-file::
class ConfigOpts(object):
@@ -104,7 +104,7 @@ The config manager has a single CLI option defined by default, --config-file:
Option values are parsed from any supplied config files using SafeConfigParser.
If none are specified, a default set is used e.g. glance-api.conf and
-glance-common.conf:
+glance-common.conf::
glance-api.conf:
[DEFAULT]
@@ -119,7 +119,7 @@ are parsed in order, with values in later files overriding those in earlier
files.
The parsing of CLI args and config files is initiated by invoking the config
-manager e.g.
+manager e.g.::
conf = ConfigOpts()
conf.register_opt(BoolOpt('verbose', ...))
@@ -127,7 +127,7 @@ manager e.g.
if conf.verbose:
...
-Options can be registered as belonging to a group:
+Options can be registered as belonging to a group::
rabbit_group = cfg.OptionGroup(name='rabbit',
title='RabbitMQ options')
@@ -154,7 +154,7 @@ Options can be registered as belonging to a group:
conf.register_opt(rabbit_ssl_opt, group=rabbit_group)
If no group is specified, options belong to the 'DEFAULT' section of config
-files:
+files::
glance-api.conf:
[DEFAULT]
@@ -175,7 +175,7 @@ Command-line options in a group are automatically prefixed with the group name:
Option values in the default group are referenced as attributes/properties on
the config manager; groups are also attributes on the config manager, with
-attributes for each of the options associated with the group:
+attributes for each of the options associated with the group::
server.start(app, conf.bind_port, conf.bind_host, conf)
@@ -184,7 +184,7 @@ attributes for each of the options associated with the group:
port=conf.rabbit.port,
...)
-Option values may reference other values using PEP 292 string substitution:
+Option values may reference other values using PEP 292 string substitution::
opts = [
cfg.StrOpt('state_path',
diff --git a/keystone/service.py b/keystone/service.py
index b017d69768..05cca4e600 100644
--- a/keystone/service.py
+++ b/keystone/service.py
@@ -109,17 +109,17 @@ class TokenController(wsgi.Application):
def authenticate(self, context, auth=None):
"""Authenticate credentials and return a token.
- Accept auth as a dict that looks like:
+ Accept auth as a dict that looks like::
- {
- "auth":{
- "passwordCredentials":{
- "username":"test_user",
- "password":"mypass"
- },
- "tenantName":"customer-x"
+ {
+ "auth":{
+ "passwordCredentials":{
+ "username":"test_user",
+ "password":"mypass"
+ },
+ "tenantName":"customer-x"
+ }
}
- }
In this case, tenant is optional, if not provided the token will be
considered "unscoped" and can later be used to get a scoped token.