1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
# Copyright (c) 2011 OpenStack Foundation
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""
Scheduler host filters
"""
from oslo_log import log as logging
from nova import filters
LOG = logging.getLogger(__name__)
class BaseHostFilter(filters.BaseFilter):
"""Base class for host filters."""
# This is set to True if this filter should be run for rebuild.
# For example, with rebuild, we need to ask the scheduler if the
# existing host is still legit for a rebuild with the new image and
# other parameters. We care about running policy filters (i.e.
# ImagePropertiesFilter) but not things that check usage on the
# existing compute node, etc.
# This also means that filters marked with RUN_ON_REBUILD = True cannot
# filter on allocation candidates or need to handle the rebuild case
# specially.
RUN_ON_REBUILD = False
def _filter_one(self, obj, spec):
"""Return True if the object passes the filter, otherwise False."""
# Do this here so we don't get scheduler.filters.utils
from nova.scheduler import utils
if not self.RUN_ON_REBUILD and utils.request_is_rebuild(spec):
# If we don't filter, default to passing the host.
return True
else:
# We are either a rebuild filter, in which case we always run,
# or this request is not rebuild in which case all filters
# should run.
return self.host_passes(obj, spec)
def host_passes(self, host_state, filter_properties):
"""Return True if the HostState passes the filter, otherwise False.
Override this in a subclass.
"""
raise NotImplementedError()
class CandidateFilterMixin:
"""Mixing that helps to implement a Filter that needs to filter host by
Placement allocation candidates.
"""
def filter_candidates(self, host_state, filter_func):
"""Checks still viable allocation candidates by the filter_func and
keep only those that are passing it.
:param host_state: HostState object holding the list of still viable
allocation candidates
:param filter_func: A callable that takes an allocation candidate and
returns a True like object if the candidate passed the filter or a
False like object if it doesn't.
"""
good_candidates = []
for candidate in host_state.allocation_candidates:
LOG.debug(
f'{self.__class__.__name__} tries allocation candidate: '
f'{candidate}',
)
if filter_func(candidate):
LOG.debug(
f'{self.__class__.__name__} accepted allocation '
f'candidate: {candidate}',
)
good_candidates.append(candidate)
else:
LOG.debug(
f'{self.__class__.__name__} rejected allocation '
f'candidate: {candidate}',
)
host_state.allocation_candidates = good_candidates
return good_candidates
class HostFilterHandler(filters.BaseFilterHandler):
def __init__(self):
super(HostFilterHandler, self).__init__(BaseHostFilter)
def all_filters():
"""Return a list of filter classes found in this directory.
This method is used as the default for available scheduler filters
and should return a list of all filter classes available.
"""
return HostFilterHandler().get_all_classes()
|