zuul
/
nodepool
Code Issues Proposed changes

Merge "doc bugfix for static provider"

This commit is contained in:
Zuul 2019-02-22 21:02:25 +00:00 committed by Gerrit Code Review
parent e8ac13027e c4f4279cb3
commit 6058bbeeba
1 changed files with 46 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/source/configuration.rst
View File

@ -977,17 +977,16 @@ Selecting the static driver adds the following options to the
nodes:
- name: trusty.example.com
labels: trusty-static
host-key: fake-key
timeout: 13
connection-port: 22022
host-key: fake-key
username: zuul
max-parallel-jobs: 1
.. attr:: pools
:type: list
Each entry in a pool's nodes section indicates a static node and
it's corresponding label.
A pool defines a group of statically declared nodes.
.. note::
@ -997,6 +996,18 @@ Selecting the static driver adds the following options to the
Each entry is a dictionary with entries as follows
.. attr:: name
:type: str
:required:
Pool name
.. attr:: nodes
:type: list
:required:
Each entry indicates a static node and it's attributes.
.. attr:: name
:type: str
:required:
@ -1010,24 +1021,12 @@ Selecting the static driver adds the following options to the
The list of labels associated with the node.
.. attr:: username
:type: str
:default: zuul
The username nodepool will use to validate it can connect to the
node.
.. attr:: timeout
:type: int
:default: 5
The timeout in second before the ssh ping is considered failed.
.. attr:: host-key
:type: str
The ssh host key of the node.
.. attr:: connection-type
:type: string
@ -1046,6 +1045,18 @@ Selecting the static driver adds the following options to the
For most nodes this is not necessary. This defaults to 22 when
``connection-type`` is 'ssh' and 5986 when it is 'winrm'.
.. attr:: host-key
:type: str
The ssh host key of the node.
.. attr:: username
:type: str
:default: zuul
The username nodepool will use to validate it can connect to the
node.
.. attr:: max-parallel-jobs
:type: int
:default: 1