[config-ref] reorganize sample configuration files

Change-Id: I958563c84bf04b22933b3238f093b9210ef0f90f
This commit is contained in:
KATO Tomoyuki 2016-07-02 04:50:11 +00:00 committed by Joseph Robinson
parent dcfdd1d453
commit c980025806
33 changed files with 191 additions and 183 deletions

@ -8,12 +8,12 @@ Block Storage service
block-storage/block-storage-overview.rst
block-storage/volume-drivers.rst
block-storage/backup-drivers.rst
block-storage/block-storage-sample-configuration-files.rst
block-storage/logs.rst
block-storage/fc-zoning.rst
block-storage/nested-quota.rst
block-storage/volume-encryption.rst
block-storage/volume-misc.rst
block-storage/samples/index.rst
tables/conf-changes/cinder.rst
.. note::

@ -1,53 +0,0 @@
.. _block-storage-sample-configuration-file:
========================================
Block Storage sample configuration files
========================================
All the files in this section can be found in ``/etc/cinder``.
cinder.conf
~~~~~~~~~~~
The ``cinder.conf`` file is installed in ``/etc/cinder`` by default.
When you manually install the Block Storage service, the options in the
``cinder.conf`` file are set to default values.
The ``cinder.conf`` file contains most of the options to configure the
Block Storage service. Here is the sample configuration file and you can
generate the latest configuration file by using the tox provided by the
Block Storage service.
.. literalinclude:: ../samples/cinder.conf.sample
:language: ini
api-paste.ini
~~~~~~~~~~~~~
Use the ``api-paste.ini`` file to configure the Block Storage API
service.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/api-paste.ini?h=stable/mitaka
policy.json
~~~~~~~~~~~
The ``policy.json`` file defines additional access controls that apply
to the Block Storage service.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/policy.json?h=stable/mitaka
rootwrap.conf
~~~~~~~~~~~~~
The ``rootwrap.conf`` file defines configuration values used by the
``rootwrap`` script when the Block Storage service must escalate its
privileges to those of the root user.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/rootwrap.conf?h=stable/mitaka

@ -0,0 +1,10 @@
=============
api-paste.ini
=============
Use the ``api-paste.ini`` file to configure the Block Storage API
service.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/api-paste.ini?h=stable/mitaka

@ -0,0 +1,15 @@
===========
cinder.conf
===========
The ``cinder.conf`` file is installed in ``/etc/cinder`` by default.
When you manually install the Block Storage service, the options in the
``cinder.conf`` file are set to default values.
The ``cinder.conf`` file contains most of the options needed to configure
the Block Storage service. You can generate the latest configuration file
by using the tox provided by the Block Storage service. Here is a sample
configuration file:
.. literalinclude:: ../../samples/cinder.conf.sample
:language: ini

@ -0,0 +1,15 @@
.. _block-storage-sample-configuration-file:
================================================
Block Storage service sample configuration files
================================================
All the files in this section can be found in ``/etc/cinder``.
.. toctree::
:maxdepth: 2
cinder.conf.rst
api-paste.ini.rst
policy.json.rst
rootwrap.conf.rst

@ -0,0 +1,10 @@
===========
policy.json
===========
The ``policy.json`` file defines additional access controls that apply
to the Block Storage service.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/policy.json?h=stable/mitaka

@ -0,0 +1,11 @@
=============
rootwrap.conf
=============
The ``rootwrap.conf`` file defines configuration values used by the
``rootwrap`` script when the Block Storage service must escalate its
privileges to those of the root user.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/rootwrap.conf?h=stable/mitaka

@ -18,9 +18,10 @@ Compute service
compute/scheduler.rst
compute/cells.rst
compute/conductor.rst
compute/nova-conf-samples.rst
compute/config-options.rst
compute/logs.rst
compute/config-samples.rst
compute/nova-conf-samples.rst
compute/samples/index.rst
tables/conf-changes/nova.rst
The Compute service is a cloud computing fabric controller,

@ -1,9 +0,0 @@
==================================
Compute sample configuration files
==================================
.. toctree::
:maxdepth: 2
config-options.rst
sample-configuration-files.rst

@ -1,11 +0,0 @@
=====================================
Additional sample configuration files
=====================================
Files in this section can be found in ``/etc/nova``.
.. toctree::
api-paste.ini.rst
policy.json.rst
rootwrap.conf.rst

@ -0,0 +1,12 @@
==========================================
Compute service sample configuration files
==========================================
Files in this section can be found in ``/etc/nova``.
.. toctree::
:maxdepth: 2
api-paste.ini.rst
policy.json.rst
rootwrap.conf.rst

@ -8,7 +8,7 @@ Dashboard
dashboard/configure.rst
common/dashboard_customizing.rst
dashboard/config-options.rst
dashboard/sample-configuration-files.rst
dashboard/samples/index.rst
dashboard/logs.rst
This chapter describes how to configure the Dashboard with

@ -1,10 +1,10 @@
=====================================
Additional sample configuration files
=====================================
====================================
Dashboard sample configuration files
====================================
Find the following files in ``/etc/openstack-dashboard``.
.. toctree::
keystone_policy.json.rst
nova_policy.json.rst
Find the following files in ``/etc/openstack-dashboard``.

@ -6,7 +6,7 @@ Identity service
identity/options.rst
identity/logs.rst
identity/sample-configuration-files.rst
identity/samples/index.rst
identity/caching.rst
tables/conf-changes/keystone.rst

@ -1,49 +0,0 @@
===========================================
Identity service sample configuration files
===========================================
You can find the files described in this section in the ``/etc/keystone``
directory.
keystone.conf
~~~~~~~~~~~~~
Use the ``keystone.conf`` file to configure most Identity service
options:
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone.conf.sample?h=stable/mitaka
keystone-paste.ini
~~~~~~~~~~~~~~~~~~
Use the ``keystone-paste.ini`` file to configure the Web Service Gateway
Interface (WSGI) middleware pipeline for the Identity service:
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone-paste.ini?h=stable/mitaka
logging.conf
~~~~~~~~~~~~
You can specify a special logging configuration file in the ``keystone.conf``
configuration file. For example, ``/etc/keystone/logging.conf``.
For details, see the `Python logging module documentation
<http://docs.python.org/2/howto/logging.html#configuring-logging>`__.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/keystone/plain/etc/logging.conf.sample?h=stable/mitaka
policy.json
~~~~~~~~~~~
Use the ``policy.json`` file to define additional access controls that apply to
the Identity service:
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/keystone/plain/etc/policy.json?h=stable/mitaka

@ -0,0 +1,13 @@
===========================================
Identity service sample configuration files
===========================================
You can find the files described in this section in the ``/etc/keystone``
directory.
.. toctree::
keystone.conf.rst
keystone-paste.ini.rst
logging.conf.rst
policy.json.rst

@ -0,0 +1,10 @@
==================
keystone-paste.ini
==================
Use the ``keystone-paste.ini`` file to configure the Web Service Gateway
Interface (WSGI) middleware pipeline for the Identity service:
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone-paste.ini?h=stable/mitaka

@ -0,0 +1,10 @@
=============
keystone.conf
=============
Use the ``keystone.conf`` file to configure most Identity service
options:
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone.conf.sample?h=stable/mitaka

@ -0,0 +1,13 @@
============
logging.conf
============
You can specify a special logging configuration file in the ``keystone.conf``
configuration file. For example, ``/etc/keystone/logging.conf``.
For details, see the `Python logging module documentation
<http://docs.python.org/2/howto/logging.html#configuring-logging>`__.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/keystone/plain/etc/logging.conf.sample?h=stable/mitaka

@ -0,0 +1,10 @@
===========
policy.json
===========
Use the ``policy.json`` file to define additional access controls that apply to
the Identity service:
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/keystone/plain/etc/policy.json?h=stable/mitaka

@ -23,8 +23,8 @@ Contents
block-storage.rst
compute.rst
dashboard.rst
database-service.rst
data-processing-service.rst
database-service.rst
identity.rst
image-service.rst
messaging.rst

@ -7,9 +7,9 @@ Shared File Systems service
shared-file-systems/overview.rst
shared-file-systems/drivers.rst
shared-file-systems/log-files.rst
shared-file-systems/sample-configuration-files.rst
shared-file-systems/rpc.rst
shared-file-systems/misc.rst
shared-file-systems/samples/index.rst
tables/conf-changes/manila.rst
The Shared File Systems service works with many different drivers that

@ -1,49 +0,0 @@
==============================================
Shared File Systems sample configuration files
==============================================
All the files in this section can be found in ``/etc/manila``.
manila.conf
-----------
The ``manila.conf`` file is installed in ``/etc/manila`` by default.
When you manually install the Shared File Systems service, the options
in the ``manila.conf`` file are set to default values.
The ``manila.conf`` file contains most of the options to configure the
Shared File Systems service.
.. literalinclude:: ../samples/manila.conf.sample
:language: ini
api-paste.ini
-------------
Use the ``api-paste.ini`` file to configure the Shared File Systems API
service.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/api-paste.ini
policy.json
-----------
The ``policy.json`` file defines additional access controls that apply
to the Shared File Systems service.
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/policy.json
rootwrap.conf
-------------
The ``rootwrap.conf`` file defines configuration values used by the
``rootwrap`` script when the Shared File Systems service must escalate
its privileges to those of the root user.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/rootwrap.conf

@ -0,0 +1,3 @@
=============
api-paste.ini
=============

@ -0,0 +1,12 @@
======================================================
Shared File Systems service sample configuration files
======================================================
All the files in this section can be found in ``/etc/manila``.
.. toctree::
manila.conf.rst
api-paste.ini.rst
policy.json.rst
rootwrap.conf.rst

@ -0,0 +1,13 @@
===========
manila.conf
===========
The ``manila.conf`` file is installed in ``/etc/manila`` by default.
When you manually install the Shared File Systems service, the options
in the ``manila.conf`` file are set to default values.
The ``manila.conf`` file contains most of the options needed to configure
the Shared File Systems service.
.. literalinclude:: ../../samples/manila.conf.sample
:language: ini

@ -0,0 +1,10 @@
===========
policy.json
===========
The ``policy.json`` file defines additional access controls that apply
to the Shared File Systems service.
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/policy.json

@ -0,0 +1,11 @@
=============
rootwrap.conf
=============
The ``rootwrap.conf`` file defines configuration values used by the
``rootwrap`` script when the Shared File Systems service must escalate
its privileges to those of the root user.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/manila/plain/etc/manila/rootwrap.conf