KDU instantiate params for model and namespace
[osm/NBI.git] / osm_nbi / engine.py
1 # -*- coding: utf-8 -*-
2
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12 # implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15
16 import logging
17 # import yaml
18 from osm_common import dbmongo, dbmemory, fslocal, fsmongo, msglocal, msgkafka, version as common_version
19 from osm_common.dbbase import DbException
20 from osm_common.fsbase import FsException
21 from osm_common.msgbase import MsgException
22 from http import HTTPStatus
23
24 from osm_nbi.authconn_keystone import AuthconnKeystone
25 from osm_nbi.authconn_internal import AuthconnInternal
26 from osm_nbi.base_topic import EngineException, versiontuple
27 from osm_nbi.admin_topics import VimAccountTopic, WimAccountTopic, SdnTopic
28 from osm_nbi.admin_topics import K8sClusterTopic, K8sRepoTopic
29 from osm_nbi.admin_topics import UserTopicAuth, ProjectTopicAuth, RoleTopicAuth
30 from osm_nbi.descriptor_topics import VnfdTopic, NsdTopic, PduTopic, NstTopic, VnfPkgOpTopic
31 from osm_nbi.instance_topics import NsrTopic, VnfrTopic, NsLcmOpTopic, NsiTopic, NsiLcmOpTopic
32 from osm_nbi.pmjobs_topics import PmJobsTopic
33 from base64 import b64encode
34 from os import urandom # , path
35 from threading import Lock
36
37 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
38 min_common_version = "0.1.16"
39
40
41 class Engine(object):
42 map_from_topic_to_class = {
43 "vnfds": VnfdTopic,
44 "nsds": NsdTopic,
45 "nsts": NstTopic,
46 "pdus": PduTopic,
47 "nsrs": NsrTopic,
48 "vnfrs": VnfrTopic,
49 "nslcmops": NsLcmOpTopic,
50 "vim_accounts": VimAccountTopic,
51 "wim_accounts": WimAccountTopic,
52 "sdns": SdnTopic,
53 "k8sclusters": K8sClusterTopic,
54 "k8srepos": K8sRepoTopic,
55 "users": UserTopicAuth, # Valid for both internal and keystone authentication backends
56 "projects": ProjectTopicAuth, # Valid for both internal and keystone authentication backends
57 "roles": RoleTopicAuth, # Valid for both internal and keystone authentication backends
58 "nsis": NsiTopic,
59 "nsilcmops": NsiLcmOpTopic,
60 "vnfpkgops": VnfPkgOpTopic,
61 # [NEW_TOPIC]: add an entry here
62 # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters
63 }
64
65 map_target_version_to_int = {
66 "1.0": 1000,
67 "1.1": 1001,
68 "1.2": 1002,
69 # Add new versions here
70 }
71
72 def __init__(self, authenticator):
73 self.db = None
74 self.fs = None
75 self.msg = None
76 self.authconn = None
77 self.config = None
78 # self.operations = None
79 self.logger = logging.getLogger("nbi.engine")
80 self.map_topic = {}
81 self.write_lock = None
82 # self.token_cache = token_cache
83 self.authenticator = authenticator
84
85 def start(self, config):
86 """
87 Connect to database, filesystem storage, and messaging
88 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
89 :return: None
90 """
91 self.config = config
92 # check right version of common
93 if versiontuple(common_version) < versiontuple(min_common_version):
94 raise EngineException("Not compatible osm/common version '{}'. Needed '{}' or higher".format(
95 common_version, min_common_version))
96
97 try:
98 if not self.db:
99 if config["database"]["driver"] == "mongo":
100 self.db = dbmongo.DbMongo()
101 self.db.db_connect(config["database"])
102 elif config["database"]["driver"] == "memory":
103 self.db = dbmemory.DbMemory()
104 self.db.db_connect(config["database"])
105 else:
106 raise EngineException("Invalid configuration param '{}' at '[database]':'driver'".format(
107 config["database"]["driver"]))
108 if not self.fs:
109 if config["storage"]["driver"] == "local":
110 self.fs = fslocal.FsLocal()
111 self.fs.fs_connect(config["storage"])
112 elif config["storage"]["driver"] == "mongo":
113 self.fs = fsmongo.FsMongo()
114 self.fs.fs_connect(config["storage"])
115 else:
116 raise EngineException("Invalid configuration param '{}' at '[storage]':'driver'".format(
117 config["storage"]["driver"]))
118 if not self.msg:
119 if config["message"]["driver"] == "local":
120 self.msg = msglocal.MsgLocal()
121 self.msg.connect(config["message"])
122 elif config["message"]["driver"] == "kafka":
123 self.msg = msgkafka.MsgKafka()
124 self.msg.connect(config["message"])
125 else:
126 raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(
127 config["message"]["driver"]))
128 if not self.authconn:
129 if config["authentication"]["backend"] == "keystone":
130 self.authconn = AuthconnKeystone(config["authentication"], self.db,
131 self.authenticator.role_permissions)
132 else:
133 self.authconn = AuthconnInternal(config["authentication"], self.db,
134 self.authenticator.role_permissions)
135 # if not self.operations:
136 # if "resources_to_operations" in config["rbac"]:
137 # resources_to_operations_file = config["rbac"]["resources_to_operations"]
138 # else:
139 # possible_paths = (
140 # __file__[:__file__.rfind("engine.py")] + "resources_to_operations.yml",
141 # "./resources_to_operations.yml"
142 # )
143 # for config_file in possible_paths:
144 # if path.isfile(config_file):
145 # resources_to_operations_file = config_file
146 # break
147 # if not resources_to_operations_file:
148 # raise EngineException("Invalid permission configuration:"
149 # "resources_to_operations file missing")
150 #
151 # with open(resources_to_operations_file, 'r') as f:
152 # resources_to_operations = yaml.load(f, Loader=yaml.Loader)
153 #
154 # self.operations = []
155 #
156 # for _, value in resources_to_operations["resources_to_operations"].items():
157 # if value not in self.operations:
158 # self.operations += [value]
159
160 self.write_lock = Lock()
161 # create one class per topic
162 for topic, topic_class in self.map_from_topic_to_class.items():
163 # if self.auth and topic_class in (UserTopicAuth, ProjectTopicAuth):
164 # self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth)
165 self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.authconn)
166
167 self.map_topic["pm_jobs"] = PmJobsTopic(self.db, config["prometheus"].get("host"),
168 config["prometheus"].get("port"))
169 except (DbException, FsException, MsgException) as e:
170 raise EngineException(str(e), http_code=e.http_code)
171
172 def stop(self):
173 try:
174 if self.db:
175 self.db.db_disconnect()
176 if self.fs:
177 self.fs.fs_disconnect()
178 if self.msg:
179 self.msg.disconnect()
180 self.write_lock = None
181 except (DbException, FsException, MsgException) as e:
182 raise EngineException(str(e), http_code=e.http_code)
183
184 def new_item(self, rollback, session, topic, indata=None, kwargs=None, headers=None):
185 """
186 Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
187 that must be completed with a call to method upload_content
188 :param rollback: list to append created items at database in case a rollback must to be done
189 :param session: contains the used login username and working project, force to avoid checkins, public
190 :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
191 :param indata: data to be inserted
192 :param kwargs: used to override the indata descriptor
193 :param headers: http request headers
194 :return: _id: identity of the inserted data.
195 """
196 if topic not in self.map_topic:
197 raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
198 with self.write_lock:
199 return self.map_topic[topic].new(rollback, session, indata, kwargs, headers)
200
201 def upload_content(self, session, topic, _id, indata, kwargs, headers):
202 """
203 Upload content for an already created entry (_id)
204 :param session: contains the used login username and working project
205 :param topic: it can be: users, projects, vnfds, nsds,
206 :param _id: server id of the item
207 :param indata: data to be inserted
208 :param kwargs: used to override the indata descriptor
209 :param headers: http request headers
210 :return: _id: identity of the inserted data.
211 """
212 if topic not in self.map_topic:
213 raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
214 with self.write_lock:
215 return self.map_topic[topic].upload_content(session, _id, indata, kwargs, headers)
216
217 def get_item_list(self, session, topic, filter_q=None):
218 """
219 Get a list of items
220 :param session: contains the used login username and working project
221 :param topic: it can be: users, projects, vnfds, nsds, ...
222 :param filter_q: filter of data to be applied
223 :return: The list, it can be empty if no one match the filter_q.
224 """
225 if topic not in self.map_topic:
226 raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
227 return self.map_topic[topic].list(session, filter_q)
228
229 def get_item(self, session, topic, _id):
230 """
231 Get complete information on an item
232 :param session: contains the used login username and working project
233 :param topic: it can be: users, projects, vnfds, nsds,
234 :param _id: server id of the item
235 :return: dictionary, raise exception if not found.
236 """
237 if topic not in self.map_topic:
238 raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
239 return self.map_topic[topic].show(session, _id)
240
241 def get_file(self, session, topic, _id, path=None, accept_header=None):
242 """
243 Get descriptor package or artifact file content
244 :param session: contains the used login username and working project
245 :param topic: it can be: users, projects, vnfds, nsds,
246 :param _id: server id of the item
247 :param path: artifact path or "$DESCRIPTOR" or None
248 :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
249 :return: opened file plus Accept format or raises an exception
250 """
251 if topic not in self.map_topic:
252 raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
253 return self.map_topic[topic].get_file(session, _id, path, accept_header)
254
255 def del_item_list(self, session, topic, _filter=None):
256 """
257 Delete a list of items
258 :param session: contains the used login username and working project
259 :param topic: it can be: users, projects, vnfds, nsds, ...
260 :param _filter: filter of data to be applied
261 :return: The deleted list, it can be empty if no one match the _filter.
262 """
263 if topic not in self.map_topic:
264 raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
265 with self.write_lock:
266 return self.map_topic[topic].delete_list(session, _filter)
267
268 def del_item(self, session, topic, _id, not_send_msg=None):
269 """
270 Delete item by its internal id
271 :param session: contains the used login username and working project
272 :param topic: it can be: users, projects, vnfds, nsds, ...
273 :param _id: server id of the item
274 :param not_send_msg: If False, message will not be sent to kafka.
275 If a list, message is not sent, but content is stored in this variable so that the caller can send this
276 message using its own loop. If None, message is sent
277 :return: dictionary with deleted item _id. It raises exception if not found.
278 """
279 if topic not in self.map_topic:
280 raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
281 with self.write_lock:
282 return self.map_topic[topic].delete(session, _id, not_send_msg=not_send_msg)
283
284 def edit_item(self, session, topic, _id, indata=None, kwargs=None):
285 """
286 Update an existing entry at database
287 :param session: contains the used login username and working project
288 :param topic: it can be: users, projects, vnfds, nsds, ...
289 :param _id: identifier to be updated
290 :param indata: data to be inserted
291 :param kwargs: used to override the indata descriptor
292 :return: dictionary with edited item _id, raise exception if not found.
293 """
294 if topic not in self.map_topic:
295 raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR)
296 with self.write_lock:
297 return self.map_topic[topic].edit(session, _id, indata, kwargs)
298
299 def upgrade_db(self, current_version, target_version):
300 if target_version not in self.map_target_version_to_int.keys():
301 raise EngineException("Cannot upgrade to version '{}' with this version of code".format(target_version),
302 http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
303
304 if current_version == target_version:
305 return
306
307 target_version_int = self.map_target_version_to_int[target_version]
308
309 if not current_version:
310 # create database version
311 serial = urandom(32)
312 version_data = {
313 "_id": "version", # Always "version"
314 "version_int": 1000, # version number
315 "version": "1.0", # version text
316 "date": "2018-10-25", # version date
317 "description": "added serial", # changes in this version
318 'status': "ENABLED", # ENABLED, DISABLED (migration in process), ERROR,
319 'serial': b64encode(serial)
320 }
321 self.db.create("admin", version_data)
322 self.db.set_secret_key(serial)
323 current_version = "1.0"
324
325 if current_version in ("1.0", "1.1") and target_version_int >= self.map_target_version_to_int["1.2"]:
326 if self.config['authentication']['backend'] == "internal":
327 self.db.del_list("roles")
328
329 version_data = {
330 "_id": "version",
331 "version_int": 1002,
332 "version": "1.2",
333 "date": "2019-06-11",
334 "description": "set new format for roles_operations"
335 }
336
337 self.db.set_one("admin", {"_id": "version"}, version_data)
338 current_version = "1.2"
339 # TODO add future migrations here
340
341 def init_db(self, target_version='1.0'):
342 """
343 Init database if empty. If not empty it checks that database version and migrates if needed
344 If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
345 :param target_version: check desired database version. Migrate to it if possible or raises exception
346 :return: None if ok, exception if error or if the version is different.
347 """
348
349 version_data = self.db.get_one("admin", {"_id": "version"}, fail_on_empty=False, fail_on_more=True)
350 # check database status is ok
351 if version_data and version_data.get("status") != 'ENABLED':
352 raise EngineException("Wrong database status '{}'".format(
353 version_data["status"]), HTTPStatus.INTERNAL_SERVER_ERROR)
354
355 # check version
356 db_version = None if not version_data else version_data.get("version")
357 if db_version != target_version:
358 self.upgrade_db(db_version, target_version)
359
360 return