[SRU] no option to override the fixed_subnet when creating a new cluster

[Felipe Reyes]

[Impact]

When a cluster template sets fixed_network and fixed_subnet and the user tries to create a new cluster using that template and decides to override the network, the fixed_subnet will inherited from the template, leaving an invalid configuration and later Neutron will refuse to allocate a port (since the subnet doesn't belong to the network). For more details see https://bugs.launchpad.net/ubuntu/+source/magnum/+bug/2038109

[Test Case]

1. Deploy an OpenStack cloud with the magnum-ui extension installed.
```
git clone https://opendev.org/openstack/charm-magnum-dashboard
cd charm-magnum-dashboard
git checkout stable/${VERSION} # ${VERSION} can be 2023.1, yoga or ussuri.
tox -e build
tox -e func-target -- ${BUNDLE} # ${BUNDLE} can be jammy-antelope, jammy-yoga or focal-ussuri
```

2. Create a new cluster template with a fixed_network test-net and fixed_subnet test-subnet
3. Create a new cluster, uncheck the option "Create new network" and pick a network different from test-net in the dropdown list.

Expected result:

The cluster gets created

Actual result:

The cluster creation fails, because the network configuration is invalid.

[ Where problems could occur ]

This is a javascript (Angular) code change, issues can be detected using the Web Developer Tools console where a javascript exeception may be raised.

Another source of problems is that this code change adds a handler when populate the list of subnets when the network is changed in the "Fixed Network" dropdown list, if there were issues the subnet list would be rendered empty.

[ Other Info ]

- This bug fix was merged during the 2024.1 (Caracal) development cycle - https://review.opendev.org/c/openstack/magnum-ui/+/898007
- The commit that fixes this issue is available since magnum-ui-14.0.0 - https://opendev.org/openstack/magnum-ui/commit/6f6c3db282fe2f0e08ad69c557eb153858b0164a
- This bug fix is not relevant for upgrades, it's purely UI fix
- This change is adding a new UI component, which on the surface may look like not suitable for a SRU, although the current UI induces users to get into a broken configuration for new clusters when overriding the cluster template's network.

[Felipe Reyes (freyes)]

https://review.opendev.org/c/openstack/magnum-ui/+/898007

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/magnum-ui 14.0.0.0rc1 release candidate.

[Felipe Reyes (freyes)]

Removing tasks for the releases that are EOL.

[Felipe Reyes (freyes)]

Marking Bobcat as won't fix since it's going EOL and this patch is not needed when doing upgrades.

[Felipe Reyes (freyes)]

Zed is EOL

[Felipe Reyes (freyes)]

marking magnum-ui as fix released, since the patch landed during the Caracal devel cycle and it's part of magnum-ui-14.0.0 - https://github.com/openstack/magnum-ui/commit/6f6c3db282fe2f0e08ad69c557eb153858b0164a

[Felipe Reyes (freyes)]

marking magnum-ui (ubuntu)/devel as invalid since the fix is part of the package shipped with Noble

[James Page (james-page)]

Sponsored for focal and jammy for SRU team review.

Uploaded to antelope UCA.

[Chris Halse Rogers (raof)]

How does this interact with https://bugs.launchpad.net/ubuntu/+source/magnum/+bug/2038109 ? It looks like maybe it does? Do these need to be tied together at all?

[James Page (james-page)]

Hello Felipe, or anyone else affected,

Accepted magnum-ui into antelope-proposed. The package will build now and be available in the Ubuntu Cloud Archive in a few hours, and then in the -proposed repository.

Please help us by testing this new package. To enable the -proposed repository:

  sudo add-apt-repository cloud-archive:antelope-proposed
  sudo apt-get update

Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, and change the tag from verification-antelope-needed to verification-antelope-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-antelope-failed. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

[Felipe Reyes (freyes)]

> How does this interact with https://bugs.launchpad.net/ubuntu/+source/magnum/+bug/2038109 ? It looks like > maybe it does? Do these need to be tied together at all?

this patch is a UI related change (web ui specifically), it doesn't rely on the patch provided on bug 2038109 . They are independent, but when both fixed they give a smoother UX.

We can override the subnet on the UI , the API supports this, it's just that the UI doesn't present to the user with a dialog to do it.

[Felipe Reyes (freyes)]

@raof , does my comment #14 address your concern?

[Timo Aaltonen (tjaalton)]

Hello Felipe, or anyone else affected,

Accepted magnum-ui into jammy-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/magnum-ui/10.0.0-0ubuntu3.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-jammy to verification-done-jammy. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-jammy. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Timo Aaltonen (tjaalton)]

Hello Felipe, or anyone else affected,

Accepted magnum-ui into focal-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/magnum-ui/6.0.1-0ubuntu1.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-focal to verification-done-focal. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-focal. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Felipe Reyes (freyes)]

The validation for Jammy has been successful, here it's the log of the changes made to upgrade python3-magnum-ui from the version in -updates to the one in -proposed, also attaching screenshots of the UI before and after the upgrade. The cluster was created successfully with the parameters/configuration expected.

root@juju-056d6d-zaza-ff13d5d59bc9-18:~# apt policy python3-magnum-ui
python3-magnum-ui:
  Installed: 10.0.0-0ubuntu3
  Candidate: 10.0.0-0ubuntu3
  Version table:
 *** 10.0.0-0ubuntu3 500
        500 http://availability-zone-3.clouds.archive.ubuntu.com/ubuntu jammy/universe amd64 Packages
        100 /var/lib/dpkg/status
root@juju-056d6d-zaza-ff13d5d59bc9-18:~# apt policy python3-magnum-ui
python3-magnum-ui:
  Installed: 10.0.0-0ubuntu3
  Candidate: 10.0.0-0ubuntu3.1
  Version table:
     10.0.0-0ubuntu3.1 500
        500 http://availability-zone-3.clouds.archive.ubuntu.com/ubuntu jammy-proposed/universe amd64 Packages
 *** 10.0.0-0ubuntu3 500
        500 http://availability-zone-3.clouds.archive.ubuntu.com/ubuntu jammy/universe amd64 Packages
        100 /var/lib/dpkg/status
root@juju-056d6d-zaza-ff13d5d59bc9-18:~# apt install --only-upgrade python3-magnum-ui
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
The following packages will be upgraded:
  python3-magnum-ui
1 upgraded, 0 newly installed, 0 to remove and 49 not upgraded.
Need to get 80.5 kB of archives.
After this operation, 1024 B of additional disk space will be used.
Get:1 http://availability-zone-3.clouds.archive.ubuntu.com/ubuntu jammy-proposed/universe amd64 python3-magnum-ui all 10.0.0-0ubuntu3.1 [80.5 kB]
Fetched 80.5 kB in 0s (657 kB/s)
(Reading database ... 119949 files and directories currently installed.)
Preparing to unpack .../python3-magnum-ui_10.0.0-0ubuntu3.1_all.deb ...
Unpacking python3-magnum-ui (10.0.0-0ubuntu3.1) over (10.0.0-0ubuntu3) ...
Setting up python3-magnum-ui (10.0.0-0ubuntu3.1) ...
Scanning processes...
Scanning candidates...
Scanning linux images...

Restarting services...
 systemctl restart packagekit.service polkit.service
Service restarts being deferred:
 systemctl restart networkd-dispatcher.service
 systemctl restart unattended-upgrades.service

No containers need to be restarted.

No user sessions are running outdated binaries.

No VM guests are running outdated hypervisor (qemu) binaries on this host.
root@juju-056d6d-zaza-ff13d5d59bc9-18:~# apt policy python3-magnum-ui
python3-magnum-ui:
  Installed: 10.0.0-0ubuntu3.1
  Candidate: 10.0.0-0ubuntu3.1
  Version table:
 *** 10.0.0-0ubuntu3.1 500
        500 http://availability-zone-3.clouds.archive.ubuntu.com/ubuntu jammy-proposed/universe amd64 Packages
        100 /var/lib/dpkg/status
     10.0.0-0ubuntu3 500
        500 http://availability-zone-3.clouds.archive.ubuntu.com/ubuntu jammy/universe amd64 Packages
root@juju-056d6d-zaza-ff13d5d59bc9-18:~# systemctl restart apache2
root@juju-056d6d-zaza-ff13d5d59bc9-18:~#

[Felipe Reyes (freyes)]

The validation for Focal has been successful, here it's the log of the changes made to upgrade python3-magnum-ui and screenshots of reproducing the issue and the issue fixed.

$ juju ssh magnum-dashboard/leader sudo -i
root@juju-aa3bad-zaza-0ac9fbf43d8c-18:~# apt policy python3-magnum-ui
python3-magnum-ui:
  Installed: 6.0.1-0ubuntu1
  Candidate: 6.0.1-0ubuntu1
  Version table:
 *** 6.0.1-0ubuntu1 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-updates/universe amd64 Packages
        100 /var/lib/dpkg/status
     5.2.0-1 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal/universe amd64 Packages
root@juju-aa3bad-zaza-0ac9fbf43d8c-18:~# vim /etc/apt/sources.list
root@juju-aa3bad-zaza-0ac9fbf43d8c-18:~# apt-get update
Get:1 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal InRelease [265 kB]
Get:2 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-updates InRelease [128 kB]
Get:3 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-proposed InRelease [277 kB]
Get:4 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-backports InRelease [128 kB]
Hit:5 http://security.ubuntu.com/ubuntu focal-security InRelease
Get:6 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-proposed/main amd64 Packages [305 kB]
Get:7 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-proposed/main Translation-en [61.2 kB]
Get:8 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-proposed/main amd64 c-n-f Metadata [1436 B]
Get:9 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-proposed/universe amd64 Packages [40.6 kB]
Get:10 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-proposed/universe Translation-en [20.0 kB]
Get:11 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-proposed/universe amd64 c-n-f Metadata [1772 B]
Fetched 1227 kB in 2s (637 kB/s)
Reading package lists... Done
root@juju-aa3bad-zaza-0ac9fbf43d8c-18:~# apt policy python3-magnum-ui
python3-magnum-ui:
  Installed: 6.0.1-0ubuntu1
  Candidate: 6.0.1-0ubuntu1.1
  Version table:
     6.0.1-0ubuntu1.1 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-proposed/universe amd64 Packages
 *** 6.0.1-0ubuntu1 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-updates/universe amd64 Packages
        100 /var/lib/dpkg/status
     5.2.0-1 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal/universe amd64 Packages
root@juju-aa3bad-zaza-0ac9fbf43d8c-18:~# apt install --only-upgrade python3-magnum-ui
Reading package lists... Done
Building dependency tree
Reading state information... Done
The following packages will be upgraded:
  python3-magnum-ui
1 upgraded, 0 newly installed, 0 to remove and 46 not upgraded.
Need to get 79.6 kB of archives.
After this operation, 2048 B of additional disk space will be used.
Get:1 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu focal-proposed/universe amd64 python3-magnum-ui all 6.0.1-0ubuntu1.1 [79.6 kB]
Fetched 79.6 kB in 0s (175 kB/s)
(Reading database ... 90440 files an...

[Felipe Reyes (freyes)]

The jammy-antelope validation was successful, the UI provides an option to set a subnet as shown in the attached images (before and after the upgrade to proposed), here it's the terminal log of the versions and upgrade process

$ juju ssh openstack-dashboard/leader sudo -i
root@juju-9e541a-jammy-antelope-18:~# apt policy python3-magnum-ui
python3-magnum-ui:
  Installed: 12.0.0-0ubuntu1~cloud0
  Candidate: 12.0.0-0ubuntu1~cloud0
  Version table:
 *** 12.0.0-0ubuntu1~cloud0 500
        500 http://ubuntu-cloud.archive.canonical.com/ubuntu jammy-updates/antelope/main amd64 Packages
        100 /var/lib/dpkg/status
     10.0.0-0ubuntu3 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu jammy/universe amd64 Packages
root@juju-9e541a-jammy-antelope-18:~# vim /etc/apt/sources.list
root@juju-9e541a-jammy-antelope-18:~# apt-get update -qq
root@juju-9e541a-jammy-antelope-18:~# apt policy python3-magnum-ui
python3-magnum-ui:
  Installed: 12.0.0-0ubuntu1~cloud0
  Candidate: 12.0.0-0ubuntu1~cloud0
  Version table:
 *** 12.0.0-0ubuntu1~cloud0 500
        500 http://ubuntu-cloud.archive.canonical.com/ubuntu jammy-updates/antelope/main amd64 Packages
        100 /var/lib/dpkg/status
     10.0.0-0ubuntu3.1 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu jammy-proposed/universe amd64 Packages
     10.0.0-0ubuntu3 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu jammy/universe amd64 Packages
root@juju-9e541a-jammy-antelope-18:~# apt install --only-upgrade python3-magnum-ui
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
python3-magnum-ui is already the newest version (12.0.0-0ubuntu1~cloud0).
0 upgraded, 0 newly installed, 0 to remove and 49 not upgraded.
root@juju-9e541a-jammy-antelope-18:~# vim /etc/apt/sources.list.d/cloud-archive.list
root@juju-9e541a-jammy-antelope-18:~# apt-get update -qq
root@juju-9e541a-jammy-antelope-18:~# apt policy python3-magnum-ui
python3-magnum-ui:
  Installed: 12.0.0-0ubuntu1~cloud0
  Candidate: 12.0.0-0ubuntu1.1~cloud0
  Version table:
     12.0.0-0ubuntu1.1~cloud0 500
        500 http://ubuntu-cloud.archive.canonical.com/ubuntu jammy-proposed/antelope/main amd64 Packages
 *** 12.0.0-0ubuntu1~cloud0 500
        500 http://ubuntu-cloud.archive.canonical.com/ubuntu jammy-updates/antelope/main amd64 Packages
        100 /var/lib/dpkg/status
     10.0.0-0ubuntu3.1 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu jammy-proposed/universe amd64 Packages
     10.0.0-0ubuntu3 500
        500 http://availability-zone-2.clouds.archive.ubuntu.com/ubuntu jammy/universe amd64 Packages
root@juju-9e541a-jammy-antelope-18:~# apt install --only-upgrade python3-magnum-ui
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
The following packages will be upgraded:
  python3-magnum-ui
1 upgraded, 0 newly installed, 0 to remove and 49 not upgraded.
Need to get 79.5 kB of archives.
After this operation, 1024 B of additional disk space will be used.
Get:1 http://ubuntu-cloud.archive.canonical.com/ubuntu jammy-proposed/antelope/main amd64 python3-magnum-ui a...

[Launchpad Janitor (janitor)]

This bug was fixed in the package magnum-ui - 6.0.1-0ubuntu1.1

---------------
magnum-ui (6.0.1-0ubuntu1.1) focal; urgency=medium

  * d/p/lp2038663.patch: Add option to override the fixed subnet when creating
    a new cluster (LP: #2038663).

 -- Felipe Reyes <email address hidden> Tue, 06 Aug 2024 09:49:23 +0100

[Chris Halse Rogers (raof)]

The verification of the Stable Release Update for magnum-ui has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

[Launchpad Janitor (janitor)]

This bug was fixed in the package magnum-ui - 10.0.0-0ubuntu3.1

---------------
magnum-ui (10.0.0-0ubuntu3.1) jammy; urgency=medium

  * d/gbp.conf: Create stable/yoga branch.
  * d/p/lp2038663.patch: Add option to override the fixed subnet when creating
    a new cluster (LP: #2038663).

 -- Felipe Reyes <email address hidden> Tue, 06 Aug 2024 09:49:52 +0100

[James Page (james-page)]

The verification of the Stable Release Update for magnum-ui has completed successfully and the package has now been released to -updates. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

[James Page (james-page)]

This bug was fixed in the package magnum-ui - 12.0.0-0ubuntu1.1~cloud0
---------------

 magnum-ui (12.0.0-0ubuntu1.1~cloud0) jammy-antelope; urgency=medium
 .
   [ Corey Bryant ]
   * d/gbp.conf: Create stable/2023.1 branch.
 .
   [ Felipe Reyes ]
   * d/p/lp2038663.patch: Add option to override the fixed subnet when creating
     a new cluster (LP: #2038663).

[James Page (james-page)]

Hello Felipe, or anyone else affected,

Accepted magnum-ui into yoga-proposed. The package will build now and be available in the Ubuntu Cloud Archive in a few hours, and then in the -proposed repository.

Please help us by testing this new package. To enable the -proposed repository:

  sudo add-apt-repository cloud-archive:yoga-proposed
  sudo apt-get update

Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, and change the tag from verification-yoga-needed to verification-yoga-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-yoga-failed. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

[James Page (james-page)]

Hello Felipe, or anyone else affected,

Accepted magnum-ui into ussuri-proposed. The package will build now and be available in the Ubuntu Cloud Archive in a few hours, and then in the -proposed repository.

Please help us by testing this new package. To enable the -proposed repository:

  sudo add-apt-repository cloud-archive:ussuri-proposed
  sudo apt-get update

Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, and change the tag from verification-ussuri-needed to verification-ussuri-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-ussuri-failed. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!