-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathec2publishimg
executable file
·339 lines (302 loc) · 11 KB
/
ec2publishimg
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
#!/usr/bin/python3
# Copyright 2022 SUSE LLC
#
# This file is part of ec2imgutils
#
# ec2imgutils is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ec2imgutils is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ec2publishimg. If not, see <http://www.gnu.org/licenses/>.
import argparse
import os
import sys
import ec2imgutils.ec2utils as utils
import ec2imgutils.ec2publishimg as ec2pubimg
from ec2imgutils.ec2imgutilsExceptions import (
EC2AccountException,
EC2PublishImgException
)
# ----------------------------------------------------------------------------
def parse_args(args):
"""Commang argument parsing function."""
parser = argparse.ArgumentParser(
description='Publish (share) images in EC2'
)
parser.add_argument(
'-a', '--account',
dest='accountName',
help='Account to use',
metavar='ACCOUNT_NAME',
)
parser.add_argument(
'--access-id',
dest='accessKey',
help='AWS access key (Optional)',
metavar='AWS_ACCESS_KEY'
)
help_msg = 'Allow the image to be copied. image, none, or a comma '
help_msg += 'separated list of AWS account numbers, default "none". '
help_msg += '(Optional)'
parser.add_argument(
'--allow-copy',
default='none',
dest='allowCopy',
help=help_msg
)
help_msg = 'Do not perform any action, print information about actions '
help_msg += 'that would be performed instead, default "False" (Optional)'
parser.add_argument(
'-n', '--dry-run',
action='store_true',
default=False,
dest='dryRun',
help=help_msg
)
parser.add_argument(
'-f', '--file',
default=os.sep.join(['~', '.ec2utils.conf']),
dest='configFilePath',
help='Path to configuration file, default ~/.ec2utils.conf (Optional)',
metavar='CONFIG_FILE'
)
# Note, one of the arguments in the group is required if --version is
# not specified. However setting this behavior through the parser
# also requires one argument to be specified even if --version is specified
# This parser behavior is true even if --version and the group are part
# of the same subgroup
publish_image_condition_group = parser.add_mutually_exclusive_group()
publish_image_condition_group.add_argument(
'--image-id',
dest='pubImgID',
help='The AMI ID of the image to be published (Optional)',
metavar='AMI_ID'
)
publish_image_condition_group.add_argument(
'--image-name',
dest='pubImgName',
help='The image name of the image to be published (Optional)',
metavar='IMAGE_NAME'
)
help_msg = 'An image name fragment to match the image name of the image '
help_msg += 'to be published (Optional)'
publish_image_condition_group.add_argument(
'--image-name-frag',
dest='pubImgNameFrag',
help=help_msg,
metavar='IMAGE_NAME_FRAGMENT'
)
help_msg = 'A regular expression to match the image name of the image '
help_msg += 'to be published (Optional)'
publish_image_condition_group.add_argument(
'--image-name-match',
dest='pubImgNameMatch',
help=help_msg,
metavar='REGEX'
)
help_msg = 'Comma separated list of regions for publishing, all '
help_msg += 'integrated regions if not given (Optional)'
parser.add_argument(
'-r', '--regions',
dest='regions',
help=help_msg,
metavar='EC2_REGIONS'
)
parser.add_argument(
'-s', '--secret-key',
dest='secretKey',
help='AWS secret access key (Optional)',
metavar='AWS_SECRET_KEY'
)
help_msg = 'all, none, or a comma separated list of AWS account numbers '
help_msg += 'to share the image(s) with, default "all"'
parser.add_argument(
'--share-with',
default='all',
dest='share',
help=help_msg,
metavar='SHARE'
)
parser.add_argument(
'--verbose',
action='store_true',
default=False,
dest='verbose',
help='Enable verbose output, default "False"'
)
parser.add_argument(
'--version',
action='version',
version=utils.get_version(),
help='Program version'
)
parsed_args = parser.parse_args(args)
return parsed_args
# ----------------------------------------------------------------------------
def check_required_arguments(args, logger):
"""This function is used to assure the additional requirements over
arguments (which ones are mandatory, etc.) are met."""
check_publish_image_args_present(args, logger)
check_allow_copy_arg(args, logger)
check_shared_arg(args, logger)
# ----------------------------------------------------------------------------
def check_publish_image_args_present(args, logger):
"""This function checks that at least one of the possible args to specify
the image to publish is present"""
if (
not args.pubImgID and not
args.pubImgName and not
args.pubImgNameFrag and not
args.pubImgNameMatch
):
error_msg = 'ec2publishimg: error: one of the arguments '
error_msg += '--image-id --image-name --image-name-frag '
error_msg += '--image-name-match is required'
logger.error(error_msg)
sys.exit(1)
# ----------------------------------------------------------------------------
def check_allow_copy_arg(args, logger):
"""This function checks that the --allow-copy argument has a valid value"""
snap_copy = args.allowCopy.lower()
if (
snap_copy != 'image' and
snap_copy != 'none' and not
utils.validate_account_numbers(snap_copy)
):
msg = 'Expecting "image", "none", or comma separated list of 12 digit '
msg += 'AWS account numbers as value of --allow-copy'
logger.error(msg)
sys.exit(1)
# ----------------------------------------------------------------------------
def check_shared_arg(args, logger):
"""This function checks that the --share argument has a valid value"""
visibility = args.share.lower()
if (
visibility != 'all' and
visibility != 'none' and not
utils.validate_account_numbers(visibility)
):
msg = 'Expecting "all", "none", or comma separated list of 12 digit '
msg += 'AWS account numbers as value of --share'
logger.error(msg)
sys.exit(1)
# ----------------------------------------------------------------------------
def get_config(args, logger):
"""Function to the the configutation parsed from the configuration file
provided as an argument (or the default path)"""
config_file = os.path.expanduser(args.configFilePath)
config = None
if not os.path.isfile(config_file):
logger.error('Configuration file "%s" not found.' % config_file)
sys.exit(1)
try:
config = utils.get_config(config_file)
except Exception as e:
logger.error(e)
sys.exit(1)
return config
# ----------------------------------------------------------------------------
def get_access_key(args, config, logger):
"""Function to get the access_key to AWS with the data provided as command
line args and configuration.
"""
access_key = args.accessKey
if not access_key:
try:
access_key = utils.get_from_config(
args.accountName,
config,
None,
'access_key_id',
'--access-id'
)
except EC2AccountException as e:
logger.error(e)
sys.exit(1)
if not access_key:
logger.error('Could not determine account access key')
sys.exit(1)
return access_key
# ----------------------------------------------------------------------------
def get_secret_key(args, config, logger):
"""Function to get the secret_key to AWS with the data provided as command
line args and configuration.
"""
secret_key = args.secretKey
if not secret_key:
try:
secret_key = utils.get_from_config(
args.accountName,
config,
None,
'secret_access_key',
'--secret-key'
)
except EC2AccountException as e:
logger.error(e)
sys.exit(1)
if not secret_key:
logger.error('Could not determine account secret access key')
sys.exit(1)
return secret_key
# ----------------------------------------------------------------------------
def get_publisher(args, access_key, secret_key, logger):
"""Function to get an instance of the ec2imgutils.EC2PublishImage class"""
try:
snap_copy = args.allowCopy.lower()
visibility = args.share.lower()
if visibility[-1] == ',':
visibility = visibility[:-1]
publisher = ec2pubimg.EC2PublishImage(
access_key=access_key,
allow_copy=snap_copy,
image_id=args.pubImgID,
image_name=args.pubImgName,
image_name_fragment=args.pubImgNameFrag,
image_name_match=args.pubImgNameMatch,
secret_key=secret_key,
visibility=visibility,
log_callback=logger
)
except EC2PublishImgException as e:
logger.error(e)
sys.exit(1)
return publisher
# ----------------------------------------------------------------------------
def publish_images_in_region(publisher, dryRun, region, logger):
"""Function to publish images in region"""
try:
publisher.set_region(region)
if dryRun:
logger.info('Dry run, image attributes will not be modified')
publisher.print_publish_info()
else:
publisher.publish_images()
except EC2PublishImgException as e:
logger.exception(e)
sys.exit(1)
except Exception as e:
logger.exception(e)
sys.exit(1)
# ----------------------------------------------------------------------------
def main(args):
args = parse_args(args)
logger = utils.get_logger(args.verbose)
check_required_arguments(args, logger)
config = get_config(args, logger)
access_key = get_access_key(args, config, logger)
secret_key = get_secret_key(args, config, logger)
regions = utils.get_regions(args, access_key, secret_key)
publisher = get_publisher(args, access_key, secret_key, logger)
for region in regions:
publish_images_in_region(publisher, args.dryRun, region, logger)
# ----------------------------------------------------------------------------
if __name__ == '__main__':
main(sys.argv[1:])