Static Driver¶
Selecting the static driver adds the following options to the providers section of the configuration.
-
providers.[static]¶
Type: list The static provider driver is used to define static nodes.
Note
For documentation purposes the option names are prefixed
providers.[static]
to disambiguate from other drivers, but[static]
is not required in the configuration (e.g. belowproviders.[static].pools
refers to thepools
key in theproviders
section when thestatic
driver is selected).Example:
providers: - name: static-rack driver: static pools: - name: main nodes: - name: trusty.example.com labels: trusty-static timeout: 13 connection-port: 22022 host-key: fake-key username: zuul max-parallel-jobs: 1
-
providers.[static].pools¶
Type: list A pool defines a group of statically declared nodes.
Note
When providing different labels, it is better to have one pool per label to avoid requests being queued when one label is at capacity.
Each entry is a dictionary with entries as follows
-
providers.[static].pools.name (required)¶
Type: str Pool name
-
providers.[static].pools.node-attributes¶
Type: dict A dictionary of key-value pairs that will be stored with the node data in ZooKeeper. The keys and values can be any arbitrary string.
-
providers.[static].pools.nodes (required)¶
Type: list Each entry indicates a static node and it’s attributes.
-
providers.[static].pools.nodes.name (required)¶
Type: str The hostname or ip address of the static node. The combination of
name
, providers.[static].pools.nodes.username, and providers.[static].pools.nodes.connection-port must be unique across all nodes defined within the configuration file.
-
providers.[static].pools.nodes.labels (required)¶
Type: list The list of labels associated with the node.
-
providers.[static].pools.nodes.host-key-checking¶
Default:True
Type: bool Specify custom behavior of validation of host connection. When set to False, nodepool-launcher will not scan the nodes before they are registered. This might be needed if nodepool-launcher and the static nodes are on isolated networks. The default value is True.
-
providers.[static].pools.nodes.timeout¶
Default:5
Type: int The timeout in second before the ssh ping is considered failed.
-
providers.[static].pools.nodes.connection-type¶
Default:ssh
Type: string The connection type that a consumer should use when connecting to the node.
- winrm¶
- ssh¶
-
providers.[static].pools.nodes.connection-port¶
Default:22 / 5986
Type: int The port that a consumer should use when connecting to the node. For most nodes this is not necessary. This defaults to 22 when
connection-type
is ‘ssh’ and 5986 when it is ‘winrm’.
-
providers.[static].pools.nodes.host-key¶
Type: str The ssh host key of the node.
-
providers.[static].pools.nodes.username¶
Default:zuul
Type: str The username nodepool will use to validate it can connect to the node.
-
providers.[static].pools.nodes.python-path¶
Default:/usr/bin/python2
Type: str The path of the default python interpreter. Used by Zuul to set
ansible_python_interpreter
. The special valueauto
will direct Zuul to use inbuilt Ansible logic to select the interpreter on Ansible >=2.8, and default to/usr/bin/python2
for earlier versions.
-
providers.[static].pools.nodes.shell-type¶
Default:sh
Type: str The shell type of the node’s default shell executable. Used by Zuul to set
ansible_shell_type
. This setting should only be usedFor a windows node with the experimental connection-type
ssh
, in which casecmd
orpowershell
should be set and reflect the node’sDefaultShell
configuration.If the default shell is not Bourne compatible (sh), but instead e.g.
csh
orfish
, and the user is aware that there is a long-standing issue withansible_shell_type
in combination withbecome
-
providers.[static].pools.nodes.max-parallel-jobs¶
Default:1
Type: int The number of jobs that can run in parallel on this node.
-
providers.[static].pools.nodes.name (required)¶
-
providers.[static].pools.name (required)¶
-
providers.[static].pools¶