openstack/keystone
Code Issues Proposed changes

Remove duplicate configuration sections

Browse Source 
Keystone nows has it's own configuration guide, which means we no
longer need to maintain a separate configuration reference in the
operator guide.

Change-Id: Iadfb90db9f5f23798d57a442e372d35519332a49
This commit is contained in:
Lance Bragstad 2017-07-17 15:04:28 +00:00
parent 33b0ec1397
commit 2c6458c355
2 changed files with 3 additions and 90 deletions
doc/source
configuration.rst
configuration/samples
index.rst

88
doc/source/configuration.rst

@ -18,94 +18,6 @@
Configuring Keystone
====================
Config Files
============
Once keystone is installed, keystone is configured via a primary configuration
file (``etc/keystone.conf``), a PasteDeploy configuration file
(``etc/keystone-paste.ini``), possibly a separate logging configuration file,
and initializing data into keystone using the command line client.
The keystone configuration files are an ``ini`` file format based on Paste_, a
common system used to configure Python WSGI based applications. The PasteDeploy
configuration entries (WSGI pipeline definitions) can be provided in a separate
``keystone-paste.ini`` file, while general and driver-specific configuration
parameters are in the primary configuration file ``keystone.conf``.
.. NOTE::
Since keystone's PasteDeploy configuration file has been separated
from the main keystone configuration file, ``keystone.conf``, all
local configuration or driver-specific configuration parameters must
go in the main keystone configuration file instead of the PasteDeploy
configuration file, i.e. configuration in ``keystone-paste.ini``
is not supported.
.. _Paste: http://pythonpaste.org/
Sample Configuration Files
--------------------------
The ``etc/`` folder distributed with keystone contains example configuration
files for each Server application.
* ``etc/keystone.conf.sample``
* ``etc/keystone-paste.ini``
* ``etc/logging.conf.sample``
* ``etc/default_catalog.templates``
* ``etc/sso_callback_template.html``
``keystone.conf`` sections
--------------------------
The primary configuration file is organized into the following sections:
* ``[DEFAULT]`` - General configuration
* ``[assignment]`` - Assignment system driver configuration
* ``[auth]`` - Authentication plugin configuration
* ``[cache]`` - Caching layer configuration
* ``[catalog]`` - Service catalog driver configuration
* ``[credential]`` - Credential system driver configuration
* ``[domain_config]`` - Domain configuration
* ``[endpoint_filter]`` - Endpoint filtering configuration
* ``[endpoint_policy]`` - Endpoint policy configuration
* ``[federation]`` - Federation driver configuration
* ``[fernet_tokens]`` - Fernet token configuration
* ``[identity]`` - Identity system driver configuration
* ``[identity_mapping]`` - Identity mapping system driver configuration
* ``[ldap]`` - LDAP configuration options
* ``[memcache]`` - Memcache configuration options
* ``[oauth1]`` - OAuth 1.0a system driver configuration
* ``[paste_deploy]`` - Pointer to the PasteDeploy configuration file
* ``[policy]`` - Policy system driver configuration for RBAC
* ``[resource]`` - Resource system driver configuration
* ``[revoke]`` - Revocation system driver configuration
* ``[role]`` - Role system driver configuration
* ``[saml]`` - SAML configuration options
* ``[security_compliance]`` - Security compliance configuration
* ``[shadow_users]`` - Shadow user configuration
* ``[signing]`` - Cryptographic signatures for PKI based tokens
* ``[token]`` - Token driver & token provider configuration
* ``[tokenless_auth]`` - Tokenless authentication configuration
* ``[trust]`` - Trust configuration
The keystone primary configuration file is expected to be named
``keystone.conf``. When starting 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 order:
* ``~/.keystone/``
* ``~/``
* ``/etc/keystone/``
* ``/etc/``
PasteDeploy configuration file is specified by the ``config_file`` parameter in
``[paste_deploy]`` section of the primary configuration file. If the parameter
is not an absolute path, then keystone looks for it in the same directories as
above. If not specified, WSGI pipeline definitions are loaded from the primary
configuration file.
Setting up other OpenStack Services
===================================

5
doc/source/configuration/samples/index.rst

@ -2,8 +2,9 @@
Sample configuration files
==========================
You can find the files described in this section in the
``/etc/keystone`` directory.
Configuration files can alter how keystone behaves at runtime and by default
are located in ``/etc/keystone/``. Links to sample configuration files can be
found below:
.. toctree::