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 n2vc
.k8s_helm_base_conn
import K8sHelmBaseConnector
26 from n2vc
.exceptions
import K8sException
29 class K8sHelm3Connector(K8sHelmBaseConnector
):
32 ####################################################################################
33 ################################### P U B L I C ####################################
34 ####################################################################################
41 kubectl_command
: str = "/usr/bin/kubectl",
42 helm_command
: str = "/usr/bin/helm3",
47 Initializes helm connector for helm v3
49 :param fs: file system for kubernetes and helm configuration
50 :param db: database object to write current operation status
51 :param kubectl_command: path to kubectl executable
52 :param helm_command: path to helm executable
54 :param on_update_db: callback called when k8s connector updates database
58 K8sHelmBaseConnector
.__init
__(
63 kubectl_command
=kubectl_command
,
64 helm_command
=helm_command
,
65 on_update_db
=on_update_db
,
68 self
.log
.info("K8S Helm3 connector initialized")
80 namespace
: str = None,
83 """Install a helm chart
85 :param cluster_uuid str: The UUID of the cluster to install to
86 :param kdu_model str: The name or path of a bundle to install
87 :param kdu_instance: Kdu instance name
88 :param atomic bool: If set, waits until the model is active and resets
89 the cluster on failure.
90 :param timeout int: The time, in seconds, to wait for the install
92 :param params dict: Key-value pairs of instantiation parameters
93 :param kdu_name: Name of the KDU instance to be installed
94 :param namespace: K8s namespace to use for the KDU instance
96 :param kwargs: Additional parameters (None yet)
98 :return: True if successful
100 _
, cluster_id
= self
._get
_namespace
_cluster
_id
(cluster_uuid
)
101 self
.log
.debug("installing {} in cluster {}".format(kdu_model
, cluster_id
))
104 self
.fs
.sync(from_path
=cluster_id
)
107 paths
, env
= self
._init
_paths
_env
(
108 cluster_name
=cluster_id
, create_if_not_exist
=True
111 # for helm3 if namespace does not exist must create it
112 if namespace
and namespace
!= "kube-system":
113 if not await self
._namespace
_exists
(cluster_id
, namespace
):
115 await self
._create
_namespace
(cluster_id
, namespace
)
116 except Exception as e
:
117 if not await self
._namespace
_exists
(cluster_id
, namespace
):
119 "namespace {} does not exist in cluster_id {} "
120 "error message: ".format(namespace
, e
)
122 self
.log
.error(err_msg
)
123 raise K8sException(err_msg
)
125 await self
._install
_impl
(
140 self
.fs
.reverse_sync(from_path
=cluster_id
)
142 self
.log
.debug("Returning kdu_instance {}".format(kdu_instance
))
145 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):
248 self
.log
.debug("get namespaces cluster_id {}".format(cluster_id
))
251 paths
, env
= self
._init
_paths
_env
(
252 cluster_name
=cluster_id
, create_if_not_exist
=True
255 command
= "{} --kubeconfig={} get namespaces -o=yaml".format(
256 self
.kubectl_command
, paths
["kube_config"]
258 output
, _rc
= await self
._local
_async
_exec
(
259 command
=command
, raise_exception_on_error
=True, env
=env
262 data
= yaml
.load(output
, Loader
=yaml
.SafeLoader
)
263 namespaces
= [item
["metadata"]["name"] for item
in data
["items"]]
264 self
.log
.debug(f
"namespaces {namespaces}")
268 async def _create_namespace(self
, cluster_id
: str, namespace
: str):
270 self
.log
.debug(f
"create namespace: {cluster_id} for cluster_id: {namespace}")
273 paths
, env
= self
._init
_paths
_env
(
274 cluster_name
=cluster_id
, create_if_not_exist
=True
277 command
= "{} --kubeconfig={} create namespace {}".format(
278 self
.kubectl_command
, paths
["kube_config"], namespace
280 _
, _rc
= await self
._local
_async
_exec
(
281 command
=command
, raise_exception_on_error
=True, env
=env
283 self
.log
.debug(f
"namespace {namespace} created")
287 async def _get_services(self
, cluster_id
: str, kdu_instance
: str, namespace
: str):
290 paths
, env
= self
._init
_paths
_env
(
291 cluster_name
=cluster_id
, create_if_not_exist
=True
294 command1
= "{} get manifest {} --namespace={}".format(
295 self
._helm
_command
, kdu_instance
, namespace
297 command2
= "{} get --namespace={} -f -".format(self
.kubectl_command
, namespace
)
298 output
, _rc
= await self
._local
_async
_exec
_pipe
(
299 command1
, command2
, env
=env
, raise_exception_on_error
=True
301 services
= self
._parse
_services
(output
)
305 async def _cluster_init(self
, cluster_id
, namespace
, paths
, env
):
307 Implements the helm version dependent cluster initialization:
308 For helm3 it creates the namespace if it is not created
310 if namespace
!= "kube-system":
311 namespaces
= await self
._get
_namespaces
(cluster_id
)
312 if namespace
not in namespaces
:
313 await self
._create
_namespace
(cluster_id
, namespace
)
315 # If default repo is not included add
316 cluster_uuid
= "{}:{}".format(namespace
, cluster_id
)
317 repo_list
= await self
.repo_list(cluster_uuid
)
318 stable_repo
= [repo
for repo
in repo_list
if repo
["name"] == "stable"]
319 if not stable_repo
and self
._stable
_repo
_url
:
320 await self
.repo_add(cluster_uuid
, "stable", self
._stable
_repo
_url
)
322 # Returns False as no software needs to be uninstalled
325 async def _uninstall_sw(self
, cluster_id
: str, namespace
: str):
326 # nothing to do to uninstall sw
329 async def _instances_list(self
, cluster_id
: str):
332 paths
, env
= self
._init
_paths
_env
(
333 cluster_name
=cluster_id
, create_if_not_exist
=True
336 command
= "{} list --all-namespaces --output yaml".format(self
._helm
_command
)
337 output
, _rc
= await self
._local
_async
_exec
(
338 command
=command
, raise_exception_on_error
=True, env
=env
341 if output
and len(output
) > 0:
342 self
.log
.debug("instances list output: {}".format(output
))
343 return yaml
.load(output
, Loader
=yaml
.SafeLoader
)
347 def _get_inspect_command(
348 self
, inspect_command
: str, kdu_model
: str, repo_str
: str, version
: str
350 inspect_command
= "{} show {} {}{} {}".format(
351 self
._helm
_command
, inspect_command
, kdu_model
, repo_str
, version
353 return inspect_command
355 async def _status_kdu(
359 namespace
: str = None,
360 show_error_log
: bool = False,
361 return_text
: bool = False,
365 "status of kdu_instance: {}, namespace: {} ".format(kdu_instance
, namespace
)
369 namespace
= "kube-system"
372 paths
, env
= self
._init
_paths
_env
(
373 cluster_name
=cluster_id
, create_if_not_exist
=True
375 command
= "{} status {} --namespace={} --output yaml".format(
376 self
._helm
_command
, kdu_instance
, namespace
379 output
, rc
= await self
._local
_async
_exec
(
381 raise_exception_on_error
=True,
382 show_error_log
=show_error_log
,
392 data
= yaml
.load(output
, Loader
=yaml
.SafeLoader
)
394 # remove field 'notes' and manifest
396 del data
.get("info")["notes"]
401 # unable to parse 'resources' as currently it is not included in helm3
404 def _get_install_command(
417 timeout_str
= "--timeout {}s".format(timeout
)
422 atomic_str
= "--atomic"
426 namespace_str
= "--namespace {}".format(namespace
)
431 version_str
= "--version {}".format(version
)
434 "{helm} install {name} {atomic} --output yaml "
435 "{params} {timeout} {ns} {model} {ver}".format(
436 helm
=self
._helm
_command
,
448 def _get_upgrade_command(
461 timeout_str
= "--timeout {}s".format(timeout
)
466 atomic_str
= "--atomic"
471 version_str
= "--version {}".format(version
)
476 namespace_str
= "--namespace {}".format(namespace
)
479 "{helm} upgrade {name} {model} {namespace} {atomic} --output yaml {params} "
480 "{timeout} {ver}".format(
481 helm
=self
._helm
_command
,
483 namespace
=namespace_str
,
493 def _get_rollback_command(
494 self
, kdu_instance
: str, namespace
: str, revision
: float
496 return "{} rollback {} {} --namespace={} --wait".format(
497 self
._helm
_command
, kdu_instance
, revision
, namespace
500 def _get_uninstall_command(self
, kdu_instance
: str, namespace
: str) -> str:
502 return "{} uninstall {} --namespace={}".format(
503 self
._helm
_command
, kdu_instance
, namespace
506 def _get_helm_chart_repos_ids(self
, cluster_uuid
) -> list:
508 cluster_filter
= {"_admin.helm-chart-v3.id": cluster_uuid
}
509 cluster
= self
.db
.get_one("k8sclusters", cluster_filter
)
511 repo_ids
= cluster
.get("_admin").get("helm_chart_repos") or []
515 "k8cluster with helm-id : {} not found".format(cluster_uuid
)