|
1
|
|
|
"""Module for handling the deployment of maintenance windows.""" |
|
2
|
1 |
|
from collections import Counter |
|
3
|
1 |
|
from dataclasses import dataclass |
|
4
|
1 |
|
from itertools import chain |
|
5
|
|
|
|
|
6
|
1 |
|
from kytos.core.common import EntityStatus |
|
7
|
1 |
|
from kytos.core.controller import Controller |
|
8
|
1 |
|
from kytos.core.events import KytosEvent |
|
9
|
1 |
|
from kytos.core.switch import Switch |
|
10
|
1 |
|
from kytos.core.interface import Interface |
|
11
|
1 |
|
from kytos.core.link import Link |
|
12
|
|
|
|
|
13
|
1 |
|
from ..models import MaintenanceWindow |
|
14
|
|
|
|
|
15
|
|
|
|
|
16
|
1 |
|
@dataclass |
|
17
|
1 |
|
class MaintenanceDeployer: |
|
18
|
|
|
"""Class for deploying maintenances""" |
|
19
|
1 |
|
controller: Controller |
|
20
|
1 |
|
maintenance_switches: Counter |
|
21
|
1 |
|
maintenance_interfaces: Counter |
|
22
|
1 |
|
maintenance_links: Counter |
|
23
|
|
|
|
|
24
|
1 |
|
@classmethod |
|
25
|
1 |
|
def new_deployer(cls, controller: Controller): |
|
26
|
|
|
""" |
|
27
|
|
|
Creates a new MaintenanceDeployer from the given Kytos Controller |
|
28
|
|
|
""" |
|
29
|
1 |
|
instance = cls(controller, Counter(), Counter(), Counter()) |
|
30
|
1 |
|
Switch.register_status_func( |
|
31
|
|
|
'maintenance_status', |
|
32
|
|
|
instance.switch_status_func |
|
33
|
|
|
) |
|
34
|
1 |
|
Switch.register_status_reason_func( |
|
35
|
|
|
'maintenance_status', |
|
36
|
|
|
instance.switch_status_reason_func |
|
37
|
|
|
) |
|
38
|
1 |
|
Interface.register_status_func( |
|
39
|
|
|
'maintenance_status', |
|
40
|
|
|
instance.interface_status_func |
|
41
|
|
|
) |
|
42
|
1 |
|
Interface.register_status_reason_func( |
|
43
|
|
|
'maintenance_status', |
|
44
|
|
|
instance.interface_status_reason_func |
|
45
|
|
|
) |
|
46
|
1 |
|
Link.register_status_func( |
|
47
|
|
|
'maintenance_status', |
|
48
|
|
|
instance.link_status_func |
|
49
|
|
|
) |
|
50
|
1 |
|
Link.register_status_reason_func( |
|
51
|
|
|
'maintenance_status', |
|
52
|
|
|
instance.link_status_reason_func |
|
53
|
|
|
) |
|
54
|
|
|
|
|
55
|
1 |
|
return instance |
|
56
|
|
|
|
|
57
|
1 |
|
def _maintenance_event(self, window_devices: dict, operation: str): |
|
58
|
|
|
"""Create events to start/end a maintenance.""" |
|
59
|
1 |
|
event = KytosEvent( |
|
60
|
|
|
f'topology.interruption.{operation}', |
|
61
|
|
|
content={ |
|
62
|
|
|
'type': 'maintenance', |
|
63
|
|
|
**window_devices |
|
64
|
|
|
} |
|
65
|
|
|
) |
|
66
|
1 |
|
self.controller.buffers.app.put(event) |
|
67
|
|
|
|
|
68
|
1 |
|
def _get_affected_ids( |
|
69
|
|
|
self, |
|
70
|
|
|
window: MaintenanceWindow |
|
71
|
|
|
) -> dict[str, list[str]]: |
|
72
|
1 |
|
explicit_switches = filter( |
|
73
|
|
|
lambda switch: switch is not None, |
|
74
|
|
|
map( |
|
75
|
|
|
self.controller.switches.get, |
|
76
|
|
|
window.switches |
|
77
|
|
|
) |
|
78
|
|
|
) |
|
79
|
|
|
|
|
80
|
1 |
|
tot_switches = list(explicit_switches) |
|
81
|
|
|
|
|
82
|
1 |
|
implicit_interfaces = chain.from_iterable( |
|
83
|
|
|
map( |
|
84
|
|
|
lambda switch: switch.interfaces.values(), |
|
85
|
|
|
tot_switches |
|
86
|
|
|
) |
|
87
|
|
|
) |
|
88
|
|
|
|
|
89
|
1 |
|
explicit_interfaces = filter( |
|
90
|
|
|
lambda interface: interface is not None, |
|
91
|
|
|
map( |
|
92
|
|
|
self.controller.get_interface_by_id, |
|
93
|
|
|
window.interfaces |
|
94
|
|
|
) |
|
95
|
|
|
) |
|
96
|
|
|
|
|
97
|
1 |
|
tot_interfaces = list(chain(implicit_interfaces, explicit_interfaces)) |
|
98
|
|
|
|
|
99
|
1 |
|
implicit_links = filter( |
|
100
|
|
|
lambda link: link is not None, |
|
101
|
|
|
map( |
|
102
|
|
|
lambda interface: interface.link, |
|
103
|
|
|
tot_interfaces |
|
104
|
|
|
) |
|
105
|
|
|
) |
|
106
|
|
|
|
|
107
|
1 |
|
explicit_links = filter( |
|
108
|
|
|
lambda link: link is not None, |
|
109
|
|
|
map( |
|
110
|
|
|
self.controller.napps[('kytos', 'topology')].links.get, |
|
111
|
|
|
window.links |
|
112
|
|
|
) |
|
113
|
|
|
) |
|
114
|
|
|
|
|
115
|
1 |
|
tot_links = list(chain(implicit_links, explicit_links)) |
|
116
|
|
|
|
|
117
|
1 |
|
affected_switch_ids = list(set(map( |
|
118
|
|
|
lambda switch: switch.id, |
|
119
|
|
|
filter( |
|
120
|
|
|
self.switch_not_in_maintenance, |
|
121
|
|
|
tot_switches |
|
122
|
|
|
) |
|
123
|
|
|
))) |
|
124
|
|
|
|
|
125
|
1 |
|
affected_interface_ids = list(set(map( |
|
126
|
|
|
lambda interface: interface.id, |
|
127
|
|
|
filter( |
|
128
|
|
|
self.interface_not_in_maintenance, |
|
129
|
|
|
tot_interfaces |
|
130
|
|
|
) |
|
131
|
|
|
))) |
|
132
|
|
|
|
|
133
|
1 |
|
affected_link_ids = list(set(map( |
|
134
|
|
|
lambda link: link.id, |
|
135
|
|
|
filter( |
|
136
|
|
|
self.link_not_in_maintenance, |
|
137
|
|
|
tot_links |
|
138
|
|
|
) |
|
139
|
|
|
))) |
|
140
|
|
|
|
|
141
|
1 |
|
return { |
|
142
|
|
|
'switches': affected_switch_ids, |
|
143
|
|
|
'interfaces': affected_interface_ids, |
|
144
|
|
|
'links': affected_link_ids, |
|
145
|
|
|
} |
|
146
|
|
|
|
|
147
|
1 |
|
def start_mw(self, window: MaintenanceWindow): |
|
148
|
|
|
"""Actions taken when a maintenance window starts.""" |
|
149
|
1 |
|
affected_ids = self._get_affected_ids(window) |
|
150
|
|
|
|
|
151
|
1 |
|
self.maintenance_switches.update(window.switches) |
|
152
|
1 |
|
self.maintenance_interfaces.update(window.interfaces) |
|
153
|
1 |
|
self.maintenance_links.update(window.links) |
|
154
|
|
|
|
|
155
|
1 |
|
self._maintenance_event( |
|
156
|
|
|
affected_ids, |
|
157
|
|
|
'start' |
|
158
|
|
|
) |
|
159
|
|
|
|
|
160
|
1 |
|
def end_mw(self, window: MaintenanceWindow): |
|
161
|
|
|
"""Actions taken when a maintenance window finishes.""" |
|
162
|
|
|
|
|
163
|
1 |
|
self.maintenance_switches.subtract(window.switches) |
|
164
|
1 |
|
self.maintenance_interfaces.subtract(window.interfaces) |
|
165
|
1 |
|
self.maintenance_links.subtract(window.links) |
|
166
|
|
|
|
|
167
|
1 |
|
affected_ids = self._get_affected_ids(window) |
|
168
|
|
|
|
|
169
|
1 |
|
self._maintenance_event( |
|
170
|
|
|
affected_ids, |
|
171
|
|
|
'end' |
|
172
|
|
|
) |
|
173
|
|
|
|
|
174
|
1 |
|
def switch_not_in_maintenance(self, dev: Switch) -> bool: |
|
175
|
|
|
"""Checks if a switch is not undergoing maintenance""" |
|
176
|
1 |
|
return not self.maintenance_switches[dev.id] |
|
177
|
|
|
|
|
178
|
1 |
|
def interface_not_in_maintenance(self, dev: Interface) -> bool: |
|
179
|
|
|
"""Checks if a interface is not undergoing maintenance""" |
|
180
|
1 |
|
return ( |
|
181
|
|
|
not self.maintenance_interfaces[dev.id] and |
|
182
|
|
|
self.switch_not_in_maintenance(dev.switch) |
|
183
|
|
|
) |
|
184
|
|
|
|
|
185
|
1 |
|
def link_not_in_maintenance(self, dev: Link) -> bool: |
|
186
|
|
|
"""Checks if a link is not undergoing maintenance""" |
|
187
|
1 |
|
return ( |
|
188
|
|
|
not self.maintenance_links[dev.id] and |
|
189
|
|
|
all( |
|
190
|
|
|
map( |
|
191
|
|
|
self.interface_not_in_maintenance, |
|
192
|
|
|
(dev.endpoint_a, dev.endpoint_b) |
|
193
|
|
|
) |
|
194
|
|
|
) |
|
195
|
|
|
) |
|
196
|
|
|
|
|
197
|
1 |
|
def switch_status_func(self, dev: Switch) -> EntityStatus: |
|
198
|
|
|
"""Checks if a given device is undergoing maintenance""" |
|
199
|
1 |
|
if self.switch_not_in_maintenance(dev): |
|
200
|
1 |
|
return EntityStatus.UP |
|
201
|
1 |
|
return EntityStatus.DOWN |
|
202
|
|
|
|
|
203
|
1 |
|
def switch_status_reason_func(self, dev: Switch) -> frozenset: |
|
204
|
|
|
"""Checks if a given device is undergoing maintenance""" |
|
205
|
1 |
|
if self.switch_not_in_maintenance(dev): |
|
206
|
1 |
|
return frozenset() |
|
207
|
1 |
|
return frozenset({'maintenance'}) |
|
208
|
|
|
|
|
209
|
1 |
|
def interface_status_func(self, dev: Interface) -> EntityStatus: |
|
210
|
|
|
"""Checks if a given device is undergoing maintenance""" |
|
211
|
1 |
|
if self.interface_not_in_maintenance(dev): |
|
212
|
1 |
|
return EntityStatus.UP |
|
213
|
1 |
|
return EntityStatus.DOWN |
|
214
|
|
|
|
|
215
|
1 |
|
def interface_status_reason_func(self, dev: Interface) -> frozenset: |
|
216
|
|
|
"""Checks if a given device is undergoing maintenance""" |
|
217
|
1 |
|
if self.interface_not_in_maintenance(dev): |
|
218
|
1 |
|
return frozenset() |
|
219
|
1 |
|
return frozenset({'maintenance'}) |
|
220
|
|
|
|
|
221
|
1 |
|
def link_status_func(self, dev: Link) -> EntityStatus: |
|
222
|
|
|
"""Checks if a given device is undergoing maintenance""" |
|
223
|
1 |
|
if self.link_not_in_maintenance(dev): |
|
224
|
1 |
|
return EntityStatus.UP |
|
225
|
1 |
|
return EntityStatus.DOWN |
|
226
|
|
|
|
|
227
|
1 |
|
def link_status_reason_func(self, dev: Link) -> frozenset: |
|
228
|
|
|
"""Checks if a given device is undergoing maintenance""" |
|
229
|
1 |
|
if self.link_not_in_maintenance(dev): |
|
230
|
|
|
return frozenset() |
|
231
|
|
|
return frozenset({'maintenance'}) |
kytos-ng /
maintenance
