Backups panel is visible even if enable_backup is False

[Dmitriy Rabotyagov]

Hi,

Volumes - Backup panel is visible even if OPENSTACK_CINDER_FEATURES = {'enable_backup': False} in local_settings.py

Meanwhile setting enable_backup to false removes an option to create backup of a volume in the volume drop-down options. But panel with backups itself stays visible for both admins and users.

As a work-around I use the following customization script:
import horizon
from django.conf import settings
if not getattr(settings, 'OPENSTACK_CINDER_FEATURES', {}).get('enable_backup', False):
    project = horizon.get_dashboard("project")
    backup = project.get_panel("backups")
    project.unregister(backup.__class__)

And for permanent fix I see the following decision. In openstack_dashboard/dashboards/project/backups/panel.py make the following changes:
...
+L16: from django.conf import settings
...
+L21: if not getattr(settings, 'OPENSTACK_CINDER_FEATURES', {}).get('enable_backup', False):
+L22: return False
...

== SRU details for Ubuntu =

[Impact]
See above.

[Test Case]
Juju deploy openstack and manually test that backup panel is not visible if enable_backup is set to False.

[Regression Potential]
Low. The patch has landed upstream in master, stable/rocky, and stable/queens. This patch has already landed in Ubuntu rocky as well.

[Trent Lloyd (lathiat)]

I can confirm this behavior, it has changed between Ocata and Queens (but is still present in the latest release also)

The "Volume Backups" used to be a tab on the "Volumes" page in Ocata. In Queens it has it's own panel on the left "Backups".

The old tab respected the enable_backup flag, but the new panel does not.

The enable_backup flag still controls the "Create Backup" option appearing in the dropdown menu for each volume; so the flag is still partially in effect.

[Trent Lloyd (lathiat)]

Looking at openstack_dashboard/api/cinder.py#volume_backup_supported (which checks the OPENSTACK_CINDER_FEATURES flag)

It notes
    # TODO(lcheng) Cinder does not expose the information if cinder
    # backup is configured yet. This is a workaround until that
    # capability is available.
    # https://bugs.launchpad.net/cinder/+bug/1334856

There is a comment on that bug about being able to query the services endpoint and an abandoned changeset to implement an alternative check. I cannot say whether either of those solutions are sensible just noting with respect to a fix for this bug it may be worth looking further at that issue.

Otherwise for a fix on the current situation I would perhaps call to openstack_dashboard.api.cinder.volume_backup_supported instead of checking the django.conf directly

[Dmitriy Rabotyagov (noonedeadpunk)]

Yep, you are absolutely right, that it's better to rely on openstack_dashboard.api.cinder.volume_backup_supported, I've just missed this function during investigation. As it seems that even if mentioned bug would be fixed, we could still rely on the output of this function in terms of cinder backup support.

[Edward Hope-Morley (hopem)]

Patch is here: https://review.openstack.org/#/c/594164/

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/605442
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=6c2225bab8b007023e031d829bc72e8e50e6f1df
Submitter: Zuul
Branch: master

commit 6c2225bab8b007023e031d829bc72e8e50e6f1df
Author: Edward Hope-Morley <email address hidden>
Date: Wed Sep 26 15:36:03 2018 +0100

    Add enabled check in Backups panel

    If enable_backup is False in OPENSTACK_CINDER_FEATURES
    then we should not display the backups panel.

    Change-Id: I276eebf0f11406bf354f5d8bbecef7b244d6d340
    Closes-Bug: #1778771

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/pike
Review: https://review.openstack.org/606052

[Corey Bryant (corey.bryant)]

This is fixed in openstack-dashboard 3:14.0.0-0ubuntu4 in cosmic/rocky.

[Launchpad Janitor (janitor)]

This bug was fixed in the package horizon - 3:14.0.0-0ubuntu4

---------------
horizon (3:14.0.0-0ubuntu4) cosmic; urgency=medium

  * d/p/add-enabled-check-in-backups-panel.patch: Cherry-picked from
    https://review.openstack.org/#/c/605715 to ensure Volume Backups panel
    is disabled if enable_backup is False (LP: #1778771).

 -- Corey Bryant <email address hidden> Mon, 01 Oct 2018 15:04:31 -0400

[Corey Bryant (corey.bryant)]

This bug was fixed in the package horizon - 3:14.0.0-0ubuntu4~cloud0
---------------

 horizon (3:14.0.0-0ubuntu4~cloud0) bionic-rocky; urgency=medium
 .
   * New update for the Ubuntu Cloud Archive.
 .
 horizon (3:14.0.0-0ubuntu4) cosmic; urgency=medium
 .
   * d/p/add-enabled-check-in-backups-panel.patch: Cherry-picked from
     https://review.openstack.org/#/c/605715 to ensure Volume Backups panel
     is disabled if enable_backup is False (LP: #1778771).

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/605715
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=19865eec5bc4a5a0ee402a55295dda2e52c2422c
Submitter: Zuul
Branch: stable/rocky

commit 19865eec5bc4a5a0ee402a55295dda2e52c2422c
Author: Edward Hope-Morley <email address hidden>
Date: Wed Sep 26 15:36:03 2018 +0100

    Add enabled check in Backups panel

    If enable_backup is False in OPENSTACK_CINDER_FEATURES
    then we should not display the backups panel.

    Change-Id: I276eebf0f11406bf354f5d8bbecef7b244d6d340
    Closes-Bug: #1778771
    (cherry picked from commit 6c2225bab8b007023e031d829bc72e8e50e6f1df)

[OpenStack Infra (hudson-openstack)]

Change abandoned by Edward Hope-Morley (<email address hidden>) on branch: master
Review: https://review.openstack.org/594164
Reason: Hi Seyeong, I think we can abandon this patch now since it is fixed in horizon upstream. The patch has been released to Stein and stable/rocky and will hopefully hit queens and pike so we can focus on the SRU instead. If you think we still need a charm patch let me know and we can discuss and reopen if necessary.

[Corey Bryant (corey.bryant)]

This has been uploaded to the bionic review queue where it is awaiting review by the SRU team: https://launchpad.net/ubuntu/bionic/+queue?queue_state=1&queue_text=

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/605994
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=5d1690da904ce4548887e3d11aa9b0687013b09d
Submitter: Zuul
Branch: stable/queens

commit 5d1690da904ce4548887e3d11aa9b0687013b09d
Author: Edward Hope-Morley <email address hidden>
Date: Wed Sep 26 15:36:03 2018 +0100

    Add enabled check in Backups panel

    If enable_backup is False in OPENSTACK_CINDER_FEATURES
    then we should not display the backups panel.

    Change-Id: I276eebf0f11406bf354f5d8bbecef7b244d6d340
    Closes-Bug: #1778771
    (cherry picked from commit 6c2225bab8b007023e031d829bc72e8e50e6f1df)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/606052
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=02e405dcac62a08b1029af730881036554d971dd
Submitter: Zuul
Branch: stable/pike

commit 02e405dcac62a08b1029af730881036554d971dd
Author: Edward Hope-Morley <email address hidden>
Date: Wed Sep 26 15:36:03 2018 +0100

    Add enabled check in Backups panel

    If enable_backup is False in OPENSTACK_CINDER_FEATURES
    then we should not display the backups panel.

    Change-Id: I276eebf0f11406bf354f5d8bbecef7b244d6d340
    Closes-Bug: #1778771
    (cherry picked from commit 6c2225bab8b007023e031d829bc72e8e50e6f1df)

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/horizon 14.0.1 release.

[Łukasz Zemczak (sil2100)]

Hello Dmitriy, or anyone else affected,

Accepted horizon into bionic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/horizon/3:13.0.1-0ubuntu3 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 and change the tag from verification-needed-bionic to verification-done-bionic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-bionic. 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.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/horizon 15.0.0.0b1 development milestone.

[Edward Hope-Morley (hopem)]

I have tested the bionic-proposed build using the provided testcase i.e. deploy openstack-dashbaord with enable_backup set to False and check that the backups panel is not there. I then set enable_backup to true and confirmed that the backups panel appears.

[Launchpad Janitor (janitor)]

This bug was fixed in the package horizon - 3:13.0.1-0ubuntu3

---------------
horizon (3:13.0.1-0ubuntu3) bionic; urgency=medium

  * d/p/add-enabled-check-in-backups-panel.patch: Cherry-picked from
    https://review.openstack.org/#/c/605994/ to ensure Volume Backups panel
    is disabled if enable_backup is False (LP: #1778771).

 -- Corey Bryant <email address hidden> Mon, 15 Oct 2018 10:03:18 -0400

[Steve Langasek (vorlon)]

The verification of the Stable Release Update for horizon has completed successfully and the package has now been 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.

[Corey Bryant (corey.bryant)]

Hello Dmitriy, or anyone else affected,

Accepted horizon into queens-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:queens-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-queens-needed to verification-queens-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-queens-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!

[Edward Hope-Morley (hopem)]

I have tested the xenial-proposed/queens build using the provided testcase i.e. deploy openstack-dashboard with enable_backup set to False and check that the backups panel is not there. I then set enable_backup to true and confirmed that the backups panel appears.

[Corey Bryant (corey.bryant)]

The verification of the Stable Release Update for horizon 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.

[Corey Bryant (corey.bryant)]

This bug was fixed in the package horizon - 3:13.0.1-0ubuntu3~cloud0
---------------

 horizon (3:13.0.1-0ubuntu3~cloud0) xenial-queens; urgency=medium
 .
   * New update for the Ubuntu Cloud Archive.
 .
 horizon (3:13.0.1-0ubuntu3) bionic; urgency=medium
 .
   * d/p/add-enabled-check-in-backups-panel.patch: Cherry-picked from
     https://review.openstack.org/#/c/605994/ to ensure Volume Backups panel
     is disabled if enable_backup is False (LP: #1778771).

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/horizon 13.0.2 release.