Merge "doc bugfix for static provider"
This commit is contained in:
commit
6058bbeeba
|
@ -977,17 +977,16 @@ Selecting the static driver adds the following options to the
|
||||||
nodes:
|
nodes:
|
||||||
- name: trusty.example.com
|
- name: trusty.example.com
|
||||||
labels: trusty-static
|
labels: trusty-static
|
||||||
host-key: fake-key
|
|
||||||
timeout: 13
|
timeout: 13
|
||||||
connection-port: 22022
|
connection-port: 22022
|
||||||
|
host-key: fake-key
|
||||||
username: zuul
|
username: zuul
|
||||||
max-parallel-jobs: 1
|
max-parallel-jobs: 1
|
||||||
|
|
||||||
.. attr:: pools
|
.. attr:: pools
|
||||||
:type: list
|
:type: list
|
||||||
|
|
||||||
Each entry in a pool's nodes section indicates a static node and
|
A pool defines a group of statically declared nodes.
|
||||||
it's corresponding label.
|
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
|
@ -1001,56 +1000,68 @@ Selecting the static driver adds the following options to the
|
||||||
:type: str
|
:type: str
|
||||||
:required:
|
:required:
|
||||||
|
|
||||||
The hostname or ip address of the static node. This must be
|
Pool name
|
||||||
unique across all nodes defined within the configuration file.
|
|
||||||
|
|
||||||
.. attr:: labels
|
.. attr:: nodes
|
||||||
:type: list
|
:type: list
|
||||||
:required:
|
:required:
|
||||||
|
|
||||||
The list of labels associated with the node.
|
Each entry indicates a static node and it's attributes.
|
||||||
|
|
||||||
.. attr:: username
|
.. attr:: name
|
||||||
:type: str
|
:type: str
|
||||||
:default: zuul
|
:required:
|
||||||
|
|
||||||
The username nodepool will use to validate it can connect to the
|
The hostname or ip address of the static node. This must be
|
||||||
node.
|
unique across all nodes defined within the configuration file.
|
||||||
|
|
||||||
.. attr:: timeout
|
.. attr:: labels
|
||||||
:type: int
|
:type: list
|
||||||
:default: 5
|
:required:
|
||||||
|
|
||||||
The timeout in second before the ssh ping is considered failed.
|
The list of labels associated with the node.
|
||||||
|
|
||||||
.. attr:: host-key
|
.. attr:: timeout
|
||||||
:type: str
|
:type: int
|
||||||
|
:default: 5
|
||||||
|
|
||||||
The ssh host key of the node.
|
The timeout in second before the ssh ping is considered failed.
|
||||||
|
|
||||||
.. attr:: connection-type
|
.. attr:: connection-type
|
||||||
:type: string
|
:type: string
|
||||||
|
|
||||||
The connection type that a consumer should use when connecting
|
The connection type that a consumer should use when connecting
|
||||||
to the node.
|
to the node.
|
||||||
|
|
||||||
.. value:: winrm
|
.. value:: winrm
|
||||||
|
|
||||||
.. value:: ssh
|
.. value:: ssh
|
||||||
|
|
||||||
.. attr:: connection-port
|
.. attr:: connection-port
|
||||||
:type: int
|
:type: int
|
||||||
:default: 22 / 5986
|
:default: 22 / 5986
|
||||||
|
|
||||||
The port that a consumer should use when connecting to the node.
|
The port that a consumer should use when connecting to the node.
|
||||||
For most nodes this is not necessary. This defaults to 22 when
|
For most nodes this is not necessary. This defaults to 22 when
|
||||||
``connection-type`` is 'ssh' and 5986 when it is 'winrm'.
|
``connection-type`` is 'ssh' and 5986 when it is 'winrm'.
|
||||||
|
|
||||||
.. attr:: max-parallel-jobs
|
.. attr:: host-key
|
||||||
:type: int
|
:type: str
|
||||||
:default: 1
|
|
||||||
|
|
||||||
The number of jobs that can run in parallel on this node.
|
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
|
||||||
|
|
||||||
|
The number of jobs that can run in parallel on this node.
|
||||||
|
|
||||||
|
|
||||||
Kubernetes Driver
|
Kubernetes Driver
|
||||||
|
|
Loading…
Reference in New Issue