zuul/nodepool
Code Issues Proposed changes

Docs: Clarify secure file usage

Browse Source 
Making specifying the secure file optional (since it isn't used)
means we should clarify that in the docs.

Change-Id: Ie17cc08835861f3e6d4c9ca206797f2287769bd3
This commit is contained in:
David Shrewsbury 2017-03-23 09:05:13 -04:00
parent 87e23755ee
commit 187d783620
2 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/configuration.rst
View File

@ -3,10 +3,6 @@
Configuration Configuration
============= =============
Nodepool reads its secure configuration from ``/etc/nodepool/secure.conf``
by default. The secure file is a standard ini config file. Note that this
file is currently unused, but may be in the future.
Nodepool reads its configuration from ``/etc/nodepool/nodepool.yaml`` Nodepool reads its configuration from ``/etc/nodepool/nodepool.yaml``
by default. The configuration file follows the standard YAML syntax by default. The configuration file follows the standard YAML syntax
with a number of sections defined with top level keys. For example, a with a number of sections defined with top level keys. For example, a

16
doc/source/installation.rst
View File

@ -52,13 +52,15 @@ Or install directly from a git checkout with::
Configuration Configuration
------------- -------------
Nodepool has two required configuration files: secure.conf and Nodepool has one required configuration file, which defaults to
nodepool.yaml, and an optional logging configuration file logging.conf. ``/etc/nodepool/nodepool.yaml``. This can be changed with the ``-c`` option.
The secure.conf file is used to store nodepool configurations that contain The Nodepool configuration file is described in :ref:`configuration`.
sensitive data. The nodepool.yaml files is used to store all other
configurations.
The logging configuration file is in the standard python logging Although there is support for a secure file that is used to store nodepool
configurations that contain sensitive data, this is currently not used, but
may be in the future.
There is an optional logging configuration file, specified with the ``-l``
option. The logging configuration file is in the standard python logging
`configuration file format `configuration file format
<http://docs.python.org/2/library/logging.config.html#configuration-file-format>`_. <http://docs.python.org/2/library/logging.config.html#configuration-file-format>`_.
The Nodepool configuration file is described in :ref:`configuration`.