3a1a5efe48d55bbc14438d4ed09000a690258e0e
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
25 from typing
import Union
28 from n2vc
.loggable
import Loggable
31 class K8sConnector(abc
.ABC
, Loggable
):
33 ####################################################################################
34 ################################### P U B L I C ####################################
35 ####################################################################################
39 def generate_kdu_instance_name(**kwargs
):
40 raise NotImplementedError("Method not implemented")
42 def __init__(self
, db
: object, log
: object = None, on_update_db
=None):
45 :param db: database object to write current operation status
46 :param log: logger for tracing
47 :param on_update_db: callback called when k8s connector updates database
51 Loggable
.__init
__(self
, log
=log
, log_to_console
=True, prefix
="\nK8S")
53 # self.log.info('Initializing generic K8S connector')
55 # the database and update callback
57 self
.on_update_db
= on_update_db
59 # self.log.info('K8S generic connector initialized')
63 self
, k8s_creds
: str, namespace
: str = "kube-system", reuse_cluster_uuid
=None
66 It prepares a given K8s cluster environment to run Charts or juju Bundles on
71 :param k8s_creds: credentials to access a given K8s cluster, i.e. a valid
73 :param namespace: optional namespace to be used for the K8s engine (helm
74 tiller, juju). By default, 'kube-system' will be used
75 :param reuse_cluster_uuid: existing cluster uuid for reuse
76 :return: uuid of the K8s cluster and True if connector has installed some
77 software in the cluster (on error, an exception will be raised)
86 repo_type
: str = "chart",
92 Add a new repository to OSM database
94 :param cluster_uuid: the cluster
95 :param name: name for the repo in OSM
96 :param url: URL of the repo
97 :param repo_type: either "chart" or "bundle"
98 :return: True if successful
102 async def repo_list(self
, cluster_uuid
: str):
104 Get the list of registered repositories
106 :param cluster_uuid: the cluster
107 :return: list of registered repositories: [ (name, url) .... ]
111 async def repo_remove(self
, cluster_uuid
: str, name
: str):
113 Remove a repository from OSM
115 :param name: repo name in OSM
116 :param cluster_uuid: the cluster
117 :return: True if successful
121 async def synchronize_repos(self
, cluster_uuid
: str, name
: str):
123 Synchronizes the list of repositories created in the cluster with
124 the repositories added by the NBI
126 :param cluster_uuid: the cluster
127 :return: List of repositories deleted from the cluster and dictionary with
133 self
, cluster_uuid
: str, force
: bool = False, uninstall_sw
: bool = False
136 Uninstalls Tiller/Charm from a known K8s cluster and removes it from the list
137 of known K8s clusters. Intended to be used e.g. when the NS instance is deleted.
139 :param cluster_uuid: UUID of a K8s cluster known by OSM.
140 :param force: force deletion, even in case there are deployed releases
141 :param uninstall_sw: flag to indicate that sw uninstallation from software is
143 :return: str: kdu_instance generated by helm
153 timeout
: float = 300,
155 db_dict
: dict = None,
156 kdu_name
: str = None,
157 namespace
: str = None,
160 Deploys of a new KDU instance. It would implicitly rely on the `install` call
161 to deploy the Chart/Bundle properly parametrized (in practice, this call would
162 happen before any _initial-config-primitive_of the VNF is called).
164 :param cluster_uuid: UUID of a K8s cluster known by OSM
165 :param kdu_model: chart/bundle:version reference (string), which can be either
167 - a name of chart/bundle available via the repos known by OSM
168 - a path to a packaged chart/bundle
169 - a path to an unpacked chart/bundle directory or a URL
170 :param kdu_instance: Kdu instance name
171 :param atomic: If set, installation process purges chart/bundle on fail, also
172 will wait until all the K8s objects are active
173 :param timeout: Time in seconds to wait for the install of the chart/bundle
174 (defaults to Helm default timeout: 300s)
175 :param params: dictionary of key-value pairs for instantiation parameters
176 (overriding default values)
177 :param dict db_dict: where to write into database when the status changes.
178 It contains a dict with {collection: <str>, filter: {},
180 e.g. {collection: "nsrs", filter:
181 {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
182 :param kdu_name: Name of the KDU instance to be installed
183 :param namespace: K8s namespace to use for the KDU instance
184 :return: True if successful
192 kdu_model
: str = None,
194 timeout
: float = 300,
196 db_dict
: dict = None,
200 Upgrades an existing KDU instance. It would implicitly use the `upgrade` call
201 over an existing Chart/Bundle. It can be used both to upgrade the chart or to
202 reconfigure it. This would be exposed as Day-2 primitive.
204 :param cluster_uuid: UUID of a K8s cluster known by OSM
205 :param kdu_instance: unique name for the KDU instance to be updated
206 :param kdu_model: new chart/bundle:version reference
207 :param atomic: rollback in case of fail and wait for pods and services are
209 :param timeout: Time in seconds to wait for the install of the chart/bundle
210 (defaults to Helm default timeout: 300s)
211 :param params: new dictionary of key-value pairs for instantiation parameters
212 :param dict db_dict: where to write into database when the status changes.
213 It contains a dict with {collection: <str>, filter: {},
215 e.g. {collection: "nsrs", filter:
216 {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
217 :param force: force recreation of resources if necessary
218 :return: reference to the new revision number of the KDU instance
227 total_timeout
: float = 1800,
228 cluster_uuid
: str = None,
229 kdu_model
: str = None,
231 db_dict
: dict = None,
234 """Scale a resource in a KDU instance.
237 kdu_instance: KDU instance name
238 scale: Scale to which to set the resource
239 resource_name: Resource name
240 total_timeout: The time, in seconds, to wait for the install
242 cluster_uuid: The UUID of the cluster
243 kdu_model: The chart/bundle reference
244 atomic: if set, upgrade process rolls back changes made in case of failed upgrade.
245 The --wait flag will be set automatically if --atomic is used
246 db_dict: Dictionary for any additional data
247 kwargs: Additional parameters
251 True if successful, False otherwise
255 async def get_scale_count(
261 timeout
: float = 300,
264 """Get a resource scale count in a KDU instance.
267 resource_name: Resource name
268 kdu_instance: KDU instance name
269 cluster_uuid: The UUID of the cluster
270 kdu_model: chart/bundle reference
271 timeout: The time, in seconds, to wait
272 kwargs: Additional parameters
275 Resource instance count
280 self
, cluster_uuid
: str, kdu_instance
: str, revision
=0, db_dict
: dict = None
283 Rolls back a previous update of a KDU instance. It would implicitly use the
284 `rollback` call. It can be used both to rollback from a Chart/Bundle version
285 update or from a reconfiguration. This would be exposed as Day-2 primitive.
287 :param cluster_uuid: UUID of a K8s cluster known by OSM
288 :param kdu_instance: unique name for the KDU instance
289 :param revision: revision to which revert changes. If omitted, it will revert
291 :param dict db_dict: where to write into database when the status changes.
292 It contains a dict with {collection: <str>, filter: {},
294 e.g. {collection: "nsrs", filter:
295 {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
296 :return:If successful, reference to the current active revision of the KDU
297 instance after the rollback
301 async def uninstall(self
, cluster_uuid
: str, kdu_instance
: str):
303 Removes an existing KDU instance. It would implicitly use the `delete` call
304 (this call would happen after all _terminate-config-primitive_ of the VNF are
307 :param cluster_uuid: UUID of a K8s cluster known by OSM
308 :param kdu_instance: unique name for the KDU instance to be deleted
309 :return: True if successful
313 async def exec_primitive(
315 cluster_uuid
: str = None,
316 kdu_instance
: str = None,
317 primitive_name
: str = None,
318 timeout
: float = 300,
320 db_dict
: dict = None,
322 """Exec primitive (Juju action)
324 :param cluster_uuid str: The UUID of the cluster
325 :param kdu_instance str: The unique name of the KDU instance
326 :param primitive_name: Name of action that will be executed
327 :param timeout: Timeout for action execution
328 :param params: Dictionary of all the parameters needed for the action
329 :db_dict: Dictionary for any additional data
331 :return: Returns the output of the action
335 async def upgrade_charm(
339 charm_id
: str = None,
340 charm_type
: str = None,
341 timeout
: float = None,
343 """This method upgrade charms in VNFs
346 ee_id: Execution environment id
347 path: Local path to the charm
349 charm_type: Charm type can be lxc-proxy-charm, native-charm or k8s-proxy-charm
350 timeout: (Float) Timeout for the ns update operation
353 The output of the update operation if status equals to "completed"
357 async def inspect_kdu(self
, kdu_model
: str, repo_url
: str = None) -> str:
359 These calls will retrieve from the Chart/Bundle:
361 - The list of configurable values and their defaults (e.g. in Charts,
362 it would retrieve the contents of `values.yaml`).
363 - If available, any embedded help file (e.g. `readme.md`) embedded in the
366 :param kdu_model: chart/bundle reference
367 :param repo_url: optional, reposotory URL (None if tar.gz, URl in other cases,
371 If successful, it will return the available parameters and their default values
372 as provided by the backend.
376 async def help_kdu(self
, kdu_model
: str, repo_url
: str = None) -> str:
379 :param kdu_model: chart/bundle reference
380 :param repo_url: optional, reposotory URL (None if tar.gz, URl in other cases,
382 :return: If successful, it will return the contents of the 'readme.md'
386 async def status_kdu(
387 self
, cluster_uuid
: str, kdu_instance
: str, yaml_format
: str
388 ) -> Union
[str, dict]:
390 This call would retrieve tha current state of a given KDU instance. It would be
391 would allow to retrieve the _composition_ (i.e. K8s objects) and _specific
392 values_ of the configuration parameters applied to a given instance. This call
393 would be based on the `status` call.
395 :param cluster_uuid: UUID of a K8s cluster known by OSM
396 :param kdu_instance: unique name for the KDU instance
397 :param yaml_format: if the return shall be returned as an YAML string or as a
399 :return: If successful, it will return the following vector of arguments:
400 - K8s `namespace` in the cluster where the KDU lives
401 - `state` of the KDU instance. It can be:
408 - List of `resources` (objects) that this release consists of, sorted by kind,
409 and the status of those resources
410 - Last `deployment_time`.
415 async def get_services(
416 self
, cluster_uuid
: str, kdu_instance
: str, namespace
: str
419 Returns a list of services defined for the specified kdu instance.
421 :param cluster_uuid: UUID of a K8s cluster known by OSM
422 :param kdu_instance: unique name for the KDU instance
423 :param namespace: K8s namespace used by the KDU instance
424 :return: If successful, it will return a list of services, Each service
425 can have the following data:
426 - `name` of the service
427 - `type` type of service in the k8 cluster
428 - `ports` List of ports offered by the service, for each port includes at least
430 - `cluster_ip` Internal ip to be used inside k8s cluster
431 - `external_ip` List of external ips (in case they are available)
435 async def get_service(
436 self
, cluster_uuid
: str, service_name
: str, namespace
: str = None
439 Obtains the data of the specified service in the k8cluster.
441 :param cluster_uuid: UUID of a K8s cluster known by OSM
442 :param service_name: name of the K8s service in the specified namespace
443 :param namespace: K8s namespace used by the KDU instance
444 :return: If successful, it will return a list of services, Each service can have
446 - `name` of the service
447 - `type` type of service in the k8 cluster
448 - `ports` List of ports offered by the service, for each port includes at least
450 - `cluster_ip` Internal ip to be used inside k8s cluster
451 - `external_ip` List of external ips (in case they are available)
455 ####################################################################################
456 ################################### P R I V A T E ##################################
457 ####################################################################################
460 async def write_app_status_to_db(
461 self
, db_dict
: dict, status
: str, detailed_status
: str, operation
: str
464 This method will write the status of the application to the database.
466 :param db_dict: A dictionary with the database necessary information. It shall contain the values for the keys:
467 - "collection": The Mongo DB collection to write to
468 - "filter": The query filter to use in the update process
469 - "path": The dot separated keys which targets the object to be updated
470 :param status: Status of the application
471 :param detailed_status: Detailed status of the application
472 :param operation: Operation that is being performed on the application
473 :return: True if successful
477 self
.warning("No db => No database write")
481 self
.warning("No db_dict => No database write")
484 self
.log
.debug("status={}".format(status
))
487 the_table
= db_dict
["collection"]
488 the_filter
= db_dict
["filter"]
489 the_path
= db_dict
["path"]
490 if not the_path
[-1] == ".":
491 the_path
= the_path
+ "."
493 the_path
+ "operation": operation
,
494 the_path
+ "status": status
,
495 the_path
+ "detailed-status": detailed_status
,
496 the_path
+ "status-time": str(time
.time()),
502 update_dict
=update_dict
,
507 if self
.on_update_db
:
508 if asyncio
.iscoroutinefunction(self
.on_update_db
):
509 await self
.on_update_db(
510 the_table
, the_filter
, the_path
, update_dict
513 self
.on_update_db(the_table
, the_filter
, the_path
, update_dict
)
517 except Exception as e
:
518 self
.log
.info("Exception writing status to database: {}".format(e
))