missing config option to cleanup instance dir of evacuated instances

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/charm-nova-compute/+/882886

We had a discussion with Rodrigo, Dan and Alex where we agreed that the path forward to fix this issue is the following:

Check if nova-compute is related to ceph-mon and configured with libvirt-image-backend=rbd [0], then [workarounds].ensure_libvirt_rbd_instance_dir_cleanup is set to True, unless instances-path[1] is set to a non-default value where the charm will go into blocked state informing the user about the unsupported configuration.

We agreed this will improve the situation for operators using Charmed OpenStack while still putting safeguards to minimize the risk of losing data.

[0] https://charmhub.io/nova-compute/configure#libvirt-image-backend
[1] https://charmhub.io/nova-compute/configure#instances-path

Hi Rodrigo, I just added a task for the charm-guide, so this bug fix receives a new entry in the release notes. Thanks

Fix proposed to branch: stable/2023.1
Review: https://review.opendev.org/c/openstack/charm-nova-compute/+/890659

Reviewed: https://review.opendev.org/c/openstack/charm-nova-compute/+/890659
Committed: https://opendev.org/openstack/charm-nova-compute/commit/003f6b6d70fe7998c57095abb6ac97d97cd2dff1
Submitter: "Zuul (22348)"
Branch: stable/2023.1

commit 003f6b6d70fe7998c57095abb6ac97d97cd2dff1
Author: Rodrigo Barbieri <email address hidden>
Date: Wed May 10 13:33:08 2023 -0300

    Set nova config for rbd instance folder cleanup after evacuations

    After evacuations and revert resizes when using rbd storage backend,
    the instance folder is usually left behind and causes issues when
    migrating the instance back to the host.
    With the config option set, the nova-compute service will cleanup
    those folders as part of the periodic checks that run for instances
    that have been evacuated/migrated.

    Closes-bug: #2019141
    Change-Id: I846ccb0a95d04139b41fdad6cbf465d303d6cc09
    (cherry picked from commit e61d89aa47cba71bb4dda12d836fde8a8fa7092c)

Fix proposed to branch: stable/zed
Review: https://review.opendev.org/c/openstack/charm-nova-compute/+/892299

Fix proposed to branch: stable/yoga
Review: https://review.opendev.org/c/openstack/charm-nova-compute/+/892334

Reviewed: https://review.opendev.org/c/openstack/charm-nova-compute/+/892299
Committed: https://opendev.org/openstack/charm-nova-compute/commit/f6a2da6d187d6fe53195e7b123e845e2f80ebb4d
Submitter: "Zuul (22348)"
Branch: stable/zed

commit f6a2da6d187d6fe53195e7b123e845e2f80ebb4d
Author: Rodrigo Barbieri <email address hidden>
Date: Wed May 10 13:33:08 2023 -0300

    Set nova config for rbd instance folder cleanup after evacuations

    After evacuations and revert resizes when using rbd storage backend,
    the instance folder is usually left behind and causes issues when
    migrating the instance back to the host.
    With the config option set, the nova-compute service will cleanup
    those folders as part of the periodic checks that run for instances
    that have been evacuated/migrated.

    Closes-bug: #2019141
    Change-Id: I846ccb0a95d04139b41fdad6cbf465d303d6cc09
    (cherry picked from commit e61d89aa47cba71bb4dda12d836fde8a8fa7092c)
    (cherry picked from commit 003f6b6d70fe7998c57095abb6ac97d97cd2dff1)

Reviewed: https://review.opendev.org/c/openstack/charm-nova-compute/+/892334
Committed: https://opendev.org/openstack/charm-nova-compute/commit/1ddfe5e6c212804ac3623dc4782fa7e51da840a0
Submitter: "Zuul (22348)"
Branch: stable/yoga

commit 1ddfe5e6c212804ac3623dc4782fa7e51da840a0
Author: Rodrigo Barbieri <email address hidden>
Date: Wed May 10 13:33:08 2023 -0300

    Set nova config for rbd instance folder cleanup after evacuations

    After evacuations and revert resizes when using rbd storage backend,
    the instance folder is usually left behind and causes issues when
    migrating the instance back to the host.
    With the config option set, the nova-compute service will cleanup
    those folders as part of the periodic checks that run for instances
    that have been evacuated/migrated.

    Closes-bug: #2019141
    Change-Id: I846ccb0a95d04139b41fdad6cbf465d303d6cc09
    (cherry picked from commit e61d89aa47cba71bb4dda12d836fde8a8fa7092c)
    (cherry picked from commit 003f6b6d70fe7998c57095abb6ac97d97cd2dff1)
    (cherry picked from commit cfafa8cf5f2d880635e66e9620ca9d0334375942)

Fix proposed to branch: stable/xena
Review: https://review.opendev.org/c/openstack/charm-nova-compute/+/897322

Fix proposed to branch: stable/wallaby
Review: https://review.opendev.org/c/openstack/charm-nova-compute/+/897323

Fix proposed to branch: stable/victoria
Review: https://review.opendev.org/c/openstack/charm-nova-compute/+/897324

Fix proposed to branch: stable/ussuri
Review: https://review.opendev.org/c/openstack/charm-nova-compute/+/897325

Reviewed: https://review.opendev.org/c/openstack/charm-nova-compute/+/897322
Committed: https://opendev.org/openstack/charm-nova-compute/commit/d3e4cc31c63e157efdc3e548a44c3f4c8f2bcdcd
Submitter: "Zuul (22348)"
Branch: stable/xena

commit d3e4cc31c63e157efdc3e548a44c3f4c8f2bcdcd
Author: Rodrigo Barbieri <email address hidden>
Date: Wed May 10 13:33:08 2023 -0300

    Set nova config for rbd instance folder cleanup after evacuations

    After evacuations and revert resizes when using rbd storage backend,
    the instance folder is usually left behind and causes issues when
    migrating the instance back to the host.
    With the config option set, the nova-compute service will cleanup
    those folders as part of the periodic checks that run for instances
    that have been evacuated/migrated.

    Closes-bug: #2019141
    Change-Id: I846ccb0a95d04139b41fdad6cbf465d303d6cc09
    (cherry picked from commit e61d89aa47cba71bb4dda12d836fde8a8fa7092c)
    (cherry picked from commit 003f6b6d70fe7998c57095abb6ac97d97cd2dff1)
    (cherry picked from commit cfafa8cf5f2d880635e66e9620ca9d0334375942)
    (cherry picked from commit 1ddfe5e6c212804ac3623dc4782fa7e51da840a0)

Reviewed: https://review.opendev.org/c/openstack/charm-nova-compute/+/897323
Committed: https://opendev.org/openstack/charm-nova-compute/commit/be845826f95f812370b33fbdd22b6fd70ebb217f
Submitter: "Zuul (22348)"
Branch: stable/wallaby

commit be845826f95f812370b33fbdd22b6fd70ebb217f
Author: Rodrigo Barbieri <email address hidden>
Date: Wed May 10 13:33:08 2023 -0300

    Set nova config for rbd instance folder cleanup after evacuations

    After evacuations and revert resizes when using rbd storage backend,
    the instance folder is usually left behind and causes issues when
    migrating the instance back to the host.
    With the config option set, the nova-compute service will cleanup
    those folders as part of the periodic checks that run for instances
    that have been evacuated/migrated.

    Closes-bug: #2019141
    Change-Id: I846ccb0a95d04139b41fdad6cbf465d303d6cc09
    (cherry picked from commit e61d89aa47cba71bb4dda12d836fde8a8fa7092c)
    (cherry picked from commit 003f6b6d70fe7998c57095abb6ac97d97cd2dff1)
    (cherry picked from commit cfafa8cf5f2d880635e66e9620ca9d0334375942)
    (cherry picked from commit 1ddfe5e6c212804ac3623dc4782fa7e51da840a0)
    (cherry picked from commit d3e4cc31c63e157efdc3e548a44c3f4c8f2bcdcd)

Reviewed: https://review.opendev.org/c/openstack/charm-nova-compute/+/897324
Committed: https://opendev.org/openstack/charm-nova-compute/commit/f1ff0d55b8ebcb0e3b6417d9fcd08da334df52cf
Submitter: "Zuul (22348)"
Branch: stable/victoria

commit f1ff0d55b8ebcb0e3b6417d9fcd08da334df52cf
Author: Rodrigo Barbieri <email address hidden>
Date: Wed May 10 13:33:08 2023 -0300

    Set nova config for rbd instance folder cleanup after evacuations

    After evacuations and revert resizes when using rbd storage backend,
    the instance folder is usually left behind and causes issues when
    migrating the instance back to the host.
    With the config option set, the nova-compute service will cleanup
    those folders as part of the periodic checks that run for instances
    that have been evacuated/migrated.

    Closes-bug: #2019141
    Change-Id: I846ccb0a95d04139b41fdad6cbf465d303d6cc09
    (cherry picked from commit e61d89aa47cba71bb4dda12d836fde8a8fa7092c)
    (cherry picked from commit 003f6b6d70fe7998c57095abb6ac97d97cd2dff1)
    (cherry picked from commit cfafa8cf5f2d880635e66e9620ca9d0334375942)
    (cherry picked from commit 1ddfe5e6c212804ac3623dc4782fa7e51da840a0)
    (cherry picked from commit d3e4cc31c63e157efdc3e548a44c3f4c8f2bcdcd)
    (cherry picked from commit be845826f95f812370b33fbdd22b6fd70ebb217f)

Reviewed: https://review.opendev.org/c/openstack/charm-nova-compute/+/897325
Committed: https://opendev.org/openstack/charm-nova-compute/commit/db6fad9810388f7edf1aa2725bb30f82137dd063
Submitter: "Zuul (22348)"
Branch: stable/ussuri

commit db6fad9810388f7edf1aa2725bb30f82137dd063
Author: Rodrigo Barbieri <email address hidden>
Date: Wed May 10 13:33:08 2023 -0300

    Set nova config for rbd instance folder cleanup after evacuations

    After evacuations and revert resizes when using rbd storage backend,
    the instance folder is usually left behind and causes issues when
    migrating the instance back to the host.
    With the config option set, the nova-compute service will cleanup
    those folders as part of the periodic checks that run for instances
    that have been evacuated/migrated.

    Closes-bug: #2019141
    Change-Id: I846ccb0a95d04139b41fdad6cbf465d303d6cc09
    (cherry picked from commit e61d89aa47cba71bb4dda12d836fde8a8fa7092c)
    (cherry picked from commit 003f6b6d70fe7998c57095abb6ac97d97cd2dff1)
    (cherry picked from commit cfafa8cf5f2d880635e66e9620ca9d0334375942)
    (cherry picked from commit 1ddfe5e6c212804ac3623dc4782fa7e51da840a0)
    (cherry picked from commit d3e4cc31c63e157efdc3e548a44c3f4c8f2bcdcd)
    (cherry picked from commit be845826f95f812370b33fbdd22b6fd70ebb217f)
    (cherry picked from commit f1ff0d55b8ebcb0e3b6417d9fcd08da334df52cf)

Related fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/charm-guide/+/900405

Reviewed: https://review.opendev.org/c/openstack/charm-guide/+/900405
Committed: https://opendev.org/openstack/charm-guide/commit/271d39c91d480a669a5a46f303932a4d8ccbb1c7
Submitter: "Zuul (22348)"
Branch: master

commit 271d39c91d480a669a5a46f303932a4d8ccbb1c7
Author: Alex Kavanagh <email address hidden>
Date: Wed Nov 8 12:25:10 2023 +0200

    Add release note for bug: 2019141

    Add note explaining impact of change of 2019141 on the operation of the
    nova-compute service with rbd storage.

    Change-Id: I9319c80af0159d28a5ef845216ee0aed5d78f33d
    Related-Bug: #2019141