From 2dedda8b6b583c6eed9dddd4963297eea04a064b Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Thu, 24 Aug 2017 15:58:05 +0100 Subject: [PATCH] doc: Add configuration index page Change-Id: Ic318e04be73639de7d26e53e1f0b152d9803fd2f --- doc/source/configuration/index.rst | 33 ++++++++++++++++++++++++++++++ doc/source/index.rst | 1 + 2 files changed, 34 insertions(+) create mode 100644 doc/source/configuration/index.rst diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 000000000000..d0d956205842 --- /dev/null +++ b/doc/source/configuration/index.rst @@ -0,0 +1,33 @@ +=================== +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 `. + +Configuration +------------- + +* :doc:`Configuration Guide `: Detailed + configuration guides for various parts of you Nova system. Helpful reference + for setting up specific hypervisor backends. + +* :doc:`Config Reference `: A complete reference of all + configuration options available in the `nova.conf` file. + +* :doc:`Sample Config File `: 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 `: A complete reference of all + policy points in nova and what they impact. + +* :doc:`Sample Policy File `: A sample policy + file with inline documentation. diff --git a/doc/source/index.rst b/doc/source/index.rst index 1e3bbd4d94c8..2a41a2c35cb2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -235,6 +235,7 @@ looking parts of our architecture. These are collected below. admin/index admin/configuration/index cli/index + configuration/index configuration/config configuration/sample-config configuration/policy