chill out on the number of items in toc

we have an absurd amount of entries in our table of contents[1]. this
patch does better groupings so we nest a bit more.

[1] https://docs.openstack.org/project-install-guide/telemetry/draft/

Change-Id: Ib56af520483b39e2c80ce03e0cf48a18bbfa5267
(cherry picked from commit b01c33f78b)
This commit is contained in:
gord chung 2017-02-21 22:33:50 +00:00
parent e67d103148
commit c16d0895c3
23 changed files with 88 additions and 43 deletions

View File

@ -6,21 +6,8 @@ Telemetry Data Collection service
:maxdepth: 2 :maxdepth: 2
get_started.rst get_started.rst
install-base-obs.rst install-compute.rst
install-base-rdo.rst install-controller.rst
install-base-ubuntu.rst
configure_services/glance/install-glance-obs.rst
configure_services/glance/install-glance-rdo.rst
configure_services/glance/install-glance-ubuntu.rst
configure_services/nova/install-nova-obs.rst
configure_services/nova/install-nova-rdo.rst
configure_services/nova/install-nova-ubuntu.rst
configure_services/cinder/install-cinder-obs.rst
configure_services/cinder/install-cinder-rdo.rst
configure_services/cinder/install-cinder-ubuntu.rst
configure_services/swift/install-swift-obs.rst
configure_services/swift/install-swift-rdo.rst
configure_services/swift/install-swift-ubuntu.rst
verify.rst verify.rst
next-steps.rst next-steps.rst
database/environment-nosql-database-obs.rst database/environment-nosql-database-obs.rst

View File

@ -6,10 +6,6 @@ Install and configure for openSUSE and SUSE Linux Enterprise
This section describes how to install and configure the This section describes how to install and configure the
Telemetry service, code-named ceilometer, on the controller node. Telemetry service, code-named ceilometer, on the controller node.
This section assumes that you already have a working OpenStack
environment with at least the following components installed:
Compute, Image Service, Identity.
Prerequisites Prerequisites
------------- -------------
@ -50,7 +46,7 @@ MongoDB before proceeding further.
the ``/etc/mongodb.conf`` file, restart the MongoDB service using the ``/etc/mongodb.conf`` file, restart the MongoDB service using
``systemctl restart mongodb``, and try calling the command again. ``systemctl restart mongodb``, and try calling the command again.
.. include:: install-base-prereq-common.rst .. include:: install-base-prereq-common.inc
Install and configure components Install and configure components
-------------------------------- --------------------------------
@ -64,7 +60,7 @@ Install and configure components
openstack-ceilometer-agent-notification \ openstack-ceilometer-agent-notification \
openstack-ceilometer-agent-central python-ceilometerclient openstack-ceilometer-agent-central python-ceilometerclient
.. include:: install-base-config-common.rst .. include:: install-base-config-common.inc
* In the ``[collector]`` section, configure the dispatcher: * In the ``[collector]`` section, configure the dispatcher:

View File

@ -6,10 +6,6 @@ Install and configure for Red Hat Enterprise Linux and CentOS
This section describes how to install and configure the This section describes how to install and configure the
Telemetry service, code-named ceilometer, on the controller node. Telemetry service, code-named ceilometer, on the controller node.
This section assumes that you already have a working OpenStack
environment with at least the following components installed:
Compute, Image Service, Identity.
Prerequisites Prerequisites
------------- -------------
@ -35,7 +31,7 @@ MongoDB before proceeding further.
Replace ``CEILOMETER_DBPASS`` with a suitable password. Replace ``CEILOMETER_DBPASS`` with a suitable password.
.. include:: install-base-prereq-common.rst .. include:: install-base-prereq-common.inc
Install and configure components Install and configure components
-------------------------------- --------------------------------
@ -48,7 +44,7 @@ Install and configure components
openstack-ceilometer-collector openstack-ceilometer-notification \ openstack-ceilometer-collector openstack-ceilometer-notification \
openstack-ceilometer-central python-ceilometerclient openstack-ceilometer-central python-ceilometerclient
.. include:: install-base-config-common.rst .. include:: install-base-config-common.inc
Configure the Apache HTTP server Configure the Apache HTTP server
-------------------------------- --------------------------------

View File

@ -6,10 +6,6 @@ Install and configure for Ubuntu
This section describes how to install and configure the This section describes how to install and configure the
Telemetry service, code-named ceilometer, on the controller node. Telemetry service, code-named ceilometer, on the controller node.
This section assumes that you already have a working OpenStack
environment with at least the following components installed:
Compute, Image Service, Identity.
Prerequisites Prerequisites
------------- -------------
@ -50,7 +46,7 @@ MongoDB before proceeding further.
the ``/etc/mongodb.conf`` file, restart the MongoDB service using the ``/etc/mongodb.conf`` file, restart the MongoDB service using
``service mongodb restart``, and try calling the command again. ``service mongodb restart``, and try calling the command again.
.. include:: install-base-prereq-common.rst .. include:: install-base-prereq-common.inc
Install and configure components Install and configure components
-------------------------------- --------------------------------
@ -63,7 +59,7 @@ Install and configure components
ceilometer-agent-central ceilometer-agent-notification \ ceilometer-agent-central ceilometer-agent-notification \
python-ceilometerclient python-ceilometerclient
.. include:: install-base-config-common.rst .. include:: install-base-config-common.inc
Configure the Apache HTTP server Configure the Apache HTTP server
-------------------------------- --------------------------------

View File

@ -13,7 +13,7 @@ Install and configure components
# zypper install openstack-ceilometer-agent-compute # zypper install openstack-ceilometer-agent-compute
.. include:: install-nova-common.rst .. include:: install-compute-common.inc
Finalize installation Finalize installation
--------------------- ---------------------

View File

@ -11,9 +11,9 @@ Install and configure components
.. code-block:: console .. code-block:: console
# yum install openstack-ceilometer-compute python-ceilometerclient python-pecan # yum install openstack-ceilometer-compute
.. include:: install-nova-common.rst .. include:: install-compute-common.inc
Finalize installation Finalize installation
--------------------- ---------------------

View File

@ -13,7 +13,7 @@ Install and configure components
# apt-get install ceilometer-agent-compute # apt-get install ceilometer-agent-compute
.. include:: install-nova-common.rst .. include:: install-compute-common.inc
Finalize installation Finalize installation
--------------------- ---------------------

View File

@ -0,0 +1,17 @@
.. _install_compute:
Install and Configure Compute Services
======================================
This section assumes that you already have a working OpenStack
environment with at least the following components installed:
Compute, Image Service, Identity.
Note that installation and configuration vary by distribution.
.. toctree::
:maxdepth: 1
install-compute-obs.rst
install-compute-rdo.rst
install-compute-ubuntu.rst

View File

@ -0,0 +1,53 @@
.. _install_controller:
Install and Configure Controller Services
=========================================
This section assumes that you already have a working OpenStack
environment with at least the following components installed:
Compute, Image Service, Identity.
Note that installation and configuration vary by distribution.
Ceilometer
----------
.. toctree::
:maxdepth: 1
install-base-obs.rst
install-base-rdo.rst
install-base-ubuntu.rst
Additional steps are required to configure services to interact with
ceilometer:
Cinder
------
.. toctree::
:maxdepth: 1
cinder/install-cinder-obs.rst
cinder/install-cinder-rdo.rst
cinder/install-cinder-ubuntu.rst
Glance
------
.. toctree::
:maxdepth: 1
glance/install-glance-obs.rst
glance/install-glance-rdo.rst
glance/install-glance-ubuntu.rst
Swift
-----
.. toctree::
:maxdepth: 1
swift/install-swift-obs.rst
swift/install-swift-rdo.rst
swift/install-swift-ubuntu.rst

View File

@ -8,7 +8,7 @@ Object Storage meters.
Your environment must include the Object Storage service. Your environment must include the Object Storage service.
.. include:: install-swift-prereq-common.rst .. include:: install-swift-prereq-common.inc
Install components Install components
------------------ ------------------
@ -19,7 +19,7 @@ Install components
# zypper install python-ceilometermiddleware # zypper install python-ceilometermiddleware
.. include:: install-swift-config-common.rst .. include:: install-swift-config-common.inc
Finalize installation Finalize installation
--------------------- ---------------------

View File

@ -8,7 +8,7 @@ Object Storage meters.
Your environment must include the Object Storage service. Your environment must include the Object Storage service.
.. include:: install-swift-prereq-common.rst .. include:: install-swift-prereq-common.inc
Install components Install components
------------------ ------------------
@ -19,7 +19,7 @@ Install components
# yum install python-ceilometermiddleware # yum install python-ceilometermiddleware
.. include:: install-swift-config-common.rst .. include:: install-swift-config-common.inc
Finalize installation Finalize installation
--------------------- ---------------------

View File

@ -8,7 +8,7 @@ Object Storage meters.
Your environment must include the Object Storage service. Your environment must include the Object Storage service.
.. include:: install-swift-prereq-common.rst .. include:: install-swift-prereq-common.inc
Install components Install components
------------------ ------------------
@ -19,7 +19,7 @@ Install components
# apt-get install python-ceilometermiddleware # apt-get install python-ceilometermiddleware
.. include:: install-swift-config-common.rst .. include:: install-swift-config-common.inc
Finalize installation Finalize installation
--------------------- ---------------------