"preferred" export path not updated in the CephFS/NFS driver

[Goutham Pacha Ravi]

Description
===========
As part of a fix for https://launchpad.net/bugs/2035137 ; the CephFS/NFS driver was improved to return preferred export paths. This is useful when transitioning from standalone NFS-Ganesha server to cephadm deployed NFS-Ganesha cluster. While multiple export paths are represented, there are a couple of issues with how this fix is working

Steps to reproduce
==================

A chronological list of steps which will help reproduce the issue I hit:
* Start with a devstack with cephadm/nfs
* Set "cephfs_ganesha_server_ip" to the same IP as the VIP assigned to the cephadm deployed nfs cluster

Expected result
===============
when "cephfs_ganesha_server_ip" is set to the same value as the IP address of the new NFS cluster, i expect the driver to ignore the IP duplication. This is clearly a misconfiguration; but not critical enough to fail startup.
it is expected that the export path through the cephadm deployed nfs cluster has its "preferred" metadata set to True

Actual result
=============
- I have redundant export paths, because the driver isn't deduplicating export server IPs
- exports pertaining to the nfs cluster aren't set as "preferred=True"

Environment
===========
1. trunk branch of manila; but this fix has been backported to antelope (2023.1)

2. Ceph/NFS with Ceph Reef

[Vida Haririan (vhariria)]

See additional triage information at https://meetings.opendev.org/meetings/manila/2024/manila.2024-02-15-15.00.log.html

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2024.2
Review: https://review.opendev.org/c/openstack/manila/+/929330

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2024.1
Review: https://review.opendev.org/c/openstack/manila/+/929331

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/924987
Committed: https://opendev.org/openstack/manila/commit/3e9d535be1799a2f2d590537125e3b7630dc4aee
Submitter: "Zuul (22348)"
Branch: master

commit 3e9d535be1799a2f2d590537125e3b7630dc4aee
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:19:37 2024 -0700

    Fix export location metadata updates by drivers

    Drivers can set arbitrary key=value metadata to export
    paths. The share manager now checks updates to previously
    set metadata when drivers update this metadata with the
    "ensure_shares" routine.

    Change-Id: Ia42de608ba056d71a1deae2c59bfb43a11672ab7
    Partial-Bug: #2053100

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2023.2
Review: https://review.opendev.org/c/openstack/manila/+/929352

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/928984
Committed: https://opendev.org/openstack/manila/commit/17088aa57af3ae2dd5a16e2e8558ec471d2c1cc5
Submitter: "Zuul (22348)"
Branch: master

commit 17088aa57af3ae2dd5a16e2e8558ec471d2c1cc5
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:23:19 2024 -0700

    Fix "preferred" export locations in the CephFS driver

    The CephFS driver used to set the "preferred"
    export path by sending back an export location
    model update; however, the "preferred" keyword
    is expected in the export location's metadata,
    not in the export location dict.

    Change-Id: Id2214412fe75456cdb52edb5ff261d32b063655f
    Closes-Bug: #2053100

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2024.2
Review: https://review.opendev.org/c/openstack/manila/+/930602

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2024.1
Review: https://review.opendev.org/c/openstack/manila/+/930643

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2023.2
Review: https://review.opendev.org/c/openstack/manila/+/930644

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2023.1
Review: https://review.opendev.org/c/openstack/manila/+/930645

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/929330
Committed: https://opendev.org/openstack/manila/commit/ffa4233b9c31cdc2a4ad90d162c6bc15d7dabde4
Submitter: "Zuul (22348)"
Branch: stable/2024.2

commit ffa4233b9c31cdc2a4ad90d162c6bc15d7dabde4
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:19:37 2024 -0700

    Fix export location metadata updates by drivers

    Drivers can set arbitrary key=value metadata to export
    paths. The share manager now checks updates to previously
    set metadata when drivers update this metadata with the
    "ensure_shares" routine.

    Change-Id: Ia42de608ba056d71a1deae2c59bfb43a11672ab7
    Partial-Bug: #2053100
    (cherry picked from commit 3e9d535be1799a2f2d590537125e3b7630dc4aee)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/930602
Committed: https://opendev.org/openstack/manila/commit/620933cdb98f3560a480923ba096a6215d7d0edd
Submitter: "Zuul (22348)"
Branch: stable/2024.2

commit 620933cdb98f3560a480923ba096a6215d7d0edd
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:23:19 2024 -0700

    Fix "preferred" export locations in the CephFS driver

    The CephFS driver used to set the "preferred"
    export path by sending back an export location
    model update; however, the "preferred" keyword
    is expected in the export location's metadata,
    not in the export location dict.

    Change-Id: Id2214412fe75456cdb52edb5ff261d32b063655f
    Closes-Bug: #2053100
    (cherry picked from commit 17088aa57af3ae2dd5a16e2e8558ec471d2c1cc5)

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/manila 19.0.0.0rc2 release candidate.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/929331
Committed: https://opendev.org/openstack/manila/commit/8a2f3a9db13c8db9d60d6a193f4bd937eb9d6ce6
Submitter: "Zuul (22348)"
Branch: stable/2024.1

commit 8a2f3a9db13c8db9d60d6a193f4bd937eb9d6ce6
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:19:37 2024 -0700

    Fix export location metadata updates by drivers

    Drivers can set arbitrary key=value metadata to export
    paths. The share manager now checks updates to previously
    set metadata when drivers update this metadata with the
    "ensure_shares" routine.

    Change-Id: Ia42de608ba056d71a1deae2c59bfb43a11672ab7
    Partial-Bug: #2053100
    (cherry picked from commit 3e9d535be1799a2f2d590537125e3b7630dc4aee)
    (cherry picked from commit ffa4233b9c31cdc2a4ad90d162c6bc15d7dabde4)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/930643
Committed: https://opendev.org/openstack/manila/commit/06da39f3733df0ae9b6d630d60aae2f0389af3b6
Submitter: "Zuul (22348)"
Branch: stable/2024.1

commit 06da39f3733df0ae9b6d630d60aae2f0389af3b6
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:23:19 2024 -0700

    Fix "preferred" export locations in the CephFS driver

    The CephFS driver used to set the "preferred"
    export path by sending back an export location
    model update; however, the "preferred" keyword
    is expected in the export location's metadata,
    not in the export location dict.

    Change-Id: Id2214412fe75456cdb52edb5ff261d32b063655f
    Closes-Bug: #2053100
    (cherry picked from commit 17088aa57af3ae2dd5a16e2e8558ec471d2c1cc5)
    (cherry picked from commit 620933cdb98f3560a480923ba096a6215d7d0edd)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/929352
Committed: https://opendev.org/openstack/manila/commit/8dc3f0c015c9ba43d37ea3bb42309db247493b8b
Submitter: "Zuul (22348)"
Branch: stable/2023.2

commit 8dc3f0c015c9ba43d37ea3bb42309db247493b8b
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:19:37 2024 -0700

    Fix export location metadata updates by drivers

    Drivers can set arbitrary key=value metadata to export
    paths. The share manager now checks updates to previously
    set metadata when drivers update this metadata with the
    "ensure_shares" routine.

    Change-Id: Ia42de608ba056d71a1deae2c59bfb43a11672ab7
    Partial-Bug: #2053100
    (cherry picked from commit 3e9d535be1799a2f2d590537125e3b7630dc4aee)
    (cherry picked from commit ffa4233b9c31cdc2a4ad90d162c6bc15d7dabde4)

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/2023.1
Review: https://review.opendev.org/c/openstack/manila/+/931290

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/930644
Committed: https://opendev.org/openstack/manila/commit/90c390013a61228341f59c46b173f2b78293ce58
Submitter: "Zuul (22348)"
Branch: stable/2023.2

commit 90c390013a61228341f59c46b173f2b78293ce58
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:23:19 2024 -0700

    Fix "preferred" export locations in the CephFS driver

    The CephFS driver used to set the "preferred"
    export path by sending back an export location
    model update; however, the "preferred" keyword
    is expected in the export location's metadata,
    not in the export location dict.

    Change-Id: Id2214412fe75456cdb52edb5ff261d32b063655f
    Closes-Bug: #2053100
    (cherry picked from commit 17088aa57af3ae2dd5a16e2e8558ec471d2c1cc5)
    (cherry picked from commit 620933cdb98f3560a480923ba096a6215d7d0edd)
    (cherry picked from commit 06da39f3733df0ae9b6d630d60aae2f0389af3b6)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/931290
Committed: https://opendev.org/openstack/manila/commit/c5e6c54329635b85e94dbd5884efea6a2af990c3
Submitter: "Zuul (22348)"
Branch: stable/2023.1

commit c5e6c54329635b85e94dbd5884efea6a2af990c3
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:19:37 2024 -0700

    Fix export location metadata updates by drivers

    Drivers can set arbitrary key=value metadata to export
    paths. The share manager now checks updates to previously
    set metadata when drivers update this metadata with the
    "ensure_shares" routine.

    Change-Id: Ia42de608ba056d71a1deae2c59bfb43a11672ab7
    Partial-Bug: #2053100
    (cherry picked from commit 3e9d535be1799a2f2d590537125e3b7630dc4aee)
    (cherry picked from commit ffa4233b9c31cdc2a4ad90d162c6bc15d7dabde4)
    (cherry picked from commit 8dc3f0c015c9ba43d37ea3bb42309db247493b8b)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/930645
Committed: https://opendev.org/openstack/manila/commit/221b560d875c6f8b8fa59a4f6c18dbe9460542fe
Submitter: "Zuul (22348)"
Branch: stable/2023.1

commit 221b560d875c6f8b8fa59a4f6c18dbe9460542fe
Author: Goutham Pacha Ravi <email address hidden>
Date: Wed Sep 11 22:23:19 2024 -0700

    Fix "preferred" export locations in the CephFS driver

    The CephFS driver used to set the "preferred"
    export path by sending back an export location
    model update; however, the "preferred" keyword
    is expected in the export location's metadata,
    not in the export location dict.

    Change-Id: Id2214412fe75456cdb52edb5ff261d32b063655f
    Closes-Bug: #2053100
    (cherry picked from commit 17088aa57af3ae2dd5a16e2e8558ec471d2c1cc5)
    (cherry picked from commit 620933cdb98f3560a480923ba096a6215d7d0edd)
    (cherry picked from commit 06da39f3733df0ae9b6d630d60aae2f0389af3b6)
    (cherry picked from commit 90c390013a61228341f59c46b173f2b78293ce58)

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/manila 18.2.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/manila 17.3.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/manila 16.3.0 Antelope release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/manila 20.0.0.0rc1 Epoxy release candidate.