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
, 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
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
, OsmRepoTopic
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
37 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
38 min_common_version
= "0.1.16"
42 map_from_topic_to_class
= {
49 "nslcmops": NsLcmOpTopic
,
50 "vim_accounts": VimAccountTopic
,
51 "wim_accounts": WimAccountTopic
,
53 "k8sclusters": K8sClusterTopic
,
54 "k8srepos": K8sRepoTopic
,
55 "osmrepos": OsmRepoTopic
,
56 "users": UserTopicAuth
, # Valid for both internal and keystone authentication backends
57 "projects": ProjectTopicAuth
, # Valid for both internal and keystone authentication backends
58 "roles": RoleTopicAuth
, # Valid for both internal and keystone authentication backends
60 "nsilcmops": NsiLcmOpTopic
,
61 "vnfpkgops": VnfPkgOpTopic
,
62 # [NEW_TOPIC]: add an entry here
63 # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters
66 map_target_version_to_int
= {
70 # Add new versions here
73 def __init__(self
, authenticator
):
79 # self.operations = None
80 self
.logger
= logging
.getLogger("nbi.engine")
82 self
.write_lock
= None
83 # self.token_cache = token_cache
84 self
.authenticator
= authenticator
86 def start(self
, config
):
88 Connect to database, filesystem storage, and messaging
89 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
93 # check right version of common
94 if versiontuple(common_version
) < versiontuple(min_common_version
):
95 raise EngineException("Not compatible osm/common version '{}'. Needed '{}' or higher".format(
96 common_version
, min_common_version
))
100 if config
["database"]["driver"] == "mongo":
101 self
.db
= dbmongo
.DbMongo()
102 self
.db
.db_connect(config
["database"])
103 elif config
["database"]["driver"] == "memory":
104 self
.db
= dbmemory
.DbMemory()
105 self
.db
.db_connect(config
["database"])
107 raise EngineException("Invalid configuration param '{}' at '[database]':'driver'".format(
108 config
["database"]["driver"]))
110 if config
["storage"]["driver"] == "local":
111 self
.fs
= fslocal
.FsLocal()
112 self
.fs
.fs_connect(config
["storage"])
113 elif config
["storage"]["driver"] == "mongo":
114 self
.fs
= fsmongo
.FsMongo()
115 self
.fs
.fs_connect(config
["storage"])
117 raise EngineException("Invalid configuration param '{}' at '[storage]':'driver'".format(
118 config
["storage"]["driver"]))
120 if config
["message"]["driver"] == "local":
121 self
.msg
= msglocal
.MsgLocal()
122 self
.msg
.connect(config
["message"])
123 elif config
["message"]["driver"] == "kafka":
124 self
.msg
= msgkafka
.MsgKafka()
125 self
.msg
.connect(config
["message"])
127 raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(
128 config
["message"]["driver"]))
129 if not self
.authconn
:
130 if config
["authentication"]["backend"] == "keystone":
131 self
.authconn
= AuthconnKeystone(config
["authentication"], self
.db
,
132 self
.authenticator
.role_permissions
)
134 self
.authconn
= AuthconnInternal(config
["authentication"], self
.db
,
135 self
.authenticator
.role_permissions
)
136 # if not self.operations:
137 # if "resources_to_operations" in config["rbac"]:
138 # resources_to_operations_file = config["rbac"]["resources_to_operations"]
141 # __file__[:__file__.rfind("engine.py")] + "resources_to_operations.yml",
142 # "./resources_to_operations.yml"
144 # for config_file in possible_paths:
145 # if path.isfile(config_file):
146 # resources_to_operations_file = config_file
148 # if not resources_to_operations_file:
149 # raise EngineException("Invalid permission configuration:"
150 # "resources_to_operations file missing")
152 # with open(resources_to_operations_file, 'r') as f:
153 # resources_to_operations = yaml.load(f, Loader=yaml.Loader)
155 # self.operations = []
157 # for _, value in resources_to_operations["resources_to_operations"].items():
158 # if value not in self.operations:
159 # self.operations += [value]
161 self
.write_lock
= Lock()
162 # create one class per topic
163 for topic
, topic_class
in self
.map_from_topic_to_class
.items():
164 # if self.auth and topic_class in (UserTopicAuth, ProjectTopicAuth):
165 # self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth)
166 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
, self
.authconn
)
168 self
.map_topic
["pm_jobs"] = PmJobsTopic(self
.db
, config
["prometheus"].get("host"),
169 config
["prometheus"].get("port"))
170 except (DbException
, FsException
, MsgException
) as e
:
171 raise EngineException(str(e
), http_code
=e
.http_code
)
176 self
.db
.db_disconnect()
178 self
.fs
.fs_disconnect()
180 self
.msg
.disconnect()
181 self
.write_lock
= None
182 except (DbException
, FsException
, MsgException
) as e
:
183 raise EngineException(str(e
), http_code
=e
.http_code
)
185 def new_item(self
, rollback
, session
, topic
, indata
=None, kwargs
=None, headers
=None):
187 Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
188 that must be completed with a call to method upload_content
189 :param rollback: list to append created items at database in case a rollback must to be done
190 :param session: contains the used login username and working project, force to avoid checkins, public
191 :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
192 :param indata: data to be inserted
193 :param kwargs: used to override the indata descriptor
194 :param headers: http request headers
195 :return: _id: identity of the inserted data.
197 if topic
not in self
.map_topic
:
198 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
199 with self
.write_lock
:
200 return self
.map_topic
[topic
].new(rollback
, session
, indata
, kwargs
, headers
)
202 def upload_content(self
, session
, topic
, _id
, indata
, kwargs
, headers
):
204 Upload content for an already created entry (_id)
205 :param session: contains the used login username and working project
206 :param topic: it can be: users, projects, vnfds, nsds,
207 :param _id: server id of the item
208 :param indata: data to be inserted
209 :param kwargs: used to override the indata descriptor
210 :param headers: http request headers
211 :return: _id: identity of the inserted data.
213 if topic
not in self
.map_topic
:
214 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
215 with self
.write_lock
:
216 return self
.map_topic
[topic
].upload_content(session
, _id
, indata
, kwargs
, headers
)
218 def get_item_list(self
, session
, topic
, filter_q
=None):
221 :param session: contains the used login username and working project
222 :param topic: it can be: users, projects, vnfds, nsds, ...
223 :param filter_q: filter of data to be applied
224 :return: The list, it can be empty if no one match the filter_q.
226 if topic
not in self
.map_topic
:
227 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
228 return self
.map_topic
[topic
].list(session
, filter_q
)
230 def get_item(self
, session
, topic
, _id
):
232 Get complete information on an item
233 :param session: contains the used login username and working project
234 :param topic: it can be: users, projects, vnfds, nsds,
235 :param _id: server id of the item
236 :return: dictionary, raise exception if not found.
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
].show(session
, _id
)
242 def get_file(self
, session
, topic
, _id
, path
=None, accept_header
=None):
244 Get descriptor package or artifact file content
245 :param session: contains the used login username and working project
246 :param topic: it can be: users, projects, vnfds, nsds,
247 :param _id: server id of the item
248 :param path: artifact path or "$DESCRIPTOR" or None
249 :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
250 :return: opened file plus Accept format or raises an exception
252 if topic
not in self
.map_topic
:
253 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
254 return self
.map_topic
[topic
].get_file(session
, _id
, path
, accept_header
)
256 def del_item_list(self
, session
, topic
, _filter
=None):
258 Delete a list of items
259 :param session: contains the used login username and working project
260 :param topic: it can be: users, projects, vnfds, nsds, ...
261 :param _filter: filter of data to be applied
262 :return: The deleted list, it can be empty if no one match the _filter.
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_list(session
, _filter
)
269 def del_item(self
, session
, topic
, _id
, not_send_msg
=None):
271 Delete item by its internal id
272 :param session: contains the used login username and working project
273 :param topic: it can be: users, projects, vnfds, nsds, ...
274 :param _id: server id of the item
275 :param not_send_msg: If False, message will not be sent to kafka.
276 If a list, message is not sent, but content is stored in this variable so that the caller can send this
277 message using its own loop. If None, message is sent
278 :return: dictionary with deleted item _id. It raises 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
].delete(session
, _id
, not_send_msg
=not_send_msg
)
285 def edit_item(self
, session
, topic
, _id
, indata
=None, kwargs
=None):
287 Update an existing entry at database
288 :param session: contains the used login username and working project
289 :param topic: it can be: users, projects, vnfds, nsds, ...
290 :param _id: identifier to be updated
291 :param indata: data to be inserted
292 :param kwargs: used to override the indata descriptor
293 :return: dictionary with edited item _id, raise exception if not found.
295 if topic
not in self
.map_topic
:
296 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
297 with self
.write_lock
:
298 return self
.map_topic
[topic
].edit(session
, _id
, indata
, kwargs
)
300 def upgrade_db(self
, current_version
, target_version
):
301 if target_version
not in self
.map_target_version_to_int
.keys():
302 raise EngineException("Cannot upgrade to version '{}' with this version of code".format(target_version
),
303 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
)
305 if current_version
== target_version
:
308 target_version_int
= self
.map_target_version_to_int
[target_version
]
310 if not current_version
:
311 # create database version
314 "_id": "version", # Always "version"
315 "version_int": 1000, # version number
316 "version": "1.0", # version text
317 "date": "2018-10-25", # version date
318 "description": "added serial", # changes in this version
319 'status': "ENABLED", # ENABLED, DISABLED (migration in process), ERROR,
320 'serial': b64encode(serial
)
322 self
.db
.create("admin", version_data
)
323 self
.db
.set_secret_key(serial
)
324 current_version
= "1.0"
326 if current_version
in ("1.0", "1.1") and target_version_int
>= self
.map_target_version_to_int
["1.2"]:
327 if self
.config
['authentication']['backend'] == "internal":
328 self
.db
.del_list("roles")
334 "date": "2019-06-11",
335 "description": "set new format for roles_operations"
338 self
.db
.set_one("admin", {"_id": "version"}, version_data
)
339 current_version
= "1.2"
340 # TODO add future migrations here
342 def init_db(self
, target_version
='1.0'):
344 Init database if empty. If not empty it checks that database version and migrates if needed
345 If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
346 :param target_version: check desired database version. Migrate to it if possible or raises exception
347 :return: None if ok, exception if error or if the version is different.
350 version_data
= self
.db
.get_one("admin", {"_id": "version"}, fail_on_empty
=False, fail_on_more
=True)
351 # check database status is ok
352 if version_data
and version_data
.get("status") != 'ENABLED':
353 raise EngineException("Wrong database status '{}'".format(
354 version_data
["status"]), HTTPStatus
.INTERNAL_SERVER_ERROR
)
357 db_version
= None if not version_data
else version_data
.get("version")
358 if db_version
!= target_version
:
359 self
.upgrade_db(db_version
, target_version
)