[OVN] Exception when deleting agent

[Kien Nguyen]

Call neutron API to delete ovn agent, it returns 204 but the agent isn't deleted. Check neutron-server.log find out there is an exception when deleting agent:

```
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event [-] Unexpected exception in notify_loop: TypeError: unhashable type: 'list'
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event Traceback (most recent call last):
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event File "/var/lib/kolla/venv/lib/python3.10/site-packages/ovsdbapp/event.py", line 177, in notify_loop
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event match.run(event, row, updates)
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event File "/var/lib/kolla/venv/lib/python3.10/site-packages/neutron/plugins/ml2/drivers/ovn/mech_driver/ovsdb/ovsdb_monitor.py", line 330, in run
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event n_agent.AgentCache().delete([row.external_ids['delete_agent']])
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event File "/var/lib/kolla/venv/lib/python3.10/site-packages/neutron/plugins/ml2/drivers/ovn/agent/neutron_agent.py", line 282, in delete
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event del self.agents[agent_id]
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event TypeError: unhashable type: 'list'
2024-12-04 09:21:15.303 838 ERROR ovsdbapp.event
2024-12-04 09:21:15.303 799 ERROR ovsdbapp.event [-] Unexpected exception in notify_loop: TypeError: unhashable type: 'list'
2024-12-04 09:21:15.303 799 ERROR ovsdbapp.event Traceback (most recent call last):
2024-12-04 09:21:15.303 799 ERROR ovsdbapp.event File "/var/lib/kolla/venv/lib/python3.10/site-packages/ovsdbapp/event.py", line 177, in notify_loop
2024-12-04 09:21:15.303 799 ERROR ovsdbapp.event match.run(event, row, updates)
2024-12-04 09:21:15.303 799 ERROR ovsdbapp.event File "/var/lib/kolla/venv/lib/python3.10/site-packages/neutron/plugins/ml2/drivers/ovn/mech_driver/ovsdb/ovsdb_monitor.py", line 330, in run
2024-12-04 09:21:15.303 799 ERROR ovsdbapp.event n_agent.AgentCache().delete([row.external_ids['delete_agent']])
2024-12-04 09:21:15.303 799 ERROR ovsdbapp.event File "/var/lib/kolla/venv/lib/python3.10/site-packages/neutron/plugins/ml2/drivers/ovn/agent/neutron_agent.py", line 282, in delete
2024-12-04 09:21:15.303 799 ERROR ovsdbapp.event del self.agents[agent_id]
2024-12-04 09:21:15.303 799 ERROR ovsdbapp.event TypeError: unhashable type: 'list'
```

[Brian Haley (brian-haley)]

An fyi that this was broken in 2023.2 with https://review.opendev.org/c/openstack/neutron/+/883607 so any fix will need to be cherry-picked back to there one it merges on master branch.

[Jimin Shin (jimin3-shin)]

I'm the reporter of https://bugs.launchpad.net/neutron/+bug/2091055 , can I fix this bug?

[Brian Haley (brian-haley)]

There was already a patch submitted, but I had asked Kien to submit a bug to track it since we need to backport.

https://review.opendev.org/c/openstack/neutron/+/936988

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/neutron/+/936988
Committed: https://opendev.org/openstack/neutron/commit/ce6e2d87c52a11ec76a0f6fb7deb25a3dc26cf86
Submitter: "Zuul (22348)"
Branch: master

commit ce6e2d87c52a11ec76a0f6fb7deb25a3dc26cf86
Author: Kien Nguyen Tuan <email address hidden>
Date: Wed Dec 4 11:10:47 2024 +0700

    Use the correct input for OVN agent deletion

    The key [1] is a list which is unhashable, therefore,
    it can not be passed as dict key [2]. It causes
    TypeError: unhashable type: 'list' exception.

    [1] https://github.com/openstack/neutron/blob/24e70ea166b517df78ca720b279e2520720de1e7/neutron/plugins/ml2/drivers/ovn/mech_driver/ovsdb/ovsdb_monitor.py#L332
    [2] https://github.com/openstack/neutron/blob/24e70ea166b517df78ca720b279e2520720de1e7/neutron/plugins/ml2/drivers/ovn/agent/neutron_agent.py#L281

    Closes-bug: #2091071
    Change-Id: I064d9b3e6cb72562a16030e1b31de45ddc8f487c

[Rodolfo Alonso (rodolfo-alonso-hernandez)]

Patch needs testing to prevent regressions.

[Jimin Shin (jimin3-shin)]

Is this bug fix going to be cherry-picked to 2024.1 branch?

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/neutron/+/937093
Committed: https://opendev.org/openstack/neutron/commit/9527821e124db50f93f9a9c4ffcb303a72b659a4
Submitter: "Zuul (22348)"
Branch: stable/2024.2

commit 9527821e124db50f93f9a9c4ffcb303a72b659a4
Author: Kien Nguyen Tuan <email address hidden>
Date: Wed Dec 4 11:10:47 2024 +0700

    Use the correct input for OVN agent deletion

    The key [1] is a list which is unhashable, therefore,
    it can not be passed as dict key [2]. It causes
    TypeError: unhashable type: 'list' exception.

    [1] https://github.com/openstack/neutron/blob/24e70ea166b517df78ca720b279e2520720de1e7/neutron/plugins/ml2/drivers/ovn/mech_driver/ovsdb/ovsdb_monitor.py#L332
    [2] https://github.com/openstack/neutron/blob/24e70ea166b517df78ca720b279e2520720de1e7/neutron/plugins/ml2/drivers/ovn/agent/neutron_agent.py#L281

    Closes-bug: #2091071
    Change-Id: I064d9b3e6cb72562a16030e1b31de45ddc8f487c
    (cherry picked from commit ce6e2d87c52a11ec76a0f6fb7deb25a3dc26cf86)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/neutron/+/937091
Committed: https://opendev.org/openstack/neutron/commit/81e38bc8972c7dbc7f15957aed91c5581fde4079
Submitter: "Zuul (22348)"
Branch: stable/2023.2

commit 81e38bc8972c7dbc7f15957aed91c5581fde4079
Author: Kien Nguyen Tuan <email address hidden>
Date: Wed Dec 4 11:10:47 2024 +0700

    Use the correct input for OVN agent deletion

    The key [1] is a list which is unhashable, therefore,
    it can not be passed as dict key [2]. It causes
    TypeError: unhashable type: 'list' exception.

    [1] https://github.com/openstack/neutron/blob/24e70ea166b517df78ca720b279e2520720de1e7/neutron/plugins/ml2/drivers/ovn/mech_driver/ovsdb/ovsdb_monitor.py#L332
    [2] https://github.com/openstack/neutron/blob/24e70ea166b517df78ca720b279e2520720de1e7/neutron/plugins/ml2/drivers/ovn/agent/neutron_agent.py#L281

    Closes-bug: #2091071
    Change-Id: I064d9b3e6cb72562a16030e1b31de45ddc8f487c
    (cherry picked from commit ce6e2d87c52a11ec76a0f6fb7deb25a3dc26cf86)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/neutron/+/937092
Committed: https://opendev.org/openstack/neutron/commit/75c5ef31915449cc478a884c6a1331dc2ba4e6c0
Submitter: "Zuul (22348)"
Branch: stable/2024.1

commit 75c5ef31915449cc478a884c6a1331dc2ba4e6c0
Author: Kien Nguyen Tuan <email address hidden>
Date: Wed Dec 4 11:10:47 2024 +0700

    Use the correct input for OVN agent deletion

    The key [1] is a list which is unhashable, therefore,
    it can not be passed as dict key [2]. It causes
    TypeError: unhashable type: 'list' exception.

    [1] https://github.com/openstack/neutron/blob/24e70ea166b517df78ca720b279e2520720de1e7/neutron/plugins/ml2/drivers/ovn/mech_driver/ovsdb/ovsdb_monitor.py#L332
    [2] https://github.com/openstack/neutron/blob/24e70ea166b517df78ca720b279e2520720de1e7/neutron/plugins/ml2/drivers/ovn/agent/neutron_agent.py#L281

    Closes-bug: #2091071
    Change-Id: I064d9b3e6cb72562a16030e1b31de45ddc8f487c
    (cherry picked from commit ce6e2d87c52a11ec76a0f6fb7deb25a3dc26cf86)

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron 23.4.0 Bobcat release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron 26.0.0.0rc1 Epoxy release candidate.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/neutron/+/944636

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/neutron/+/944636
Committed: https://opendev.org/openstack/neutron/commit/dd7c7f4b2bea8081ccd7408560068e29710f1ac0
Submitter: "Zuul (22348)"
Branch: master

commit dd7c7f4b2bea8081ccd7408560068e29710f1ac0
Author: Rodolfo Alonso Hernandez <email address hidden>
Date: Mon Mar 17 08:43:12 2025 +0000

    [OVN] Add ``AgentCache`` deletion test

    This patch adds a test for the patch [1] that fixes the
    ``AgentCache`` deletion call from the ``ChassisAgentDeleteEvent``
    event. This test avoids future regressions.

    [1]https://review.opendev.org/c/openstack/neutron/+/936988

    Closes-Bug: #2091071
    Change-Id: Iccd2d9aec131e2fea3a9cc29995dc4b867c20bb4

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron 25.2.0 Dalmatian release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron 24.2.0 Caracal release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron 27.0.0.0b1 Flamingo development milestone.