tempest/releasenotes/notes/deprecate-scheduler-available-filters-cbca2017ba3cf2aa.yaml
Artom Lifshitz 595ae16987 Deprecate available filters in favor of enabled
Previously, Tempest's default for scheduler_available_filters was
'all'. This was different from Nova's default enabled_filters, which
does *not* include all possible filters available in Nova. Thus, in a
deployment where both options were kept at their default value,
Tempest's is_scheduler_filter_enabled() would return True for all
filters, even if those filters weren't enabled in Nova. In addition,
the 'available' wording could be made clearer. This patch deprecates
scheduler_available_filters, replacing it with
scheduler_enabled_filters. The latter has its default value set to
Nova's enabled_filters default.

Related-bug: 1628443
Change-Id: I5c87865dc650d383ee006d36b6d52cdd90577ab9
2018-11-02 08:09:33 -04:00

14 lines
765 B
YAML

---
deprecations:
- |
The ``scheduler_available_filters`` option is being deprecated in favor of
``scheduler_enabled_filters``. The new name is more indicative of what the
option means. ``scheduler_enabled_filters``'s default value is set to the
default value of Nova's ``enabled_filters``.
``scheduler_available_filters``'s default was `all`. There was confusion
around this value. Sometimes it was understood to mean the default Nova
filters are enabled, other times it was understood to mean all filters are
enabled. While `all` is still allowed for ``scheduler_enabled_filters`` for
backwards compatibility, it is strongly recommended to provide an explicit
list of filters that matches what's configured in nova.conf.