787be0361568fbb71fd755df3fe9e7991a5b9307
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
22 from typing
import Union
26 from n2vc
.k8s_helm_base_conn
import K8sHelmBaseConnector
27 from n2vc
.exceptions
import K8sException
30 class K8sHelm3Connector(K8sHelmBaseConnector
):
33 ####################################################################################
34 ################################### P U B L I C ####################################
35 ####################################################################################
42 kubectl_command
: str = "/usr/bin/kubectl",
43 helm_command
: str = "/usr/bin/helm3",
48 Initializes helm connector for helm v3
50 :param fs: file system for kubernetes and helm configuration
51 :param db: database object to write current operation status
52 :param kubectl_command: path to kubectl executable
53 :param helm_command: path to helm executable
55 :param on_update_db: callback called when k8s connector updates database
59 K8sHelmBaseConnector
.__init
__(
64 kubectl_command
=kubectl_command
,
65 helm_command
=helm_command
,
66 on_update_db
=on_update_db
,
69 self
.log
.info("K8S Helm3 connector initialized")
81 namespace
: str = None,
84 """Install a helm chart
86 :param cluster_uuid str: The UUID of the cluster to install to
87 :param kdu_model str: The name or path of a bundle to install
88 :param kdu_instance: Kdu instance name
89 :param atomic bool: If set, waits until the model is active and resets
90 the cluster on failure.
91 :param timeout int: The time, in seconds, to wait for the install
93 :param params dict: Key-value pairs of instantiation parameters
94 :param kdu_name: Name of the KDU instance to be installed
95 :param namespace: K8s namespace to use for the KDU instance
97 :param kwargs: Additional parameters (None yet)
99 :return: True if successful
101 _
, cluster_id
= self
._get
_namespace
_cluster
_id
(cluster_uuid
)
102 self
.log
.debug("installing {} in cluster {}".format(kdu_model
, cluster_id
))
105 self
.fs
.sync(from_path
=cluster_id
)
108 paths
, env
= self
._init
_paths
_env
(
109 cluster_name
=cluster_id
, create_if_not_exist
=True
112 # for helm3 if namespace does not exist must create it
113 if namespace
and namespace
!= "kube-system":
114 if not await self
._namespace
_exists
(cluster_id
, namespace
):
116 await self
._create
_namespace
(cluster_id
, namespace
)
117 except Exception as e
:
118 if not await self
._namespace
_exists
(cluster_id
, namespace
):
120 "namespace {} does not exist in cluster_id {} "
121 "error message: ".format(namespace
, e
)
123 self
.log
.error(err_msg
)
124 raise K8sException(err_msg
)
126 await self
._install
_impl
(
141 self
.fs
.reverse_sync(from_path
=cluster_id
)
143 self
.log
.debug("Returning kdu_instance {}".format(kdu_instance
))
146 async def inspect_kdu(self
, kdu_model
: str, repo_url
: str = None) -> str:
148 "inspect kdu_model {} from (optional) repo: {}".format(kdu_model
, repo_url
)
151 return await self
._exec
_inspect
_comand
(
152 inspect_command
="all", kdu_model
=kdu_model
, repo_url
=repo_url
156 ####################################################################################
157 ################################### P R I V A T E ##################################
158 ####################################################################################
161 def _init_paths_env(self
, cluster_name
: str, create_if_not_exist
: bool = True):
163 Creates and returns base cluster and kube dirs and returns them.
164 Also created helm3 dirs according to new directory specification, paths are
165 returned and also environment variables that must be provided to execute commands
167 Helm 3 directory specification uses XDG categories for variable support:
168 - Cache: $XDG_CACHE_HOME, for example, ${HOME}/.cache/helm/
169 - Configuration: $XDG_CONFIG_HOME, for example, ${HOME}/.config/helm/
170 - Data: $XDG_DATA_HOME, for example ${HOME}/.local/share/helm
172 The variables assigned for this paths are:
173 (In the documentation the variables names are $HELM_PATH_CACHE, $HELM_PATH_CONFIG,
174 $HELM_PATH_DATA but looking and helm env the variable names are different)
175 - Cache: $HELM_CACHE_HOME
176 - Config: $HELM_CONFIG_HOME
177 - Data: $HELM_DATA_HOME
178 - helm kubeconfig: $KUBECONFIG
180 :param cluster_name: cluster_name
181 :return: Dictionary with config_paths and dictionary with helm environment variables
185 if base
.endswith("/") or base
.endswith("\\"):
188 # base dir for cluster
189 cluster_dir
= base
+ "/" + cluster_name
192 kube_dir
= cluster_dir
+ "/" + ".kube"
193 if create_if_not_exist
and not os
.path
.exists(kube_dir
):
194 self
.log
.debug("Creating dir {}".format(kube_dir
))
195 os
.makedirs(kube_dir
)
197 helm_path_cache
= cluster_dir
+ "/.cache/helm"
198 if create_if_not_exist
and not os
.path
.exists(helm_path_cache
):
199 self
.log
.debug("Creating dir {}".format(helm_path_cache
))
200 os
.makedirs(helm_path_cache
)
202 helm_path_config
= cluster_dir
+ "/.config/helm"
203 if create_if_not_exist
and not os
.path
.exists(helm_path_config
):
204 self
.log
.debug("Creating dir {}".format(helm_path_config
))
205 os
.makedirs(helm_path_config
)
207 helm_path_data
= cluster_dir
+ "/.local/share/helm"
208 if create_if_not_exist
and not os
.path
.exists(helm_path_data
):
209 self
.log
.debug("Creating dir {}".format(helm_path_data
))
210 os
.makedirs(helm_path_data
)
212 config_filename
= kube_dir
+ "/config"
214 # 2 - Prepare dictionary with paths
216 "kube_dir": kube_dir
,
217 "kube_config": config_filename
,
218 "cluster_dir": cluster_dir
,
221 # 3 - Prepare environment variables
223 "HELM_CACHE_HOME": helm_path_cache
,
224 "HELM_CONFIG_HOME": helm_path_config
,
225 "HELM_DATA_HOME": helm_path_data
,
226 "KUBECONFIG": config_filename
,
229 for file_name
, file in paths
.items():
230 if "dir" in file_name
and not os
.path
.exists(file):
231 err_msg
= "{} dir does not exist".format(file)
232 self
.log
.error(err_msg
)
233 raise K8sException(err_msg
)
237 async def _namespace_exists(self
, cluster_id
, namespace
) -> bool:
239 "checking if namespace {} exists cluster_id {}".format(
240 namespace
, cluster_id
243 namespaces
= await self
._get
_namespaces
(cluster_id
)
244 return namespace
in namespaces
if namespaces
else False
246 async def _get_namespaces(self
, cluster_id
: str):
247 self
.log
.debug("get namespaces cluster_id {}".format(cluster_id
))
250 paths
, env
= self
._init
_paths
_env
(
251 cluster_name
=cluster_id
, create_if_not_exist
=True
254 command
= "{} --kubeconfig={} get namespaces -o=yaml".format(
255 self
.kubectl_command
, paths
["kube_config"]
257 output
, _rc
= await self
._local
_async
_exec
(
258 command
=command
, raise_exception_on_error
=True, env
=env
261 data
= yaml
.load(output
, Loader
=yaml
.SafeLoader
)
262 namespaces
= [item
["metadata"]["name"] for item
in data
["items"]]
263 self
.log
.debug(f
"namespaces {namespaces}")
267 async def _create_namespace(self
, cluster_id
: str, namespace
: str):
268 self
.log
.debug(f
"create namespace: {cluster_id} for cluster_id: {namespace}")
271 paths
, env
= self
._init
_paths
_env
(
272 cluster_name
=cluster_id
, create_if_not_exist
=True
275 command
= "{} --kubeconfig={} create namespace {}".format(
276 self
.kubectl_command
, paths
["kube_config"], namespace
278 _
, _rc
= await self
._local
_async
_exec
(
279 command
=command
, raise_exception_on_error
=True, env
=env
281 self
.log
.debug(f
"namespace {namespace} created")
285 async def _get_services(
286 self
, cluster_id
: str, kdu_instance
: str, namespace
: str, kubeconfig
: str
289 paths
, env
= self
._init
_paths
_env
(
290 cluster_name
=cluster_id
, create_if_not_exist
=True
293 command1
= "env KUBECONFIG={} {} get manifest {} --namespace={}".format(
294 kubeconfig
, self
._helm
_command
, kdu_instance
, namespace
296 command2
= "{} get --namespace={} -f -".format(self
.kubectl_command
, namespace
)
297 output
, _rc
= await self
._local
_async
_exec
_pipe
(
298 command1
, command2
, env
=env
, raise_exception_on_error
=True
300 services
= self
._parse
_services
(output
)
304 async def _cluster_init(self
, cluster_id
, namespace
, paths
, env
):
306 Implements the helm version dependent cluster initialization:
307 For helm3 it creates the namespace if it is not created
309 if namespace
!= "kube-system":
310 namespaces
= await self
._get
_namespaces
(cluster_id
)
311 if namespace
not in namespaces
:
312 await self
._create
_namespace
(cluster_id
, namespace
)
314 # If default repo is not included add
315 cluster_uuid
= "{}:{}".format(namespace
, cluster_id
)
316 repo_list
= await self
.repo_list(cluster_uuid
)
317 stable_repo
= [repo
for repo
in repo_list
if repo
["name"] == "stable"]
318 if not stable_repo
and self
._stable
_repo
_url
:
319 await self
.repo_add(cluster_uuid
, "stable", self
._stable
_repo
_url
)
321 # Returns False as no software needs to be uninstalled
324 async def _uninstall_sw(self
, cluster_id
: str, namespace
: str):
325 # nothing to do to uninstall sw
328 async def _instances_list(self
, cluster_id
: str):
330 paths
, env
= self
._init
_paths
_env
(
331 cluster_name
=cluster_id
, create_if_not_exist
=True
334 command
= "{} list --all-namespaces --output yaml".format(self
._helm
_command
)
335 output
, _rc
= await self
._local
_async
_exec
(
336 command
=command
, raise_exception_on_error
=True, env
=env
339 if output
and len(output
) > 0:
340 self
.log
.debug("instances list output: {}".format(output
))
341 return yaml
.load(output
, Loader
=yaml
.SafeLoader
)
345 def _get_inspect_command(
346 self
, inspect_command
: str, kdu_model
: str, repo_str
: str, version
: str
348 inspect_command
= "{} show {} {}{} {}".format(
349 self
._helm
_command
, inspect_command
, kdu_model
, repo_str
, version
351 return inspect_command
353 async def _status_kdu(
357 namespace
: str = None,
358 yaml_format
: bool = False,
359 show_error_log
: bool = False,
360 ) -> Union
[str, dict]:
362 "status of kdu_instance: {}, namespace: {} ".format(kdu_instance
, namespace
)
366 namespace
= "kube-system"
369 paths
, env
= self
._init
_paths
_env
(
370 cluster_name
=cluster_id
, create_if_not_exist
=True
372 command
= "env KUBECONFIG={} {} status {} --namespace={} --output yaml".format(
373 paths
["kube_config"], self
._helm
_command
, kdu_instance
, namespace
376 output
, rc
= await self
._local
_async
_exec
(
378 raise_exception_on_error
=True,
379 show_error_log
=show_error_log
,
389 data
= yaml
.load(output
, Loader
=yaml
.SafeLoader
)
391 # remove field 'notes' and manifest
393 del data
.get("info")["notes"]
397 # parse the manifest to a list of dictionaries
398 if "manifest" in data
:
399 manifest_str
= data
.get("manifest")
400 manifest_docs
= yaml
.load_all(manifest_str
, Loader
=yaml
.SafeLoader
)
402 data
["manifest"] = []
403 for doc
in manifest_docs
:
404 data
["manifest"].append(doc
)
408 def _get_install_command(
421 timeout_str
= "--timeout {}s".format(timeout
)
426 atomic_str
= "--atomic"
430 namespace_str
= "--namespace {}".format(namespace
)
435 version_str
= "--version {}".format(version
)
438 "env KUBECONFIG={kubeconfig} {helm} install {name} {atomic} --output yaml "
439 "{params} {timeout} {ns} {model} {ver}".format(
440 kubeconfig
=kubeconfig
,
441 helm
=self
._helm
_command
,
453 def _get_upgrade_command(
466 timeout_str
= "--timeout {}s".format(timeout
)
471 atomic_str
= "--atomic"
476 version_str
= "--version {}".format(version
)
481 namespace_str
= "--namespace {}".format(namespace
)
484 "env KUBECONFIG={kubeconfig} {helm} upgrade {name} {model} {namespace} {atomic} "
485 "--output yaml {params} {timeout} {ver}"
487 kubeconfig
=kubeconfig
,
488 helm
=self
._helm
_command
,
490 namespace
=namespace_str
,
499 def _get_rollback_command(
500 self
, kdu_instance
: str, namespace
: str, revision
: float, kubeconfig
: str
502 return "env KUBECONFIG={} {} rollback {} {} --namespace={} --wait".format(
503 kubeconfig
, self
._helm
_command
, kdu_instance
, revision
, namespace
506 def _get_uninstall_command(
507 self
, kdu_instance
: str, namespace
: str, kubeconfig
: str
509 return "env KUBECONFIG={} {} uninstall {} --namespace={}".format(
510 kubeconfig
, self
._helm
_command
, kdu_instance
, namespace
513 def _get_helm_chart_repos_ids(self
, cluster_uuid
) -> list:
515 cluster_filter
= {"_admin.helm-chart-v3.id": cluster_uuid
}
516 cluster
= self
.db
.get_one("k8sclusters", cluster_filter
)
518 repo_ids
= cluster
.get("_admin").get("helm_chart_repos") or []
522 "k8cluster with helm-id : {} not found".format(cluster_uuid
)