Tidy up docs - fixup missing links to TOC where possible
Due to layout of current docs, some sections don't display the TOC on the left hand navbar, for example installation/installation.html One of the reasons is that the subsections there (installing or updating) are labelled as sections (=== instead of ----). This updates the installation and troubleshooting sections Change-Id: Iad8f9fd760716c3f7139684861b12e2cd286501a
This commit is contained in:
marios
parent
c19933f955
commit
36e23f3ef1
@ -1,12 +1,12 @@
|
||||
Baremetal Environment
|
||||
=====================
|
||||
-----------------------------------
|
||||
|
||||
|project| can be used in an all baremetal environment. One machine will be
|
||||
used for Undercloud, the others will be used for your Overcloud.
|
||||
|
||||
|
||||
Minimum System Requirements
|
||||
---------------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
To deploy a minimal TripleO cloud with |project| you need the following baremetal
|
||||
machines:
|
||||
|
||||
@ -36,7 +36,7 @@ TripleO is supporting only the following operating systems:
|
||||
|
||||
|
||||
Preparing the Baremetal Environment
|
||||
-----------------------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Networking
|
||||
^^^^^^^^^^
|
||||
@ -122,7 +122,7 @@ Setting Up The Undercloud Machine
|
||||
.. _Red Hat Satellite User Guide: https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/
|
||||
|
||||
Configuration Files
|
||||
-------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
instackenv.json
|
||||
^^^^^^^^^^^^^^^
|
||||
@ -200,7 +200,7 @@ For example::
|
||||
}
|
||||
|
||||
Ironic Drivers
|
||||
--------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Ironic drivers provide various level of support for different hardware.
|
||||
The most up-to-date information about Ironic drivers is at
|
||||
|
||||
@ -4,7 +4,6 @@ Environment Setup
|
||||
|project| can be used in baremetal as well as in virtual environments. This
|
||||
section contains instructions on how to setup your environments properly.
|
||||
|
||||
.. toctree::
|
||||
.. include:: virtual.rst
|
||||
.. include:: baremetal.rst
|
||||
|
||||
Virtual Environment <virtual>
|
||||
Baremetal Environment <baremetal>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
Virtual Environment
|
||||
===================
|
||||
-----------------------------------
|
||||
|
||||
|project| can be used in a virtual environment using virtual machines instead
|
||||
of actual baremetal. However, one baremetal machine is still
|
||||
@ -7,7 +7,7 @@ needed to act as the host for the virtual machines.
|
||||
|
||||
|
||||
Minimum System Requirements
|
||||
---------------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
By default, this setup creates 3 virtual machines:
|
||||
|
||||
* 1 Undercloud
|
||||
@ -47,7 +47,7 @@ The baremetal machine must meet the following minimum system requirements:
|
||||
.. _preparing_virtual_environment:
|
||||
|
||||
Preparing the Virtual Environment (Automated)
|
||||
---------------------------------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
#. Install RHEL 7.1 Server x86_64 or CentOS 7 x86_64 on your host machine.
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ Undercloud Installation
|
||||
This section contains instructions on how to install the undercloud and how to
|
||||
update components after installation.
|
||||
|
||||
.. toctree::
|
||||
.. include:: installing.rst
|
||||
|
||||
.. include:: updating.rst
|
||||
|
||||
Installing the Undercloud <installing>
|
||||
Updating Undercloud Components <updating>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
Installing the Undercloud
|
||||
==========================
|
||||
--------------------------
|
||||
|
||||
#. Log in to your machine (baremetal or VM) where you want to install the
|
||||
undercloud as a non-root user (such as the stack user)::
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
Troubleshooting Image Build
|
||||
===========================
|
||||
-----------------------------------
|
||||
|
||||
Images fail to build
|
||||
--------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
More space needed
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
Troubleshooting Node Management Failures
|
||||
========================================
|
||||
-----------------------------------
|
||||
|
||||
Where Are the Logs?
|
||||
-------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Some logs are stored in *journald*, but most are stored as text files in
|
||||
``/var/log``. Ironic and ironic-discoverd logs are stored in journald. Note
|
||||
@ -21,7 +21,7 @@ node if it was detected (only for bare metal).
|
||||
.. _node_registration_problems:
|
||||
|
||||
Node Registration Problems
|
||||
--------------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Any problems with node data registered into Ironic can be fixed using the
|
||||
Ironic CLI.
|
||||
@ -46,7 +46,7 @@ A Wrong IPMI address can be fixed with the following command::
|
||||
.. _introspection_problems:
|
||||
|
||||
Hardware Introspection Problems
|
||||
--------------------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Discovery hangs and times out
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
Troubleshooting a Failed Overcloud Deployment
|
||||
=============================================
|
||||
-----------------------------------
|
||||
|
||||
If an Overcloud deployment has failed, the OpenStack clients and service log
|
||||
files can be used to troubleshoot the failed deployment. The following commands
|
||||
are all run on the Undercloud and assume a stackrc file has been sourced.
|
||||
|
||||
Identifying Failed Component
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
In most cases, Heat will show the failed overcloud stack when a deployment
|
||||
has failed::
|
||||
@ -82,7 +82,7 @@ in the resulting table.
|
||||
console (e.g. iDRAC for DELL) for bare metal machines.
|
||||
|
||||
Debugging Using Heat
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* Identifying the failed Heat resource
|
||||
|
||||
@ -229,7 +229,7 @@ Debugging Using Heat
|
||||
$ sudo sosreport --all-logs
|
||||
|
||||
No Valid Host Found Error
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Sometimes ``/var/log/nova/nova-conductor.log`` contains the following error::
|
||||
|
||||
|
||||
@ -1,5 +1,8 @@
|
||||
Debugging TripleO Heat Templates
|
||||
================================
|
||||
-----------------------------------
|
||||
|
||||
Useful Links
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Please follow this flow:
|
||||
http://hardysteven.blogspot.co.uk/2015/04/debugging-tripleo-heat-templates.html
|
||||
|
||||
@ -1,5 +1,8 @@
|
||||
Troubleshooting instack-virt-setup Failures
|
||||
===========================================
|
||||
-----------------------------------
|
||||
|
||||
Known Issues:
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* Due to a `bug in libvirt`_, it is possible for instack-virt-setup to fail
|
||||
with an error such as the following::
|
||||
|
||||
@ -5,10 +5,8 @@ At this chapter you will find answers for frequently asked questions and
|
||||
help with troubleshooting when using |project|.
|
||||
|
||||
|
||||
.. toctree::
|
||||
|
||||
Virtual Setup Problems <troubleshooting-virt-setup>
|
||||
Image Building Problems <troubleshooting-image-build>
|
||||
Node Management Problems <troubleshooting-nodes>
|
||||
Failed Overcloud Deployment <troubleshooting-overcloud>
|
||||
Tripleo Heat Templates <troubleshooting-tripleo-heat-templates>
|
||||
.. include:: troubleshooting-virt-setup.rst
|
||||
.. include:: troubleshooting-image-build.rst
|
||||
.. include:: troubleshooting-nodes.rst
|
||||
.. include:: troubleshooting-overcloud.rst
|
||||
.. include:: troubleshooting-tripleo-heat-templates.rst
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user