crash in cloud-init when using set-name on networkd renderer

[ubuntu-server-builder]

This bug was originally filed in Launchpad as LP: #1949407

Launchpad details

affected_projects = []
assignee = None
assignee_name = None
date_closed = 2022-02-15T21:54:26.283058+00:00
date_created = 2021-11-01T21:45:22.499204+00:00
date_fix_committed = 2021-11-09T19:44:10.903051+00:00
date_fix_released = 2022-02-15T21:54:26.283058+00:00
id = 1949407
importance = undecided
is_complete = True
lp_url = https://bugs.launchpad.net/cloud-init/+bug/1949407
milestone = None
owner = pradipdhara
owner_name = Pradip Dhara
private = False
status = fix_released
submitter = pradipdhara
submitter_name = Pradip Dhara
tags = []
duplicates = []

Launchpad user Pradip Dhara(pradipdhara) wrote on 2021-11-01T21:45:22.499204+00:00

When using set-name with a networkd renderer, we are hitting the following crash:
Traceback (most recent call last):
File "/usr/lib/python3.7/site-packages/cloudinit/cmd/main.py", line 682, in status_wrapper
ret = functor(name, args)
File "/usr/lib/python3.7/site-packages/cloudinit/cmd/main.py", line 391, in main_init
init.apply_network_config(bring_up=bool(mode != sources.DSMODE_LOCAL))
File "/usr/lib/python3.7/site-packages/cloudinit/stages.py", line 825, in apply_network_config
netcfg, bring_up=bring_up)
File "/usr/lib/python3.7/site-packages/cloudinit/distros/init.py", line 222, in apply_network_config
self._write_network_state(network_state)
File "/usr/lib/python3.7/site-packages/cloudinit/distros/init.py", line 125, in _write_network_state
renderer.render_network_state(network_state)
File "/usr/lib/python3.7/site-packages/cloudinit/net/networkd.py", line 220, in render_network_state
ret_dict = self._render_content(network_state)
File "/usr/lib/python3.7/site-packages/cloudinit/net/networkd.py", line 245, in _render_content
self.dhcp_domain(ns.config['ethernets'][name], cfg)
KeyError: 'eth0'

1. Tell us your cloud provider
   DataSourceVMware

2. Any appropriate cloud-init configuration you can provide us
   instance-id: "management-appliance-control-plane-0"
   local-hostname: "management-appliance-control-plane-0"
   wait-on-network:
   ipv4: false
   ipv6: false
   network:
   version: 2
   ethernets:
   id0:
   match:
   macaddress: "00:50:56:9d:14:42"
   set-name: "eth0"
   wakeonlan: true
   addresses:

   • "192.168.20.30/24"
     gateway4: "192.168.20.1"
     nameservers:
     addresses:
     • "127.0.0.53"
     • ""
     • ""

3. Perform the following on the system and attach it to this bug:
   Attached is the output of cloud-init collect-logs

[ubuntu-server-builder]

Launchpad user Pradip Dhara(pradipdhara) wrote on 2021-11-01T21:45:22.499204+00:00

Launchpad attachments: cloud-init.tar.gz

[ubuntu-server-builder]

Launchpad user Pradip Dhara(pradipdhara) wrote on 2021-11-01T21:46:36.283459+00:00

The proposed fix in netword.py is at:
pradipd@756742a

[ubuntu-server-builder]

Launchpad user James Falcon(falcojr) wrote on 2021-11-04T19:08:57.512284+00:00

See #1100 for the PR

[ubuntu-server-builder]

Launchpad user Andrew Kutz(akutz) wrote on 2021-11-05T15:34:43.031430+00:00

Submitted a PR at #1100

[ubuntu-server-builder]

Launchpad user Chad Smith(chad.smith) wrote on 2021-11-09T19:43:16.914457+00:00

Upstream commit landed with a fix for this issue. Thanks Andrew and Pradip!

fff6de4

[ubuntu-server-builder]

Launchpad user Brett Holman(holmanb) wrote on 2022-02-15T21:54:27.354930+00:00

This bug is believed to be fixed in cloud-init in version 22.1. If this is still a problem for you, please make a comment and set the state back to New

Thank you.