1 # -*- coding: utf-8 -*-
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
19 from osm_common
import (
26 version
as common_version
,
28 from osm_common
.dbbase
import DbException
29 from osm_common
.fsbase
import FsException
30 from osm_common
.msgbase
import MsgException
31 from http
import HTTPStatus
33 from osm_nbi
.authconn_keystone
import AuthconnKeystone
34 from osm_nbi
.authconn_internal
import AuthconnInternal
35 from osm_nbi
.authconn_tacacs
import AuthconnTacacs
36 from osm_nbi
.base_topic
import EngineException
, versiontuple
37 from osm_nbi
.admin_topics
import VimAccountTopic
, WimAccountTopic
, SdnTopic
38 from osm_nbi
.admin_topics
import K8sClusterTopic
, K8sRepoTopic
, OsmRepoTopic
39 from osm_nbi
.admin_topics
import VcaTopic
40 from osm_nbi
.admin_topics
import UserTopicAuth
, ProjectTopicAuth
, RoleTopicAuth
41 from osm_nbi
.descriptor_topics
import (
48 from osm_nbi
.instance_topics
import (
55 from osm_nbi
.vnf_instance_topics
import VnfInstances
, VnfLcmOpTopic
56 from osm_nbi
.pmjobs_topics
import PmJobsTopic
57 from osm_nbi
.subscription_topics
import NslcmSubscriptionsTopic
58 from base64
import b64encode
59 from os
import urandom
# , path
60 from threading
import Lock
62 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
63 min_common_version
= "0.1.16"
67 map_from_topic_to_class
= {
74 "nslcmops": NsLcmOpTopic
,
75 "vim_accounts": VimAccountTopic
,
76 "wim_accounts": WimAccountTopic
,
78 "k8sclusters": K8sClusterTopic
,
80 "k8srepos": K8sRepoTopic
,
81 "osmrepos": OsmRepoTopic
,
82 "users": UserTopicAuth
, # Valid for both internal and keystone authentication backends
83 "projects": ProjectTopicAuth
, # Valid for both internal and keystone authentication backends
84 "roles": RoleTopicAuth
, # Valid for both internal and keystone authentication backends
86 "nsilcmops": NsiLcmOpTopic
,
87 "vnfpkgops": VnfPkgOpTopic
,
88 "nslcm_subscriptions": NslcmSubscriptionsTopic
,
89 "vnf_instances": VnfInstances
,
90 "vnflcmops": VnfLcmOpTopic
,
91 # [NEW_TOPIC]: add an entry here
92 # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters
95 map_target_version_to_int
= {
99 # Add new versions here
102 def __init__(self
, authenticator
):
108 # self.operations = None
109 self
.logger
= logging
.getLogger("nbi.engine")
111 self
.write_lock
= None
112 # self.token_cache = token_cache
113 self
.authenticator
= authenticator
115 def start(self
, config
):
117 Connect to database, filesystem storage, and messaging
118 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
122 # check right version of common
123 if versiontuple(common_version
) < versiontuple(min_common_version
):
124 raise EngineException(
125 "Not compatible osm/common version '{}'. Needed '{}' or higher".format(
126 common_version
, min_common_version
132 if config
["database"]["driver"] == "mongo":
133 self
.db
= dbmongo
.DbMongo()
134 self
.db
.db_connect(config
["database"])
135 elif config
["database"]["driver"] == "memory":
136 self
.db
= dbmemory
.DbMemory()
137 self
.db
.db_connect(config
["database"])
139 raise EngineException(
140 "Invalid configuration param '{}' at '[database]':'driver'".format(
141 config
["database"]["driver"]
145 if config
["storage"]["driver"] == "local":
146 self
.fs
= fslocal
.FsLocal()
147 self
.fs
.fs_connect(config
["storage"])
148 elif config
["storage"]["driver"] == "mongo":
149 self
.fs
= fsmongo
.FsMongo()
150 self
.fs
.fs_connect(config
["storage"])
152 raise EngineException(
153 "Invalid configuration param '{}' at '[storage]':'driver'".format(
154 config
["storage"]["driver"]
158 if config
["message"]["driver"] == "local":
159 self
.msg
= msglocal
.MsgLocal()
160 self
.msg
.connect(config
["message"])
161 elif config
["message"]["driver"] == "kafka":
162 self
.msg
= msgkafka
.MsgKafka()
163 self
.msg
.connect(config
["message"])
165 raise EngineException(
166 "Invalid configuration param '{}' at '[message]':'driver'".format(
167 config
["message"]["driver"]
170 if not self
.authconn
:
171 if config
["authentication"]["backend"] == "keystone":
172 self
.authconn
= AuthconnKeystone(
173 config
["authentication"],
175 self
.authenticator
.role_permissions
,
177 elif config
["authentication"]["backend"] == "tacacs":
178 self
.authconn
= AuthconnTacacs(
179 config
["authentication"],
181 self
.authenticator
.role_permissions
,
184 self
.authconn
= AuthconnInternal(
185 config
["authentication"],
187 self
.authenticator
.role_permissions
,
189 # if not self.operations:
190 # if "resources_to_operations" in config["rbac"]:
191 # resources_to_operations_file = config["rbac"]["resources_to_operations"]
194 # __file__[:__file__.rfind("engine.py")] + "resources_to_operations.yml",
195 # "./resources_to_operations.yml"
197 # for config_file in possible_paths:
198 # if path.isfile(config_file):
199 # resources_to_operations_file = config_file
201 # if not resources_to_operations_file:
202 # raise EngineException("Invalid permission configuration:"
203 # "resources_to_operations file missing")
205 # with open(resources_to_operations_file, 'r') as f:
206 # resources_to_operations = yaml.load(f, Loader=yaml.Loader)
208 # self.operations = []
210 # for _, value in resources_to_operations["resources_to_operations"].items():
211 # if value not in self.operations:
212 # self.operations += [value]
214 self
.write_lock
= Lock()
215 # create one class per topic
216 for topic
, topic_class
in self
.map_from_topic_to_class
.items():
217 # if self.auth and topic_class in (UserTopicAuth, ProjectTopicAuth):
218 # self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth)
219 self
.map_topic
[topic
] = topic_class(
220 self
.db
, self
.fs
, self
.msg
, self
.authconn
223 self
.map_topic
["pm_jobs"] = PmJobsTopic(
225 config
["prometheus"].get("host"),
226 config
["prometheus"].get("port"),
228 except (DbException
, FsException
, MsgException
) as e
:
229 raise EngineException(str(e
), http_code
=e
.http_code
)
234 self
.db
.db_disconnect()
236 self
.fs
.fs_disconnect()
238 self
.msg
.disconnect()
239 self
.write_lock
= None
240 except (DbException
, FsException
, MsgException
) as e
:
241 raise EngineException(str(e
), http_code
=e
.http_code
)
244 self
, rollback
, session
, topic
, indata
=None, kwargs
=None, headers
=None
247 Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
248 that must be completed with a call to method upload_content
249 :param rollback: list to append created items at database in case a rollback must to be done
250 :param session: contains the used login username and working project, force to avoid checkins, public
251 :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
252 :param indata: data to be inserted
253 :param kwargs: used to override the indata descriptor
254 :param headers: http request headers
255 :return: _id: identity of the inserted data.
257 if topic
not in self
.map_topic
:
258 raise EngineException(
259 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
261 with self
.write_lock
:
262 return self
.map_topic
[topic
].new(rollback
, session
, indata
, kwargs
, headers
)
264 def upload_content(self
, session
, topic
, _id
, indata
, kwargs
, headers
):
266 Upload content for an already created entry (_id)
267 :param session: contains the used login username and working project
268 :param topic: it can be: users, projects, vnfds, nsds,
269 :param _id: server id of the item
270 :param indata: data to be inserted
271 :param kwargs: used to override the indata descriptor
272 :param headers: http request headers
273 :return: _id: identity of the inserted data.
275 if topic
not in self
.map_topic
:
276 raise EngineException(
277 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
279 with self
.write_lock
:
280 return self
.map_topic
[topic
].upload_content(
281 session
, _id
, indata
, kwargs
, headers
284 def get_item_list(self
, session
, topic
, filter_q
=None, api_req
=False):
287 :param session: contains the used login username and working project
288 :param topic: it can be: users, projects, vnfds, nsds, ...
289 :param filter_q: filter of data to be applied
290 :param api_req: True if this call is serving an external API request. False if serving internal request.
291 :return: The list, it can be empty if no one match the filter_q.
293 if topic
not in self
.map_topic
:
294 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
295 return self
.map_topic
[topic
].list(session
, filter_q
, api_req
)
297 def get_item(self
, session
, topic
, _id
, filter_q
=None, api_req
=False):
299 Get complete information on an item
300 :param session: contains the used login username and working project
301 :param topic: it can be: users, projects, vnfds, nsds,
302 :param _id: server id of the item
303 :param filter_q: other arguments
304 :param api_req: True if this call is serving an external API request. False if serving internal request.
305 :return: dictionary, raise exception if not found.
307 if topic
not in self
.map_topic
:
308 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
309 return self
.map_topic
[topic
].show(session
, _id
, filter_q
, api_req
)
311 def get_file(self
, session
, topic
, _id
, path
=None, accept_header
=None):
313 Get descriptor package or artifact file content
314 :param session: contains the used login username and working project
315 :param topic: it can be: users, projects, vnfds, nsds,
316 :param _id: server id of the item
317 :param path: artifact path or "$DESCRIPTOR" or None
318 :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
319 :return: opened file plus Accept format or raises an exception
321 if topic
not in self
.map_topic
:
322 raise EngineException(
323 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
325 return self
.map_topic
[topic
].get_file(session
, _id
, path
, accept_header
)
327 def del_item_list(self
, session
, topic
, _filter
=None):
329 Delete a list of items
330 :param session: contains the used login username and working project
331 :param topic: it can be: users, projects, vnfds, nsds, ...
332 :param _filter: filter of data to be applied
333 :return: The deleted list, it can be empty if no one match the _filter.
335 if topic
not in self
.map_topic
:
336 raise EngineException(
337 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
339 with self
.write_lock
:
340 return self
.map_topic
[topic
].delete_list(session
, _filter
)
342 def del_item(self
, session
, topic
, _id
, not_send_msg
=None):
344 Delete item by its internal id
345 :param session: contains the used login username and working project
346 :param topic: it can be: users, projects, vnfds, nsds, ...
347 :param _id: server id of the item
348 :param not_send_msg: If False, message will not be sent to kafka.
349 If a list, message is not sent, but content is stored in this variable so that the caller can send this
350 message using its own loop. If None, message is sent
351 :return: dictionary with deleted item _id. It raises exception if not found.
353 if topic
not in self
.map_topic
:
354 raise EngineException(
355 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
357 with self
.write_lock
:
358 return self
.map_topic
[topic
].delete(session
, _id
, not_send_msg
=not_send_msg
)
360 def edit_item(self
, session
, topic
, _id
, indata
=None, kwargs
=None):
362 Update an existing entry at database
363 :param session: contains the used login username and working project
364 :param topic: it can be: users, projects, vnfds, nsds, ...
365 :param _id: identifier to be updated
366 :param indata: data to be inserted
367 :param kwargs: used to override the indata descriptor
368 :return: dictionary with edited item _id, raise exception if not found.
370 if topic
not in self
.map_topic
:
371 raise EngineException(
372 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
374 with self
.write_lock
:
375 return self
.map_topic
[topic
].edit(session
, _id
, indata
, kwargs
)
377 def upgrade_db(self
, current_version
, target_version
):
378 if target_version
not in self
.map_target_version_to_int
.keys():
379 raise EngineException(
380 "Cannot upgrade to version '{}' with this version of code".format(
383 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
,
386 if current_version
== target_version
:
389 target_version_int
= self
.map_target_version_to_int
[target_version
]
391 if not current_version
:
392 # create database version
395 "_id": "version", # Always "version"
396 "version_int": 1000, # version number
397 "version": "1.0", # version text
398 "date": "2018-10-25", # version date
399 "description": "added serial", # changes in this version
400 "status": "ENABLED", # ENABLED, DISABLED (migration in process), ERROR,
401 "serial": b64encode(serial
),
403 self
.db
.create("admin", version_data
)
404 self
.db
.set_secret_key(serial
)
405 current_version
= "1.0"
408 current_version
in ("1.0", "1.1")
409 and target_version_int
>= self
.map_target_version_to_int
["1.2"]
411 if self
.config
["authentication"]["backend"] == "internal":
412 self
.db
.del_list("roles")
418 "date": "2019-06-11",
419 "description": "set new format for roles_operations",
422 self
.db
.set_one("admin", {"_id": "version"}, version_data
)
423 current_version
= "1.2"
424 # TODO add future migrations here
426 def init_db(self
, target_version
="1.0"):
428 Init database if empty. If not empty it checks that database version and migrates if needed
429 If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
430 :param target_version: check desired database version. Migrate to it if possible or raises exception
431 :return: None if ok, exception if error or if the version is different.
434 version_data
= self
.db
.get_one(
435 "admin", {"_id": "version"}, fail_on_empty
=False, fail_on_more
=True
437 # check database status is ok
438 if version_data
and version_data
.get("status") != "ENABLED":
439 raise EngineException(
440 "Wrong database status '{}'".format(version_data
["status"]),
441 HTTPStatus
.INTERNAL_SERVER_ERROR
,
445 db_version
= None if not version_data
else version_data
.get("version")
446 if db_version
!= target_version
:
447 self
.upgrade_db(db_version
, target_version
)