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
.pmjobs_topics
import PmJobsTopic
56 from osm_nbi
.subscription_topics
import NslcmSubscriptionsTopic
57 from base64
import b64encode
58 from os
import urandom
# , path
59 from threading
import Lock
61 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
62 min_common_version
= "0.1.16"
66 map_from_topic_to_class
= {
73 "nslcmops": NsLcmOpTopic
,
74 "vim_accounts": VimAccountTopic
,
75 "wim_accounts": WimAccountTopic
,
77 "k8sclusters": K8sClusterTopic
,
79 "k8srepos": K8sRepoTopic
,
80 "osmrepos": OsmRepoTopic
,
81 "users": UserTopicAuth
, # Valid for both internal and keystone authentication backends
82 "projects": ProjectTopicAuth
, # Valid for both internal and keystone authentication backends
83 "roles": RoleTopicAuth
, # Valid for both internal and keystone authentication backends
85 "nsilcmops": NsiLcmOpTopic
,
86 "vnfpkgops": VnfPkgOpTopic
,
87 "nslcm_subscriptions": NslcmSubscriptionsTopic
,
88 # [NEW_TOPIC]: add an entry here
89 # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters
92 map_target_version_to_int
= {
96 # Add new versions here
99 def __init__(self
, authenticator
):
105 # self.operations = None
106 self
.logger
= logging
.getLogger("nbi.engine")
108 self
.write_lock
= None
109 # self.token_cache = token_cache
110 self
.authenticator
= authenticator
112 def start(self
, config
):
114 Connect to database, filesystem storage, and messaging
115 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
119 # check right version of common
120 if versiontuple(common_version
) < versiontuple(min_common_version
):
121 raise EngineException(
122 "Not compatible osm/common version '{}'. Needed '{}' or higher".format(
123 common_version
, min_common_version
129 if config
["database"]["driver"] == "mongo":
130 self
.db
= dbmongo
.DbMongo()
131 self
.db
.db_connect(config
["database"])
132 elif config
["database"]["driver"] == "memory":
133 self
.db
= dbmemory
.DbMemory()
134 self
.db
.db_connect(config
["database"])
136 raise EngineException(
137 "Invalid configuration param '{}' at '[database]':'driver'".format(
138 config
["database"]["driver"]
142 if config
["storage"]["driver"] == "local":
143 self
.fs
= fslocal
.FsLocal()
144 self
.fs
.fs_connect(config
["storage"])
145 elif config
["storage"]["driver"] == "mongo":
146 self
.fs
= fsmongo
.FsMongo()
147 self
.fs
.fs_connect(config
["storage"])
149 raise EngineException(
150 "Invalid configuration param '{}' at '[storage]':'driver'".format(
151 config
["storage"]["driver"]
155 if config
["message"]["driver"] == "local":
156 self
.msg
= msglocal
.MsgLocal()
157 self
.msg
.connect(config
["message"])
158 elif config
["message"]["driver"] == "kafka":
159 self
.msg
= msgkafka
.MsgKafka()
160 self
.msg
.connect(config
["message"])
162 raise EngineException(
163 "Invalid configuration param '{}' at '[message]':'driver'".format(
164 config
["message"]["driver"]
167 if not self
.authconn
:
168 if config
["authentication"]["backend"] == "keystone":
169 self
.authconn
= AuthconnKeystone(
170 config
["authentication"],
172 self
.authenticator
.role_permissions
,
174 elif config
["authentication"]["backend"] == "tacacs":
175 self
.authconn
= AuthconnTacacs(
176 config
["authentication"],
178 self
.authenticator
.role_permissions
,
181 self
.authconn
= AuthconnInternal(
182 config
["authentication"],
184 self
.authenticator
.role_permissions
,
186 # if not self.operations:
187 # if "resources_to_operations" in config["rbac"]:
188 # resources_to_operations_file = config["rbac"]["resources_to_operations"]
191 # __file__[:__file__.rfind("engine.py")] + "resources_to_operations.yml",
192 # "./resources_to_operations.yml"
194 # for config_file in possible_paths:
195 # if path.isfile(config_file):
196 # resources_to_operations_file = config_file
198 # if not resources_to_operations_file:
199 # raise EngineException("Invalid permission configuration:"
200 # "resources_to_operations file missing")
202 # with open(resources_to_operations_file, 'r') as f:
203 # resources_to_operations = yaml.load(f, Loader=yaml.Loader)
205 # self.operations = []
207 # for _, value in resources_to_operations["resources_to_operations"].items():
208 # if value not in self.operations:
209 # self.operations += [value]
211 self
.write_lock
= Lock()
212 # create one class per topic
213 for topic
, topic_class
in self
.map_from_topic_to_class
.items():
214 # if self.auth and topic_class in (UserTopicAuth, ProjectTopicAuth):
215 # self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth)
216 self
.map_topic
[topic
] = topic_class(
217 self
.db
, self
.fs
, self
.msg
, self
.authconn
220 self
.map_topic
["pm_jobs"] = PmJobsTopic(
222 config
["prometheus"].get("host"),
223 config
["prometheus"].get("port"),
225 except (DbException
, FsException
, MsgException
) as e
:
226 raise EngineException(str(e
), http_code
=e
.http_code
)
231 self
.db
.db_disconnect()
233 self
.fs
.fs_disconnect()
235 self
.msg
.disconnect()
236 self
.write_lock
= None
237 except (DbException
, FsException
, MsgException
) as e
:
238 raise EngineException(str(e
), http_code
=e
.http_code
)
241 self
, rollback
, session
, topic
, indata
=None, kwargs
=None, headers
=None
244 Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
245 that must be completed with a call to method upload_content
246 :param rollback: list to append created items at database in case a rollback must to be done
247 :param session: contains the used login username and working project, force to avoid checkins, public
248 :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
249 :param indata: data to be inserted
250 :param kwargs: used to override the indata descriptor
251 :param headers: http request headers
252 :return: _id: identity of the inserted data.
254 if topic
not in self
.map_topic
:
255 raise EngineException(
256 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
258 with self
.write_lock
:
259 return self
.map_topic
[topic
].new(rollback
, session
, indata
, kwargs
, headers
)
261 def upload_content(self
, session
, topic
, _id
, indata
, kwargs
, headers
):
263 Upload content for an already created entry (_id)
264 :param session: contains the used login username and working project
265 :param topic: it can be: users, projects, vnfds, nsds,
266 :param _id: server id of the item
267 :param indata: data to be inserted
268 :param kwargs: used to override the indata descriptor
269 :param headers: http request headers
270 :return: _id: identity of the inserted data.
272 if topic
not in self
.map_topic
:
273 raise EngineException(
274 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
276 with self
.write_lock
:
277 return self
.map_topic
[topic
].upload_content(
278 session
, _id
, indata
, kwargs
, headers
281 def get_item_list(self
, session
, topic
, filter_q
=None, api_req
=False):
284 :param session: contains the used login username and working project
285 :param topic: it can be: users, projects, vnfds, nsds, ...
286 :param filter_q: filter of data to be applied
287 :param api_req: True if this call is serving an external API request. False if serving internal request.
288 :return: The list, it can be empty if no one match the filter_q.
290 if topic
not in self
.map_topic
:
291 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
292 return self
.map_topic
[topic
].list(session
, filter_q
, api_req
)
294 def get_item(self
, session
, topic
, _id
, filter_q
=None, api_req
=False):
296 Get complete information on an item
297 :param session: contains the used login username and working project
298 :param topic: it can be: users, projects, vnfds, nsds,
299 :param _id: server id of the item
300 :param filter_q: other arguments
301 :param api_req: True if this call is serving an external API request. False if serving internal request.
302 :return: dictionary, raise exception if not found.
304 if topic
not in self
.map_topic
:
305 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
306 return self
.map_topic
[topic
].show(session
, _id
, filter_q
, api_req
)
308 def get_file(self
, session
, topic
, _id
, path
=None, accept_header
=None):
310 Get descriptor package or artifact file content
311 :param session: contains the used login username and working project
312 :param topic: it can be: users, projects, vnfds, nsds,
313 :param _id: server id of the item
314 :param path: artifact path or "$DESCRIPTOR" or None
315 :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
316 :return: opened file plus Accept format or raises an exception
318 if topic
not in self
.map_topic
:
319 raise EngineException(
320 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
322 return self
.map_topic
[topic
].get_file(session
, _id
, path
, accept_header
)
324 def del_item_list(self
, session
, topic
, _filter
=None):
326 Delete a list of items
327 :param session: contains the used login username and working project
328 :param topic: it can be: users, projects, vnfds, nsds, ...
329 :param _filter: filter of data to be applied
330 :return: The deleted list, it can be empty if no one match the _filter.
332 if topic
not in self
.map_topic
:
333 raise EngineException(
334 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
336 with self
.write_lock
:
337 return self
.map_topic
[topic
].delete_list(session
, _filter
)
339 def del_item(self
, session
, topic
, _id
, not_send_msg
=None):
341 Delete item by its internal id
342 :param session: contains the used login username and working project
343 :param topic: it can be: users, projects, vnfds, nsds, ...
344 :param _id: server id of the item
345 :param not_send_msg: If False, message will not be sent to kafka.
346 If a list, message is not sent, but content is stored in this variable so that the caller can send this
347 message using its own loop. If None, message is sent
348 :return: dictionary with deleted item _id. It raises exception if not found.
350 if topic
not in self
.map_topic
:
351 raise EngineException(
352 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
354 with self
.write_lock
:
355 return self
.map_topic
[topic
].delete(session
, _id
, not_send_msg
=not_send_msg
)
357 def edit_item(self
, session
, topic
, _id
, indata
=None, kwargs
=None):
359 Update an existing entry at database
360 :param session: contains the used login username and working project
361 :param topic: it can be: users, projects, vnfds, nsds, ...
362 :param _id: identifier to be updated
363 :param indata: data to be inserted
364 :param kwargs: used to override the indata descriptor
365 :return: dictionary with edited item _id, raise exception if not found.
367 if topic
not in self
.map_topic
:
368 raise EngineException(
369 "Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
371 with self
.write_lock
:
372 return self
.map_topic
[topic
].edit(session
, _id
, indata
, kwargs
)
374 def upgrade_db(self
, current_version
, target_version
):
375 if target_version
not in self
.map_target_version_to_int
.keys():
376 raise EngineException(
377 "Cannot upgrade to version '{}' with this version of code".format(
380 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
,
383 if current_version
== target_version
:
386 target_version_int
= self
.map_target_version_to_int
[target_version
]
388 if not current_version
:
389 # create database version
392 "_id": "version", # Always "version"
393 "version_int": 1000, # version number
394 "version": "1.0", # version text
395 "date": "2018-10-25", # version date
396 "description": "added serial", # changes in this version
397 "status": "ENABLED", # ENABLED, DISABLED (migration in process), ERROR,
398 "serial": b64encode(serial
),
400 self
.db
.create("admin", version_data
)
401 self
.db
.set_secret_key(serial
)
402 current_version
= "1.0"
405 current_version
in ("1.0", "1.1")
406 and target_version_int
>= self
.map_target_version_to_int
["1.2"]
408 if self
.config
["authentication"]["backend"] == "internal":
409 self
.db
.del_list("roles")
415 "date": "2019-06-11",
416 "description": "set new format for roles_operations",
419 self
.db
.set_one("admin", {"_id": "version"}, version_data
)
420 current_version
= "1.2"
421 # TODO add future migrations here
423 def init_db(self
, target_version
="1.0"):
425 Init database if empty. If not empty it checks that database version and migrates if needed
426 If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
427 :param target_version: check desired database version. Migrate to it if possible or raises exception
428 :return: None if ok, exception if error or if the version is different.
431 version_data
= self
.db
.get_one(
432 "admin", {"_id": "version"}, fail_on_empty
=False, fail_on_more
=True
434 # check database status is ok
435 if version_data
and version_data
.get("status") != "ENABLED":
436 raise EngineException(
437 "Wrong database status '{}'".format(version_data
["status"]),
438 HTTPStatus
.INTERNAL_SERVER_ERROR
,
442 db_version
= None if not version_data
else version_data
.get("version")
443 if db_version
!= target_version
:
444 self
.upgrade_db(db_version
, target_version
)