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.
18 from osm_common
import dbmongo
, dbmemory
, fslocal
, 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
24 from authconn_keystone
import AuthconnKeystone
25 from base_topic
import EngineException
, versiontuple
26 from admin_topics
import UserTopic
, ProjectTopic
, VimAccountTopic
, WimAccountTopic
, SdnTopic
27 from admin_topics
import UserTopicAuth
, ProjectTopicAuth
, RoleTopicAuth
28 from descriptor_topics
import VnfdTopic
, NsdTopic
, PduTopic
, NstTopic
29 from instance_topics
import NsrTopic
, VnfrTopic
, NsLcmOpTopic
, NsiTopic
, NsiLcmOpTopic
30 from pmjobs_topics
import PmJobsTopic
31 from base64
import b64encode
32 from os
import urandom
, path
33 from threading
import Lock
35 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
36 min_common_version
= "0.1.16"
40 map_from_topic_to_class
= {
47 "nslcmops": NsLcmOpTopic
,
48 "vim_accounts": VimAccountTopic
,
49 "wim_accounts": WimAccountTopic
,
52 "projects": ProjectTopic
,
54 "nsilcmops": NsiLcmOpTopic
55 # [NEW_TOPIC]: add an entry here
56 # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters
65 self
.operations
= None
66 self
.logger
= logging
.getLogger("nbi.engine")
68 self
.write_lock
= None
70 def start(self
, config
):
72 Connect to database, filesystem storage, and messaging
73 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
77 # check right version of common
78 if versiontuple(common_version
) < versiontuple(min_common_version
):
79 raise EngineException("Not compatible osm/common version '{}'. Needed '{}' or higher".format(
80 common_version
, min_common_version
))
84 if config
["database"]["driver"] == "mongo":
85 self
.db
= dbmongo
.DbMongo()
86 self
.db
.db_connect(config
["database"])
87 elif config
["database"]["driver"] == "memory":
88 self
.db
= dbmemory
.DbMemory()
89 self
.db
.db_connect(config
["database"])
91 raise EngineException("Invalid configuration param '{}' at '[database]':'driver'".format(
92 config
["database"]["driver"]))
94 if config
["storage"]["driver"] == "local":
95 self
.fs
= fslocal
.FsLocal()
96 self
.fs
.fs_connect(config
["storage"])
98 raise EngineException("Invalid configuration param '{}' at '[storage]':'driver'".format(
99 config
["storage"]["driver"]))
101 if config
["message"]["driver"] == "local":
102 self
.msg
= msglocal
.MsgLocal()
103 self
.msg
.connect(config
["message"])
104 elif config
["message"]["driver"] == "kafka":
105 self
.msg
= msgkafka
.MsgKafka()
106 self
.msg
.connect(config
["message"])
108 raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(
109 config
["message"]["driver"]))
111 if config
["authentication"]["backend"] == "keystone":
112 self
.auth
= AuthconnKeystone(config
["authentication"])
113 if not self
.operations
:
114 if "resources_to_operations" in config
["rbac"]:
115 resources_to_operations_file
= config
["rbac"]["resources_to_operations"]
118 __file__
[:__file__
.rfind("engine.py")] + "resources_to_operations.yml",
119 "./resources_to_operations.yml"
121 for config_file
in possible_paths
:
122 if path
.isfile(config_file
):
123 resources_to_operations_file
= config_file
125 if not resources_to_operations_file
:
126 raise EngineException("Invalid permission configuration: resources_to_operations file missing")
128 with
open(resources_to_operations_file
, 'r') as f
:
129 resources_to_operations
= yaml
.load(f
)
133 for _
, value
in resources_to_operations
["resources_to_operations"].items():
134 if value
not in self
.operations
:
135 self
.operations
+= value
137 if config
["authentication"]["backend"] == "keystone":
138 self
.map_from_topic_to_class
["users"] = UserTopicAuth
139 self
.map_from_topic_to_class
["projects"] = ProjectTopicAuth
140 self
.map_from_topic_to_class
["roles"] = RoleTopicAuth
142 self
.write_lock
= Lock()
143 # create one class per topic
144 for topic
, topic_class
in self
.map_from_topic_to_class
.items():
145 if self
.auth
and topic_class
in (UserTopicAuth
, ProjectTopicAuth
):
146 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
, self
.auth
)
147 elif self
.auth
and topic_class
== RoleTopicAuth
:
148 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
, self
.auth
,
151 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
)
152 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
)
153 self
.map_topic
["pm_jobs"] = PmJobsTopic(config
["prometheus"].get("host"), config
["prometheus"].get("port"))
154 except (DbException
, FsException
, MsgException
) as e
:
155 raise EngineException(str(e
), http_code
=e
.http_code
)
160 self
.db
.db_disconnect()
162 self
.fs
.fs_disconnect()
164 self
.msg
.disconnect()
165 self
.write_lock
= None
166 except (DbException
, FsException
, MsgException
) as e
:
167 raise EngineException(str(e
), http_code
=e
.http_code
)
169 def new_item(self
, rollback
, session
, topic
, indata
=None, kwargs
=None, headers
=None, force
=False):
171 Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
172 that must be completed with a call to method upload_content
173 :param rollback: list to append created items at database in case a rollback must to be done
174 :param session: contains the used login username and working project
175 :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
176 :param indata: data to be inserted
177 :param kwargs: used to override the indata descriptor
178 :param headers: http request headers
179 :param force: If True avoid some dependence checks
180 :return: _id: identity of the inserted data.
182 if topic
not in self
.map_topic
:
183 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
184 with self
.write_lock
:
185 return self
.map_topic
[topic
].new(rollback
, session
, indata
, kwargs
, headers
, force
)
187 def upload_content(self
, session
, topic
, _id
, indata
, kwargs
, headers
, force
=False):
189 Upload content for an already created entry (_id)
190 :param session: contains the used login username and working project
191 :param topic: it can be: users, projects, vnfds, nsds,
192 :param _id: server id of the item
193 :param indata: data to be inserted
194 :param kwargs: used to override the indata descriptor
195 :param headers: http request headers
196 :param force: If True avoid some dependence checks
197 :return: _id: identity of the inserted data.
199 if topic
not in self
.map_topic
:
200 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
201 with self
.write_lock
:
202 return self
.map_topic
[topic
].upload_content(session
, _id
, indata
, kwargs
, headers
, force
)
204 def get_item_list(self
, session
, topic
, filter_q
=None):
207 :param session: contains the used login username and working project
208 :param topic: it can be: users, projects, vnfds, nsds, ...
209 :param filter_q: filter of data to be applied
210 :return: The list, it can be empty if no one match the filter_q.
212 if topic
not in self
.map_topic
:
213 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
214 return self
.map_topic
[topic
].list(session
, filter_q
)
216 def get_item(self
, session
, topic
, _id
):
218 Get complete information on an item
219 :param session: contains the used login username and working project
220 :param topic: it can be: users, projects, vnfds, nsds,
221 :param _id: server id of the item
222 :return: dictionary, raise exception if not found.
224 if topic
not in self
.map_topic
:
225 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
226 return self
.map_topic
[topic
].show(session
, _id
)
228 def get_file(self
, session
, topic
, _id
, path
=None, accept_header
=None):
230 Get descriptor package or artifact file content
231 :param session: contains the used login username and working project
232 :param topic: it can be: users, projects, vnfds, nsds,
233 :param _id: server id of the item
234 :param path: artifact path or "$DESCRIPTOR" or None
235 :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
236 :return: opened file plus Accept format or raises an exception
238 if topic
not in self
.map_topic
:
239 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
240 return self
.map_topic
[topic
].get_file(session
, _id
, path
, accept_header
)
242 def del_item_list(self
, session
, topic
, _filter
=None):
244 Delete a list of items
245 :param session: contains the used login username and working project
246 :param topic: it can be: users, projects, vnfds, nsds, ...
247 :param _filter: filter of data to be applied
248 :return: The deleted list, it can be empty if no one match the _filter.
250 if topic
not in self
.map_topic
:
251 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
252 with self
.write_lock
:
253 return self
.map_topic
[topic
].delete_list(session
, _filter
)
255 def del_item(self
, session
, topic
, _id
, force
=False):
257 Delete item by its internal id
258 :param session: contains the used login username and working project
259 :param topic: it can be: users, projects, vnfds, nsds, ...
260 :param _id: server id of the item
261 :param force: indicates if deletion must be forced in case of conflict
262 :return: dictionary with deleted item _id. It raises exception if not found.
264 if topic
not in self
.map_topic
:
265 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
266 with self
.write_lock
:
267 return self
.map_topic
[topic
].delete(session
, _id
, force
)
269 def edit_item(self
, session
, topic
, _id
, indata
=None, kwargs
=None, force
=False):
271 Update an existing entry at database
272 :param session: contains the used login username and working project
273 :param topic: it can be: users, projects, vnfds, nsds, ...
274 :param _id: identifier to be updated
275 :param indata: data to be inserted
276 :param kwargs: used to override the indata descriptor
277 :param force: If True avoid some dependence checks
278 :return: dictionary, raise exception if not found.
280 if topic
not in self
.map_topic
:
281 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
282 with self
.write_lock
:
283 return self
.map_topic
[topic
].edit(session
, _id
, indata
, kwargs
, force
)
285 def create_admin_project(self
):
287 Creates a new project 'admin' into database if database is empty. Useful for initialization.
288 :return: _id identity of the inserted data, or None
291 projects
= self
.db
.get_one("projects", fail_on_empty
=False, fail_on_more
=False)
294 project_desc
= {"name": "admin"}
295 fake_session
= {"project_id": "admin", "username": "admin", "admin": True}
297 _id
= self
.map_topic
["projects"].new(rollback_list
, fake_session
, project_desc
, force
=True)
300 def create_admin_user(self
):
302 Creates a new user admin/admin into database if database is empty. Useful for initialization
303 :return: _id identity of the inserted data, or None
305 users
= self
.db
.get_one("users", fail_on_empty
=False, fail_on_more
=False)
308 # raise EngineException("Unauthorized. Database users is not empty", HTTPStatus.UNAUTHORIZED)
309 user_desc
= {"username": "admin", "password": "admin", "projects": ["admin"]}
310 fake_session
= {"project_id": "admin", "username": "admin", "admin": True}
312 _id
= self
.map_topic
["users"].new(roolback_list
, fake_session
, user_desc
, force
=True)
315 def create_admin(self
):
317 Creates new 'admin' user and project into database if database is empty. Useful for initialization.
318 :return: _id identity of the inserted data, or None
320 project_id
= self
.create_admin_project()
321 user_id
= self
.create_admin_user()
322 if not project_id
and not user_id
:
325 return {'project_id': project_id
, 'user_id': user_id
}
327 def upgrade_db(self
, current_version
, target_version
):
328 if not target_version
or current_version
== target_version
:
330 if target_version
== '1.0':
331 if not current_version
:
332 # create database version
335 "_id": 'version', # Always 'version'
336 "version_int": 1000, # version number
337 "version": '1.0', # version text
338 "date": "2018-10-25", # version date
339 "description": "added serial", # changes in this version
340 'status': 'ENABLED', # ENABLED, DISABLED (migration in process), ERROR,
341 'serial': b64encode(serial
)
343 self
.db
.create("admin", version_data
)
344 self
.db
.set_secret_key(serial
)
346 # TODO add future migrations here
348 raise EngineException("Wrong database version '{}'. Expected '{}'"
349 ". It cannot be up/down-grade".format(current_version
, target_version
),
350 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
)
352 def init_db(self
, target_version
='1.0'):
354 Init database if empty. If not empty it checks that database version and migrates if needed
355 If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
356 :param target_version: check desired database version. Migrate to it if possible or raises exception
357 :return: None if ok, exception if error or if the version is different.
360 version_data
= self
.db
.get_one("admin", {"_id": "version"}, fail_on_empty
=False, fail_on_more
=True)
361 # check database status is ok
362 if version_data
and version_data
.get("status") != 'ENABLED':
363 raise EngineException("Wrong database status '{}'".format(
364 version_data
["status"]), HTTPStatus
.INTERNAL_SERVER_ERROR
)
367 db_version
= None if not version_data
else version_data
.get("version")
368 if db_version
!= target_version
:
369 self
.upgrade_db(db_version
, target_version
)
371 # create user admin if not exist