[Bug 2141119] Re: [SRU] Don't fail if a provider driver cannot be loaded in Octavia API

[Zachary Raines]

** Description changed:

  [ Impact ]
  
  Currently, when the enabled_provider_drivers setting is not correctly
  configured, e.g., it contains a non-existing driver, or when a provider
  driver fails to load, octavia as a whole errors out and the API becomes
  unreachable. This means that if there is a transient problem with a
  provider, or a misconfiguration, even if that provider is not being
  actively used, the other functioning drivers cannot be used.
  
- 
  [ Test Plan ]
  
  1. Deploy openstack with octavia and the amphora and ovn-plugin providers.
-   - For Yoga-Caracal, this can be done using Charmed
-     OpenStack.
-   - For Caracal-Epoxy this can be done with sunbeam.
+   - For Yoga-Caracal, this can be done using Charmed
+     OpenStack.
+   - For Caracal-Epoxy this can be done with sunbeam.
  
- 2. Misconfigure the ovn-provider by setting `ovn-provider` by setting
- `ovn.ovn_nb_connection=6666` in `/etc/octavia/octavia.conf`.
+ 2. Manually break the ovn-provider by adding an error to the __init__ method of
+    the provider class.
  
  3. Confirm that octavia errors out on start.
  
  4. Refresh octavia with patched version.
  
- 5. Confirm that octavia comes up with the amphora provider.
+ 5. Repeat 2
+ 
+ 6. Confirm that octavia comes up with the amphora provider.
  
  [ Where problems could occur ]
  
  This patch implements the strategy described in [0], skipping over
  drivers which error while allowing others to proceed with
  initialization. The Octavia API service now removes the failing
  driver(s) from the enabled list, and the other provider drivers remain
  functional.
  
  Because driver initialization errors are no longer fatal, it is easier
  for user to miss problems with their configuration. Errors are still
  logged, however, and misconfigured drivers will be missing from the
  provider list.
  
  [ Other Info ]
  
  This patch has been merged upstream into master, stable/*, and
  unmaintained/*.
  
  Story for this patch: https://storyboard.openstack.org/#!/story/2008710
  Upstream patch: https://review.opendev.org/c/openstack/octavia/+/780215

-- 
You received this bug notification because you are a member of Ubuntu
OpenStack, which is subscribed to Ubuntu Cloud Archive.
https://bugs.launchpad.net/bugs/2141119

Title:
  [SRU] Don't fail if a provider driver cannot be loaded in Octavia API

Status in Ubuntu Cloud Archive:
  New
Status in Ubuntu Cloud Archive antelope series:
  New
Status in Ubuntu Cloud Archive bobcat series:
  New
Status in Ubuntu Cloud Archive caracal series:
  New
Status in Ubuntu Cloud Archive dalmatian series:
  New
Status in Ubuntu Cloud Archive epoxy series:
  New
Status in Ubuntu Cloud Archive flamingo series:
  New
Status in Ubuntu Cloud Archive gazpacho series:
  New
Status in Ubuntu Cloud Archive yoga series:
  New
Status in Ubuntu Cloud Archive zed series:
  New
Status in octavia package in Ubuntu:
  Fix Released
Status in octavia source package in Jammy:
  New
Status in octavia source package in Noble:
  New
Status in octavia source package in Questing:
  New
Status in octavia source package in Resolute:
  Fix Released

Bug description:
  [ Impact ]

  Currently, when the enabled_provider_drivers setting is not correctly
  configured, e.g., it contains a non-existing driver, or when a
  provider driver fails to load, octavia as a whole errors out and the
  API becomes unreachable. This means that if there is a transient
  problem with a provider, or a misconfiguration, even if that provider
  is not being actively used, the other functioning drivers cannot be
  used.

  [ Test Plan ]

  1. Deploy openstack with octavia and the amphora and ovn-plugin providers.
    - For Yoga-Caracal, this can be done using Charmed
      OpenStack.
    - For Caracal-Epoxy this can be done with sunbeam.

  2. Manually break the ovn-provider by adding an error to the __init__ method of
     the provider class.

  3. Confirm that octavia errors out on start.

  4. Refresh octavia with patched version.

  5. Repeat 2

  6. Confirm that octavia comes up with the amphora provider.

  [ Where problems could occur ]

  This patch implements the strategy described in [0], skipping over
  drivers which error while allowing others to proceed with
  initialization. The Octavia API service now removes the failing
  driver(s) from the enabled list, and the other provider drivers remain
  functional.

  Because driver initialization errors are no longer fatal, it is easier
  for user to miss problems with their configuration. Errors are still
  logged, however, and misconfigured drivers will be missing from the
  provider list.

  [ Other Info ]

  This patch has been merged upstream into master, stable/*, and
  unmaintained/*.

  Story for this patch: https://storyboard.openstack.org/#!/story/2008710
  Upstream patch: https://review.opendev.org/c/openstack/octavia/+/780215

To manage notifications about this bug go to:
https://bugs.launchpad.net/cloud-archive/+bug/2141119/+subscriptions