2 # Copyright 2020 Telefonica Investigacion y Desarrollo, S.A.U.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
24 from grpclib
.client
import Channel
26 from osm_lcm
.frontend_pb2
import PrimitiveRequest
27 from osm_lcm
.frontend_pb2
import SshKeyRequest
, SshKeyReply
28 from osm_lcm
.frontend_grpc
import FrontendExecutorStub
30 from n2vc
.n2vc_conn
import N2VCConnector
31 from n2vc
.k8s_helm_conn
import K8sHelmConnector
32 from n2vc
.exceptions
import N2VCBadArgumentsException
, N2VCException
, N2VCExecutionException
34 from osm_lcm
.lcm_utils
import deep_get
37 def retryer(max_wait_time
=60, delay_time
=10):
40 ConnectionRefusedError
43 @functools.wraps(func
)
44 async def wrapped(*args
, **kwargs
):
45 wait_time
= max_wait_time
48 return await func(*args
, **kwargs
)
49 except retry_exceptions
:
50 wait_time
= wait_time
- delay_time
51 await asyncio
.sleep(delay_time
)
54 return ConnectionRefusedError
59 class LCMHelmConn(N2VCConnector
):
60 _KUBECTL_OSM_NAMESPACE
= "osm"
61 _KUBECTL_OSM_CLUSTER_NAME
= "_system-osm-k8s"
62 _EE_SERVICE_PORT
= 50050
64 # Time beetween retries
66 # Initial max retry time
67 _MAX_INITIAL_RETRY_TIME
= 300
78 vca_config
: dict = None,
81 Initialize EE helm connector.
84 # parent class constructor
85 N2VCConnector
.__init
__(
93 vca_config
=vca_config
,
94 on_update_db
=on_update_db
,
97 self
.log
.debug("Initialize helm N2VC connector")
99 # TODO - Obtain data from configuration
100 self
._ee
_service
_port
= self
._EE
_SERVICE
_PORT
102 self
._retry
_delay
= self
._EE
_RETRY
_DELAY
103 self
._max
_retry
_time
= self
._MAX
_RETRY
_TIME
104 self
._initial
_retry
_time
= self
._MAX
_INITIAL
_RETRY
_TIME
106 # initialize helm connector
107 self
._k
8sclusterhelm
= K8sHelmConnector(
108 kubectl_command
=self
.vca_config
.get("kubectlpath"),
109 helm_command
=self
.vca_config
.get("helmpath"),
116 self
._system
_cluster
_id
= None
117 self
.log
.info("Helm N2VC connector initialized")
119 # TODO - ¿reuse_ee_id?
120 async def create_execution_environment(self
,
123 reuse_ee_id
: str = None,
124 progress_timeout
: float = None,
125 total_timeout
: float = None,
126 artifact_path
: str = None,
127 vca_type
: str = None) -> (str, dict):
129 Creates a new helm execution environment deploying the helm-chat indicated in the
131 :param str namespace: This param is not used, all helm charts are deployed in the osm
133 :param dict db_dict: where to write to database when the status changes.
134 It contains a dictionary with {collection: str, filter: {}, path: str},
135 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path:
136 "_admin.deployed.VCA.3"}
137 :param str reuse_ee_id: ee id from an older execution. TODO - right now this params is not used
138 :param float progress_timeout:
139 :param float total_timeout:
140 :param str artifact_path path of package content
141 :param str vca_type Type of vca, not used as assumed of type helm
142 :returns str, dict: id of the new execution environment including namespace.helm_id
143 and credentials object set to None as all credentials should be osm kubernetes .kubeconfig
147 "create_execution_environment: namespace: {}, artifact_path: {}, db_dict: {}, "
148 "reuse_ee_id: {}".format(
149 namespace
, artifact_path
, db_dict
, reuse_ee_id
)
152 # Validate artifact-path is provided
153 if artifact_path
is None or len(artifact_path
) == 0:
154 raise N2VCBadArgumentsException(
155 message
="artifact_path is mandatory", bad_args
=["artifact_path"]
158 # Validate artifact-path exists
160 # remove / in charm path
161 while artifact_path
.find("//") >= 0:
162 artifact_path
= artifact_path
.replace("//", "/")
165 if self
.fs
.file_exists(artifact_path
):
166 helm_chart_path
= artifact_path
168 msg
= "artifact path does not exist: {}".format(artifact_path
)
169 raise N2VCBadArgumentsException(message
=msg
, bad_args
=["artifact_path"])
171 if artifact_path
.startswith("/"):
172 full_path
= self
.fs
.path
+ helm_chart_path
174 full_path
= self
.fs
.path
+ "/" + helm_chart_path
177 # Call helm conn install
178 # Obtain system cluster id from database
179 system_cluster_uuid
= self
._get
_system
_cluster
_id
()
181 self
.log
.debug("install helm chart: {}".format(full_path
))
182 helm_id
= await self
._k
8sclusterhelm
.install(system_cluster_uuid
, kdu_model
=full_path
,
183 namespace
=self
._KUBECTL
_OSM
_NAMESPACE
,
185 timeout
=progress_timeout
)
187 ee_id
= "{}.{}".format(self
._KUBECTL
_OSM
_NAMESPACE
, helm_id
)
189 except Exception as e
:
190 self
.log
.error("Error deploying chart ee: {}".format(e
), exc_info
=True)
191 raise N2VCException("Error deploying chart ee: {}".format(e
))
193 async def register_execution_environment(self
, namespace
: str, credentials
: dict, db_dict
: dict,
194 progress_timeout
: float = None, total_timeout
: float = None) -> str:
198 async def install_configuration_sw(self
,
202 progress_timeout
: float = None,
203 total_timeout
: float = None,
211 async def add_relation(self
, ee_id_1
: str, ee_id_2
: str, endpoint_1
: str, endpoint_2
: str):
215 async def remove_relation(self
):
219 async def get_status(self
, namespace
: str, yaml_format
: bool = True):
220 # not used for this connector
223 async def get_ee_ssh_public__key(self
, ee_id
: str, db_dict
: dict, progress_timeout
: float = None,
224 total_timeout
: float = None) -> str:
226 Obtains ssh-public key from ee executing GetSShKey method from the ee.
228 :param str ee_id: the id of the execution environment returned by
229 create_execution_environment or register_execution_environment
231 :param float progress_timeout:
232 :param float total_timeout:
233 :returns: public key of the execution environment
237 "get_ee_ssh_public_key: ee_id: {}, db_dict: {}".format(
242 if ee_id
is None or len(ee_id
) == 0:
243 raise N2VCBadArgumentsException(
244 message
="ee_id is mandatory", bad_args
=["ee_id"]
248 # Obtain ip_addr for the ee service, it is resolved by dns from the ee name by kubernetes
249 namespace
, helm_id
= self
._get
_ee
_id
_parts
(ee_id
)
250 ip_addr
= socket
.gethostbyname(helm_id
)
252 # Obtain ssh_key from the ee, this method will implement retries to allow the ee
253 # install libraries and start successfully
254 ssh_key
= await self
._get
_ssh
_key
(ip_addr
)
256 except Exception as e
:
257 self
.log
.error("Error obtaining ee ssh_key: {}".format(e
), exc_info
=True)
258 raise N2VCException("Error obtaining ee ssh_ke: {}".format(e
))
260 async def exec_primitive(self
, ee_id
: str, primitive_name
: str, params_dict
: dict, db_dict
: dict = None,
261 progress_timeout
: float = None, total_timeout
: float = None) -> str:
263 Execute a primitive in the execution environment
265 :param str ee_id: the one returned by create_execution_environment or
266 register_execution_environment with the format namespace.helm_id
267 :param str primitive_name: must be one defined in the software. There is one
268 called 'config', where, for the proxy case, the 'credentials' of VM are
270 :param dict params_dict: parameters of the action
271 :param dict db_dict: where to write into database when the status changes.
272 It contains a dict with
273 {collection: <str>, filter: {}, path: <str>},
274 e.g. {collection: "nslcmops", filter:
275 {_id: <nslcmop_id>, path: "_admin.VCA"}
276 It will be used to store information about intermediate notifications
277 :param float progress_timeout:
278 :param float total_timeout:
279 :returns str: primitive result, if ok. It raises exceptions in case of fail
282 self
.log
.info("exec primitive for ee_id : {}, primitive_name: {}, params_dict: {}, db_dict: {}".format(
283 ee_id
, primitive_name
, params_dict
, db_dict
287 if ee_id
is None or len(ee_id
) == 0:
288 raise N2VCBadArgumentsException(
289 message
="ee_id is mandatory", bad_args
=["ee_id"]
291 if primitive_name
is None or len(primitive_name
) == 0:
292 raise N2VCBadArgumentsException(
293 message
="action_name is mandatory", bad_args
=["action_name"]
295 if params_dict
is None:
299 namespace
, helm_id
= self
._get
_ee
_id
_parts
(ee_id
)
300 ip_addr
= socket
.gethostbyname(helm_id
)
301 except Exception as e
:
302 self
.log
.error("Error getting ee ip ee: {}".format(e
))
303 raise N2VCException("Error getting ee ip ee: {}".format(e
))
305 if primitive_name
== "config":
307 # Execute config primitive, higher timeout to check the case ee is starting
308 status
, detailed_message
= await self
._execute
_config
_primitive
(ip_addr
, params_dict
, db_dict
=db_dict
)
309 self
.log
.debug("Executed config primitive ee_id_ {}, status: {}, message: {}".format(
310 ee_id
, status
, detailed_message
))
312 self
.log
.error("Error configuring helm ee, status: {}, message: {}".format(
313 status
, detailed_message
))
314 raise N2VCExecutionException(
315 message
="Error configuring helm ee_id: {}, status: {}, message: {}: ".format(
316 ee_id
, status
, detailed_message
318 primitive_name
=primitive_name
,
320 except Exception as e
:
321 self
.log
.error("Error configuring helm ee: {}".format(e
))
322 raise N2VCExecutionException(
323 message
="Error configuring helm ee_id: {}, {}".format(
326 primitive_name
=primitive_name
,
332 status
, detailed_message
= await self
._execute
_primitive
(ip_addr
, primitive_name
,
333 params_dict
, db_dict
=db_dict
)
334 self
.log
.debug("Executed primitive {} ee_id_ {}, status: {}, message: {}".format(
335 primitive_name
, ee_id
, status
, detailed_message
))
336 if status
!= "OK" and status
!= "PROCESSING":
338 "Execute primitive {} returned not ok status: {}, message: {}".format(
339 primitive_name
, status
, detailed_message
)
341 raise N2VCExecutionException(
342 message
="Execute primitive {} returned not ok status: {}, message: {}".format(
343 primitive_name
, status
, detailed_message
345 primitive_name
=primitive_name
,
347 except Exception as e
:
349 "Error executing primitive {}: {}".format(primitive_name
, e
)
351 raise N2VCExecutionException(
352 message
="Error executing primitive {} into ee={} : {}".format(
353 primitive_name
, ee_id
, e
355 primitive_name
=primitive_name
,
357 return detailed_message
359 async def deregister_execution_environments(self
):
363 async def delete_execution_environment(self
, ee_id
: str, db_dict
: dict = None, total_timeout
: float = None):
365 Delete an execution environment
366 :param str ee_id: id of the execution environment to delete, included namespace.helm_id
367 :param dict db_dict: where to write into database when the status changes.
368 It contains a dict with
369 {collection: <str>, filter: {}, path: <str>},
370 e.g. {collection: "nsrs", filter:
371 {_id: <nsd-id>, path: "_admin.deployed.VCA.3"}
372 :param float total_timeout:
375 self
.log
.info("ee_id: {}".format(ee_id
))
379 raise N2VCBadArgumentsException(
380 message
="ee_id is mandatory", bad_args
=["ee_id"]
385 # Obtain cluster_uuid
386 system_cluster_uuid
= self
._get
_system
_cluster
_id
()
389 namespace
, helm_id
= self
._get
_ee
_id
_parts
(ee_id
)
392 await self
._k
8sclusterhelm
.uninstall(system_cluster_uuid
, helm_id
)
393 self
.log
.info("ee_id: {} deleted".format(ee_id
))
394 except Exception as e
:
395 self
.log
.error("Error deleting ee id: {}: {}".format(ee_id
, e
), exc_info
=True)
396 raise N2VCException("Error deleting ee id {}: {}".format(ee_id
, e
))
398 async def delete_namespace(self
, namespace
: str, db_dict
: dict = None, total_timeout
: float = None):
399 # method not implemented for this connector, execution environments must be deleted individually
402 async def install_k8s_proxy_charm(
408 progress_timeout
: float = None,
409 total_timeout
: float = None,
414 @retryer(max_wait_time
=_MAX_INITIAL_RETRY_TIME
, delay_time
=_EE_RETRY_DELAY
)
415 async def _get_ssh_key(self
, ip_addr
):
416 channel
= Channel(ip_addr
, self
._ee
_service
_port
)
418 stub
= FrontendExecutorStub(channel
)
419 self
.log
.debug("get ssh key, ip_addr: {}".format(ip_addr
))
420 reply
: SshKeyReply
= await stub
.GetSshKey(SshKeyRequest())
425 @retryer(max_wait_time
=_MAX_INITIAL_RETRY_TIME
, delay_time
=_EE_RETRY_DELAY
)
426 async def _execute_config_primitive(self
, ip_addr
, params
, db_dict
=None):
427 return await self
._execute
_primitive
_internal
(ip_addr
, "config", params
, db_dict
=db_dict
)
429 @retryer(max_wait_time
=_MAX_RETRY_TIME
, delay_time
=_EE_RETRY_DELAY
)
430 async def _execute_primitive(self
, ip_addr
, primitive_name
, params
, db_dict
=None):
431 return await self
._execute
_primitive
_internal
(ip_addr
, primitive_name
, params
, db_dict
=db_dict
)
433 async def _execute_primitive_internal(self
, ip_addr
, primitive_name
, params
, db_dict
=None):
435 channel
= Channel(ip_addr
, self
._ee
_service
_port
)
437 stub
= FrontendExecutorStub(channel
)
438 async with stub
.RunPrimitive
.open() as stream
:
439 primitive_id
= str(uuid
.uuid1())
441 self
.log
.debug("Execute primitive internal: id:{}, name:{}, params: {}".
442 format(primitive_id
, primitive_name
, params
))
443 await stream
.send_message(
444 PrimitiveRequest(id=primitive_id
, name
=primitive_name
, params
=yaml
.dump(params
)), end
=True)
445 async for reply
in stream
:
446 self
.log
.debug("Received reply: {}".format(reply
))
448 # If db_dict provided write notifs in database
450 self
._write
_op
_detailed
_status
(db_dict
, reply
.status
, reply
.detailed_message
)
452 return reply
.status
, reply
.detailed_message
454 return "ERROR", "No result received"
458 def _write_op_detailed_status(self
, db_dict
, status
, detailed_message
):
460 # write ee_id to database: _admin.deployed.VCA.x
462 the_table
= db_dict
["collection"]
463 the_filter
= db_dict
["filter"]
464 update_dict
= {"detailed-status": "{}: {}".format(status
, detailed_message
)}
465 # self.log.debug('Writing ee_id to database: {}'.format(the_path))
469 update_dict
=update_dict
,
472 except asyncio
.CancelledError
:
474 except Exception as e
:
475 self
.log
.error("Error writing detailedStatus to database: {}".format(e
))
477 def _get_system_cluster_id(self
):
478 if not self
._system
_cluster
_id
:
479 db_k8cluster
= self
.db
.get_one("k8sclusters", {"name": self
._KUBECTL
_OSM
_CLUSTER
_NAME
})
480 k8s_hc_id
= deep_get(db_k8cluster
, ("_admin", "helm-chart", "id"))
481 self
._system
_cluster
_id
= k8s_hc_id
482 return self
._system
_cluster
_id
484 def _get_ee_id_parts(self
, ee_id
):
485 namespace
, _
, helm_id
= ee_id
.partition('.')
486 return namespace
, helm_id