1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
|
# ============LICENSE_START=======================================================
# org.onap.dcae
# ================================================================================
# Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
# Copyright (c) 2020 Pantheon.tech. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============LICENSE_END=========================================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
# Lifecycle interface calls for containerized components
# Needed by Cloudify Manager to load google.auth for the Kubernetes python client
from . import cloudify_importer
import time, copy
import json
from cloudify import ctx
from cloudify.decorators import operation
from cloudify.exceptions import NonRecoverableError, RecoverableError
from onap_dcae_dcaepolicy_lib import Policies
from k8splugin import discovery as dis
from k8splugin.decorators import monkeypatch_loggers, wrap_error_handling_start, \
merge_inputs_for_start, merge_inputs_for_create, wrap_error_handling_update
from k8splugin.exceptions import DockerPluginDeploymentError
from k8splugin import utils
from configure import configure
import k8sclient
# Get configuration
plugin_conf = configure.configure()
CONSUL_HOST = plugin_conf.get("consul_host")
CONSUL_INTERNAL_NAME = plugin_conf.get("consul_dns_name")
DCAE_NAMESPACE = plugin_conf.get("namespace")
DEFAULT_MAX_WAIT = plugin_conf.get("max_wait", 1800)
DEFAULT_K8S_LOCATION = plugin_conf.get("default_k8s_location")
COMPONENT_CA_CERT_PATH = plugin_conf.get("tls").get("component_ca_cert_path")
CBS_BASE_URL = plugin_conf.get("cbs").get("base_url")
# Used to construct delivery urls for data router subscribers. Data router in FTL
# requires https but this author believes that ONAP is to be defaulted to http.
DEFAULT_SCHEME = "http"
# Property keys
SERVICE_COMPONENT_NAME = "service_component_name"
CONTAINER_ID = "container_id"
APPLICATION_CONFIG = "application_config"
K8S_DEPLOYMENT = "k8s_deployment"
RESOURCE_KW = "resource_config"
LOCATION_ID = "location_id"
# Utility methods
# Lifecycle interface calls for dcae.nodes.DockerContainer
def _setup_for_discovery(**kwargs):
"""Setup for config discovery"""
try:
name = kwargs['name']
application_config = kwargs[APPLICATION_CONFIG]
# NOTE: application_config is no longer a json string and is inputed as a
# YAML map which translates to a dict. We don't have to do any
# preprocessing anymore.
conn = dis.create_kv_conn(CONSUL_HOST)
dis.push_service_component_config(conn, name, application_config)
return kwargs
except dis.DiscoveryConnectionError as e:
raise RecoverableError(e)
except Exception as e:
ctx.logger.error("Unexpected error while pushing configuration: {0}"
.format(str(e)))
raise NonRecoverableError(e)
def _generate_component_name(**kwargs):
"""Generate component name"""
service_component_type = kwargs['service_component_type']
name_override = kwargs['service_component_name_override']
kwargs['name'] = name_override if name_override \
else dis.generate_service_component_name(service_component_type)
return kwargs
def _done_for_create(**kwargs):
"""Wrap up create operation"""
name = kwargs['name']
kwargs[SERVICE_COMPONENT_NAME] = name
# All updates to the runtime_properties happens here. I don't see a reason
# why we shouldn't do this because the context is not being mutated by
# something else and will keep the other functions pure (pure in the sense
# not dealing with CloudifyContext).
ctx.instance.runtime_properties.update(kwargs)
ctx.logger.info("Done setting up: {0}".format(name))
return kwargs
def _get_resources(**kwargs):
if kwargs is not None:
ctx.logger.debug("{0}: {1}".format(RESOURCE_KW, kwargs.get(RESOURCE_KW)))
return kwargs.get(RESOURCE_KW)
ctx.logger.info("set resources to None")
return None
def _get_location():
''' Get the k8s location property. Set to the default if the property is missing, None, or zero-length '''
return ctx.node.properties["location_id"] if "location_id" in ctx.node.properties and ctx.node.properties["location_id"] \
else DEFAULT_K8S_LOCATION
@merge_inputs_for_create
@monkeypatch_loggers
@Policies.gather_policies_to_node()
@operation
def create_for_components(**create_inputs):
"""Create step for service components
This interface is responsible for:
1. Generating service component name
2. Populating config information into Consul
"""
_done_for_create(
**_setup_for_discovery(
**_enhance_docker_params(
**_generate_component_name(
**create_inputs))))
def _parse_streams(**kwargs):
"""Parse streams and setup for DMaaP plugin"""
# The DMaaP plugin requires this plugin to set the runtime properties
# keyed by the node name.
for stream in kwargs["streams_publishes"]:
kwargs[stream["name"]] = stream
for stream in kwargs["streams_subscribes"]:
if stream["type"] == "data_router":
# Don't want to mutate the source
stream = copy.deepcopy(stream)
# Set up the delivery URL
# Using service_component_name as the host name in the subscriber URL
# will work in a single-cluster ONAP deployment. Whether it will also work
# in a multi-cluster ONAP deployment--with a central location and one or
# more remote ("edge") locations depends on how networking and DNS is set
# up in a multi-cluster deployment
service_component_name = kwargs["name"]
ports, _ = k8sclient.parse_ports(kwargs["ports"])
dport, _ = ports[0]
subscriber_host = "{host}:{port}".format(host=service_component_name, port=dport)
scheme = stream.get("scheme", DEFAULT_SCHEME)
if "route" not in stream:
raise NonRecoverableError("'route' key missing from data router subscriber")
path = stream["route"]
stream["delivery_url"] = "{scheme}://{host}/{path}".format(
scheme=scheme, host=subscriber_host, path=path)
# If username and password has not been provided then generate it. The
# DMaaP plugin doesn't generate for subscribers. The generation code
# and length of username password has been lifted from the DMaaP
# plugin.
if not stream.get("username", None):
stream["username"] = utils.random_string(8)
if not stream.get("password", None):
stream["password"] = utils.random_string(10)
kwargs[stream["name"]] = stream
return kwargs
@merge_inputs_for_create
@monkeypatch_loggers
@Policies.gather_policies_to_node()
@operation
def create_for_components_with_streams(**create_inputs):
"""Create step for service components that use DMaaP
This interface is responsible for:
1. Generating service component name
2. Setup runtime properties for DMaaP plugin
3. Populating application config into Consul
"""
_done_for_create(
**_setup_for_discovery(
**_parse_streams(
**_enhance_docker_params(
**_generate_component_name(
**create_inputs)))))
@merge_inputs_for_create
@monkeypatch_loggers
@operation
def create_for_platforms(**create_inputs):
"""Create step for platform components
This interface is responible for:
1. Populating config information into Consul
"""
_done_for_create(
**_setup_for_discovery(
**create_inputs))
def _verify_k8s_deployment(location, service_component_name, max_wait):
"""Verify that the k8s Deployment is ready
Args:
-----
location (string): location of the k8s cluster where the component was deployed
service_component_name: component's service component name
max_wait (integer): limit to how may attempts to make which translates to
seconds because each sleep is one second. 0 means infinite.
Return:
-------
True if deployment is ready within the maximum wait time, False otherwise
"""
num_attempts = 1
while True:
if k8sclient.is_available(location, DCAE_NAMESPACE, service_component_name):
return True
else:
num_attempts += 1
if max_wait > 0 and max_wait < num_attempts:
return False
time.sleep(1)
return True
def _create_and_start_container(container_name, image, **kwargs):
'''
This will create a k8s Deployment and, if needed, a k8s Service or two.
(We are being opinionated in our use of k8s... this code decides what k8s abstractions and features to use.
We're not exposing k8s to the component developer and the blueprint author.
This is a conscious choice. We want to use k8s in a controlled, consistent way, and we want to hide
the details from the component developer and the blueprint author.)
kwargs may have:
- volumes: array of volume objects, where a volume object is:
{"host":{"path": "/path/on/host"}, "container":{"bind":"/path/on/container","mode":"rw_or_ro"}
- ports: array of strings in the form "container_port:host_port"
- envs: map of name-value pairs ( {name0: value0, name1: value1...} )
- always_pull: boolean. If true, sets image pull policy to "Always"
so that a fresh copy of the image is always pull. Otherwise, sets
image pull policy to "IfNotPresent"
- msb_list: array of msb objects, where an msb object is as described in msb/msb.py.
- log_info: an object with info for setting up ELK logging, with the form:
{"log_directory": "/path/to/container/log/directory", "alternate_fb_path" : "/alternate/sidecar/log/path"}"
- tls_info: an object with information for setting up the component to act as a TLS server, with the form:
{"use_tls" : true_or_false, "cert_directory": "/path/to/directory_where_certs_should_be_placed" }
- replicas: number of replicas to be launched initially
- readiness: object with information needed to create a readiness check
- liveness: object with information needed to create a liveness check
- k8s_location: name of the Kubernetes location (cluster) where the component is to be deployed
'''
tls_info = kwargs.get("tls_info")
env = { "CONSUL_HOST": CONSUL_INTERNAL_NAME,
"CONFIG_BINDING_SERVICE": "config-binding-service",
"DCAE_CA_CERTPATH" : "{0}/cacert.pem".format(tls_info["cert_directory"]) if (tls_info and tls_info["cert_directory"]) else COMPONENT_CA_CERT_PATH,
"CBS_CONFIG_URL" : "{0}/{1}".format(CBS_BASE_URL, container_name)
}
env.update(kwargs.get("envs", {}))
ctx.logger.info("Starting k8s deployment for {}, image: {}, env: {}, kwargs: {}".format(container_name, image, env, kwargs))
ctx.logger.info("Passing k8sconfig: {}".format(plugin_conf))
replicas = kwargs.get("replicas", 1)
resource_config = _get_resources(**kwargs)
_, dep = k8sclient.deploy(DCAE_NAMESPACE,
container_name,
image,
replicas=replicas,
always_pull=kwargs.get("always_pull_image", False),
k8sconfig=plugin_conf,
resources=resource_config,
volumes=kwargs.get("volumes", []),
ports=kwargs.get("ports", []),
msb_list=kwargs.get("msb_list"),
tls_info=kwargs.get("tls_info"),
env=env,
labels=kwargs.get("labels", {}),
log_info=kwargs.get("log_info"),
readiness=kwargs.get("readiness"),
liveness=kwargs.get("liveness"),
k8s_location=kwargs.get("k8s_location"))
# Capture the result of deployment for future use
ctx.instance.runtime_properties[K8S_DEPLOYMENT] = dep
kwargs[K8S_DEPLOYMENT] = dep
ctx.instance.runtime_properties["replicas"] = replicas
ctx.logger.info ("k8s deployment initiated successfully for {0}: {1}".format(container_name, dep))
return kwargs
def _parse_cloudify_context(**kwargs):
"""Parse Cloudify context
Extract what is needed. This is impure function because it requires ctx.
"""
kwargs["deployment_id"] = ctx.deployment.id
# Set some labels for the Kubernetes pods
# The name segment is required and must be 63 characters or less
kwargs["labels"] = {
"cfydeployment" : ctx.deployment.id,
"cfynode": ctx.node.name[:63],
"cfynodeinstance": ctx.instance.id[:63]
}
# Pick up the centralized logging info
if "log_info" in ctx.node.properties and "log_directory" in ctx.node.properties["log_info"]:
kwargs["log_info"] = ctx.node.properties["log_info"]
# Pick up TLS info if present
if "tls_info" in ctx.node.properties:
kwargs["tls_info"] = ctx.node.properties["tls_info"]
# Pick up replica count and always_pull_image flag
if "replicas" in ctx.node.properties:
kwargs["replicas"] = ctx.node.properties["replicas"]
if "always_pull_image" in ctx.node.properties:
kwargs["always_pull_image"] = ctx.node.properties["always_pull_image"]
# Pick up location
kwargs["k8s_location"] = _get_location()
return kwargs
def _enhance_docker_params(**kwargs):
'''
Set up Docker environment variables and readiness/liveness check info
and inject into kwargs.
'''
# Get info for setting up readiness/liveness probe, if present
docker_config = kwargs.get("docker_config", {})
if "healthcheck" in docker_config:
kwargs["readiness"] = docker_config["healthcheck"]
if "livehealthcheck" in docker_config:
kwargs["liveness"] = docker_config["livehealthcheck"]
envs = kwargs.get("envs", {})
# Set tags on this component for its Consul registration as a service
tags = [kwargs.get("deployment_id", None), kwargs["service_id"]]
tags = [ str(tag) for tag in tags if tag is not None ]
# Registrator will use this to register this component with tags. Must be
# comma delimited.
envs["SERVICE_TAGS"] = ",".join(tags)
kwargs["envs"] = envs
def combine_params(key, docker_config, kwargs):
v = docker_config.get(key, []) + kwargs.get(key, [])
kwargs[key] = v
return kwargs
# Add the lists of ports and volumes unintelligently - meaning just add the
# lists together with no deduping.
kwargs = combine_params("ports", docker_config, kwargs)
kwargs = combine_params("volumes", docker_config, kwargs)
return kwargs
def _create_and_start_component(**kwargs):
"""Create and start component (container)"""
image = kwargs["image"]
service_component_name = kwargs[SERVICE_COMPONENT_NAME]
# Need to be picky and manually select out pieces because just using kwargs
# which contains everything confused the execution of
# _create_and_start_container because duplicate variables exist
sub_kwargs = {
"volumes": kwargs.get("volumes", []),
"ports": kwargs.get("ports", None),
"envs": kwargs.get("envs", {}),
"log_info": kwargs.get("log_info", {}),
"tls_info": kwargs.get("tls_info", {}),
"labels": kwargs.get("labels", {}),
"resource_config": kwargs.get("resource_config",{}),
"readiness": kwargs.get("readiness",{}),
"liveness": kwargs.get("liveness",{}),
"k8s_location": kwargs.get("k8s_location")}
returned_args = _create_and_start_container(service_component_name, image, **sub_kwargs)
kwargs[K8S_DEPLOYMENT] = returned_args[K8S_DEPLOYMENT]
return kwargs
def _verify_component(**kwargs):
"""Verify deployment is ready"""
service_component_name = kwargs[SERVICE_COMPONENT_NAME]
max_wait = kwargs.get("max_wait", DEFAULT_MAX_WAIT)
ctx.logger.info("Waiting up to {0} secs for {1} to become ready".format(max_wait, service_component_name))
if _verify_k8s_deployment(kwargs.get("k8s_location"), service_component_name, max_wait):
ctx.logger.info("k8s deployment is ready for: {0}".format(service_component_name))
else:
# The component did not become ready within the "max_wait" interval.
# Delete the k8s components created already and remove configuration from Consul.
ctx.logger.error("k8s deployment never became ready for {0}".format(service_component_name))
if (K8S_DEPLOYMENT in kwargs) and (len(kwargs[K8S_DEPLOYMENT]["deployment"]) > 0):
ctx.logger.info("attempting to delete k8s artifacts: {0}".format(kwargs[K8S_DEPLOYMENT]))
k8sclient.undeploy(kwargs[K8S_DEPLOYMENT])
ctx.logger.info("deleted k8s artifacts: {0}".format(kwargs[K8S_DEPLOYMENT]))
cleanup_discovery(**kwargs)
raise DockerPluginDeploymentError("k8s deployment never became ready for {0}".format(service_component_name))
return kwargs
def _done_for_start(**kwargs):
ctx.instance.runtime_properties.update(kwargs)
ctx.logger.info("Done starting: {0}".format(kwargs["name"]))
return kwargs
def _setup_msb_registration(service_name, msb_reg):
return {
"serviceName" : service_name,
"port" : msb_reg.get("port", "80"),
"version" : msb_reg.get("version", "v1"),
"url" : msb_reg.get("url_path", "/v1"),
"protocol" : "REST",
"enable_ssl" : msb_reg.get("uses_ssl", False),
"visualRange" : "1"
}
@wrap_error_handling_start
@merge_inputs_for_start
@monkeypatch_loggers
@operation
def create_and_start_container_for_components(**start_inputs):
"""Initiate Kubernetes deployment for service components
This operation method is to be used with the ContainerizedServiceComponent
node type. After initiating a Kubernetes deployment, the plugin will verify with Kubernetes
that the app is up and responding successfully to readiness probes.
"""
_done_for_start(
**_verify_component(
**_create_and_start_component(
**_parse_cloudify_context(**start_inputs))))
@wrap_error_handling_start
@monkeypatch_loggers
@operation
def create_and_start_container_for_platforms(**kwargs):
"""Initiate Kubernetes deployment for platform components
This operation method is to be used with the ContainerizedPlatformComponent
node type.
"""
# Capture node properties
image = ctx.node.properties["image"]
docker_config = ctx.node.properties.get("docker_config", {})
resource_config = ctx.node.properties.get("resource_config", {})
kwargs["resource_config"] = resource_config
if "healthcheck" in docker_config:
kwargs["readiness"] = docker_config["healthcheck"]
if "livehealthcheck" in docker_config:
kwargs["liveness"] = docker_config["livehealthcheck"]
if "dns_name" in ctx.node.properties:
service_component_name = ctx.node.properties["dns_name"]
else:
service_component_name = ctx.node.properties["name"]
# Set some labels for the Kubernetes pods
# The name segment is required and must be 63 characters or less
kwargs["labels"] = {
"cfydeployment" : ctx.deployment.id,
"cfynode": ctx.node.name[:63],
"cfynodeinstance": ctx.instance.id[:63]
}
host_port = ctx.node.properties["host_port"]
container_port = ctx.node.properties["container_port"]
# Cloudify properties are all required and Cloudify complains that None
# is not a valid type for integer. Defaulting to 0 to indicate to not
# use this and not to set a specific port mapping in cases like service
# change handler.
if container_port != 0:
# Doing this because other nodes might want to use this property
port_mapping = "{cp}:{hp}".format(cp=container_port, hp=host_port)
ports = kwargs.get("ports", []) + [ port_mapping ]
kwargs["ports"] = ports
if "ports" not in kwargs:
ctx.logger.warn("No port mappings defined. Will randomly assign port.")
# All of the new node properties could be handled more DRYly!
# If a registration to MSB is required, then set up the registration info
if "msb_registration" in ctx.node.properties and "port" in ctx.node.properties["msb_registration"]:
kwargs["msb_list"] = [_setup_msb_registration(service_component_name, ctx.node.properties["msb_registration"])]
# If centralized logging via ELK is desired, then set up the logging info
if "log_info" in ctx.node.properties and "log_directory" in ctx.node.properties["log_info"]:
kwargs["log_info"] = ctx.node.properties["log_info"]
# Pick up TLS info if present
if "tls_info" in ctx.node.properties:
kwargs["tls_info"] = ctx.node.properties["tls_info"]
# Pick up replica count and always_pull_image flag
if "replicas" in ctx.node.properties:
kwargs["replicas"] = ctx.node.properties["replicas"]
if "always_pull_image" in ctx.node.properties:
kwargs["always_pull_image"] = ctx.node.properties["always_pull_image"]
# Pick up location
kwargs["k8s_location"] = _get_location()
returned_args = _create_and_start_container(service_component_name, image, **kwargs)
# Verify that the k8s deployment is ready
# - Set service component name into kwargs
# - max_wait is already in kwargs if it was set
returned_args[SERVICE_COMPONENT_NAME] = service_component_name
_verify_component(**returned_args)
@wrap_error_handling_start
@monkeypatch_loggers
@operation
def create_and_start_container(**kwargs):
"""Initiate a Kubernetes deployment for the generic ContainerizedApplication node type"""
service_component_name = ctx.node.properties["name"]
ctx.instance.runtime_properties[SERVICE_COMPONENT_NAME] = service_component_name
image = ctx.node.properties["image"]
kwargs["k8s_location"] = _get_location()
_create_and_start_container(service_component_name, image,**kwargs)
@monkeypatch_loggers
@operation
def stop_and_remove_container(**kwargs):
"""Delete Kubernetes deployment"""
if K8S_DEPLOYMENT in ctx.instance.runtime_properties:
try:
deployment_description = ctx.instance.runtime_properties[K8S_DEPLOYMENT]
k8sclient.undeploy(deployment_description)
except Exception as e:
ctx.logger.error("Unexpected error while deleting k8s deployment: {0}"
.format(str(e)))
else:
# A previous install workflow may have failed,
# and no Kubernetes deployment info was recorded in runtime_properties.
# No need to run the undeploy operation
ctx.logger.info("No k8s deployment information, not attempting to delete k8s deployment")
@wrap_error_handling_update
@monkeypatch_loggers
@operation
def scale(replicas, **kwargs):
"""Change number of replicas in the deployment"""
service_component_name = ctx.instance.runtime_properties["service_component_name"]
if replicas > 0:
current_replicas = ctx.instance.runtime_properties["replicas"]
ctx.logger.info("Scaling {0} from {1} to {2} replica(s)".format(service_component_name, current_replicas, replicas))
deployment_description = ctx.instance.runtime_properties[K8S_DEPLOYMENT]
k8sclient.scale(deployment_description, replicas)
ctx.instance.runtime_properties["replicas"] = replicas
# Verify that the scaling took place as expected
max_wait = kwargs.get("max_wait", DEFAULT_MAX_WAIT)
ctx.logger.info("Waiting up to {0} secs for {1} to scale and become ready".format(max_wait, service_component_name))
if _verify_k8s_deployment(deployment_description["location"], service_component_name, max_wait):
ctx.logger.info("Scaling complete: {0} from {1} to {2} replica(s)".format(service_component_name, current_replicas, replicas))
else:
ctx.logger.info("Ignoring request to scale {0} to zero replicas".format(service_component_name))
@wrap_error_handling_update
@monkeypatch_loggers
@operation
def update_image(image, **kwargs):
""" Restart component with a new Docker image """
service_component_name = ctx.instance.runtime_properties["service_component_name"]
if image:
current_image = ctx.instance.runtime_properties["image"]
ctx.logger.info("Updating app image for {0} from {1} to {2}".format(service_component_name, current_image, image))
deployment_description = ctx.instance.runtime_properties[K8S_DEPLOYMENT]
k8sclient.upgrade(deployment_description, image)
ctx.instance.runtime_properties["image"] = image
# Verify that the update took place as expected
max_wait = kwargs.get("max_wait", DEFAULT_MAX_WAIT)
ctx.logger.info("Waiting up to {0} secs for {1} to be updated and become ready".format(max_wait, service_component_name))
if _verify_k8s_deployment(deployment_description["location"], service_component_name, max_wait):
ctx.logger.info("Update complete: {0} from {1} to {2}".format(service_component_name, current_image, image))
else:
ctx.logger.info("Ignoring update_image request for {0} with unusable image '{1}'".format(service_component_name, str(image)))
#TODO: implement rollback operation when kubernetes python client fix is available.
# (See comments in k8sclient.py.)
# In the meantime, it's possible to undo an update_image operation by doing a second
# update_image that specifies the older image.
@monkeypatch_loggers
@Policies.cleanup_policies_on_node
@operation
def cleanup_discovery(**kwargs):
"""Delete configuration from Consul"""
if SERVICE_COMPONENT_NAME in ctx.instance.runtime_properties:
service_component_name = ctx.instance.runtime_properties[SERVICE_COMPONENT_NAME]
try:
conn = dis.create_kv_conn(CONSUL_HOST)
dis.remove_service_component_config(conn, service_component_name)
except dis.DiscoveryConnectionError as e:
raise RecoverableError(e)
else:
# When another node in the blueprint fails install,
# this node may not have generated a service component name.
# There's nothing to delete from Consul.
ctx.logger.info ("No service_component_name, not attempting to delete config from Consul")
def _notify_container(**kwargs):
"""
Notify container using the policy section in the docker_config.
Notification consists of running a script in the application container
in each pod in the Kubernetes deployment associated with this node.
Return the list of notification results.
"""
dc = kwargs["docker_config"]
resp = []
if "policy" in dc and dc["policy"].get("trigger_type") == "docker":
# Build the command to execute in the container
# SCRIPT_PATH policies {"policies" : ...., "updated_policies" : ..., "removed_policies": ...}
script_path = dc["policy"]["script_path"]
policy_data = {
"policies": kwargs["policies"],
"updated_policies": kwargs["updated_policies"],
"removed_policies": kwargs["removed_policies"]
}
command = [script_path, "policies", json.dumps(policy_data)]
# Execute the command
deployment_description = ctx.instance.runtime_properties[K8S_DEPLOYMENT]
resp = k8sclient.execute_command_in_deployment(deployment_description, command)
# else the default is no trigger
return resp
@operation
@monkeypatch_loggers
@Policies.update_policies_on_node()
def policy_update(updated_policies, removed_policies=None, policies=None, **kwargs):
"""Policy update task
This method is responsible for updating the application configuration and
notifying the applications that the change has occurred. This is to be used
for the dcae.interfaces.policy.policy_update operation.
:updated_policies: contains the list of changed policy-configs when configs_only=True
(default) Use configs_only=False to bring the full policy objects in :updated_policies:.
"""
service_component_name = ctx.instance.runtime_properties[SERVICE_COMPONENT_NAME]
ctx.logger.info("policy_update for {0}-- updated_policies: {1}, removed_policies: {2}, policies: {3}"
.format(service_component_name, updated_policies, removed_policies, policies))
update_inputs = copy.deepcopy(ctx.instance.runtime_properties)
update_inputs["updated_policies"] = updated_policies
update_inputs["removed_policies"] = removed_policies
update_inputs["policies"] = policies
resp = _notify_container(**update_inputs)
ctx.logger.info("policy_update complete for {0}--notification results: {1}".format(service_component_name,json.dumps(resp)))
|