zuul
/
nodepool
Code Issues Proposed changes

Clarify reasons for host-key-checking setting 

Mention why the host-key-checking feature exists, so that users will
be aware of possible errors which may arise if they choose to
disable it. Also clarify why having the launcher and nodes on
different networks may lead you to need to disable the behavior.

Change-Id: I769080c5330bb7e6336f315eb0237324f0fda758
This commit is contained in:
Jeremy Stanley 2022-05-16 14:50:51 +00:00
parent a64adca5da
commit e4b2d412d0
6 changed files with 74 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/aws.rst
View File

@ -398,10 +398,14 @@ Selecting the ``aws`` driver adds the following options to the
:type: bool
:default: True
Specify custom behavior of validation of SSH host keys. When set to
False, nodepool-launcher will not ssh-keyscan nodes after they are
booted. This might be needed if nodepool-launcher and the nodes it
launches are on different networks. The default value is True.
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.
.. attr:: labels
:type: list

26
doc/source/azure.rst
View File

@ -157,11 +157,14 @@ section of the configuration.
:type: bool
:default: true
Specify custom behavior of validation of SSH host keys. When
set to False, nodepool-launcher will not ssh-keyscan nodes after
they are booted. This might be needed if nodepool-launcher and
the nodes it launches are on different networks. The default
value is true.
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.
.. attr:: rate
:type: float seconds
@ -529,11 +532,14 @@ section of the configuration.
:type: bool
:default: true
Specify custom behavior of validation of SSH host keys. When
set to False, nodepool-launcher will not ssh-keyscan nodes after
they are booted. This might be needed if nodepool-launcher and
the nodes it launches are on different networks. The default
value is true.
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.
.. attr:: labels
:type: list

12
doc/source/gce.rst
View File

@ -205,10 +205,14 @@ section of the configuration.
:type: bool
:default: True
Specify custom behavior of validation of SSH host keys. When set to
False, nodepool-launcher will not ssh-keyscan nodes after they are
booted. This might be needed if nodepool-launcher and the nodes it
launches are on different networks. The default value is True.
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.
.. attr:: use-internal-ip
:default: False

26
doc/source/ibmvpc.rst
View File

@ -200,11 +200,14 @@ section of the configuration.
:type: bool
:default: true
Specify custom behavior of validation of SSH host keys. When
set to False, nodepool-launcher will not ssh-keyscan nodes after
they are booted. This might be needed if nodepool-launcher and
the nodes it launches are on different networks. The default
value is true.
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.
.. attr:: rate
:type: float seconds
@ -609,11 +612,14 @@ section of the configuration.
:type: bool
:default: true
Specify custom behavior of validation of SSH host keys. When
set to False, nodepool-launcher will not ssh-keyscan nodes after
they are booted. This might be needed if nodepool-launcher and
the nodes it launches are on different networks. The default
value is true.
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.
.. attr:: labels
:type: list

25
doc/source/openstack.rst
View File

@ -500,11 +500,14 @@ Selecting the OpenStack driver adds the following options to the
:type: bool
:default: True
Specify custom behavior of validation of SSH host keys. When
set to False, nodepool-launcher will not ssh-keyscan nodes
after they are booted. This might be needed if
nodepool-launcher and the nodes it launches are on different
networks. The default value is True.
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.
.. attr:: labels
:type: list
@ -593,10 +596,14 @@ Selecting the OpenStack driver adds the following options to the
:type: bool
:default: True
Specify custom behavior of validation of SSH host keys. When set to
False, nodepool-launcher will not ssh-keyscan nodes after they are
booted. This might be needed if nodepool-launcher and the nodes it
launches are on different networks. The default value is True.
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.
.. note:: This value will override the value for
:attr:`providers.[openstack].pools.host-key-checking`.

17
doc/source/static.rst
View File

@ -89,14 +89,17 @@ Selecting the static driver adds the following options to the
The list of labels associated with the node.
.. attr:: host-key-checking
:type: bool
:default: True
:type: bool
:default: True
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.
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.
.. attr:: timeout
:type: int