openstack/openstack-ansible
Code Issues Proposed changes

Do not use underscores in container names

Browse Source 
According to RFC1034 [1], underscores are not legitimate symbols for
hostnames. We have a naming convention that historically uses underscores
in names of containers which leads to a complications in some cases/logic
Moreover, container actual hostnames are always different from their
inventory_hostnames, which might break some logic of external dependencies.

To change this historical issue, all new containers will have different
naming convention, where only dash will be used as a separator.
This will not touch already existing in inventory containers and they will
preserve their names for the time being.

[1] http://www.faqs.org/rfcs/rfc1034.html

Change-Id: Iedebf9935059ecfe8370f2a84ad52516cc93320e
This commit is contained in:
Dmitriy Rabotyagov 2024-01-12 13:30:40 +01:00 committed by Dmitriy Rabotyagov
parent f73cf9a0a9
commit d74d038032
2 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
osa_toolkit/generate.py
View File

@ -324,24 +324,26 @@ def _append_to_host_groups(inventory, container_type, assignment, host_type,
hdata[_keys] = options
def _add_container_hosts(assignment, config, container_name, container_type,
def _add_container_hosts(assignment, config, container_group, container_type,
inventory, properties):
"""Add a given container name and type to the hosts.
:param assignment: ``str`` Name of container component target
:param config: ``dict`` User defined information
:param container_name: ``str`` Name fo container
:param container_group: ``str`` Name of container group. Used for
defining container name
:param container_type: ``str`` Type of container
:param inventory: ``dict`` Living dictionary of inventory
:param properties: ``dict`` Dict of container properties
"""
physical_host_type = '{}_hosts'.format(container_type.split('_')[0])
container_name = re.sub(r'_', '-', f'{container_group}')
# If the physical host type is not in config return
if physical_host_type not in config:
return
for host_type in inventory[physical_host_type]['hosts']:
container_hosts = inventory[container_name]['hosts']
container_hosts = inventory[container_group]['hosts']
# If host_type is not in config do not append containers to it
if host_type not in config[physical_host_type]:
@ -358,11 +360,11 @@ def _add_container_hosts(assignment, config, container_name, container_type,
if no_containers:
properties['is_metal'] = True
container_affinity = affinity.get(container_name, 1)
container_affinity = affinity.get(container_group, 1)
# Ensures that container names are not longer than 63
# This section will ensure that we are not it by the following bug:
# https://bugzilla.mindrot.org/show_bug.cgi?id=2239
type_and_name = '{}_{}'.format(host_type, container_name)
type_and_name = '{}-{}'.format(host_type, container_name)
logger.debug("Generated container name %s", type_and_name)
max_hostname_len = 52
is_metal = properties.get('is_metal', False)
@ -396,7 +398,7 @@ def _add_container_hosts(assignment, config, container_name, container_type,
physical_host['container_types'] = container_host_type
# Add all of the containers into the inventory
logger.debug("Building containers for host %s", container_name)
logger.debug("Building containers for host %s", container_group)
_build_container_hosts(
container_affinity,
container_hosts,

13
releasenotes/notes/container_inventory_hostname-d51b794a3ab9c2b8.yaml Normal file
View File

@ -0,0 +1,13 @@
---
prelude: >
Naming convention for containers has changed in Ansible inventory
to match requirements defined by RFC1034.
From now on, all newly added containers will not have underscore (``_``)
symbol neither in their ``inventory_hostname`` nor in ``container_name``
This change does not touch or alter already existing containers in the
inventory.
In order to apply new naming convention for an existing environment you
need to delete containers on the host and from the inventory. After that
new container name will be generated and container can be created again.