:seedling: Small refactoring in the ironic startup scripts and template by mchiappero · Pull Request #787 · metal3-io/ironic-image

mchiappero · 2025-11-14T08:59:35Z

What this PR does / why we need it:
This PR introduces a set of code refactoring, aiming at making the code more readable but extracting common logic that may become useful with future code additions. Most notably:

some mangling logic for IP addresses provided as input is now in its own function
the logic to lookup a the interface where an IP address is bound now lives in a dedicated function
In the future a matching utility function to retrieve the (first) IP address assigned to an interface will also be added, but implies more changes and will be introduced along with other functional changes.

Checklist:

Integration tests have been added, if necessary.

metal3-io-bot · 2025-11-14T08:59:47Z

Hi @mchiappero. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

elfosardo · 2025-11-14T10:17:42Z

/ok-to-test

Rozzii

Thanks for the refactor, I also not a fun of complex jinja templates so I support the idea but I would like to point out a few shellcheck issues and nits.

tuminoid · 2025-11-16T15:29:11Z

Same as #788 ?

elfosardo · 2025-11-18T16:38:24Z

+
+    if [[ "$#" -gt 2 ]]; then
+        echo "ERROR: ${FUNCNAME[0]}: too many parameters" >&2
+        return 1


not sure we want a return here, let's just use exit ?
maybe also for the other return statements
unless you really want to capture the exit code, then use echo, but I don't see the point

Whether to exit or not is not a decision to be made at this scope. The caller could, and probably should, use exit, but there is no homogeneous error handling in general across these scripts.

Sorry, I thought it was a different error test... Yes we could exit here in this case since it would be an invalid use of the function rather than invalid input. I don't mind, it's an unfortunate side effect of using the wrong tool for the job, it doesn't make much of a difference.

elfosardo · 2025-11-18T16:38:43Z

+        local PARSED_IP
+        PARSED_IP="$(parse_ip_address "${PROVISIONING_IP}")"
+        if [[ -z "${IRONIC_IP}" ]]; then
+            return 1


we should probably provide an error message here ?

By the way, we could wrap it in a "parse_or_die" sort of function, and avoid the test here.

By the way, we could wrap it in a "parse_or_die" sort of function, and avoid the test here.

E.g.:

parse_ip_address_or_die() { local RESULT RESULT="$(parse_ip_address $@)" if [[ -z "${RESULT}" ]]; then echo "ERROR: \"$@\" is not a valid IP address, failed to start ironic" exit 1 fi echo "${RESULT}" }

mchiappero · 2025-11-24T08:35:43Z

I think the code now is a good shape, let me know how we can unblock this, if there is any other change you would like to see.

Rozzii · 2025-11-25T11:32:13Z

/retest

tuminoid · 2025-11-26T05:42:11Z

/retest
/test metal3-centos-e2e-integration-test-main metal3-ubuntu-e2e-integration-test-main

mchiappero · 2025-11-26T11:23:58Z

Sorry, the grep bit in get_interface_of_ip is wrong for some reason, just noticing now. Let me fix it.

mchiappero · 2025-12-04T10:15:45Z

Sorry, the grep bit in get_interface_of_ip is wrong for some reason, just noticing now. Let me fix it.

Sorry for the delay, I'll change the grep command a bit, but I have tested the current version against a number of different containers, from SUSE images to Ubuntu without any problem. Let's see...

mchiappero · 2025-12-04T10:32:18Z

/retest

elfosardo

that was an oversight
please squash the commits

dtantsur · 2025-12-20T09:57:21Z

Honestly, the commits here seem to be reasonable deliniated, I'm not sure where the requests to squash them is coming from. Unlike in gerrit, we don't have any "single PR - single commit" rule.

dtantsur · 2025-12-22T16:10:11Z

 wait_for_interface_or_ip

+if [[ "$(echo "${LISTEN_ALL_INTERFACES}" | tr '[:upper:]' '[:lower:]')" == "true" ]]; then
+    export IRONIC_HOST_IP="::"


I wonder if this one will be easy to confuse with the existing IRONIC_URL_HOST. I'm not sure what a better alternative would be, but I'm worried about this change deepening the confusion. If we cannot find an alternative, I'd rather leave the "if" condition in the template.

Since IRONIC_URL_HOST can be different from the actual listening address, we could change IRONIC_HOST_IP to IRONIC_LISTEN_ADDRESS/IRONIC_BIND_ADDRESS (BTW, it could actually be a hostname too). And/or limit the scope of IRONIC_URL_HOST to ironic-common.sh, which is probably not a bad thing anyway. Along with some documentation.

I don't know if you guys had the chance to have a think about it, but the more I think about it the more I believe we should address this "globally": it's not very clear from the outside what controls what when it comes to IP addresses, for instance IRONIC_IP is not even mentioned in the README file. I can drop this specific commit from the PR, but if so we should take the chance to review the root problem of ease of understanding of which variable affects what and their documentation.

/cc @elfosardo @dtantsur

I would say let's address the naming of the IP variable separately. At least that would be my preference @mchiappero , I agree with you that the naming has to be handled globally and I think a separate independent PR would be the way to go for the sake of clarity and ease of reviewing.

Rozzii

I have one comment, apart from that I think the commits are reasonably separate from each other but belong to the general refactoring topic so I would not force squashing.

Rozzii · 2026-01-14T11:04:16Z

 wait_for_interface_or_ip

+if [[ "$(echo "${LISTEN_ALL_INTERFACES}" | tr '[:upper:]' '[:lower:]')" == "true" ]]; then
+    export IRONIC_HOST_IP="::"


I would say let's address the naming of the IP variable separately. At least that would be my preference @mchiappero , I agree with you that the naming has to be handled globally and I think a separate independent PR would be the way to go for the sake of clarity and ease of reviewing.

mchiappero · 2026-01-15T14:03:58Z

I have dropped the templating related commit and squashed the last two commits.

Edit: and rebased. Sorry for the confusion but the content of the commits has not changed.

Whether IRONIC_IP or PROVISIONIG_IP is provided to ironic-image, any such address should be checked for validity and, if needed, properly formatted. For this reason, this commit introduces parse_ip_address to be consumed inside wait_for_interface_or_ip. Signed-off-by: Marco Chiappero <marco.chiappero@suse.com>

Add a new get_interface_of_ip function that returns the name of the interface of a given IP, and use it to determine if the PROVISIONING_IP address is actually present on a network interface. This improves the code readability and enables additional debugging output. This function supersedes a similar check present in get_provisioning_interface, hence this commit also reverts commit 2742439. Signed-off-by: Marco Chiappero <marco.chiappero@suse.com>

mchiappero · 2026-01-21T21:12:10Z

We should be good to merge now, let me know so that we can start closing these old MR. Thank you!

Rozzii · 2026-02-03T10:37:51Z

/test metal3-centos-e2e-integration-test-main
/test metal3-ubuntu-e2e-integration-test-main

Rozzii

/approve

tuminoid · 2026-02-04T07:14:07Z

/retest

tuminoid · 2026-02-04T11:39:43Z

/retest
Maybe CI is fixed now...

mchiappero · 2026-02-10T16:51:16Z

I think we can now lift the block, @elfosardo?

elfosardo · 2026-02-17T09:19:12Z

/unhold

elfosardo · 2026-02-17T09:20:07Z

/lgtm

metal3-io-bot · 2026-02-17T09:21:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: elfosardo, Rozzii

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [Rozzii,elfosardo]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

…ackport Bug OCPBUGS-76547: Bump 4.20 ironic-image to include firmware update fixes

metal3-io-bot requested review from Rozzii and tuminoid November 14, 2025 08:59

metal3-io-bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 14, 2025

metal3-io-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 14, 2025

mchiappero mentioned this pull request Nov 14, 2025

⚠️ WIP: Fully support dual-stack/dual socket setups #716

Closed

metal3-io-bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 14, 2025

Rozzii reviewed Nov 14, 2025

View reviewed changes

mchiappero force-pushed the ironic-refactoring branch from 284ed37 to b81d0f9 Compare November 14, 2025 16:07

mchiappero commented Nov 14, 2025

View reviewed changes

Comment thread scripts/ironic-common.sh Outdated

mchiappero force-pushed the ironic-refactoring branch 2 times, most recently from 5eaafa0 to 8e987bf Compare November 14, 2025 17:37

tuminoid mentioned this pull request Nov 16, 2025

⚠️ Improve priority and validation of input variables consumed in wait_for_interface_or_ip #788

Open

2 tasks

mchiappero force-pushed the ironic-refactoring branch from 8e987bf to 50b86cd Compare November 17, 2025 19:57

elfosardo requested changes Nov 18, 2025

View reviewed changes

This was referenced Nov 18, 2025

✨ Support both IPv4 and IPv6 addresses in startup scripts and configuration files #789

Open

✨ Allow IRONIC_IP, IRONIC_IPV6 and URLs to be derived from a DNS record #791

Draft

mchiappero force-pushed the ironic-refactoring branch 3 times, most recently from 3c0fbf5 to 0979ec7 Compare November 19, 2025 08:29

mchiappero force-pushed the ironic-refactoring branch from 0979ec7 to 354f16c Compare December 4, 2025 10:27

elfosardo requested changes Dec 18, 2025

View reviewed changes

metal3-io-bot removed the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 18, 2025

dtantsur reviewed Dec 22, 2025

View reviewed changes

metal3-io-bot requested review from dtantsur and elfosardo January 14, 2026 06:22

Rozzii reviewed Jan 14, 2026

View reviewed changes

mchiappero force-pushed the ironic-refactoring branch from 06ff57e to 3b0da3e Compare January 15, 2026 13:56

mchiappero added 2 commits January 15, 2026 14:07

mchiappero force-pushed the ironic-refactoring branch from 3b0da3e to 8c478b4 Compare January 15, 2026 14:08

Rozzii self-requested a review January 29, 2026 08:03

Rozzii reviewed Feb 3, 2026

View reviewed changes

metal3-io-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 3, 2026

metal3-io-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 17, 2026

metal3-io-bot added the lgtm Indicates that a PR is ready to be merged. label Feb 17, 2026

elfosardo requested a review from tuminoid February 17, 2026 09:21

elfosardo approved these changes Feb 17, 2026

View reviewed changes

metal3-io-bot merged commit a2ad2fc into metal3-io:main Feb 17, 2026
14 checks passed

metal3-io-bot added this to the ironic-image - v35.0 milestone Feb 17, 2026

iurygregory pushed a commit to iurygregory/ironic-image that referenced this pull request Apr 10, 2026

Merge pull request metal3-io#787 from jacob-anders/fwupd-fixes-4.20-b…

56c9894

…ackport Bug OCPBUGS-76547: Bump 4.20 ironic-image to include firmware update fixes

Conversation

mchiappero commented Nov 14, 2025

Uh oh!

metal3-io-bot commented Nov 14, 2025

Uh oh!

elfosardo commented Nov 14, 2025

Uh oh!

Rozzii left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tuminoid commented Nov 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mchiappero Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mchiappero commented Nov 24, 2025

Uh oh!

Rozzii commented Nov 25, 2025

Uh oh!

tuminoid commented Nov 26, 2025

Uh oh!

mchiappero commented Nov 26, 2025

Uh oh!

mchiappero commented Dec 4, 2025

Uh oh!

mchiappero commented Dec 4, 2025

Uh oh!

elfosardo left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dtantsur commented Dec 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rozzii Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rozzii left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rozzii Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mchiappero commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mchiappero commented Jan 21, 2026

mchiappero Nov 19, 2025 •

edited

Loading

elfosardo left a comment •

edited

Loading

Rozzii Jan 14, 2026 •

edited

Loading

Rozzii left a comment •

edited

Loading

Rozzii Jan 14, 2026 •

edited

Loading

mchiappero commented Jan 15, 2026 •

edited

Loading