zuul/nodepool
Code Issues Proposed changes

Add image-id and image-name options to cloud-images

Browse Source 
The cloud-image name is currently used both to specify the image
in the cloud, and also as a cross-referencing key within the
nodepool config.  As such, it ends up being repeated within the config
(possibly quite often in large configurations).

Separate these functions so that an image can be identified once in
a cloud provider, and referenced from multiple labels with the internal
key.  This makes for improved readability in some cases (such as long
cloud image names, or specifying images by uuid), and reduces churn
when cloud image identifiers change.

Change-Id: I83f2902be4b9b73a949461b7f14da548066b9562
This commit is contained in:
James E. Blair 2017-06-14 15:18:07 -07:00
parent 279809ed1d
commit a9952312c2
4 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/configuration.rst
View File

@ -467,12 +467,27 @@ Example configuration::
``name``
Identifier to refer this cloud-image from :ref:`labels` section.
Since this name appears elsewhere in the nodepool configuration
file, you may want to use your own descriptive name here and use
one of ``image-id`` or ``image-name`` to specify the cloud image
so that if the image name or id changes on the cloud, the impact
to your Nodepool configuration will be minimal. However, if
neither of those attributes are provided, this is also assumed to
be the image name or ID in the cloud.
**optional**
``config-drive`` (boolean)
Whether config drive should be used for the cloud image. Default ``True``
``image-id`` (str)
If this is provided, it is used to select the image from the cloud
provider by ID, rather than name. Mutually exclusive with ``image-name``.
``image-name`` (str)
If this is provided, it is used to select the image from the cloud
provider by this name or ID. Mutually exclusive with ``image-id``.
.. _pool_labels:

2
nodepool/cmd/config_validator.py
View File

@ -67,6 +67,8 @@ class ConfigValidator:
provider_cloud_images = {
'name': str,
'config-drive': bool,
v.Exclusive('image-id', 'cloud-image-name-or-id'): str,
v.Exclusive('image-name', 'cloud-image-name-or-id'): str,
}
provider = {

2
nodepool/config.py
View File

@ -250,6 +250,8 @@ def loadConfig(config_path):
i = ProviderCloudImage()
i.name = image['name']
i.config_drive = image.get('config-drive', None)
i.image_id = image.get('image-id', None)
i.image_name = image.get('image-name', None)
p.cloud_images[i.name] = i
p.pools = {}
for pool in provider.get('pools', []):

7
nodepool/launcher.py
View File

@ -294,7 +294,12 @@ class NodeLauncher(threading.Thread, StatsReporter):
# image_external is what we use for OpenStack.
# image_id is what we record in the node for zk.
# image_name is what we log, so matches the config.
image_external = self._cloud_image.name
if self._cloud_image.image_id:
image_external = dict(id=self._cloud_image.image_id)
elif self._cloud_image.image_name:
image_external = self._cloud_image.image_name
else:
image_external = self._cloud_image.name
image_id = self._cloud_image.name
image_name = self._cloud_image.name