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
26 from n2vc
.k8s_helm_base_conn
import K8sHelmBaseConnector
27 from n2vc
.exceptions
import K8sException
30 class K8sHelmConnector(K8sHelmBaseConnector
):
33 ####################################################################################
34 ################################### P U B L I C ####################################
35 ####################################################################################
42 kubectl_command
: str = "/usr/bin/kubectl",
43 helm_command
: str = "/usr/bin/helm",
46 vca_config
: dict = None,
49 Initializes helm connector for helm v2
51 :param fs: file system for kubernetes and helm configuration
52 :param db: database object to write current operation status
53 :param kubectl_command: path to kubectl executable
54 :param helm_command: path to helm executable
56 :param on_update_db: callback called when k8s connector updates database
60 K8sHelmBaseConnector
.__init
__(
65 kubectl_command
=kubectl_command
,
66 helm_command
=helm_command
,
67 on_update_db
=on_update_db
,
68 vca_config
=vca_config
,
71 self
.log
.info("Initializing K8S Helm2 connector")
73 # initialize helm client-only
74 self
.log
.debug("Initializing helm client-only...")
75 command
= "{} init --client-only --stable-repo-url {} ".format(
76 self
._helm
_command
, self
._stable
_repo
_url
)
78 asyncio
.ensure_future(
79 self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False)
81 # loop = asyncio.get_event_loop()
82 # loop.run_until_complete(self._local_async_exec(command=command,
83 # raise_exception_on_error=False))
84 except Exception as e
:
86 msg
="helm init failed (it was already initialized): {}".format(e
)
89 self
.log
.info("K8S Helm2 connector initialized")
100 kdu_name
: str = None,
101 namespace
: str = None,
105 Deploys of a new KDU instance. It would implicitly rely on the `install` call
106 to deploy the Chart/Bundle properly parametrized (in practice, this call would
107 happen before any _initial-config-primitive_of the VNF is called).
109 :param cluster_uuid: UUID of a K8s cluster known by OSM
110 :param kdu_model: chart/ reference (string), which can be either
112 - a name of chart available via the repos known by OSM
113 - a path to a packaged chart
114 - a path to an unpacked chart directory or a URL
115 :param kdu_instance: Kdu instance name
116 :param atomic: If set, installation process purges chart/bundle on fail, also
117 will wait until all the K8s objects are active
118 :param timeout: Time in seconds to wait for the install of the chart/bundle
119 (defaults to Helm default timeout: 300s)
120 :param params: dictionary of key-value pairs for instantiation parameters
121 (overriding default values)
122 :param dict db_dict: where to write into database when the status changes.
123 It contains a dict with {collection: <str>, filter: {},
125 e.g. {collection: "nsrs", filter:
126 {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
127 :param kdu_name: Name of the KDU instance to be installed
128 :param namespace: K8s namespace to use for the KDU instance
129 :param kwargs: Additional parameters (None yet)
130 :return: True if successful
132 _
, cluster_id
= self
._get
_namespace
_cluster
_id
(cluster_uuid
)
133 self
.log
.debug("installing {} in cluster {}".format(kdu_model
, cluster_id
))
136 self
.fs
.sync(from_path
=cluster_id
)
139 paths
, env
= self
._init
_paths
_env
(
140 cluster_name
=cluster_id
, create_if_not_exist
=True
143 await self
._install
_impl
(
158 self
.fs
.reverse_sync(from_path
=cluster_id
)
160 self
.log
.debug("Returning kdu_instance {}".format(kdu_instance
))
163 async def inspect_kdu(self
, kdu_model
: str, repo_url
: str = None) -> str:
166 "inspect kdu_model {} from (optional) repo: {}".format(kdu_model
, repo_url
)
169 return await self
._exec
_inspect
_comand
(
170 inspect_command
="", kdu_model
=kdu_model
, repo_url
=repo_url
174 ####################################################################################
175 ################################### P R I V A T E ##################################
176 ####################################################################################
179 def _init_paths_env(self
, cluster_name
: str, create_if_not_exist
: bool = True):
181 Creates and returns base cluster and kube dirs and returns them.
182 Also created helm3 dirs according to new directory specification, paths are
183 returned and also environment variables that must be provided to execute commands
185 Helm 2 directory specification uses helm_home dir:
187 The variables assigned for this paths are:
188 - Helm hone: $HELM_HOME
189 - helm kubeconfig: $KUBECONFIG
191 :param cluster_name: cluster_name
192 :return: Dictionary with config_paths and dictionary with helm environment variables
195 if base
.endswith("/") or base
.endswith("\\"):
198 # base dir for cluster
199 cluster_dir
= base
+ "/" + cluster_name
202 kube_dir
= cluster_dir
+ "/" + ".kube"
203 if create_if_not_exist
and not os
.path
.exists(kube_dir
):
204 self
.log
.debug("Creating dir {}".format(kube_dir
))
205 os
.makedirs(kube_dir
)
208 helm_dir
= cluster_dir
+ "/" + ".helm"
209 if create_if_not_exist
and not os
.path
.exists(helm_dir
):
210 self
.log
.debug("Creating dir {}".format(helm_dir
))
211 os
.makedirs(helm_dir
)
213 config_filename
= kube_dir
+ "/config"
215 # 2 - Prepare dictionary with paths
217 "kube_dir": kube_dir
,
218 "kube_config": config_filename
,
219 "cluster_dir": cluster_dir
,
220 "helm_dir": helm_dir
,
223 for file_name
, file in paths
.items():
224 if "dir" in file_name
and not os
.path
.exists(file):
225 err_msg
= "{} dir does not exist".format(file)
226 self
.log
.error(err_msg
)
227 raise K8sException(err_msg
)
229 # 3 - Prepare environment variables
230 env
= {"HELM_HOME": helm_dir
, "KUBECONFIG": config_filename
}
234 async def _get_services(self
, cluster_id
, kdu_instance
, namespace
):
237 paths
, env
= self
._init
_paths
_env
(
238 cluster_name
=cluster_id
, create_if_not_exist
=True
241 command1
= "{} get manifest {} ".format(self
._helm
_command
, kdu_instance
)
242 command2
= "{} get --namespace={} -f -".format(self
.kubectl_command
, namespace
)
243 output
, _rc
= await self
._local
_async
_exec
_pipe
(
244 command1
, command2
, env
=env
, raise_exception_on_error
=True
246 services
= self
._parse
_services
(output
)
250 async def _cluster_init(self
, cluster_id
: str, namespace
: str,
251 paths
: dict, env
: dict):
253 Implements the helm version dependent cluster initialization:
254 For helm2 it initialized tiller environment if needed
257 # check if tiller pod is up in cluster
258 command
= "{} --kubeconfig={} --namespace={} get deployments".format(
259 self
.kubectl_command
, paths
["kube_config"], namespace
261 output
, _rc
= await self
._local
_async
_exec
(
262 command
=command
, raise_exception_on_error
=True, env
=env
265 output_table
= self
._output
_to
_table
(output
=output
)
267 # find 'tiller' pod in all pods
268 already_initialized
= False
270 for row
in output_table
:
271 if row
[0].startswith("tiller-deploy"):
272 already_initialized
= True
278 n2vc_installed_sw
= False
279 if not already_initialized
:
281 "Initializing helm in client and server: {}".format(cluster_id
)
283 command
= "{} --kubeconfig={} --namespace kube-system create serviceaccount {}".format(
284 self
.kubectl_command
, paths
["kube_config"], self
.service_account
286 _
, _rc
= await self
._local
_async
_exec
(
287 command
=command
, raise_exception_on_error
=False, env
=env
291 "{} --kubeconfig={} create clusterrolebinding osm-tiller-cluster-rule "
292 "--clusterrole=cluster-admin --serviceaccount=kube-system:{}"
293 ).format(self
.kubectl_command
, paths
["kube_config"], self
.service_account
)
294 _
, _rc
= await self
._local
_async
_exec
(
295 command
=command
, raise_exception_on_error
=False, env
=env
299 "{} --kubeconfig={} --tiller-namespace={} --home={} --service-account {} "
300 " --stable-repo-url {} init"
303 paths
["kube_config"],
306 self
.service_account
,
307 self
._stable
_repo
_url
309 _
, _rc
= await self
._local
_async
_exec
(
310 command
=command
, raise_exception_on_error
=True, env
=env
312 n2vc_installed_sw
= True
314 # check client helm installation
315 check_file
= paths
["helm_dir"] + "/repository/repositories.yaml"
316 if not self
._check
_file
_exists
(
317 filename
=check_file
, exception_if_not_exists
=False
319 self
.log
.info("Initializing helm in client: {}".format(cluster_id
))
321 "{} --kubeconfig={} --tiller-namespace={} "
322 "--home={} init --client-only --stable-repo-url {} "
325 paths
["kube_config"],
328 self
._stable
_repo
_url
,
330 output
, _rc
= await self
._local
_async
_exec
(
331 command
=command
, raise_exception_on_error
=True, env
=env
334 self
.log
.info("Helm client already initialized")
336 # remove old stable repo and add new one
337 cluster_uuid
= "{}:{}".format(namespace
, cluster_id
)
338 repo_list
= await self
.repo_list(cluster_uuid
)
339 for repo
in repo_list
:
340 if repo
["name"] == "stable" and repo
["url"] != self
._stable
_repo
_url
:
341 self
.log
.debug("Add new stable repo url: {}")
342 await self
.repo_remove(cluster_uuid
,
344 await self
.repo_add(cluster_uuid
,
346 self
._stable
_repo
_url
)
349 return n2vc_installed_sw
351 async def _uninstall_sw(self
, cluster_id
: str, namespace
: str):
352 # uninstall Tiller if necessary
354 self
.log
.debug("Uninstalling tiller from cluster {}".format(cluster_id
))
357 paths
, env
= self
._init
_paths
_env
(
358 cluster_name
=cluster_id
, create_if_not_exist
=True
362 # find namespace for tiller pod
363 command
= "{} --kubeconfig={} get deployments --all-namespaces".format(
364 self
.kubectl_command
, paths
["kube_config"]
366 output
, _rc
= await self
._local
_async
_exec
(
367 command
=command
, raise_exception_on_error
=False, env
=env
369 output_table
= self
._output
_to
_table
(output
=output
)
371 for r
in output_table
:
373 if "tiller-deploy" in r
[1]:
379 msg
= "Tiller deployment not found in cluster {}".format(cluster_id
)
382 self
.log
.debug("namespace for tiller: {}".format(namespace
))
385 # uninstall tiller from cluster
386 self
.log
.debug("Uninstalling tiller from cluster {}".format(cluster_id
))
387 command
= "{} --kubeconfig={} --home={} reset".format(
388 self
._helm
_command
, paths
["kube_config"], paths
["helm_dir"]
390 self
.log
.debug("resetting: {}".format(command
))
391 output
, _rc
= await self
._local
_async
_exec
(
392 command
=command
, raise_exception_on_error
=True, env
=env
394 # Delete clusterrolebinding and serviceaccount.
395 # Ignore if errors for backward compatibility
397 "{} --kubeconfig={} delete clusterrolebinding.rbac.authorization.k8s."
398 "io/osm-tiller-cluster-rule"
399 ).format(self
.kubectl_command
, paths
["kube_config"])
400 output
, _rc
= await self
._local
_async
_exec
(
401 command
=command
, raise_exception_on_error
=False, env
=env
403 command
= "{} --kubeconfig={} --namespace kube-system delete serviceaccount/{}".format(
404 self
.kubectl_command
, paths
["kube_config"], self
.service_account
406 output
, _rc
= await self
._local
_async
_exec
(
407 command
=command
, raise_exception_on_error
=False, env
=env
411 self
.log
.debug("namespace not found")
413 async def _instances_list(self
, cluster_id
):
416 paths
, env
= self
._init
_paths
_env
(
417 cluster_name
=cluster_id
, create_if_not_exist
=True
420 command
= "{} list --output yaml".format(self
._helm
_command
)
422 output
, _rc
= await self
._local
_async
_exec
(
423 command
=command
, raise_exception_on_error
=True, env
=env
426 if output
and len(output
) > 0:
427 # parse yaml and update keys to lower case to unify with helm3
428 instances
= yaml
.load(output
, Loader
=yaml
.SafeLoader
).get("Releases")
430 for instance
in instances
:
431 new_instance
= dict((k
.lower(), v
) for k
, v
in instance
.items())
432 new_instances
.append(new_instance
)
437 def _get_inspect_command(self
, show_command
: str, kdu_model
: str, repo_str
: str,
439 inspect_command
= "{} inspect {} {}{} {}".format(
440 self
._helm
_command
, show_command
, kdu_model
, repo_str
, version
442 return inspect_command
444 async def _status_kdu(
448 namespace
: str = None,
449 show_error_log
: bool = False,
450 return_text
: bool = False,
454 "status of kdu_instance: {}, namespace: {} ".format(kdu_instance
, namespace
)
458 paths
, env
= self
._init
_paths
_env
(
459 cluster_name
=cluster_id
, create_if_not_exist
=True
461 command
= "{} status {} --output yaml".format(self
._helm
_command
, kdu_instance
)
462 output
, rc
= await self
._local
_async
_exec
(
464 raise_exception_on_error
=True,
465 show_error_log
=show_error_log
,
475 data
= yaml
.load(output
, Loader
=yaml
.SafeLoader
)
477 # remove field 'notes'
479 del data
.get("info").get("status")["notes"]
483 # parse field 'resources'
485 resources
= str(data
.get("info").get("status").get("resources"))
486 resource_table
= self
._output
_to
_table
(resources
)
487 data
.get("info").get("status")["resources"] = resource_table
491 # set description to lowercase (unify with helm3)
493 data
.get("info")["description"] = data
.get("info").pop("Description")
499 def _get_helm_chart_repos_ids(self
, cluster_uuid
) -> list:
501 cluster_filter
= {"_admin.helm-chart.id": cluster_uuid
}
502 cluster
= self
.db
.get_one("k8sclusters", cluster_filter
)
504 repo_ids
= cluster
.get("_admin").get("helm_chart_repos") or []
508 "k8cluster with helm-id : {} not found".format(cluster_uuid
)
511 async def _is_install_completed(self
, cluster_id
: str, kdu_instance
: str) -> bool:
513 status
= await self
._status
_kdu
(
514 cluster_id
=cluster_id
, kdu_instance
=kdu_instance
, return_text
=False
517 # extract info.status.resources-> str
520 # NAME READY UP-TO-DATE AVAILABLE AGE
521 # halting-horse-mongodb 0/1 1 0 0s
522 # halting-petit-mongodb 1/1 1 0 0s
524 resources
= K8sHelmBaseConnector
._get
_deep
(
525 status
, ("info", "status", "resources")
529 resources
= K8sHelmBaseConnector
._output
_to
_table
(resources
)
531 num_lines
= len(resources
)
534 while index
< num_lines
:
536 line1
= resources
[index
]
538 # find '==>' in column 0
539 if line1
[0] == "==>":
540 line2
= resources
[index
]
542 # find READY in column 1
543 if line2
[1] == "READY":
545 line3
= resources
[index
]
547 while len(line3
) > 1 and index
< num_lines
:
548 ready_value
= line3
[1]
549 parts
= ready_value
.split(sep
="/")
550 current
= int(parts
[0])
551 total
= int(parts
[1])
553 self
.log
.debug("NOT READY:\n {}".format(line3
))
555 line3
= resources
[index
]
563 def _get_install_command(
564 self
, kdu_model
, kdu_instance
, namespace
, params_str
, version
, atomic
, timeout
569 timeout_str
= "--timeout {}".format(timeout
)
574 atomic_str
= "--atomic"
578 namespace_str
= "--namespace {}".format(namespace
)
583 version_str
= version_str
= "--version {}".format(version
)
586 "{helm} install {atomic} --output yaml "
587 "{params} {timeout} --name={name} {ns} {model} {ver}".format(
588 helm
=self
._helm
_command
,
600 def _get_upgrade_command(
601 self
, kdu_model
, kdu_instance
, namespace
, params_str
, version
, atomic
, timeout
606 timeout_str
= "--timeout {}".format(timeout
)
611 atomic_str
= "--atomic"
616 version_str
= "--version {}".format(version
)
618 command
= "{helm} upgrade {atomic} --output yaml {params} {timeout} {name} {model} {ver}"\
619 .format(helm
=self
._helm
_command
,
629 def _get_rollback_command(self
, kdu_instance
, namespace
, revision
) -> str:
630 return "{} rollback {} {} --wait".format(
631 self
._helm
_command
, kdu_instance
, revision
634 def _get_uninstall_command(self
, kdu_instance
: str, namespace
: str) -> str:
635 return "{} delete --purge {}".format(self
._helm
_command
, kdu_instance
)