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
|
# ============LICENSE_START=======================================================
# org.onap.dcae
# ================================================================================
# Copyright (c) 2017-2018 AT&T Intellectual Property. 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.
# -*- coding: utf-8 -*-
"""
Provides utilities for Docker components
"""
import socket
from sys import platform
import docker
import six
import dockering as doc
from dcae_cli.util.logger import get_logger
from dcae_cli.util.exc import DcaeException
dlog = get_logger('Docker')
_reg_img = 'gliderlabs/registrator:latest'
# TODO: Source this from app's configuration [ONAP URL TBD]
_reg_cmd = '-ip {:} consul://make-me-valid:8500'
class DockerError(DcaeException):
pass
class DockerConstructionError(DcaeException):
pass
# Functions to provide envs to pass into Docker containers
def _convert_profile_to_docker_envs(profile):
"""Convert a profile object to Docker environment variables
Parameters
----------
profile: namedtuple
Returns
-------
dict of environemnt variables to be used by docker-py
"""
profile = profile._asdict()
return dict([(key.upper(), value) for key, value in six.iteritems(profile)])
def build_envs(profile, docker_config, instance_name):
profile_envs = _convert_profile_to_docker_envs(profile)
health_envs = doc.create_envs_healthcheck(docker_config)
return doc.create_envs(instance_name, profile_envs, health_envs)
# Methods to call Docker engine
# TODO: Consolidate these two docker client methods. Need ability to invoke local
# vs remote Docker engine
def get_docker_client(profile, logins=[]):
hostname, port = profile.docker_host.split(":")
try:
client = doc.create_client(hostname, port, logins=logins)
client.ping()
return client
except:
raise DockerError('Could not connect to the Docker daemon. Is it running?')
def image_exists(image):
'''Returns True if the image exists locally'''
client = docker.APIClient(version="auto", **docker.utils.kwargs_from_env())
return True if client.images(image) else False
def _infer_ip():
'''Infers the IP address of the host running this tool'''
if not platform.startswith('linux'):
raise DockerError('Non-linux environment detected. Use the --external-ip flag when running Docker components.')
ip = socket.gethostbyname(socket.gethostname())
dlog.info("Docker host external IP address inferred to be {:}. If this is incorrect, use the --external-ip flag.".format(ip))
return ip
def _run_container(client, config, name=None, wait=False):
'''Runs a container'''
if name is not None:
info = six.next(iter(client.containers(all=True, filters={'name': "^/{:}$".format(name)})), None)
if info is not None:
if info['State'] == 'running':
dlog.info("Container '{:}' was detected as already running.".format(name))
return info
else:
client.remove_container(info['Id'])
cont = doc.create_container_using_config(client, name, config)
client.start(cont)
info = client.inspect_container(cont)
name = info['Name'][1:] # remove '/' prefix
image = config['Image']
dlog.info("Running image '{:}' as '{:}'".format(image, name))
if not wait:
return info
cont_log = dlog.getChild(name)
try:
for msg in client.logs(cont, stream=True):
cont_log.info(msg.decode())
else:
dlog.info("Container '{:}' exitted suddenly.".format(name))
except (KeyboardInterrupt, SystemExit):
dlog.info("Stopping container '{:}' and cleaning up...".format(name))
client.kill(cont)
client.remove_container(cont)
def _run_registrator(client, external_ip=None):
'''Ensures that Registrator is running'''
ip = _infer_ip() if external_ip is None else external_ip
cmd = _reg_cmd.format(ip).split()
binds={'/var/run/docker.sock': {'bind': '/tmp/docker.sock'}}
hconf = client.create_host_config(binds=binds, network_mode='host')
conf = client.create_container_config(image=_reg_img, command=cmd, host_config=hconf)
_run_container(client, conf, name='registrator', wait=False)
# TODO: Need to revisit and reimplement _run_registrator(client, external_ip)
#
# High level calls
#
def deploy_component(profile, image, instance_name, docker_config, should_wait=False,
logins=[]):
"""Deploy Docker component
This calls runs a Docker container detached. The assumption is that the Docker
host already has registrator running.
TODO: Split out the wait functionality
Args
----
logins (list): List of objects where the objects are each a docker login of
the form:
{"registry": .., "username":.., "password":.. }
Returns
-------
Dict that is the result from a Docker inspect call
"""
ports = docker_config.get("ports", None)
hcp = doc.add_host_config_params_ports(ports=ports)
volumes = docker_config.get("volumes", None)
hcp = doc.add_host_config_params_volumes(volumes=volumes, host_config_params=hcp)
# Thankfully passing in an IP will return back an IP
dh = profile.docker_host.split(":")[0]
_, _, dhips = socket.gethostbyname_ex(dh)
if dhips:
hcp = doc.add_host_config_params_dns(dhips[0], hcp)
else:
raise DockerConstructionError("Could not resolve the docker hostname:{0}".format(dh))
envs = build_envs(profile, docker_config, instance_name)
client = get_docker_client(profile, logins=logins)
config = doc.create_container_config(client, image, envs, hcp)
return _run_container(client, config, name=instance_name, wait=should_wait)
def undeploy_component(client, image, instance_name):
"""Undeploy Docker component
TODO: Handle error scenarios. Look into:
* no container found error - docker.errors.NotFound
* failure to remove image - docker.errors.APIError: 409 Client Error
* retry, check for still running container
Returns
-------
True if the container and associated image has been removed False otherwise
"""
try:
client.remove_container(instance_name, force=True)
client.remove_image(image)
return True
except Exception as e:
dlog.error("Error while undeploying Docker container/image: {0}".format(e))
return False
def reconfigure(client, instance_name, command):
""" Execute the Reconfig script in the Docker container """
# 'command' has 3 parts in a list (1 Command and 2 ARGs)
exec_Id = client.exec_create(container=instance_name, cmd=command)
exec_start_resp = client.exec_start(exec_Id, stream=True)
# Using a 'single' generator response to solve issue of 'start_exec' returning control after 6 minutes
for response in exec_start_resp:
dlog.info("Reconfig Script execution response: {:}".format(response))
exec_start_resp.close()
break
|
