zuul
/
nodepool
Code Issues Proposed changes

Clarify static node name uniqueness in docs 

Static node names are either a hostname or IP address. By their
very nature, this needs to be unique across all nodes defined in
the config, even across pools. And the static driver assumes this
is the case. Add text to make sure this is explicitly pointed out.

Also, note that multiple pools are supported, but useless.

Change-Id: I8c8c1e2cda9b0250910c4af455b8e1472ad86151
This commit is contained in:
David Shrewsbury 2018-06-13 12:16:37 -04:00
parent 9de68b83dd
commit a1fd015c25
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/configuration.rst
View File

@ -711,6 +711,11 @@ Static driver
The static provider driver is used to define static nodes. Nodes are also
partitioned into groups called "pools" (see :ref:`static_nodes` for details).
.. NOTE::
Although you may define more than one pool, it is essentially useless to do
so since a node's ``name`` must be unique across all pools.
Example::
providers:
@ -732,13 +737,14 @@ Example::
static nodes
~~~~~~~~~~~~
Each entry in a pool`s nodes section indicates a static node and it's
Each entry in a pool's nodes section indicates a static node and it's
corresponding label.
**required**
``name``
The hostname or ip address of the static node.
The hostname or ip address of the static node. This must be unique
across all nodes defined within the configuration file.
``labels`` (list)
The list of labels associated with the node.