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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
# vim: tabstop=4 shiftwidth=4 softtabstop=4
# coding=utf-8
# Copyright 2013 Hewlett-Packard Development Company, L.P.
# 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.
"""
Client side of the conductor RPC API.
"""
from oslo.config import cfg
from ironic.common import hash_ring as hash
from ironic.conductor import manager
from ironic.db import api as dbapi
from ironic.objects import base as objects_base
import ironic.openstack.common.rpc.proxy
# NOTE(max_lobur): This is temporary override for Oslo setting defined in
# ironic.openstack.common.rpc.__init__.py. Should stay while Oslo is not fixed.
# *The setting shows what exceptions can be deserialized from RPC response.
# *This won't be reflected in ironic.conf.sample
# TODO(max_lobur): cover this by an integration test as
# described in https://bugs.launchpad.net/ironic/+bug/1252824
cfg.CONF.set_default('allowed_rpc_exception_modules',
['ironic.common.exception',
'exceptions', ])
class ConductorAPI(ironic.openstack.common.rpc.proxy.RpcProxy):
"""Client side of the conductor RPC API.
API version history:
1.0 - Initial version.
Included get_node_power_status
1.1 - Added update_node and start_power_state_change.
1.2 - Added vendor_passhthru.
1.3 - Rename start_power_state_change to change_node_power_state.
1.4 - Added do_node_deploy and do_node_tear_down.
1.5 - Added validate_driver_interfaces.
1.6 - change_node_power_state, do_node_deploy and do_node_tear_down
accept node id instead of node object.
1.7 - Added topic parameter to RPC methods.
1.8 - Added change_node_maintenance_mode.
"""
RPC_API_VERSION = '1.8'
def __init__(self, topic=None):
if topic is None:
topic = manager.MANAGER_TOPIC
# Initialize consistent hash ring
self.hash_rings = {}
d2c = dbapi.get_instance().get_active_driver_dict()
for driver in d2c.keys():
self.hash_rings[driver] = hash.HashRing(d2c[driver])
super(ConductorAPI, self).__init__(
topic=topic,
serializer=objects_base.IronicObjectSerializer(),
default_version=self.RPC_API_VERSION)
def get_topic_for(self, node):
"""Get the RPC topic for the conductor service which the node
is mapped to.
:param node: a node object.
:returns: an RPC topic string.
"""
try:
ring = self.hash_rings[node.driver]
dest = ring.get_hosts(node.uuid)
return self.topic + "." + dest[0]
except KeyError:
return self.topic
def get_node_power_state(self, context, node_id, topic=None):
"""Ask a conductor for the node power state.
:param context: request context.
:param node_id: node id or uuid.
:param topic: RPC topic. Defaults to self.topic.
:returns: power status.
"""
return self.call(context,
self.make_msg('get_node_power_state',
node_id=node_id),
topic=topic or self.topic)
def update_node(self, context, node_obj, topic=None):
"""Synchronously, have a conductor update the node's information.
Update the node's information in the database and return a node object.
The conductor will lock the node while it validates the supplied
information. If driver_info is passed, it will be validated by
the core drivers. If instance_uuid is passed, it will be set or unset
only if the node is properly configured.
Note that power_state should not be passed via this method.
Use change_node_power_state for initiating driver actions.
:param context: request context.
:param node_obj: a changed (but not saved) node object.
:param topic: RPC topic. Defaults to self.topic.
:returns: updated node object, including all fields.
"""
return self.call(context,
self.make_msg('update_node',
node_obj=node_obj),
topic=topic or self.topic)
def change_node_power_state(self, context, node_id, new_state, topic=None):
"""Asynchronously change power state of a node.
:param context: request context.
:param node_id: node id or uuid.
:param new_state: one of ironic.common.states power state values
:param topic: RPC topic. Defaults to self.topic.
"""
self.cast(context,
self.make_msg('change_node_power_state',
node_id=node_id,
new_state=new_state),
topic=topic or self.topic)
def vendor_passthru(self, context, node_id, driver_method, info,
topic=None):
"""Pass vendor specific info to a node driver.
:param context: request context.
:param node_id: node id or uuid.
:param driver_method: name of method for driver.
:param info: info for node driver.
:param topic: RPC topic. Defaults to self.topic.
:raises: InvalidParameterValue for parameter errors.
:raises: UnsupportedDriverExtension for unsupported extensions.
"""
topic = topic or self.topic
driver_data = self.call(context,
self.make_msg('validate_vendor_action',
node_id=node_id,
driver_method=driver_method,
info=info),
topic=topic)
# this method can do nothing if 'driver_method' intended only
# for obtain 'driver_data'
self.cast(context,
self.make_msg('do_vendor_action',
node_id=node_id,
driver_method=driver_method,
info=info),
topic=topic)
return driver_data
def do_node_deploy(self, context, node_id, topic=None):
"""Signal to conductor service to perform a deployment.
:param context: request context.
:param node_id: node id or uuid.
:param topic: RPC topic. Defaults to self.topic.
The node must already be configured and in the appropriate
undeployed state before this method is called.
"""
self.cast(context,
self.make_msg('do_node_deploy',
node_id=node_id),
topic=topic or self.topic)
def do_node_tear_down(self, context, node_id, topic=None):
"""Signal to conductor service to tear down a deployment.
:param context: request context.
:param node_id: node id or uuid.
:param topic: RPC topic. Defaults to self.topic.
The node must already be configured and in the appropriate
deployed state before this method is called.
"""
self.cast(context,
self.make_msg('do_node_tear_down',
node_id=node_id),
topic=topic or self.topic)
def validate_driver_interfaces(self, context, node_id, topic=None):
"""Validate the `core` and `standardized` interfaces for drivers.
:param context: request context.
:param node_id: node id or uuid.
:param topic: RPC topic. Defaults to self.topic.
:returns: a dictionary containing the results of each
interface validation.
"""
return self.call(context,
self.make_msg('validate_driver_interfaces',
node_id=node_id),
topic=topic or self.topic)
def change_node_maintenance_mode(self, context, node_id, mode):
"""Set node maintenance mode on or off.
:param context: request context.
:param node_id: node id or uuid.
:param mode: True or False.
:returns: a node object.
:raises: NodeMaintenanceFailure.
"""
return self.call(context,
self.make_msg('change_node_maintenance_mode',
node_id=node_id,
mode=mode))
|
