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
29 from osm_nbi
.admin_topics
import UserTopicAuth
, ProjectTopicAuth
, RoleTopicAuth
30 from osm_nbi
.descriptor_topics
import VnfdTopic
, NsdTopic
, PduTopic
, NstTopic
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 "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
59 "nsilcmops": NsiLcmOpTopic
60 # [NEW_TOPIC]: add an entry here
61 # "pm_jobs": PmJobsTopic will be added manually because it needs other parameters
64 map_target_version_to_int
= {
68 # Add new versions here
71 def __init__(self
, token_cache
):
77 self
.operations
= None
78 self
.logger
= logging
.getLogger("nbi.engine")
80 self
.write_lock
= None
81 self
.token_cache
= token_cache
83 def start(self
, config
):
85 Connect to database, filesystem storage, and messaging
86 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
90 # check right version of common
91 if versiontuple(common_version
) < versiontuple(min_common_version
):
92 raise EngineException("Not compatible osm/common version '{}'. Needed '{}' or higher".format(
93 common_version
, min_common_version
))
97 if config
["database"]["driver"] == "mongo":
98 self
.db
= dbmongo
.DbMongo()
99 self
.db
.db_connect(config
["database"])
100 elif config
["database"]["driver"] == "memory":
101 self
.db
= dbmemory
.DbMemory()
102 self
.db
.db_connect(config
["database"])
104 raise EngineException("Invalid configuration param '{}' at '[database]':'driver'".format(
105 config
["database"]["driver"]))
107 if config
["storage"]["driver"] == "local":
108 self
.fs
= fslocal
.FsLocal()
109 self
.fs
.fs_connect(config
["storage"])
110 elif config
["storage"]["driver"] == "mongo":
111 self
.fs
= fsmongo
.FsMongo()
112 self
.fs
.fs_connect(config
["storage"])
114 raise EngineException("Invalid configuration param '{}' at '[storage]':'driver'".format(
115 config
["storage"]["driver"]))
117 if config
["message"]["driver"] == "local":
118 self
.msg
= msglocal
.MsgLocal()
119 self
.msg
.connect(config
["message"])
120 elif config
["message"]["driver"] == "kafka":
121 self
.msg
= msgkafka
.MsgKafka()
122 self
.msg
.connect(config
["message"])
124 raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format(
125 config
["message"]["driver"]))
127 if config
["authentication"]["backend"] == "keystone":
128 self
.auth
= AuthconnKeystone(config
["authentication"], self
.db
, None)
130 self
.auth
= AuthconnInternal(config
["authentication"], self
.db
, self
.token_cache
)
131 if not self
.operations
:
132 if "resources_to_operations" in config
["rbac"]:
133 resources_to_operations_file
= config
["rbac"]["resources_to_operations"]
136 __file__
[:__file__
.rfind("engine.py")] + "resources_to_operations.yml",
137 "./resources_to_operations.yml"
139 for config_file
in possible_paths
:
140 if path
.isfile(config_file
):
141 resources_to_operations_file
= config_file
143 if not resources_to_operations_file
:
144 raise EngineException("Invalid permission configuration: resources_to_operations file missing")
146 with
open(resources_to_operations_file
, 'r') as f
:
147 resources_to_operations
= yaml
.load(f
, Loader
=yaml
.Loader
)
151 for _
, value
in resources_to_operations
["resources_to_operations"].items():
152 if value
not in self
.operations
:
153 self
.operations
+= [value
]
155 self
.write_lock
= Lock()
156 # create one class per topic
157 for topic
, topic_class
in self
.map_from_topic_to_class
.items():
158 # if self.auth and topic_class in (UserTopicAuth, ProjectTopicAuth):
159 # self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth)
160 if self
.auth
and topic_class
== RoleTopicAuth
:
161 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
, self
.auth
,
164 self
.map_topic
[topic
] = topic_class(self
.db
, self
.fs
, self
.msg
, self
.auth
)
166 self
.map_topic
["pm_jobs"] = PmJobsTopic(self
.db
, config
["prometheus"].get("host"),
167 config
["prometheus"].get("port"))
168 except (DbException
, FsException
, MsgException
) as e
:
169 raise EngineException(str(e
), http_code
=e
.http_code
)
174 self
.db
.db_disconnect()
176 self
.fs
.fs_disconnect()
178 self
.msg
.disconnect()
179 self
.write_lock
= None
180 except (DbException
, FsException
, MsgException
) as e
:
181 raise EngineException(str(e
), http_code
=e
.http_code
)
183 def new_item(self
, rollback
, session
, topic
, indata
=None, kwargs
=None, headers
=None):
185 Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
186 that must be completed with a call to method upload_content
187 :param rollback: list to append created items at database in case a rollback must to be done
188 :param session: contains the used login username and working project, force to avoid checkins, public
189 :param topic: it can be: users, projects, vim_accounts, sdns, nsrs, nsds, vnfds
190 :param indata: data to be inserted
191 :param kwargs: used to override the indata descriptor
192 :param headers: http request headers
193 :return: _id: identity of the inserted data.
195 if topic
not in self
.map_topic
:
196 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
197 with self
.write_lock
:
198 return self
.map_topic
[topic
].new(rollback
, session
, indata
, kwargs
, headers
)
200 def upload_content(self
, session
, topic
, _id
, indata
, kwargs
, headers
):
202 Upload content for an already created entry (_id)
203 :param session: contains the used login username and working project
204 :param topic: it can be: users, projects, vnfds, nsds,
205 :param _id: server id of the item
206 :param indata: data to be inserted
207 :param kwargs: used to override the indata descriptor
208 :param headers: http request headers
209 :return: _id: identity of the inserted data.
211 if topic
not in self
.map_topic
:
212 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
213 with self
.write_lock
:
214 return self
.map_topic
[topic
].upload_content(session
, _id
, indata
, kwargs
, headers
)
216 def get_item_list(self
, session
, topic
, filter_q
=None):
219 :param session: contains the used login username and working project
220 :param topic: it can be: users, projects, vnfds, nsds, ...
221 :param filter_q: filter of data to be applied
222 :return: The list, it can be empty if no one match the filter_q.
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
].list(session
, filter_q
)
228 def get_item(self
, session
, topic
, _id
):
230 Get complete information on an item
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 :return: dictionary, raise exception if not found.
236 if topic
not in self
.map_topic
:
237 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
238 return self
.map_topic
[topic
].show(session
, _id
)
240 def get_file(self
, session
, topic
, _id
, path
=None, accept_header
=None):
242 Get descriptor package or artifact file content
243 :param session: contains the used login username and working project
244 :param topic: it can be: users, projects, vnfds, nsds,
245 :param _id: server id of the item
246 :param path: artifact path or "$DESCRIPTOR" or None
247 :param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
248 :return: opened file plus Accept format or raises an exception
250 if topic
not in self
.map_topic
:
251 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
252 return self
.map_topic
[topic
].get_file(session
, _id
, path
, accept_header
)
254 def del_item_list(self
, session
, topic
, _filter
=None):
256 Delete a list of items
257 :param session: contains the used login username and working project
258 :param topic: it can be: users, projects, vnfds, nsds, ...
259 :param _filter: filter of data to be applied
260 :return: The deleted list, it can be empty if no one match the _filter.
262 if topic
not in self
.map_topic
:
263 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
264 with self
.write_lock
:
265 return self
.map_topic
[topic
].delete_list(session
, _filter
)
267 def del_item(self
, session
, topic
, _id
):
269 Delete item by its internal id
270 :param session: contains the used login username and working project
271 :param topic: it can be: users, projects, vnfds, nsds, ...
272 :param _id: server id of the item
273 :return: dictionary with deleted item _id. It raises exception if not found.
275 if topic
not in self
.map_topic
:
276 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
277 with self
.write_lock
:
278 return self
.map_topic
[topic
].delete(session
, _id
)
280 def edit_item(self
, session
, topic
, _id
, indata
=None, kwargs
=None):
282 Update an existing entry at database
283 :param session: contains the used login username and working project
284 :param topic: it can be: users, projects, vnfds, nsds, ...
285 :param _id: identifier to be updated
286 :param indata: data to be inserted
287 :param kwargs: used to override the indata descriptor
288 :return: dictionary with edited item _id, raise exception if not found.
290 if topic
not in self
.map_topic
:
291 raise EngineException("Unknown topic {}!!!".format(topic
), HTTPStatus
.INTERNAL_SERVER_ERROR
)
292 with self
.write_lock
:
293 return self
.map_topic
[topic
].edit(session
, _id
, indata
, kwargs
)
295 def upgrade_db(self
, current_version
, target_version
):
296 if target_version
not in self
.map_target_version_to_int
.keys():
297 raise EngineException("Cannot upgrade to version '{}' with this version of code".format(target_version
),
298 http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
)
300 if current_version
== target_version
:
303 target_version_int
= self
.map_target_version_to_int
[target_version
]
305 if not current_version
:
306 # create database version
309 "_id": "version", # Always "version"
310 "version_int": 1000, # version number
311 "version": "1.0", # version text
312 "date": "2018-10-25", # version date
313 "description": "added serial", # changes in this version
314 'status': "ENABLED", # ENABLED, DISABLED (migration in process), ERROR,
315 'serial': b64encode(serial
)
317 self
.db
.create("admin", version_data
)
318 self
.db
.set_secret_key(serial
)
319 current_version
= "1.0"
321 if current_version
in ("1.0", "1.1") and target_version_int
>= self
.map_target_version_to_int
["1.2"]:
322 if self
.config
['authentication']['backend'] == "internal":
323 self
.db
.del_list("roles")
329 "date": "2019-06-11",
330 "description": "set new format for roles_operations"
333 self
.db
.set_one("admin", {"_id": "version"}, version_data
)
334 current_version
= "1.2"
335 # TODO add future migrations here
337 def init_db(self
, target_version
='1.0'):
339 Init database if empty. If not empty it checks that database version and migrates if needed
340 If empty, it creates a new user admin/admin at 'users' and a new entry at 'version'
341 :param target_version: check desired database version. Migrate to it if possible or raises exception
342 :return: None if ok, exception if error or if the version is different.
345 version_data
= self
.db
.get_one("admin", {"_id": "version"}, fail_on_empty
=False, fail_on_more
=True)
346 # check database status is ok
347 if version_data
and version_data
.get("status") != 'ENABLED':
348 raise EngineException("Wrong database status '{}'".format(
349 version_data
["status"]), HTTPStatus
.INTERNAL_SERVER_ERROR
)
352 db_version
= None if not version_data
else version_data
.get("version")
353 if db_version
!= target_version
:
354 self
.upgrade_db(db_version
, target_version
)