nodepool/doc/source/static.rst

zuul

Static Driver

Selecting the static driver adds the following options to the providers section of the configuration.

providers.[static]

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. below providers.[static].pools refers to the pools key in the providers section when the static 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

pools

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

name

Pool name

priority

The priority of this provider pool (a lesser number is a higher priority). Nodepool launchers will yield requests to other provider pools with a higher priority as long as they are not paused. This means that in general, higher priority pools will reach quota first before lower priority pools begin to be used.

This setting may be specified at the provider level in order to apply to all pools within that provider, or it can be overridden here for a specific pool.

node-attributes

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.

nodes

Each entry indicates a static node and it's attributes.

name

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.

labels

The list of labels associated with the node.

host-key-checking

Whether to validate SSH host keys. When true, this helps ensure that nodes are ready to receive SSH connections before they are supplied to the requestor. When set to false, nodepool-launcher will not attempt to ssh-keyscan nodes after they are booted. Disable this if nodepool-launcher and the nodes it launches are on different networks, where the launcher is unable to reach the nodes directly, or when using Nodepool with non-SSH node platforms. The default value is true.

timeout

The timeout in second before the ssh ping is considered failed.

connection-type

The connection type that a consumer should use when connecting to the node.

winrm

ssh

connection-port

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'.

host-key

The ssh host key of the node.

username

The username nodepool will use to validate it can connect to the node.

python-path

The path of the default python interpreter. Used by Zuul to set ansible_python_interpreter. The special value auto 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.

shell-type

The shell type of the node's default shell executable. Used by Zuul to set ansible_shell_type. This setting should only be used

• For a windows node with the experimental connection-type ssh, in which case cmd or powershell should be set and reflect the node's DefaultShell configuration.
• If the default shell is not Bourne compatible (sh), but instead e.g. csh or fish, and the user is aware that there is a long-standing issue with ansible_shell_type in combination with become

max-parallel-jobs

The number of jobs that can run in parallel on this node.