16b9486bf7
- Add a new pdf-docs environment to enable PDF build. - sphinxcontrib-svg2pdfconverter is used to handle SVG properly. - maxlistdepth=10 in latex_elements is needed to handle deeper levels of nesting. - Sample config/policy files are skipped in the PDF document as inline sample files cause LaTeX error [1] and direct links in PDF doc is discouraged. Note that sample-config and sample-policy need to be excluded to avoid the LaTeX error [1] and :orphan: is specified in those files. [1] https://github.com/sphinx-doc/sphinx/issues/3099 Change-Id: I3aaea1d15a357f550f529beaa84fb1a1a7748358
58 lines
1.6 KiB
ReStructuredText
58 lines
1.6 KiB
ReStructuredText
===================
|
|
Configuration Guide
|
|
===================
|
|
|
|
The static configuration for nova lives in two main files: ``nova.conf`` and
|
|
``policy.json``. These are described below. For a bigger picture view on
|
|
configuring nova to solve specific problems, refer to the :doc:`Nova Admin
|
|
Guide </admin/index>`.
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
* :doc:`Configuration Guide </admin/configuration/index>`: Detailed
|
|
configuration guides for various parts of your Nova system. Helpful
|
|
reference for setting up specific hypervisor backends.
|
|
|
|
* :doc:`Config Reference <config>`: A complete reference of all
|
|
configuration options available in the ``nova.conf`` file.
|
|
|
|
.. only:: html
|
|
|
|
* :doc:`Sample Config File <sample-config>`: A sample config
|
|
file with inline documentation.
|
|
|
|
Policy
|
|
------
|
|
|
|
Nova, like most OpenStack projects, uses a policy language to restrict
|
|
permissions on REST API actions.
|
|
|
|
* :doc:`Policy Reference <policy>`: A complete reference of all
|
|
policy points in nova and what they impact.
|
|
|
|
.. only:: html
|
|
|
|
* :doc:`Sample Policy File <sample-policy>`: A sample nova
|
|
policy file with inline documentation.
|
|
|
|
.. # NOTE(mriedem): This is the section where we hide things that we don't
|
|
# actually want in the table of contents but sphinx build would fail if
|
|
# they aren't in the toctree somewhere.
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
config
|
|
policy
|
|
|
|
.. # NOTE(amotoki): Sample files are only available in HTML document.
|
|
# Inline sample files with literalinclude hit LaTeX processing error
|
|
# like TeX capacity exceeded and direct links are discouraged in PDF doc.
|
|
.. only:: html
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
sample-config
|
|
sample-policy
|