2 # Copyright 2019 Telefonica Investigacion y Desarrollo, S.A.U.
3 # This file is part of OSM
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
19 # For those usages not covered by the Apache License, Version 2.0 please
20 # contact with: nfvlabs@tid.es
31 from http
import HTTPStatus
32 from n2vc
.loggable
import Loggable
33 from n2vc
.exceptions
import N2VCBadArgumentsException
35 from osm_common
.dbmongo
import DbException
38 class N2VCDeploymentStatus(Enum
):
41 COMPLETED
= 'completed'
46 class N2VCConnector(abc
.ABC
, Loggable
):
47 """Generic N2VC connector
53 ##################################################################################################
54 ########################################## P U B L I C ###########################################
55 ##################################################################################################
69 """Initialize N2VC abstract connector. It defines de API for VCA connectors
71 :param object db: Mongo object managing the MongoDB (repo common DbBase)
72 :param object fs: FileSystem object managing the package artifacts (repo common FsBase)
73 :param object log: the logging object to log to
74 :param object loop: the loop to use for asyncio (default current thread loop)
75 :param str url: a string that how to connect to the VCA (if needed, IP and port can be obtained from there)
76 :param str username: the username to authenticate with VCA
77 :param dict vca_config: Additional parameters for the specific VCA. For example, for juju it will contain:
78 secret: The password to authenticate with
79 public_key: The contents of the juju public SSH key
80 ca_cert str: The CA certificate used to authenticate
81 :param on_update_db: callback called when n2vc connector updates database. Received arguments:
83 filter: e.g. {_id: <nsd-id> }
84 path: e.g. "_admin.deployed.VCA.3."
85 updated_data: e.g. , "{ _admin.deployed.VCA.3.status: 'xxx', etc }"
89 Loggable
.__init
__(self
, log
=log
, log_to_console
=True, prefix
='\nN2VC')
93 raise N2VCBadArgumentsException('Argument db is mandatory', ['db'])
95 raise N2VCBadArgumentsException('Argument fs is mandatory', ['fs'])
97 self
.info('url={}, username={}, vca_config={}'.format(url
, username
, vca_config
))
99 # store arguments into self
102 self
.loop
= loop
or asyncio
.get_event_loop()
104 self
.username
= username
105 self
.vca_config
= vca_config
106 self
.on_update_db
= on_update_db
108 # generate private/public key-pair
109 self
.get_public_key()
112 async def get_status(self
, namespace
: str):
113 """Get namespace status
115 :param namespace: we obtain ns from namespace
118 # TODO: review which public key
119 async def get_public_key(self
) -> str:
120 """Get the VCA ssh-public-key
122 Returns the SSH public key from local mahine, to be injected into virtual machines to
123 be managed by the VCA.
124 First run, a ssh keypair will be created.
125 The public key is injected into a VM so that we can provision the
126 machine with Juju, after which Juju will communicate with the VM
127 directly via the juju agent.
132 # Find the path where we expect our key lives (~/.ssh)
133 homedir
= os
.environ
['HOME']
134 sshdir
= "{}/.ssh".format(homedir
)
135 if not os
.path
.exists(sshdir
):
138 self
.private_key_path
= "{}/id_n2vc_rsa".format(sshdir
)
139 self
.public_key_path
= "{}.pub".format(self
.private_key_path
)
141 # If we don't have a key generated, then we have to generate it using ssh-keygen
142 if not os
.path
.exists(self
.private_key_path
):
143 cmd
= "ssh-keygen -t {} -b {} -N '' -f {}".format(
146 self
.private_key_path
148 # run command with arguments
149 subprocess
.check_output(shlex
.split(cmd
))
151 # Read the public key. Only one public key (one line) in the file
152 with
open(self
.public_key_path
, "r") as file:
153 public_key
= file.readline()
158 async def create_execution_environment(
162 reuse_ee_id
: str = None,
163 progress_timeout
: float = None,
164 total_timeout
: float = None
166 """Create an Execution Environment. Returns when it is created or raises an exception on failing
168 :param str namespace: Contains a dot separate string.
169 LCM will use: [<nsi-id>].<ns-id>.<vnf-id>.<vdu-id>[-<count>]
170 :param dict db_dict: where to write to database when the status changes.
171 It contains a dictionary with {collection: str, filter: {}, path: str},
172 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.VCA.3"}
173 :param str reuse_ee_id: ee id from an older execution. It allows us to reuse an older environment
174 :param float progress_timeout:
175 :param float total_timeout:
176 :returns str, dict: id of the new execution environment and credentials for it
177 (credentials can contains hostname, username, etc depending on underlying cloud)
181 async def register_execution_environment(
186 progress_timeout
: float = None,
187 total_timeout
: float = None
190 Register an existing execution environment at the VCA
192 :param str namespace: same as create_execution_environment method
193 :param dict credentials: credentials to access the existing execution environment
194 (it can contains hostname, username, path to private key, etc depending on underlying cloud)
195 :param dict db_dict: where to write to database when the status changes.
196 It contains a dictionary with {collection: str, filter: {}, path: str},
197 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.VCA.3"}
198 :param float progress_timeout:
199 :param float total_timeout:
200 :returns str: id of the execution environment
204 async def install_configuration_sw(
209 progress_timeout
: float = None,
210 total_timeout
: float = None
213 Install the software inside the execution environment identified by ee_id
215 :param str ee_id: the id of the execution environment returned by create_execution_environment
216 or register_execution_environment
217 :param str artifact_path: where to locate the artifacts (parent folder) using the self.fs
218 the final artifact path will be a combination of this artifact_path and additional string from
219 the config_dict (e.g. charm name)
220 :param dict db_dict: where to write into database when the status changes.
221 It contains a dict with {collection: <str>, filter: {}, path: <str>},
222 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.VCA.3"}
223 :param float progress_timeout:
224 :param float total_timeout:
228 async def get_ee_ssh_public__key(
232 progress_timeout
: float = None,
233 total_timeout
: float = None
236 Generate a priv/pub key pair in the execution environment and return the public key
238 :param str ee_id: the id of the execution environment returned by create_execution_environment
239 or register_execution_environment
240 :param dict db_dict: where to write into database when the status changes.
241 It contains a dict with {collection: <str>, filter: {}, path: <str>},
242 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.VCA.3"}
243 :param float progress_timeout:
244 :param float total_timeout:
245 :returns: public key of the execution environment
246 For the case of juju proxy charm ssh-layered, it is the one returned by 'get-ssh-public-key'
248 It raises a N2VC exception if fails
252 async def add_relation(
260 Add a relation between two Execution Environments (using their associated endpoints).
262 :param str ee_id_1: The id of the first execution environment
263 :param str ee_id_2: The id of the second execution environment
264 :param str endpoint_1: The endpoint in the first execution environment
265 :param str endpoint_2: The endpoint in the second execution environment
270 async def remove_relation(
278 async def deregister_execution_environments(
285 async def delete_namespace(
288 db_dict
: dict = None,
289 total_timeout
: float = None
292 Remove a network scenario and its execution environments
293 :param namespace: [<nsi-id>].<ns-id>
294 :param dict db_dict: where to write into database when the status changes.
295 It contains a dict with {collection: <str>, filter: {}, path: <str>},
296 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.VCA.3"}
297 :param float total_timeout:
301 async def delete_execution_environment(
304 db_dict
: dict = None,
305 total_timeout
: float = None
308 Delete an execution environment
309 :param str ee_id: id of the execution environment to delete
310 :param dict db_dict: where to write into database when the status changes.
311 It contains a dict with {collection: <str>, filter: {}, path: <str>},
312 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.VCA.3"}
313 :param float total_timeout:
317 async def exec_primitive(
322 db_dict
: dict = None,
323 progress_timeout
: float = None,
324 total_timeout
: float = None
327 Execute a primitive in the execution environment
329 :param str ee_id: the one returned by create_execution_environment or register_execution_environment
330 :param str primitive_name: must be one defined in the software. There is one called 'config',
331 where, for the proxy case, the 'credentials' of VM are provided
332 :param dict params_dict: parameters of the action
333 :param dict db_dict: where to write into database when the status changes.
334 It contains a dict with {collection: <str>, filter: {}, path: <str>},
335 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.VCA.3"}
336 :param float progress_timeout:
337 :param float total_timeout:
338 :returns str: primitive result, if ok. It raises exceptions in case of fail
341 async def disconnect(self
):
347 ##################################################################################################
348 ########################################## P R I V A T E #########################################
349 ##################################################################################################
352 def _get_namespace_components(self
, namespace
: str) -> (str, str, str, str, str):
354 Split namespace components
356 :param namespace: [<nsi-id>].<ns-id>.<vnf-id>.<vdu-id>[-<count>]
357 :return: nsi_id, ns_id, vnf_id, vdu_id, vdu_count
361 if namespace
is None or len(namespace
) == 0:
362 raise N2VCBadArgumentsException('Argument namespace is mandatory', ['namespace'])
364 # split namespace components
365 parts
= namespace
.split('.')
371 if len(parts
) > 0 and len(parts
[0]) > 0:
373 if len(parts
) > 1 and len(parts
[1]) > 0:
375 if len(parts
) > 2 and len(parts
[2]) > 0:
377 if len(parts
) > 3 and len(parts
[3]) > 0:
379 vdu_parts
= parts
[3].split('-')
380 if len(vdu_parts
) > 1:
381 vdu_id
= vdu_parts
[0]
382 vdu_count
= vdu_parts
[1]
384 return nsi_id
, ns_id
, vnf_id
, vdu_id
, vdu_count
386 async def write_app_status_to_db(
389 status
: N2VCDeploymentStatus
,
390 detailed_status
: str,
395 self
.debug('No db_dict => No database write')
398 self
.debug('status={} / detailed-status={} / VCA-status={} / entity_type={}'
399 .format(str(status
.value
), detailed_status
, vca_status
, entity_type
))
403 the_table
= db_dict
['collection']
404 the_filter
= db_dict
['filter']
405 the_path
= db_dict
['path']
406 if not the_path
[-1] == '.':
407 the_path
= the_path
+ '.'
409 the_path
+ 'status': str(status
.value
),
410 the_path
+ 'detailed-status': detailed_status
,
411 the_path
+ 'VCA-status': vca_status
,
412 the_path
+ 'entity-type': entity_type
,
413 the_path
+ 'status-time': str(time
.time()),
419 update_dict
=update_dict
,
424 if self
.on_update_db
:
425 if asyncio
.iscoroutinefunction(self
.on_update_db
):
426 await self
.on_update_db(the_table
, the_filter
, the_path
, update_dict
)
428 self
.on_update_db(the_table
, the_filter
, the_path
, update_dict
)
430 except DbException
as e
:
431 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
432 self
.error('NOT_FOUND error: Exception writing status to database: {}'.format(e
))
434 self
.info('Exception writing status to database: {}'.format(e
))
437 def juju_status_2_osm_status(type: str, status
: str) -> N2VCDeploymentStatus
:
438 if type == 'application' or type == 'unit':
439 if status
in ['waiting', 'maintenance']:
440 return N2VCDeploymentStatus
.RUNNING
441 elif status
in ['active']:
442 return N2VCDeploymentStatus
.COMPLETED
443 elif status
in ['blocked']:
444 return N2VCDeploymentStatus
.RUNNING
446 return N2VCDeploymentStatus
.UNKNOWN
447 elif type == 'action':
448 if status
in ['running']:
449 return N2VCDeploymentStatus
.RUNNING
450 elif status
in ['completed']:
451 return N2VCDeploymentStatus
.COMPLETED
453 return N2VCDeploymentStatus
.UNKNOWN
454 elif type == 'machine':
455 if status
in ['pending']:
456 return N2VCDeploymentStatus
.PENDING
457 elif status
in ['started']:
458 return N2VCDeploymentStatus
.COMPLETED
460 return N2VCDeploymentStatus
.UNKNOWN
462 return N2VCDeploymentStatus
.FAILED