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
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# pylint: disable=missing-docstring,invalid-name
import random
import tempfile
import shutil
import os.path
# pylint: disable=redefined-builtin,wildcard-import,unused-wildcard-import
from ansible.module_utils.basic import * # noqa: F403
DOCUMENTATION = '''
---
module: openshift_container_binary_sync
short_description: Copies OpenShift binaries out of the given image tag to host system.
'''
class BinarySyncError(Exception):
def __init__(self, msg):
super(BinarySyncError, self).__init__(msg)
self.msg = msg
# pylint: disable=too-few-public-methods,too-many-instance-attributes
class BinarySyncer(object):
"""
Syncs the openshift, oc, and kubectl binaries/symlinks out of
a container onto the host system.
"""
def __init__(self, module, image, tag, backend):
self.module = module
self.changed = False
self.output = []
self.bin_dir = '/usr/local/bin'
self._image = image
self.tag = tag
self.backend = backend
self.temp_dir = None # TBD
def sync(self):
if self.backend == 'atomic':
return self._sync_atomic()
return self._sync_docker()
def _sync_atomic(self):
self.temp_dir = tempfile.mkdtemp()
temp_dir_mount = tempfile.mkdtemp()
try:
image_spec = '%s:%s' % (self.image, self.tag)
rc, stdout, stderr = self.module.run_command(['atomic', 'mount',
'--storage', "ostree",
image_spec, temp_dir_mount])
if rc:
raise BinarySyncError("Error mounting image. stdout=%s, stderr=%s" %
(stdout, stderr))
for i in ["openshift", "oc"]:
src_file = os.path.join(temp_dir_mount, "usr/bin", i)
shutil.copy(src_file, self.temp_dir)
self._sync_binaries()
finally:
self.module.run_command(['atomic', 'umount', temp_dir_mount])
shutil.rmtree(temp_dir_mount)
shutil.rmtree(self.temp_dir)
def _sync_docker(self):
container_name = "openshift-cli-%s" % random.randint(1, 100000)
rc, stdout, stderr = self.module.run_command(['docker', 'create', '--name',
container_name, '%s:%s' % (self.image, self.tag)])
if rc:
raise BinarySyncError("Error creating temporary docker container. stdout=%s, stderr=%s" %
(stdout, stderr))
self.output.append(stdout)
try:
self.temp_dir = tempfile.mkdtemp()
self.output.append("Using temp dir: %s" % self.temp_dir)
rc, stdout, stderr = self.module.run_command(['docker', 'cp', "%s:/usr/bin/openshift" % container_name,
self.temp_dir])
if rc:
raise BinarySyncError("Error copying file from docker container: stdout=%s, stderr=%s" %
(stdout, stderr))
rc, stdout, stderr = self.module.run_command(['docker', 'cp', "%s:/usr/bin/oc" % container_name,
self.temp_dir])
if rc:
raise BinarySyncError("Error copying file from docker container: stdout=%s, stderr=%s" %
(stdout, stderr))
self._sync_binaries()
finally:
shutil.rmtree(self.temp_dir)
self.module.run_command(['docker', 'rm', container_name])
def _sync_binaries(self):
self._sync_binary('openshift')
# In older versions, oc was a symlink to openshift:
if os.path.islink(os.path.join(self.temp_dir, 'oc')):
self._sync_symlink('oc', 'openshift')
else:
self._sync_binary('oc')
# Ensure correct symlinks created:
self._sync_symlink('kubectl', 'openshift')
# Remove old oadm binary
if os.path.exists(os.path.join(self.bin_dir, 'oadm')):
os.remove(os.path.join(self.bin_dir, 'oadm'))
def _sync_symlink(self, binary_name, link_to):
""" Ensure the given binary name exists and links to the expected binary. """
# The symlink we are creating:
link_path = os.path.join(self.bin_dir, binary_name)
# The expected file we should be linking to:
link_dest = os.path.join(self.bin_dir, link_to)
if not os.path.exists(link_path) or \
not os.path.islink(link_path) or \
os.path.realpath(link_path) != os.path.realpath(link_dest):
if os.path.exists(link_path):
os.remove(link_path)
os.symlink(link_to, os.path.join(self.bin_dir, binary_name))
self.output.append("Symlinked %s to %s." % (link_path, link_dest))
self.changed = True
def _sync_binary(self, binary_name):
src_path = os.path.join(self.temp_dir, binary_name)
dest_path = os.path.join(self.bin_dir, binary_name)
incoming_checksum = self.module.run_command(['sha256sum', src_path])[1]
if not os.path.exists(dest_path) or self.module.run_command(['sha256sum', dest_path])[1] != incoming_checksum:
# See: https://github.com/openshift/openshift-ansible/issues/4965
if os.path.islink(dest_path):
os.unlink(dest_path)
self.output.append('Removed old symlink {} before copying binary.'.format(dest_path))
shutil.move(src_path, dest_path)
self.output.append("Moved %s to %s." % (src_path, dest_path))
self.changed = True
@property
def raw_image(self):
"""
Returns the image as it was originally passed in to the instance.
.. note::
This image string will only work directly with the atomic command.
:returns: The original image passed in.
:rtype: str
"""
return self._image
@property
def image(self):
"""
Returns the image without atomic prefixes used to map to skopeo args.
:returns: The image string without prefixes
:rtype: str
"""
image = self._image
for remove in ('oci:', 'http:', 'https:'):
if image.startswith(remove):
image = image.replace(remove, '')
return image
def main():
module = AnsibleModule( # noqa: F405
argument_spec=dict(
image=dict(required=True),
tag=dict(required=True),
backend=dict(required=True),
),
supports_check_mode=True
)
image = module.params['image']
tag = module.params['tag']
backend = module.params['backend']
if backend not in ["docker", "atomic"]:
module.fail_json(msg="unknown backend")
binary_syncer = BinarySyncer(module, image, tag, backend)
try:
binary_syncer.sync()
except BinarySyncError as ex:
module.fail_json(msg=ex.msg)
return module.exit_json(changed=binary_syncer.changed,
output=binary_syncer.output)
if __name__ == '__main__':
main()
|
