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
24 from n2vc
.loggable
import Loggable
29 class K8sConnector(abc
.ABC
, Loggable
):
32 ##################################################################################################
33 ########################################## P U B L I C ###########################################
34 ##################################################################################################
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
.info('Initializing generic K8S connector')
55 # the database and update callback
57 self
.on_update_db
= on_update_db
59 self
.info('K8S generic connector initialized')
65 namespace
: str = 'kube-system',
66 reuse_cluster_uuid
=None
69 It prepares a given K8s cluster environment to run Charts or juju Bundles on both sides:
73 :param k8s_creds: credentials to access a given K8s cluster, i.e. a valid '.kube/config'
74 :param namespace: optional namespace for helm tiller. 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 software in the cluster
77 (on error, an exception will be raised)
86 repo_type
: str = 'chart'
89 Add a new repository to OSM database
91 :param cluster_uuid: the cluster
92 :param name: name for the repo in OSM
93 :param url: URL of the repo
94 :param repo_type: either "chart" or "bundle"
95 :return: True if successful
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(
117 Remove a repository from OSM
119 :param name: repo name in OSM
120 :param cluster_uuid: the cluster
121 :return: True if successful
129 uninstall_sw
: bool = False
132 Uninstalls Tiller/Charm from a known K8s cluster and removes it from the list of known K8s clusters.
133 Intended to be used e.g. when the NS instance is deleted.
135 :param cluster_uuid: UUID of a K8s cluster known by OSM.
136 :param force: force deletion, even in case there are deployed releases
137 :param uninstall_sw: flag to indicate that sw uninstallation from software is needed
138 :return: str: kdu_instance generated by helm
147 timeout
: float = 300,
152 Deploys of a new KDU instance. It would implicitly rely on the `install` call to deploy the Chart/Bundle
153 properly parametrized (in practice, this call would happen before any _initial-config-primitive_
154 of the VNF is called).
156 :param cluster_uuid: UUID of a K8s cluster known by OSM
157 :param kdu_model: chart/bundle:version reference (string), which can be either of these options:
158 - a name of chart/bundle available via the repos known by OSM
159 - a path to a packaged chart/bundle
160 - a path to an unpacked chart/bundle directory or a URL
161 :param atomic: If set, installation process purges chart/bundle on fail, also will wait until
162 all the K8s objects are active
163 :param timeout: Time in seconds to wait for the install of the chart/bundle (defaults to
164 Helm default timeout: 300s)
165 :param params: dictionary of key-value pairs for instantiation parameters (overriding default values)
166 :param dict db_dict: where to write into database when the status changes.
167 It contains a dict with {collection: <str>, filter: {}, path: <str>},
168 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
169 :return: True if successful
177 kdu_model
: str = None,
179 timeout
: float = 300,
184 Upgrades an existing KDU instance. It would implicitly use the `upgrade` call over an existing Chart/Bundle.
185 It can be used both to upgrade the chart or to reconfigure it. This would be exposed as Day-2 primitive.
187 :param cluster_uuid: UUID of a K8s cluster known by OSM
188 :param kdu_instance: unique name for the KDU instance to be updated
189 :param kdu_model: new chart/bundle:version reference
190 :param atomic: rollback in case of fail and wait for pods and services are available
191 :param timeout: Time in seconds to wait for the install of the chart/bundle (defaults to
192 Helm default timeout: 300s)
193 :param params: new dictionary of key-value pairs for instantiation parameters
194 :param dict db_dict: where to write into database when the status changes.
195 It contains a dict with {collection: <str>, filter: {}, path: <str>},
196 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
197 :return: reference to the new revision number of the KDU instance
209 Rolls back a previous update of a KDU instance. It would implicitly use the `rollback` call.
210 It can be used both to rollback from a Chart/Bundle version update or from a reconfiguration.
211 This would be exposed as Day-2 primitive.
213 :param cluster_uuid: UUID of a K8s cluster known by OSM
214 :param kdu_instance: unique name for the KDU instance
215 :param revision: revision to which revert changes. If omitted, it will revert the last update only
216 :param dict db_dict: where to write into database when the status changes.
217 It contains a dict with {collection: <str>, filter: {}, path: <str>},
218 e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
219 :return:If successful, reference to the current active revision of the KDU instance after the rollback
229 Removes an existing KDU instance. It would implicitly use the `delete` call (this call would happen
230 after all _terminate-config-primitive_ of the VNF are invoked).
232 :param cluster_uuid: UUID of a K8s cluster known by OSM
233 :param kdu_instance: unique name for the KDU instance to be deleted
234 :return: True if successful
238 async def inspect_kdu(
244 These calls will retrieve from the Chart/Bundle:
246 - The list of configurable values and their defaults (e.g. in Charts, it would retrieve
247 the contents of `values.yaml`).
248 - If available, any embedded help file (e.g. `readme.md`) embedded in the Chart/Bundle.
250 :param kdu_model: chart/bundle reference
251 :param repo_url: optional, reposotory URL (None if tar.gz, URl in other cases, even stable URL)
254 If successful, it will return the available parameters and their default values as provided by the backend.
265 :param kdu_model: chart/bundle reference
266 :param repo_url: optional, reposotory URL (None if tar.gz, URl in other cases, even stable URL)
267 :return: If successful, it will return the contents of the 'readme.md'
271 async def status_kdu(
277 This call would retrieve tha current state of a given KDU instance. It would be would allow to retrieve
278 the _composition_ (i.e. K8s objects) and _specific values_ of the configuration parameters applied
279 to a given instance. This call would be based on the `status` call.
281 :param cluster_uuid: UUID of a K8s cluster known by OSM
282 :param kdu_instance: unique name for the KDU instance
283 :return: If successful, it will return the following vector of arguments:
284 - K8s `namespace` in the cluster where the KDU lives
285 - `state` of the KDU instance. It can be:
292 - List of `resources` (objects) that this release consists of, sorted by kind, and the status of those resources
293 - Last `deployment_time`.
298 ##################################################################################################
299 ########################################## P R I V A T E #########################################
300 ##################################################################################################
303 async def write_app_status_to_db(
307 detailed_status
: str,
312 self
.warning('No db => No database write')
316 self
.warning('No db_dict => No database write')
319 self
.debug('status={}'.format(status
))
323 the_table
= db_dict
['collection']
324 the_filter
= db_dict
['filter']
325 the_path
= db_dict
['path']
326 if not the_path
[-1] == '.':
327 the_path
= the_path
+ '.'
329 the_path
+ 'operation': operation
,
330 the_path
+ 'status': status
,
331 the_path
+ 'detailed-status': detailed_status
,
332 the_path
+ 'status-time': str(time
.time()),
338 update_dict
=update_dict
,
343 if self
.on_update_db
:
344 if asyncio
.iscoroutinefunction(self
.on_update_db
):
345 await self
.on_update_db(the_table
, the_filter
, the_path
, update_dict
)
347 self
.on_update_db(the_table
, the_filter
, the_path
, update_dict
)
351 except Exception as e
:
352 self
.info('Exception writing status to database: {}'.format(e
))