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.
25 from grpclib
.client
import Channel
27 from osm_lcm
.frontend_pb2
import PrimitiveRequest
28 from osm_lcm
.frontend_pb2
import SshKeyRequest
, SshKeyReply
29 from osm_lcm
.frontend_grpc
import FrontendExecutorStub
30 from osm_lcm
.lcm_utils
import LcmBase
32 from osm_lcm
.data_utils
.database
.database
import Database
33 from osm_lcm
.data_utils
.filesystem
.filesystem
import Filesystem
35 from n2vc
.n2vc_conn
import N2VCConnector
36 from n2vc
.k8s_helm_conn
import K8sHelmConnector
37 from n2vc
.k8s_helm3_conn
import K8sHelm3Connector
38 from n2vc
.exceptions
import N2VCBadArgumentsException
, N2VCException
, N2VCExecutionException
40 from osm_lcm
.lcm_utils
import deep_get
43 def retryer(max_wait_time
=60, delay_time
=10):
46 ConnectionRefusedError
49 @functools.wraps(func
)
50 async def wrapped(*args
, **kwargs
):
51 wait_time
= max_wait_time
54 return await func(*args
, **kwargs
)
55 except retry_exceptions
:
56 wait_time
= wait_time
- delay_time
57 await asyncio
.sleep(delay_time
)
60 return ConnectionRefusedError
65 class LCMHelmConn(N2VCConnector
, LcmBase
):
66 _KUBECTL_OSM_NAMESPACE
= "osm"
67 _KUBECTL_OSM_CLUSTER_NAME
= "_system-osm-k8s"
68 _EE_SERVICE_PORT
= 50050
70 # Time beetween retries
72 # Initial max retry time
73 _MAX_INITIAL_RETRY_TIME
= 300
82 vca_config
: dict = None,
85 Initialize EE helm connector.
88 self
.db
= Database().instance
.db
89 self
.fs
= Filesystem().instance
.fs
91 # parent class constructor
92 N2VCConnector
.__init
__(
98 vca_config
=vca_config
,
99 on_update_db
=on_update_db
,
104 self
.log
.debug("Initialize helm N2VC connector")
106 # TODO - Obtain data from configuration
107 self
._ee
_service
_port
= self
._EE
_SERVICE
_PORT
109 self
._retry
_delay
= self
._EE
_RETRY
_DELAY
110 self
._max
_retry
_time
= self
._MAX
_RETRY
_TIME
111 self
._initial
_retry
_time
= self
._MAX
_INITIAL
_RETRY
_TIME
113 # initialize helm connector for helmv2 and helmv3
114 self
._k
8sclusterhelm
2 = K8sHelmConnector(
115 kubectl_command
=self
.vca_config
.get("kubectlpath"),
116 helm_command
=self
.vca_config
.get("helmpath"),
123 self
._k
8sclusterhelm
3 = K8sHelm3Connector(
124 kubectl_command
=self
.vca_config
.get("kubectlpath"),
125 helm_command
=self
.vca_config
.get("helm3path"),
132 self
._system
_cluster
_id
= None
133 self
.log
.info("Helm N2VC connector initialized")
135 # TODO - ¿reuse_ee_id?
136 async def create_execution_environment(self
,
139 reuse_ee_id
: str = None,
140 progress_timeout
: float = None,
141 total_timeout
: float = None,
143 artifact_path
: str = None,
144 vca_type
: str = None,
145 *kargs
, **kwargs
) -> (str, dict):
147 Creates a new helm execution environment deploying the helm-chat indicated in the
149 :param str namespace: This param is not used, all helm charts are deployed in the osm
151 :param dict db_dict: where to write to database when the status changes.
152 It contains a dictionary with {collection: str, filter: {}, path: str},
153 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path:
154 "_admin.deployed.VCA.3"}
155 :param str reuse_ee_id: ee id from an older execution. TODO - right now this params is not used
156 :param float progress_timeout:
157 :param float total_timeout:
158 :param dict config: General variables to instantiate KDU
159 :param str artifact_path: path of package content
160 :param str vca_type: Type of vca, must be type helm or helm-v3
161 :returns str, dict: id of the new execution environment including namespace.helm_id
162 and credentials object set to None as all credentials should be osm kubernetes .kubeconfig
166 "create_execution_environment: namespace: {}, artifact_path: {}, db_dict: {}, "
167 "reuse_ee_id: {}".format(
168 namespace
, artifact_path
, db_dict
, reuse_ee_id
)
171 # Validate artifact-path is provided
172 if artifact_path
is None or len(artifact_path
) == 0:
173 raise N2VCBadArgumentsException(
174 message
="artifact_path is mandatory", bad_args
=["artifact_path"]
177 # Validate artifact-path exists and sync path
178 from_path
= os
.path
.split(artifact_path
)[0]
179 self
.fs
.sync(from_path
)
181 # remove / in charm path
182 while artifact_path
.find("//") >= 0:
183 artifact_path
= artifact_path
.replace("//", "/")
186 if self
.fs
.file_exists(artifact_path
):
187 helm_chart_path
= artifact_path
189 msg
= "artifact path does not exist: {}".format(artifact_path
)
190 raise N2VCBadArgumentsException(message
=msg
, bad_args
=["artifact_path"])
192 if artifact_path
.startswith("/"):
193 full_path
= self
.fs
.path
+ helm_chart_path
195 full_path
= self
.fs
.path
+ "/" + helm_chart_path
197 while full_path
.find("//") >= 0:
198 full_path
= full_path
.replace("//", "/")
201 # Call helm conn install
202 # Obtain system cluster id from database
203 system_cluster_uuid
= await self
._get
_system
_cluster
_id
()
204 # Add parameter osm if exist to global
205 if config
and config
.get("osm"):
206 if not config
.get("global"):
207 config
["global"] = {}
208 config
["global"]["osm"] = config
.get("osm")
210 self
.log
.debug("install helm chart: {}".format(full_path
))
211 if vca_type
== "helm":
212 helm_id
= await self
._k
8sclusterhelm
2.install(system_cluster_uuid
, kdu_model
=full_path
,
213 namespace
=self
._KUBECTL
_OSM
_NAMESPACE
,
216 timeout
=progress_timeout
)
218 helm_id
= await self
._k
8sclusterhelm
3.install(system_cluster_uuid
, kdu_model
=full_path
,
219 namespace
=self
._KUBECTL
_OSM
_NAMESPACE
,
222 timeout
=progress_timeout
)
224 ee_id
= "{}:{}.{}".format(vca_type
, self
._KUBECTL
_OSM
_NAMESPACE
, helm_id
)
226 except N2VCException
:
228 except Exception as e
:
229 self
.log
.error("Error deploying chart ee: {}".format(e
), exc_info
=True)
230 raise N2VCException("Error deploying chart ee: {}".format(e
))
232 async def register_execution_environment(self
, namespace
: str, credentials
: dict, db_dict
: dict,
233 progress_timeout
: float = None, total_timeout
: float = None,
234 *kargs
, **kwargs
) -> str:
238 async def install_configuration_sw(self
,
242 progress_timeout
: float = None,
243 total_timeout
: float = None,
251 async def add_relation(self
, ee_id_1
: str, ee_id_2
: str, endpoint_1
: str, endpoint_2
: str):
255 async def remove_relation(self
):
259 async def get_status(self
, namespace
: str, yaml_format
: bool = True):
260 # not used for this connector
263 async def get_ee_ssh_public__key(self
, ee_id
: str, db_dict
: dict, progress_timeout
: float = None,
264 total_timeout
: float = None) -> str:
266 Obtains ssh-public key from ee executing GetSShKey method from the ee.
268 :param str ee_id: the id of the execution environment returned by
269 create_execution_environment or register_execution_environment
271 :param float progress_timeout:
272 :param float total_timeout:
273 :returns: public key of the execution environment
277 "get_ee_ssh_public_key: ee_id: {}, db_dict: {}".format(
282 if ee_id
is None or len(ee_id
) == 0:
283 raise N2VCBadArgumentsException(
284 message
="ee_id is mandatory", bad_args
=["ee_id"]
288 # Obtain ip_addr for the ee service, it is resolved by dns from the ee name by kubernetes
289 version
, namespace
, helm_id
= self
._get
_ee
_id
_parts
(ee_id
)
290 ip_addr
= socket
.gethostbyname(helm_id
)
292 # Obtain ssh_key from the ee, this method will implement retries to allow the ee
293 # install libraries and start successfully
294 ssh_key
= await self
._get
_ssh
_key
(ip_addr
)
296 except Exception as e
:
297 self
.log
.error("Error obtaining ee ssh_key: {}".format(e
), exc_info
=True)
298 raise N2VCException("Error obtaining ee ssh_ke: {}".format(e
))
300 async def exec_primitive(self
, ee_id
: str, primitive_name
: str, params_dict
: dict, db_dict
: dict = None,
301 progress_timeout
: float = None, total_timeout
: float = None) -> str:
303 Execute a primitive in the execution environment
305 :param str ee_id: the one returned by create_execution_environment or
306 register_execution_environment with the format namespace.helm_id
307 :param str primitive_name: must be one defined in the software. There is one
308 called 'config', where, for the proxy case, the 'credentials' of VM are
310 :param dict params_dict: parameters of the action
311 :param dict db_dict: where to write into database when the status changes.
312 It contains a dict with
313 {collection: <str>, filter: {}, path: <str>},
314 e.g. {collection: "nslcmops", filter:
315 {_id: <nslcmop_id>, path: "_admin.VCA"}
316 It will be used to store information about intermediate notifications
317 :param float progress_timeout:
318 :param float total_timeout:
319 :returns str: primitive result, if ok. It raises exceptions in case of fail
322 self
.log
.info("exec primitive for ee_id : {}, primitive_name: {}, params_dict: {}, db_dict: {}".format(
323 ee_id
, primitive_name
, params_dict
, db_dict
327 if ee_id
is None or len(ee_id
) == 0:
328 raise N2VCBadArgumentsException(
329 message
="ee_id is mandatory", bad_args
=["ee_id"]
331 if primitive_name
is None or len(primitive_name
) == 0:
332 raise N2VCBadArgumentsException(
333 message
="action_name is mandatory", bad_args
=["action_name"]
335 if params_dict
is None:
339 version
, namespace
, helm_id
= self
._get
_ee
_id
_parts
(ee_id
)
340 ip_addr
= socket
.gethostbyname(helm_id
)
341 except Exception as e
:
342 self
.log
.error("Error getting ee ip ee: {}".format(e
))
343 raise N2VCException("Error getting ee ip ee: {}".format(e
))
345 if primitive_name
== "config":
347 # Execute config primitive, higher timeout to check the case ee is starting
348 status
, detailed_message
= await self
._execute
_config
_primitive
(ip_addr
, params_dict
, db_dict
=db_dict
)
349 self
.log
.debug("Executed config primitive ee_id_ {}, status: {}, message: {}".format(
350 ee_id
, status
, detailed_message
))
352 self
.log
.error("Error configuring helm ee, status: {}, message: {}".format(
353 status
, detailed_message
))
354 raise N2VCExecutionException(
355 message
="Error configuring helm ee_id: {}, status: {}, message: {}: ".format(
356 ee_id
, status
, detailed_message
358 primitive_name
=primitive_name
,
360 except Exception as e
:
361 self
.log
.error("Error configuring helm ee: {}".format(e
))
362 raise N2VCExecutionException(
363 message
="Error configuring helm ee_id: {}, {}".format(
366 primitive_name
=primitive_name
,
372 status
, detailed_message
= await self
._execute
_primitive
(ip_addr
, primitive_name
,
373 params_dict
, db_dict
=db_dict
)
374 self
.log
.debug("Executed primitive {} ee_id_ {}, status: {}, message: {}".format(
375 primitive_name
, ee_id
, status
, detailed_message
))
376 if status
!= "OK" and status
!= "PROCESSING":
378 "Execute primitive {} returned not ok status: {}, message: {}".format(
379 primitive_name
, status
, detailed_message
)
381 raise N2VCExecutionException(
382 message
="Execute primitive {} returned not ok status: {}, message: {}".format(
383 primitive_name
, status
, detailed_message
385 primitive_name
=primitive_name
,
387 except Exception as e
:
389 "Error executing primitive {}: {}".format(primitive_name
, e
)
391 raise N2VCExecutionException(
392 message
="Error executing primitive {} into ee={} : {}".format(
393 primitive_name
, ee_id
, e
395 primitive_name
=primitive_name
,
397 return detailed_message
399 async def deregister_execution_environments(self
):
403 async def delete_execution_environment(self
, ee_id
: str, db_dict
: dict = None, total_timeout
: float = None):
405 Delete an execution environment
406 :param str ee_id: id of the execution environment to delete, included namespace.helm_id
407 :param dict db_dict: where to write into database when the status changes.
408 It contains a dict with
409 {collection: <str>, filter: {}, path: <str>},
410 e.g. {collection: "nsrs", filter:
411 {_id: <nsd-id>, path: "_admin.deployed.VCA.3"}
412 :param float total_timeout:
415 self
.log
.info("ee_id: {}".format(ee_id
))
419 raise N2VCBadArgumentsException(
420 message
="ee_id is mandatory", bad_args
=["ee_id"]
425 # Obtain cluster_uuid
426 system_cluster_uuid
= await self
._get
_system
_cluster
_id
()
429 version
, namespace
, helm_id
= self
._get
_ee
_id
_parts
(ee_id
)
431 # Uninstall chart, for backward compatibility we must assume that if there is no
432 # version it is helm-v2
433 if version
== "helm-v3":
434 await self
._k
8sclusterhelm
3.uninstall(system_cluster_uuid
, helm_id
)
436 await self
._k
8sclusterhelm
2.uninstall(system_cluster_uuid
, helm_id
)
437 self
.log
.info("ee_id: {} deleted".format(ee_id
))
438 except N2VCException
:
440 except Exception as e
:
441 self
.log
.error("Error deleting ee id: {}: {}".format(ee_id
, e
), exc_info
=True)
442 raise N2VCException("Error deleting ee id {}: {}".format(ee_id
, e
))
444 async def delete_namespace(self
, namespace
: str, db_dict
: dict = None, total_timeout
: float = None):
445 # method not implemented for this connector, execution environments must be deleted individually
448 async def install_k8s_proxy_charm(
454 progress_timeout
: float = None,
455 total_timeout
: float = None,
461 @retryer(max_wait_time
=_MAX_INITIAL_RETRY_TIME
, delay_time
=_EE_RETRY_DELAY
)
462 async def _get_ssh_key(self
, ip_addr
):
463 channel
= Channel(ip_addr
, self
._ee
_service
_port
)
465 stub
= FrontendExecutorStub(channel
)
466 self
.log
.debug("get ssh key, ip_addr: {}".format(ip_addr
))
467 reply
: SshKeyReply
= await stub
.GetSshKey(SshKeyRequest())
472 @retryer(max_wait_time
=_MAX_INITIAL_RETRY_TIME
, delay_time
=_EE_RETRY_DELAY
)
473 async def _execute_config_primitive(self
, ip_addr
, params
, db_dict
=None):
474 return await self
._execute
_primitive
_internal
(ip_addr
, "config", params
, db_dict
=db_dict
)
476 @retryer(max_wait_time
=_MAX_RETRY_TIME
, delay_time
=_EE_RETRY_DELAY
)
477 async def _execute_primitive(self
, ip_addr
, primitive_name
, params
, db_dict
=None):
478 return await self
._execute
_primitive
_internal
(ip_addr
, primitive_name
, params
, db_dict
=db_dict
)
480 async def _execute_primitive_internal(self
, ip_addr
, primitive_name
, params
, db_dict
=None):
482 channel
= Channel(ip_addr
, self
._ee
_service
_port
)
484 stub
= FrontendExecutorStub(channel
)
485 async with stub
.RunPrimitive
.open() as stream
:
486 primitive_id
= str(uuid
.uuid1())
488 self
.log
.debug("Execute primitive internal: id:{}, name:{}, params: {}".
489 format(primitive_id
, primitive_name
, params
))
490 await stream
.send_message(
491 PrimitiveRequest(id=primitive_id
, name
=primitive_name
, params
=yaml
.dump(params
)), end
=True)
492 async for reply
in stream
:
493 self
.log
.debug("Received reply: {}".format(reply
))
495 # If db_dict provided write notifs in database
497 self
._write
_op
_detailed
_status
(db_dict
, reply
.status
, reply
.detailed_message
)
499 return reply
.status
, reply
.detailed_message
501 return "ERROR", "No result received"
505 def _write_op_detailed_status(self
, db_dict
, status
, detailed_message
):
507 # write ee_id to database: _admin.deployed.VCA.x
509 the_table
= db_dict
["collection"]
510 the_filter
= db_dict
["filter"]
511 update_dict
= {"detailed-status": "{}: {}".format(status
, detailed_message
)}
512 # self.log.debug('Writing ee_id to database: {}'.format(the_path))
516 update_dict
=update_dict
,
519 except asyncio
.CancelledError
:
521 except Exception as e
:
522 self
.log
.error("Error writing detailedStatus to database: {}".format(e
))
524 async def _get_system_cluster_id(self
):
525 if not self
._system
_cluster
_id
:
526 db_k8cluster
= self
.db
.get_one("k8sclusters", {"name": self
._KUBECTL
_OSM
_CLUSTER
_NAME
})
527 k8s_hc_id
= deep_get(db_k8cluster
, ("_admin", "helm-chart-v3", "id"))
530 # backward compatibility for existing clusters that have not been initialized for helm v3
531 cluster_id
= db_k8cluster
.get("_id")
532 k8s_credentials
= yaml
.safe_dump(db_k8cluster
.get("credentials"))
533 k8s_hc_id
, uninstall_sw
= await self
._k
8sclusterhelm
3.init_env(k8s_credentials
,
534 reuse_cluster_uuid
=cluster_id
)
535 db_k8scluster_update
= {"_admin.helm-chart-v3.error_msg": None,
536 "_admin.helm-chart-v3.id": k8s_hc_id
,
537 "_admin.helm-chart-v3}.created": uninstall_sw
,
538 "_admin.helm-chart-v3.operationalState": "ENABLED"}
539 self
.update_db_2("k8sclusters", cluster_id
, db_k8scluster_update
)
540 except Exception as e
:
541 self
.log
.error("error initializing helm-v3 cluster: {}".format(str(e
)))
542 raise N2VCException("K8s system cluster '{}' has not been initialized for helm-chart-v3".format(
544 self
._system
_cluster
_id
= k8s_hc_id
545 return self
._system
_cluster
_id
547 def _get_ee_id_parts(self
, ee_id
):
549 Parses ee_id stored at database that can be either 'version:namespace.helm_id' or only
550 namespace.helm_id for backward compatibility
551 If exists helm version can be helm-v3 or helm (helm-v2 old version)
553 version
, _
, part_id
= ee_id
.rpartition(':')
554 namespace
, _
, helm_id
= part_id
.rpartition('.')
555 return version
, namespace
, helm_id