nova/doc/source/configuration/index.rst
Ghanshyam Mann af21183082 Add docs and releasenotes for BP policy-defaults-refresh
This commit adds the documents to explain the new defaults,
migration plan and releases notes for policies changes in
BP policy-defaults-refresh

Partial implement blueprint policy-defaults-refresh

Change-Id: I00e678858a8e46786f3b69fbba3f5353932de49b
2020-04-23 02:06:06 +00:00

105 lines
3.2 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.
.. # 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.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
config
.. # 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
Policy
------
Nova, like most OpenStack projects, uses a policy language to restrict
permissions on REST API actions.
* :doc:`Policy Concepts <policy-concepts>`: Starting in the Ussuri
release, Nova API policy defines new default roles with system scope
capabilities. These new changes improve the security level and
manageability of Nova API as they are richer in terms of handling access at
system and project level token with 'Read' and 'Write' roles.
.. toctree::
:hidden:
policy-concepts
* :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.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
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-policy
Extra Specs
-----------
Nova uses *flavor extra specs* as a way to provide additional information to
instances beyond basic information like amount of RAM or disk. This information
can range from hints for the scheduler to hypervisor-specific configuration
instructions for the instance.
* :doc:`Extra Spec Reference <extra-specs>`: A complete reference for all extra
specs currently recognized and supported by nova.
.. toctree::
:hidden:
extra-specs