os-net-config throwing error when applying routes to interface/VLAN

[Dan Sneddon]

Fairly recent changes to os-net-config allow simple changes like IP, MTU, netmask, or routes to be changed on the fly without restarting the interface. However, route updates to interfaces and VLANs are still causing interfaces to be restarted due to an error.

The error encountered is:

Object "route add 172.33.9.0/26 via 172.20.1.59 dev vlan100" is unknown, try "ip help".

This can be duplicated by calling 'ip' with the parameters above passed as a string, such as:

# ip "route add 172.33.9.0/26 via 172.20.1.59 dev vlan100"

This appears to be due to an incorrect call to self.execute() where the command parameters are being passed as a string:

self.execute('Running ip %s' % command, ipcmd, command)

Instead, if we split the commands and pass it as a pointer to the list of args, that should work:

args = command.split()
self.execute('Running ip %s' % command, ipcmd, *args)

[Dan Sneddon (dsneddon)]

It turns out that this is a compound bug with two code errors. The first is the command-line parameters being passed as a string instead of a pointer to the args. The second is an incorrect filename in checking existing routes. This code:

            for interface in apply_routes:
                logger.debug('Applying routes for interface %s' % interface[0])
                commands = self.iproute2_route_commands(interface[0], interface[1])

is passing an interface name where it should be passing a filename. Here is the corrected code:

            for interface in apply_routes:
                logger.debug('Applying routes for interface %s' % interface[0])
                filename = self.root_dir + route_config_path(interface[1])
                commands = self.iproute2_route_commands(interface[0], filename)

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/642182

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/642182
Committed: https://git.openstack.org/cgit/openstack/os-net-config/commit/?id=e912b02c3bec61ec3af610820601cc24b5dc1cba
Submitter: Zuul
Branch: master

commit e912b02c3bec61ec3af610820601cc24b5dc1cba
Author: Dan Sneddon <email address hidden>
Date: Fri Mar 8 15:46:34 2019 -0800

    Fix os-net-config interface restarts when applying routes

    There is a bug in the os-net-config code that applies updates to
    existing routes. Instead of deleting routes that no longer exist
    in the config and adding routes on the fly that do, the process
    always fails so the interface gets restarted.

    This change fixes the external call to "/sbin/ip", but also
    fixes a bug where the name of the file containing the stored
    routes was being passed incorrectly. This caused os-net-config
    to always think there were no routes present, and to apply the
    new route without deleting the old route. This can lead to an
    error if the routes conflict.

    Change-Id: I4315e9812c641a667a1d5c6529cdba5d2f5bf640
    Closes-bug: 1819212

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/rocky
Review: https://review.openstack.org/642847

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/642847
Committed: https://git.openstack.org/cgit/openstack/os-net-config/commit/?id=21dfd95bbe8268ddc30cefc5ac5ea92a573d5155
Submitter: Zuul
Branch: stable/rocky

commit 21dfd95bbe8268ddc30cefc5ac5ea92a573d5155
Author: Dan Sneddon <email address hidden>
Date: Fri Mar 8 15:46:34 2019 -0800

    Fix os-net-config interface restarts when applying routes

    There is a bug in the os-net-config code that applies updates to
    existing routes. Instead of deleting routes that no longer exist
    in the config and adding routes on the fly that do, the process
    always fails so the interface gets restarted.

    This change fixes the external call to "/sbin/ip", but also
    fixes a bug where the name of the file containing the stored
    routes was being passed incorrectly. This caused os-net-config
    to always think there were no routes present, and to apply the
    new route without deleting the old route. This can lead to an
    error if the routes conflict.

    Change-Id: I4315e9812c641a667a1d5c6529cdba5d2f5bf640
    Closes-bug: 1819212
    (cherry picked from commit e912b02c3bec61ec3af610820601cc24b5dc1cba)

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/queens
Review: https://review.openstack.org/643041

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/os-net-config 10.3.0 release.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/643041
Committed: https://git.openstack.org/cgit/openstack/os-net-config/commit/?id=f26718f557f7bf8940d60795d42e4552917363e4
Submitter: Zuul
Branch: stable/queens

commit f26718f557f7bf8940d60795d42e4552917363e4
Author: Dan Sneddon <email address hidden>
Date: Fri Mar 8 15:46:34 2019 -0800

    Fix os-net-config interface restarts when applying routes

    There is a bug in the os-net-config code that applies updates to
    existing routes. Instead of deleting routes that no longer exist
    in the config and adding routes on the fly that do, the process
    always fails so the interface gets restarted.

    This change fixes the external call to "/sbin/ip", but also
    fixes a bug where the name of the file containing the stored
    routes was being passed incorrectly. This caused os-net-config
    to always think there were no routes present, and to apply the
    new route without deleting the old route. This can lead to an
    error if the routes conflict.

    Change-Id: I4315e9812c641a667a1d5c6529cdba5d2f5bf640
    Closes-bug: 1819212
    (cherry picked from commit e912b02c3bec61ec3af610820601cc24b5dc1cba)
    (cherry picked from commit 21dfd95bbe8268ddc30cefc5ac5ea92a573d5155)

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/os-net-config 9.4.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/os-net-config 8.5.0 release.