This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6318

automation: move image operations to own functions
ClosedPublic

Authored by indygreg on Apr 27 2019, 2:51 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG195dcc10b3d7: automation: move image operations to own functions
Summary

An upcoming commit will need this functionality with slightly different
values and it is enough code to not want to duplicate. Let's refactor
into standalone functions so it can be reused.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Apr 27 2019, 2:51 PM
Closed by commit rHG195dcc10b3d7: automation: move image operations to own functions (authored by indygreg). · Explain WhyMay 15 2019, 11:46 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 15096

contrib/automation/hgautomation/aws.py

print('removing role %s from %s' % (role, profile.name)) print('removing role %s from %s' % (role, profile.name))
profile.remove_role(RoleName=role) profile.remove_role(RoleName=role)
for role in sorted(wanted - have): for role in sorted(wanted - have):
print('adding role %s to %s' % (role, profile.name)) print('adding role %s to %s' % (role, profile.name))
profile.add_role(RoleName=role) profile.add_role(RoleName=role)
def find_windows_server_2019_image(ec2resource): def find_image(ec2resource, owner_id, name):
"""Find the Amazon published Windows Server 2019 base image.""" """Find an AMI by its owner ID and name."""
images = ec2resource.images.filter( images = ec2resource.images.filter(
Filters=[ Filters=[
{ {
'Name': 'owner-alias', 'Name': 'owner-id',
'Values': ['amazon'], 'Values': [owner_id],
}, },
{ {
'Name': 'state', 'Name': 'state',
'Values': ['available'], 'Values': ['available'],
}, },
{ {
'Name': 'image-type', 'Name': 'image-type',
'Values': ['machine'], 'Values': ['machine'],
}, },
{ {
'Name': 'name', 'Name': 'name',
'Values': ['Windows_Server-2019-English-Full-Base-2019.02.13'], 'Values': [name],
}, },
]) ])
for image in images: for image in images:
return image return image
raise Exception('unable to find Windows Server 2019 image') raise Exception('unable to find image for %s' % name)
def ensure_security_groups(ec2resource, prefix='hg-'): def ensure_security_groups(ec2resource, prefix='hg-'):
"""Ensure all necessary Mercurial security groups are present. """Ensure all necessary Mercurial security groups are present.
All security groups are prefixed with ``hg-`` by default. Any security All security groups are prefixed with ``hg-`` by default. Any security
groups having this prefix but aren't in our list are deleted. groups having this prefix but aren't in our list are deleted.
""" """
for instance in instances: for instance in instances:
client = wait_for_winrm(instance.public_ip_address, 'Administrator', password) client = wait_for_winrm(instance.public_ip_address, 'Administrator', password)
print('established WinRM connection to %s' % instance.id) print('established WinRM connection to %s' % instance.id)
instance.winrm_client = client instance.winrm_client = client
yield instances yield instances
def resolve_fingerprint(fingerprint):
fingerprint = json.dumps(fingerprint, sort_keys=True)
return hashlib.sha256(fingerprint.encode('utf-8')).hexdigest()
def find_and_reconcile_image(ec2resource, name, fingerprint):
"""Attempt to find an existing EC2 AMI with a name and fingerprint.
If an image with the specified fingerprint is found, it is returned.
Otherwise None is returned.
Existing images for the specified name that don't have the specified
fingerprint or are missing required metadata or deleted.
"""
# Find existing AMIs with this name and delete the ones that are invalid.
# Store a reference to a good image so it can be returned one the
# image state is reconciled.
images = ec2resource.images.filter(
Filters=[{'Name': 'name', 'Values': [name]}])
existing_image = None
for image in images:
if image.tags is None:
print('image %s for %s lacks required tags; removing' % (
image.id, image.name))
remove_ami(ec2resource, image)
else:
tags = {t['Key']: t['Value'] for t in image.tags}
if tags.get('HGIMAGEFINGERPRINT') == fingerprint:
existing_image = image
else:
print('image %s for %s has wrong fingerprint; removing' % (
image.id, image.name))
remove_ami(ec2resource, image)
return existing_image
def create_ami_from_instance(ec2client, instance, name, description,
fingerprint):
"""Create an AMI from a running instance.
Returns the ``ec2resource.Image`` representing the created AMI.
"""
instance.stop()
ec2client.get_waiter('instance_stopped').wait(
InstanceIds=[instance.id],
WaiterConfig={
'Delay': 5,
})
print('%s is stopped' % instance.id)
image = instance.create_image(
Name=name,
Description=description,
)
image.create_tags(Tags=[
{
'Key': 'HGIMAGEFINGERPRINT',
'Value': fingerprint,
},
])
print('waiting for image %s' % image.id)
ec2client.get_waiter('image_available').wait(
ImageIds=[image.id],
)
print('image %s available as %s' % (image.id, image.name))
return image
def ensure_windows_dev_ami(c: AWSConnection, prefix='hg-'): def ensure_windows_dev_ami(c: AWSConnection, prefix='hg-'):
"""Ensure Windows Development AMI is available and up-to-date. """Ensure Windows Development AMI is available and up-to-date.
If necessary, a modern AMI will be built by starting a temporary EC2 If necessary, a modern AMI will be built by starting a temporary EC2
instance and bootstrapping it. instance and bootstrapping it.
Obsolete AMIs will be deleted so there is only a single AMI having the Obsolete AMIs will be deleted so there is only a single AMI having the
desired name. desired name.
Returns an ``ec2.Image`` of either an existing AMI or a newly-built Returns an ``ec2.Image`` of either an existing AMI or a newly-built
one. one.
""" """
ec2client = c.ec2client ec2client = c.ec2client
ec2resource = c.ec2resource ec2resource = c.ec2resource
ssmclient = c.session.client('ssm') ssmclient = c.session.client('ssm')
name = '%s%s' % (prefix, 'windows-dev') name = '%s%s' % (prefix, 'windows-dev')
image = find_image(ec2resource,
'801119661308',
'Windows_Server-2019-English-Full-Base-2019.02.13')
config = { config = {
'BlockDeviceMappings': [ 'BlockDeviceMappings': [
{ {
'DeviceName': '/dev/sda1', 'DeviceName': '/dev/sda1',
'Ebs': { 'Ebs': {
'DeleteOnTermination': True, 'DeleteOnTermination': True,
'VolumeSize': 32, 'VolumeSize': 32,
'VolumeType': 'gp2', 'VolumeType': 'gp2',
}, },
} }
], ],
'ImageId': find_windows_server_2019_image(ec2resource).id, 'ImageId': image.id,
'InstanceInitiatedShutdownBehavior': 'stop', 'InstanceInitiatedShutdownBehavior': 'stop',
'InstanceType': 't3.medium', 'InstanceType': 't3.medium',
'KeyName': '%sautomation' % prefix, 'KeyName': '%sautomation' % prefix,
'MaxCount': 1, 'MaxCount': 1,
'MinCount': 1, 'MinCount': 1,
'SecurityGroupIds': [c.security_groups['windows-dev-1'].id], 'SecurityGroupIds': [c.security_groups['windows-dev-1'].id],
} }
# Disable Windows Defender when bootstrapping because it just slows # Disable Windows Defender when bootstrapping because it just slows
# things down. # things down.
commands.insert(0, 'Set-MpPreference -DisableRealtimeMonitoring $true') commands.insert(0, 'Set-MpPreference -DisableRealtimeMonitoring $true')
commands.append('Set-MpPreference -DisableRealtimeMonitoring $false') commands.append('Set-MpPreference -DisableRealtimeMonitoring $false')
# Compute a deterministic fingerprint to determine whether image needs # Compute a deterministic fingerprint to determine whether image needs
# to be regenerated. # to be regenerated.
fingerprint = { fingerprint = resolve_fingerprint({
'instance_config': config, 'instance_config': config,
'user_data': WINDOWS_USER_DATA, 'user_data': WINDOWS_USER_DATA,
'initial_bootstrap': WINDOWS_BOOTSTRAP_POWERSHELL, 'initial_bootstrap': WINDOWS_BOOTSTRAP_POWERSHELL,
'bootstrap_commands': commands, 'bootstrap_commands': commands,
} })
fingerprint = json.dumps(fingerprint, sort_keys=True)
fingerprint = hashlib.sha256(fingerprint.encode('utf-8')).hexdigest()
# Find existing AMIs with this name and delete the ones that are invalid.
# Store a reference to a good image so it can be returned one the
# image state is reconciled.
images = ec2resource.images.filter(
Filters=[{'Name': 'name', 'Values': [name]}])
existing_image = None
for image in images: existing_image = find_and_reconcile_image(ec2resource, name, fingerprint)
if image.tags is None:
print('image %s for %s lacks required tags; removing' % (
image.id, image.name))
remove_ami(ec2resource, image)
else:
tags = {t['Key']: t['Value'] for t in image.tags}
if tags.get('HGIMAGEFINGERPRINT') == fingerprint:
existing_image = image
else:
print('image %s for %s has wrong fingerprint; removing' % (
image.id, image.name))
remove_ami(ec2resource, image)
if existing_image: if existing_image:
return existing_image return existing_image
print('no suitable Windows development image found; creating one...') print('no suitable Windows development image found; creating one...')
with create_temp_windows_ec2_instances(c, config) as instances: with create_temp_windows_ec2_instances(c, config) as instances:
assert len(instances) == 1 assert len(instances) == 1
c.automation.default_password()) c.automation.default_password())
print('established WinRM connection to %s' % instance.id) print('established WinRM connection to %s' % instance.id)
instance.winrm_client = client instance.winrm_client = client
print('bootstrapping instance...') print('bootstrapping instance...')
run_powershell(instance.winrm_client, '\n'.join(commands)) run_powershell(instance.winrm_client, '\n'.join(commands))
print('bootstrap completed; stopping %s to create image' % instance.id) print('bootstrap completed; stopping %s to create image' % instance.id)
instance.stop() return create_ami_from_instance(ec2client, instance, name,
'Mercurial Windows development environment',
ec2client.get_waiter('instance_stopped').wait( fingerprint)
InstanceIds=[instance.id],
WaiterConfig={
'Delay': 5,
})
print('%s is stopped' % instance.id)
image = instance.create_image(
Name=name,
Description='Mercurial Windows development environment',
)
image.create_tags(Tags=[
{
'Key': 'HGIMAGEFINGERPRINT',
'Value': fingerprint,
},
])
print('waiting for image %s' % image.id)
ec2client.get_waiter('image_available').wait(
ImageIds=[image.id],
)
print('image %s available as %s' % (image.id, image.name))
return image
@contextlib.contextmanager @contextlib.contextmanager
def temporary_windows_dev_instances(c: AWSConnection, image, instance_type, def temporary_windows_dev_instances(c: AWSConnection, image, instance_type,
prefix='hg-', disable_antivirus=False): prefix='hg-', disable_antivirus=False):
"""Create a temporary Windows development EC2 instance. """Create a temporary Windows development EC2 instance.
Context manager resolves to the list of ``EC2.Instance`` that were created. Context manager resolves to the list of ``EC2.Instance`` that were created.