Merge "Fix internal doc links (bug 1176211)"
This commit is contained in:
commit
f1172aac7d
@ -33,11 +33,8 @@ To contribute tests, docs, code, etc, refer to our `Gerrit-Jenkins-Github Workfl
|
|||||||
|
|
||||||
Setup
|
Setup
|
||||||
-----
|
-----
|
||||||
.. _setup: setup.rst
|
|
||||||
.. _configuration: configuration.rst
|
|
||||||
.. _keystonemanage: man/keystone-manage.rst
|
|
||||||
|
|
||||||
Get your development environment set up according to setup_. The
|
Get your development environment set up according to :doc:`setup`. The
|
||||||
instructions from here will assume that you have installed keystone into a
|
instructions from here will assume that you have installed keystone into a
|
||||||
virtualenv. If you chose not to, simply exclude "tools/with_venv.sh" from the
|
virtualenv. If you chose not to, simply exclude "tools/with_venv.sh" from the
|
||||||
example commands below.
|
example commands below.
|
||||||
@ -63,7 +60,7 @@ To run the keystone Admin and API server instances, use::
|
|||||||
$ tools/with_venv.sh bin/keystone-all
|
$ tools/with_venv.sh bin/keystone-all
|
||||||
|
|
||||||
this runs keystone with the configuration the etc/ directory of the project.
|
this runs keystone with the configuration the etc/ directory of the project.
|
||||||
See configuration_ for details on how Keystone is configured. By default,
|
See :doc:`configuration` for details on how Keystone is configured. By default,
|
||||||
keystone is configured with KVS backends, so any data entered into keystone run
|
keystone is configured with KVS backends, so any data entered into keystone run
|
||||||
in this fashion will not persist across restarts.
|
in this fashion will not persist across restarts.
|
||||||
|
|
||||||
@ -72,7 +69,7 @@ Interacting with Keystone
|
|||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
You can interact with Keystone through the command line using
|
You can interact with Keystone through the command line using
|
||||||
keystonemanage_ which allows you to initialize keystone, etc.
|
:doc:`man/keystonemanage` which allows you to initialize keystone, etc.
|
||||||
|
|
||||||
You can also interact with Keystone through its REST API. There is a python
|
You can also interact with Keystone through its REST API. There is a python
|
||||||
keystone client library `python-keystoneclient`_ which interacts exclusively
|
keystone client library `python-keystoneclient`_ which interacts exclusively
|
||||||
|
@ -18,14 +18,10 @@
|
|||||||
===================
|
===================
|
||||||
Installing Keystone
|
Installing Keystone
|
||||||
===================
|
===================
|
||||||
.. _developing: developing.rst
|
|
||||||
.. _setup: setup.rst
|
|
||||||
.. _configuration: configuration.rst
|
|
||||||
.. _configuring-services: configuringservices.rst
|
|
||||||
|
|
||||||
This document describes how to install Keystone in order to use it. If you are
|
This document describes how to install Keystone in order to use it. If you are
|
||||||
intending to develop on or with Keystone, please read developing_ and
|
intending to develop on or with Keystone, please read :doc:`developing` and
|
||||||
setup_.
|
:doc:`setup`.
|
||||||
|
|
||||||
Installing from Source
|
Installing from Source
|
||||||
----------------------
|
----------------------
|
||||||
@ -67,7 +63,7 @@ You will find sample configuration files in ``etc/``
|
|||||||
* policy.json
|
* policy.json
|
||||||
* default_catalog.templates
|
* default_catalog.templates
|
||||||
|
|
||||||
From here, refer to configuration_ to choose which backend drivers to
|
From here, refer to :doc:`configuration` to choose which backend drivers to
|
||||||
enable and use. Once configured, you should be able to run keystone by issuing
|
enable and use. Once configured, you should be able to run keystone by issuing
|
||||||
the command::
|
the command::
|
||||||
|
|
||||||
@ -75,7 +71,7 @@ the command::
|
|||||||
|
|
||||||
which (by default) will show logging on the console from which it was started.
|
which (by default) will show logging on the console from which it was started.
|
||||||
Once started, you can initialize data in keystone for use with the rest of
|
Once started, you can initialize data in keystone for use with the rest of
|
||||||
openstack, as described in configuring-services_.
|
openstack, as described in :doc:`configuringservices`.
|
||||||
|
|
||||||
An excellent reference implementation of setting up keystone is DEVSTACK_,
|
An excellent reference implementation of setting up keystone is DEVSTACK_,
|
||||||
most commonly used for development and testing setup of not only Keystone,
|
most commonly used for development and testing setup of not only Keystone,
|
||||||
@ -103,7 +99,7 @@ options for setting up and running Keystone. As of this writing, the defaults
|
|||||||
for Keystone backends are all SQL based, stored locally in a sqlite.
|
for Keystone backends are all SQL based, stored locally in a sqlite.
|
||||||
|
|
||||||
Once installed, you still need to initialize data in Keystone, which you can
|
Once installed, you still need to initialize data in Keystone, which you can
|
||||||
find described in configuring-services_.
|
find described in :doc:`configuringservices`.
|
||||||
|
|
||||||
Installing from packages: Fedora
|
Installing from packages: Fedora
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
@ -20,7 +20,6 @@ Middleware Architecture
|
|||||||
|
|
||||||
Abstract
|
Abstract
|
||||||
========
|
========
|
||||||
.. _architecture: architecture.rst
|
|
||||||
|
|
||||||
The Keystone middleware architecture supports a common authentication protocol
|
The Keystone middleware architecture supports a common authentication protocol
|
||||||
in use between the OpenStack projects. By using keystone as a common
|
in use between the OpenStack projects. By using keystone as a common
|
||||||
@ -33,7 +32,7 @@ authentication middleware which acts as the internal API mechanism for
|
|||||||
OpenStack projects based on the WSGI standard.
|
OpenStack projects based on the WSGI standard.
|
||||||
|
|
||||||
For the architecture of keystone and its services, please see
|
For the architecture of keystone and its services, please see
|
||||||
architecture_. This documentation primarily describes the implementation
|
:doc:`architecture`. This documentation primarily describes the implementation
|
||||||
in ``keystoneclient/middleware/auth_token.py``
|
in ``keystoneclient/middleware/auth_token.py``
|
||||||
(:py:class:`keystoneclient.middleware.auth_token.AuthProtocol`)
|
(:py:class:`keystoneclient.middleware.auth_token.AuthProtocol`)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user