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
30 from uuid
import uuid4
32 from n2vc
.k8s_conn
import K8sConnector
33 from n2vc
.exceptions
import K8sException
36 class K8sHelmConnector(K8sConnector
):
39 ##################################################################################################
40 ########################################## P U B L I C ###########################################
41 ##################################################################################################
48 kubectl_command
: str = '/usr/bin/kubectl',
49 helm_command
: str = '/usr/bin/helm',
55 :param fs: file system for kubernetes and helm configuration
56 :param db: database object to write current operation status
57 :param kubectl_command: path to kubectl executable
58 :param helm_command: path to helm executable
60 :param on_update_db: callback called when k8s connector updates database
64 K8sConnector
.__init
__(
68 on_update_db
=on_update_db
71 self
.info('Initializing K8S Helm connector')
73 # random numbers for release name generation
74 random
.seed(time
.time())
79 # exception if kubectl is not installed
80 self
.kubectl_command
= kubectl_command
81 self
._check
_file
_exists
(filename
=kubectl_command
, exception_if_not_exists
=True)
83 # exception if helm is not installed
84 self
._helm
_command
= helm_command
85 self
._check
_file
_exists
(filename
=helm_command
, exception_if_not_exists
=True)
87 # initialize helm client-only
88 self
.debug('Initializing helm client-only...')
89 command
= '{} init --client-only'.format(self
._helm
_command
)
91 asyncio
.ensure_future(self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False))
92 # loop = asyncio.get_event_loop()
93 # loop.run_until_complete(self._local_async_exec(command=command, raise_exception_on_error=False))
94 except Exception as e
:
95 self
.warning(msg
='helm init failed (it was already initialized): {}'.format(e
))
97 self
.info('K8S Helm connector initialized')
102 namespace
: str = 'kube-system',
103 reuse_cluster_uuid
=None
106 It prepares a given K8s cluster environment to run Charts on both sides:
110 :param k8s_creds: credentials to access a given K8s cluster, i.e. a valid '.kube/config'
111 :param namespace: optional namespace to be used for helm. By default, 'kube-system' will be used
112 :param reuse_cluster_uuid: existing cluster uuid for reuse
113 :return: uuid of the K8s cluster and True if connector has installed some software in the cluster
114 (on error, an exception will be raised)
117 cluster_uuid
= reuse_cluster_uuid
119 cluster_uuid
= str(uuid4())
121 self
.debug('Initializing K8S environment. namespace: {}'.format(namespace
))
123 # create config filename
124 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
125 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
126 f
= open(config_filename
, "w")
130 # check if tiller pod is up in cluster
131 command
= '{} --kubeconfig={} --namespace={} get deployments'\
132 .format(self
.kubectl_command
, config_filename
, namespace
)
133 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=True)
135 output_table
= K8sHelmConnector
._output
_to
_table
(output
=output
)
137 # find 'tiller' pod in all pods
138 already_initialized
= False
140 for row
in output_table
:
141 if row
[0].startswith('tiller-deploy'):
142 already_initialized
= True
144 except Exception as e
:
148 n2vc_installed_sw
= False
149 if not already_initialized
:
150 self
.info('Initializing helm in client and server: {}'.format(cluster_uuid
))
151 command
= '{} --kubeconfig={} --tiller-namespace={} --home={} init'\
152 .format(self
._helm
_command
, config_filename
, namespace
, helm_dir
)
153 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=True)
154 n2vc_installed_sw
= True
156 # check client helm installation
157 check_file
= helm_dir
+ '/repository/repositories.yaml'
158 if not self
._check
_file
_exists
(filename
=check_file
, exception_if_not_exists
=False):
159 self
.info('Initializing helm in client: {}'.format(cluster_uuid
))
160 command
= '{} --kubeconfig={} --tiller-namespace={} --home={} init --client-only'\
161 .format(self
._helm
_command
, config_filename
, namespace
, helm_dir
)
162 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=True)
164 self
.info('Helm client already initialized')
166 self
.info('Cluster initialized {}'.format(cluster_uuid
))
168 return cluster_uuid
, n2vc_installed_sw
175 repo_type
: str = 'chart'
178 self
.debug('adding {} repository {}. URL: {}'.format(repo_type
, name
, url
))
181 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
182 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
185 command
= '{} --kubeconfig={} --home={} repo update'.format(self
._helm
_command
, config_filename
, helm_dir
)
186 self
.debug('updating repo: {}'.format(command
))
187 await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False)
189 # helm repo add name url
190 command
= '{} --kubeconfig={} --home={} repo add {} {}'\
191 .format(self
._helm
_command
, config_filename
, helm_dir
, name
, url
)
192 self
.debug('adding repo: {}'.format(command
))
193 await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=True)
200 Get the list of registered repositories
202 :return: list of registered repositories: [ (name, url) .... ]
205 self
.debug('list repositories for cluster {}'.format(cluster_uuid
))
208 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
209 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
211 command
= '{} --kubeconfig={} --home={} repo list --output yaml'\
212 .format(self
._helm
_command
, config_filename
, helm_dir
)
214 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=True)
215 if output
and len(output
) > 0:
216 return yaml
.load(output
, Loader
=yaml
.SafeLoader
)
220 async def repo_remove(
226 Remove a repository from OSM
228 :param cluster_uuid: the cluster
229 :param name: repo name in OSM
230 :return: True if successful
233 self
.debug('list repositories for cluster {}'.format(cluster_uuid
))
236 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
237 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
239 command
= '{} --kubeconfig={} --home={} repo remove {}'\
240 .format(self
._helm
_command
, config_filename
, helm_dir
, name
)
242 await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=True)
248 uninstall_sw
: bool = False
251 self
.debug('Resetting K8s environment. cluster uuid: {}'.format(cluster_uuid
))
253 # get kube and helm directories
254 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
255 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=False)
257 # uninstall releases if needed
258 releases
= await self
.instances_list(cluster_uuid
=cluster_uuid
)
259 if len(releases
) > 0:
263 kdu_instance
= r
.get('Name')
264 chart
= r
.get('Chart')
265 self
.debug('Uninstalling {} -> {}'.format(chart
, kdu_instance
))
266 await self
.uninstall(cluster_uuid
=cluster_uuid
, kdu_instance
=kdu_instance
)
267 except Exception as e
:
268 self
.error('Error uninstalling release {}: {}'.format(kdu_instance
, e
))
270 msg
= 'Cluster has releases and not force. Cannot reset K8s environment. Cluster uuid: {}'\
271 .format(cluster_uuid
)
273 raise K8sException(msg
)
277 self
.debug('Uninstalling tiller from cluster {}'.format(cluster_uuid
))
279 # find namespace for tiller pod
280 command
= '{} --kubeconfig={} get deployments --all-namespaces'\
281 .format(self
.kubectl_command
, config_filename
)
282 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False)
283 output_table
= K8sHelmConnector
._output
_to
_table
(output
=output
)
285 for r
in output_table
:
287 if 'tiller-deploy' in r
[1]:
290 except Exception as e
:
293 msg
= 'Tiller deployment not found in cluster {}'.format(cluster_uuid
)
296 self
.debug('namespace for tiller: {}'.format(namespace
))
298 force_str
= '--force'
301 # delete tiller deployment
302 self
.debug('Deleting tiller deployment for cluster {}, namespace {}'.format(cluster_uuid
, namespace
))
303 command
= '{} --namespace {} --kubeconfig={} {} delete deployment tiller-deploy'\
304 .format(self
.kubectl_command
, namespace
, config_filename
, force_str
)
305 await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False)
307 # uninstall tiller from cluster
308 self
.debug('Uninstalling tiller from cluster {}'.format(cluster_uuid
))
309 command
= '{} --kubeconfig={} --home={} reset'\
310 .format(self
._helm
_command
, config_filename
, helm_dir
)
311 self
.debug('resetting: {}'.format(command
))
312 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=True)
314 self
.debug('namespace not found')
316 # delete cluster directory
317 dir = self
.fs
.path
+ '/' + cluster_uuid
318 self
.debug('Removing directory {}'.format(dir))
319 shutil
.rmtree(dir, ignore_errors
=True)
328 timeout
: float = 300,
333 self
.debug('installing {} in cluster {}'.format(kdu_model
, cluster_uuid
))
336 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
337 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
340 # params_str = K8sHelmConnector._params_to_set_option(params)
341 params_str
, file_to_delete
= self
._params
_to
_file
_option
(cluster_uuid
=cluster_uuid
, params
=params
)
345 timeout_str
= '--timeout {}'.format(timeout
)
350 atomic_str
= '--atomic'
355 parts
= kdu_model
.split(sep
=':')
357 version_str
= '--version {}'.format(parts
[1])
360 # generate a name for the release. Then, check if already exists
362 while kdu_instance
is None:
363 kdu_instance
= K8sHelmConnector
._generate
_release
_name
(kdu_model
)
365 result
= await self
._status
_kdu
(
366 cluster_uuid
=cluster_uuid
,
367 kdu_instance
=kdu_instance
,
370 if result
is not None:
371 # instance already exists: generate a new one
373 except Exception as e
:
377 command
= '{} install {} --output yaml --kubeconfig={} --home={} {} {} --name={} {} {}'\
378 .format(self
._helm
_command
, atomic_str
, config_filename
, helm_dir
,
379 params_str
, timeout_str
, kdu_instance
, kdu_model
, version_str
)
380 self
.debug('installing: {}'.format(command
))
383 # exec helm in a task
384 exec_task
= asyncio
.ensure_future(
385 coro_or_future
=self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False)
387 # write status in another task
388 status_task
= asyncio
.ensure_future(
389 coro_or_future
=self
._store
_status
(
390 cluster_uuid
=cluster_uuid
,
391 kdu_instance
=kdu_instance
,
398 # wait for execution task
399 await asyncio
.wait([exec_task
])
404 output
, rc
= exec_task
.result()
408 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False)
410 # remove temporal values yaml file
412 os
.remove(file_to_delete
)
415 await self
._store
_status
(
416 cluster_uuid
=cluster_uuid
,
417 kdu_instance
=kdu_instance
,
425 msg
= 'Error executing command: {}\nOutput: {}'.format(command
, output
)
427 raise K8sException(msg
)
429 self
.debug('Returning kdu_instance {}'.format(kdu_instance
))
432 async def instances_list(
437 returns a list of deployed releases in a cluster
439 :param cluster_uuid: the cluster
443 self
.debug('list releases for cluster {}'.format(cluster_uuid
))
446 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
447 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
449 command
= '{} --kubeconfig={} --home={} list --output yaml'\
450 .format(self
._helm
_command
, config_filename
, helm_dir
)
452 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=True)
454 if output
and len(output
) > 0:
455 return yaml
.load(output
, Loader
=yaml
.SafeLoader
).get('Releases')
463 kdu_model
: str = None,
465 timeout
: float = 300,
470 self
.debug('upgrading {} in cluster {}'.format(kdu_model
, cluster_uuid
))
473 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
474 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
477 # params_str = K8sHelmConnector._params_to_set_option(params)
478 params_str
, file_to_delete
= self
._params
_to
_file
_option
(cluster_uuid
=cluster_uuid
, params
=params
)
482 timeout_str
= '--timeout {}'.format(timeout
)
487 atomic_str
= '--atomic'
491 if kdu_model
and ':' in kdu_model
:
492 parts
= kdu_model
.split(sep
=':')
494 version_str
= '--version {}'.format(parts
[1])
498 command
= '{} upgrade {} --output yaml --kubeconfig={} --home={} {} {} {} {} {}'\
499 .format(self
._helm
_command
, atomic_str
, config_filename
, helm_dir
,
500 params_str
, timeout_str
, kdu_instance
, kdu_model
, version_str
)
501 self
.debug('upgrading: {}'.format(command
))
505 # exec helm in a task
506 exec_task
= asyncio
.ensure_future(
507 coro_or_future
=self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False)
509 # write status in another task
510 status_task
= asyncio
.ensure_future(
511 coro_or_future
=self
._store
_status
(
512 cluster_uuid
=cluster_uuid
,
513 kdu_instance
=kdu_instance
,
520 # wait for execution task
521 await asyncio
.wait([exec_task
])
525 output
, rc
= exec_task
.result()
529 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False)
531 # remove temporal values yaml file
533 os
.remove(file_to_delete
)
536 await self
._store
_status
(
537 cluster_uuid
=cluster_uuid
,
538 kdu_instance
=kdu_instance
,
546 msg
= 'Error executing command: {}\nOutput: {}'.format(command
, output
)
548 raise K8sException(msg
)
550 # return new revision number
551 instance
= await self
.get_instance_info(cluster_uuid
=cluster_uuid
, kdu_instance
=kdu_instance
)
553 revision
= int(instance
.get('Revision'))
554 self
.debug('New revision: {}'.format(revision
))
567 self
.debug('rollback kdu_instance {} to revision {} from cluster {}'
568 .format(kdu_instance
, revision
, cluster_uuid
))
571 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
572 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
574 command
= '{} rollback --kubeconfig={} --home={} {} {} --wait'\
575 .format(self
._helm
_command
, config_filename
, helm_dir
, kdu_instance
, revision
)
577 # exec helm in a task
578 exec_task
= asyncio
.ensure_future(
579 coro_or_future
=self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=False)
581 # write status in another task
582 status_task
= asyncio
.ensure_future(
583 coro_or_future
=self
._store
_status
(
584 cluster_uuid
=cluster_uuid
,
585 kdu_instance
=kdu_instance
,
587 operation
='rollback',
592 # wait for execution task
593 await asyncio
.wait([exec_task
])
598 output
, rc
= exec_task
.result()
601 await self
._store
_status
(
602 cluster_uuid
=cluster_uuid
,
603 kdu_instance
=kdu_instance
,
605 operation
='rollback',
611 msg
= 'Error executing command: {}\nOutput: {}'.format(command
, output
)
613 raise K8sException(msg
)
615 # return new revision number
616 instance
= await self
.get_instance_info(cluster_uuid
=cluster_uuid
, kdu_instance
=kdu_instance
)
618 revision
= int(instance
.get('Revision'))
619 self
.debug('New revision: {}'.format(revision
))
630 Removes an existing KDU instance. It would implicitly use the `delete` call (this call would happen
631 after all _terminate-config-primitive_ of the VNF are invoked).
633 :param cluster_uuid: UUID of a K8s cluster known by OSM
634 :param kdu_instance: unique name for the KDU instance to be deleted
635 :return: True if successful
638 self
.debug('uninstall kdu_instance {} from cluster {}'.format(kdu_instance
, cluster_uuid
))
641 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
642 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
644 command
= '{} --kubeconfig={} --home={} delete --purge {}'\
645 .format(self
._helm
_command
, config_filename
, helm_dir
, kdu_instance
)
647 output
, rc
= await self
._local
_async
_exec
(command
=command
, raise_exception_on_error
=True)
649 return self
._output
_to
_table
(output
)
651 async def inspect_kdu(
657 self
.debug('inspect kdu_model {} from (optional) repo: {}'.format(kdu_model
, repo_url
))
659 return await self
._exec
_inspect
_comand
(inspect_command
='', kdu_model
=kdu_model
, repo_url
=repo_url
)
661 async def values_kdu(
667 self
.debug('inspect kdu_model values {} from (optional) repo: {}'.format(kdu_model
, repo_url
))
669 return await self
._exec
_inspect
_comand
(inspect_command
='values', kdu_model
=kdu_model
, repo_url
=repo_url
)
677 self
.debug('inspect kdu_model {} readme.md from repo: {}'.format(kdu_model
, repo_url
))
679 return await self
._exec
_inspect
_comand
(inspect_command
='readme', kdu_model
=kdu_model
, repo_url
=repo_url
)
681 async def status_kdu(
687 # call internal function
688 return await self
._status
_kdu
(
689 cluster_uuid
=cluster_uuid
,
690 kdu_instance
=kdu_instance
,
696 ##################################################################################################
697 ########################################## P R I V A T E #########################################
698 ##################################################################################################
701 async def _exec_inspect_comand(
703 inspect_command
: str,
710 repo_str
= ' --repo {}'.format(repo_url
)
711 idx
= kdu_model
.find('/')
714 kdu_model
= kdu_model
[idx
:]
716 inspect_command
= '{} inspect {} {}{}'.format(self
._helm
_command
, inspect_command
, kdu_model
, repo_str
)
717 output
, rc
= await self
._local
_async
_exec
(command
=inspect_command
, encode_utf8
=True)
721 async def _status_kdu(
725 show_error_log
: bool = False,
726 return_text
: bool = False
729 self
.debug('status of kdu_instance {}'.format(kdu_instance
))
732 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
733 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
735 command
= '{} --kubeconfig={} --home={} status {} --output yaml'\
736 .format(self
._helm
_command
, config_filename
, helm_dir
, kdu_instance
)
738 output
, rc
= await self
._local
_async
_exec
(
740 raise_exception_on_error
=True,
741 show_error_log
=show_error_log
750 data
= yaml
.load(output
, Loader
=yaml
.SafeLoader
)
752 # remove field 'notes'
754 del data
.get('info').get('status')['notes']
758 # parse field 'resources'
760 resources
= str(data
.get('info').get('status').get('resources'))
761 resource_table
= self
._output
_to
_table
(resources
)
762 data
.get('info').get('status')['resources'] = resource_table
763 except Exception as e
:
768 async def get_instance_info(
773 instances
= await self
.instances_list(cluster_uuid
=cluster_uuid
)
774 for instance
in instances
:
775 if instance
.get('Name') == kdu_instance
:
777 self
.debug('Instance {} not found'.format(kdu_instance
))
781 def _generate_release_name(
784 # check embeded chart (file or dir)
785 if chart_name
.startswith('/'):
786 # extract file or directory name
787 chart_name
= chart_name
[chart_name
.rfind('/')+1:]
789 elif '://' in chart_name
:
790 # extract last portion of URL
791 chart_name
= chart_name
[chart_name
.rfind('/')+1:]
795 if c
.isalpha() or c
.isnumeric():
802 # if does not start with alpha character, prefix 'a'
803 if not name
[0].isalpha():
808 def get_random_number():
809 r
= random
.randrange(start
=1, stop
=99999999)
814 name
= name
+ get_random_number()
817 async def _store_status(
822 check_every
: float = 10,
823 db_dict
: dict = None,
824 run_once
: bool = False
828 await asyncio
.sleep(check_every
)
829 detailed_status
= await self
.status_kdu(cluster_uuid
=cluster_uuid
, kdu_instance
=kdu_instance
)
830 status
= detailed_status
.get('info').get('Description')
832 self
.debug('STATUS:\n{}'.format(status
))
833 self
.debug('DETAILED STATUS:\n{}'.format(detailed_status
))
836 result
= await self
.write_app_status_to_db(
839 detailed_status
=str(detailed_status
),
842 self
.info('Error writing in database. Task exiting...')
844 except asyncio
.CancelledError
:
845 self
.debug('Task cancelled')
847 except Exception as e
:
853 async def _is_install_completed(
859 status
= await self
._status
_kdu
(cluster_uuid
=cluster_uuid
, kdu_instance
=kdu_instance
, return_text
=False)
861 # extract info.status.resources-> str
864 # NAME READY UP-TO-DATE AVAILABLE AGE
865 # halting-horse-mongodb 0/1 1 0 0s
866 # halting-petit-mongodb 1/1 1 0 0s
868 resources
= K8sHelmConnector
._get
_deep
(status
, ('info', 'status', 'resources'))
871 resources
= K8sHelmConnector
._output
_to
_table
(resources
)
873 num_lines
= len(resources
)
875 while index
< num_lines
:
877 line1
= resources
[index
]
879 # find '==>' in column 0
880 if line1
[0] == '==>':
881 line2
= resources
[index
]
883 # find READY in column 1
884 if line2
[1] == 'READY':
886 line3
= resources
[index
]
888 while len(line3
) > 1 and index
< num_lines
:
889 ready_value
= line3
[1]
890 parts
= ready_value
.split(sep
='/')
891 current
= int(parts
[0])
892 total
= int(parts
[1])
894 self
.debug('NOT READY:\n {}'.format(line3
))
896 line3
= resources
[index
]
899 except Exception as e
:
905 def _get_deep(dictionary
: dict, members
: tuple):
910 value
= target
.get(m
)
915 except Exception as e
:
919 # find key:value in several lines
921 def _find_in_lines(p_lines
: list, p_key
: str) -> str:
924 if line
.startswith(p_key
+ ':'):
925 parts
= line
.split(':')
926 the_value
= parts
[1].strip()
928 except Exception as e
:
933 # params for use in -f file
934 # returns values file option and filename (in order to delete it at the end)
935 def _params_to_file_option(self
, cluster_uuid
: str, params
: dict) -> (str, str):
937 if params
and len(params
) > 0:
938 kube_dir
, helm_dir
, config_filename
, cluster_dir
= \
939 self
._get
_paths
(cluster_name
=cluster_uuid
, create_if_not_exist
=True)
941 def get_random_number():
942 r
= random
.randrange(start
=1, stop
=99999999)
950 value
= params
.get(key
)
951 if '!!yaml' in str(value
):
952 value
= yaml
.load(value
[7:])
955 values_file
= get_random_number() + '.yaml'
956 with
open(values_file
, 'w') as stream
:
957 yaml
.dump(params2
, stream
, indent
=4, default_flow_style
=False)
959 return '-f {}'.format(values_file
), values_file
963 # params for use in --set option
965 def _params_to_set_option(params
: dict) -> str:
967 if params
and len(params
) > 0:
970 value
= params
.get(key
, None)
971 if value
is not None:
973 params_str
+= '--set '
977 params_str
+= '{}={}'.format(key
, value
)
981 def _output_to_lines(output
: str) -> list:
982 output_lines
= list()
983 lines
= output
.splitlines(keepends
=False)
987 output_lines
.append(line
)
991 def _output_to_table(output
: str) -> list:
992 output_table
= list()
993 lines
= output
.splitlines(keepends
=False)
995 line
= line
.replace('\t', ' ')
997 output_table
.append(line_list
)
998 cells
= line
.split(sep
=' ')
1002 line_list
.append(cell
)
1005 def _get_paths(self
, cluster_name
: str, create_if_not_exist
: bool = False) -> (str, str, str, str):
1007 Returns kube and helm directories
1009 :param cluster_name:
1010 :param create_if_not_exist:
1011 :return: kube, helm directories, config filename and cluster dir.
1012 Raises exception if not exist and cannot create
1016 if base
.endswith("/") or base
.endswith("\\"):
1019 # base dir for cluster
1020 cluster_dir
= base
+ '/' + cluster_name
1021 if create_if_not_exist
and not os
.path
.exists(cluster_dir
):
1022 self
.debug('Creating dir {}'.format(cluster_dir
))
1023 os
.makedirs(cluster_dir
)
1024 if not os
.path
.exists(cluster_dir
):
1025 msg
= 'Base cluster dir {} does not exist'.format(cluster_dir
)
1027 raise K8sException(msg
)
1030 kube_dir
= cluster_dir
+ '/' + '.kube'
1031 if create_if_not_exist
and not os
.path
.exists(kube_dir
):
1032 self
.debug('Creating dir {}'.format(kube_dir
))
1033 os
.makedirs(kube_dir
)
1034 if not os
.path
.exists(kube_dir
):
1035 msg
= 'Kube config dir {} does not exist'.format(kube_dir
)
1037 raise K8sException(msg
)
1040 helm_dir
= cluster_dir
+ '/' + '.helm'
1041 if create_if_not_exist
and not os
.path
.exists(helm_dir
):
1042 self
.debug('Creating dir {}'.format(helm_dir
))
1043 os
.makedirs(helm_dir
)
1044 if not os
.path
.exists(helm_dir
):
1045 msg
= 'Helm config dir {} does not exist'.format(helm_dir
)
1047 raise K8sException(msg
)
1049 config_filename
= kube_dir
+ '/config'
1050 return kube_dir
, helm_dir
, config_filename
, cluster_dir
1053 def _remove_multiple_spaces(str):
1056 str = str.replace(' ', ' ')
1063 command
= K8sHelmConnector
._remove
_multiple
_spaces
(command
)
1064 self
.debug('Executing sync local command: {}'.format(command
))
1065 # raise exception if fails
1068 output
= subprocess
.check_output(command
, shell
=True, universal_newlines
=True)
1071 except Exception as e
:
1074 return output
, return_code
1076 async def _local_async_exec(
1079 raise_exception_on_error
: bool = False,
1080 show_error_log
: bool = True,
1081 encode_utf8
: bool = False
1084 command
= K8sHelmConnector
._remove
_multiple
_spaces
(command
)
1085 self
.debug('Executing async local command: {}'.format(command
))
1088 command
= command
.split(sep
=' ')
1091 process
= await asyncio
.create_subprocess_exec(
1093 stdout
=asyncio
.subprocess
.PIPE
,
1094 stderr
=asyncio
.subprocess
.PIPE
1097 # wait for command terminate
1098 stdout
, stderr
= await process
.communicate()
1100 return_code
= process
.returncode
1104 output
= stdout
.decode('utf-8').strip()
1105 # output = stdout.decode()
1107 output
= stderr
.decode('utf-8').strip()
1108 # output = stderr.decode()
1110 if return_code
!= 0 and show_error_log
:
1111 self
.debug('Return code (FAIL): {}\nOutput:\n{}'.format(return_code
, output
))
1113 self
.debug('Return code: {}'.format(return_code
))
1115 if raise_exception_on_error
and return_code
!= 0:
1116 raise Exception(output
)
1119 output
= output
.encode('utf-8').strip()
1120 output
= str(output
).replace('\\n', '\n')
1122 return output
, return_code
1124 except Exception as e
:
1125 msg
= 'Exception executing command: {} -> {}'.format(command
, e
)
1128 if raise_exception_on_error
:
1142 command
= K8sHelmConnector
._remove
_multiple
_spaces
(command
)
1143 self
.debug('Executing sync remote ssh command: {}'.format(command
))
1145 ssh
= paramiko
.SSHClient()
1146 ssh
.set_missing_host_key_policy(paramiko
.AutoAddPolicy())
1147 ssh
.connect(hostname
=hostname
, username
=username
, password
=password
)
1148 ssh_stdin
, ssh_stdout
, ssh_stderr
= ssh
.exec_command(command
=command
, timeout
=timeout
)
1149 output
= ssh_stdout
.read().decode('utf-8')
1150 error
= ssh_stderr
.read().decode('utf-8')
1152 self
.error('ERROR: {}'.format(error
))
1156 output
= output
.replace('\\n', '\n')
1157 self
.debug('OUTPUT: {}'.format(output
))
1159 return output
, return_code
1161 def _check_file_exists(self
, filename
: str, exception_if_not_exists
: bool = False):
1162 self
.debug('Checking if file {} exists...'.format(filename
))
1163 if os
.path
.exists(filename
):
1166 msg
= 'File {} does not exist'.format(filename
)
1167 if exception_if_not_exists
:
1169 raise K8sException(msg
)