🎉 ECR Cleanup Feature (#48)

* 🎉 Added ecr_cleanup

* 🎉 Added cleanup ECR operation

* 📝 Updated README

---------

Co-authored-by: Alex Lubneuski <[email protected]>

README.md

@@ -195,6 +195,21 @@ In this example, "igor" will generate files based on the "simple-tf" template. I
 In our case it will look up a bucket for terraform state files. 
 You can add more templates here:
 
+ecr_cleanup
+--------
+
+Igor will cleanup non-active images from specified repositories. It will check ECS Task Definitions and PRD Clusters. 
+
+***Usage***
+
+~~~
+igor ecr_cleanup --repos test_ecr, test1_ecr
+~~~
+
+In this example, "igor" will generate files based on the "simple-tf" template. It will replace placeholders for account, environment, project, region with values supplied values. Additionally, igor will replace values in templates that found in accounts_info.json file. 
+In our case it will look up a bucket for terraform state files. 
+You can add more templates here:
+
 ~~~
 d3b_cli_igor/utils/templates
 ~~~

d3b_cli_igor/app_ops/ecr_actions.py

@@ -0,0 +1,181 @@
+import d3b_cli_igor.common
+import boto3, numpy, sys, time, json
+
+logger = d3b_cli_igor.common.get_logger(
+    __name__, testing_mode=False, log_format="detailed"
+)
+
+#TODO:
+# Figure out how to find the latest image
+# Currently it will delete all images that are not used in task / task definition . Which is the problem for ETL etc. 
+
+#Set app cluster name
+ecs_client = d3b_cli_igor.common.setup("ecs")
+ecr_client = d3b_cli_igor.common.setup("ecr")
+
+def query_yes_no(question, default="yes"):
+    """Ask a yes/no question via raw_input() and return their answer.
+
+    "question" is a string that is presented to the user.
+    "default" is the presumed answer if the user just hits <Enter>.
+            It must be "yes" (the default), "no" or None (meaning
+            an answer is required of the user).
+
+    The "answer" return value is True for "yes" or False for "no".
+    """
+    valid = {"yes": True, "y": True, "ye": True, "no": False, "n": False}
+    if default is None:
+        prompt = " [y/n] "
+    elif default == "yes":
+        prompt = " [Y/n] "
+    elif default == "no":
+        prompt = " [y/N] "
+    else:
+        raise ValueError("invalid default answer: '%s'" % default)
+
+    while True:
+        sys.stdout.write(question + prompt)
+        choice = input().lower()
+        if default is not None and choice == "":
+            return valid[default]
+        elif choice in valid:
+            return valid[choice]
+        else:
+            sys.stdout.write("Please respond with 'yes' or 'no' " "(or 'y' or 'n').\n")
+
+def get_repo_objects(repos):
+    repositories = []
+    for r in ecr_client.describe_repositories()['repositories']:
+        if r['repositoryName'] in repos:
+            repositories.append(r)
+    return repositories
+
+def list_ecr_images(repos):
+    logger.info("Getting images from ECR repos")
+    print(repos)
+    if (len(repos) > 0):
+        #Replace repo names with objects
+        repos = get_repo_objects(repos)
+    else:
+        repos = ecr_client.describe_repositories()['respositories']
+    container_images = []
+    for r in repos:
+        images = ecr_client.list_images(
+            repositoryName = r['repositoryName']
+        )
+        logger.info("Repo: " + r['repositoryName'])
+        for i in images['imageIds']:
+            if 'imageTag' in i:
+                image_name = r['repositoryUri'] + ":" + i['imageTag']
+                container_images.append({"image": image_name, "digest": i["imageDigest"], "repoName": r['repositoryName'], "tag": i["imageTag"]})
+    return container_images
+
+def list_running_task_images(app_cluster):
+    logger.info("Getting images from RUNNING tasks, from " + app_cluster + "cluster")
+    ecs_tasks = []
+    images = []
+    services = ecs_client.list_services(
+        cluster=(app_cluster),
+        maxResults=100,
+        launchType="FARGATE"
+    )
+    for i in services["serviceArns"]:
+        task = ecs_client.list_tasks(
+            cluster=(app_cluster),
+            maxResults=100,
+            serviceName=i,
+            desiredStatus='RUNNING',
+            launchType='FARGATE'
+        )
+        ecs_tasks = ecs_tasks + task['taskArns']
+    #Check for empty running tasks
+    if len(ecs_tasks) > 0: 
+        tasks_details = ecs_client.describe_tasks( cluster=app_cluster, tasks=ecs_tasks)
+        for t in tasks_details['tasks']:
+            for c in t['containers']:
+                images.append({"image": c['image'], "digest": c['imageDigest']})
+    return images
+
+def list_active_task_definitions(repos):
+    logger.info("Getting images from Task Definitions")
+    ecs_tasks = []
+    images = []
+    tds = ecs_client.list_task_definitions(
+        status='ACTIVE'
+    )
+    for i in tds["taskDefinitionArns"]:
+        td = ecs_client.describe_task_definition(taskDefinition=i)
+        for c in td['taskDefinition']['containerDefinitions']:
+            images.append({"image": c['image'], "digest": ""})
+    #Since task definiteions do not have image digest, we need to look it up
+    for i in list_ecr_images(repos):
+        for idx,ti in enumerate(images):
+            if ( ti['image'] in i['image']):
+                images[idx]['digest'] = i['digest']
+
+    return images
+
+def list_clusters():
+    clusters = []
+    for c in ecs_client.list_clusters()['clusterArns']:
+        clusters.append(c.split('/')[1])
+    return clusters
+
+def get_list_of_old_images(active_images, ecr_images):
+    images_to_remove = []
+    digests_to_keep = []
+    items_to_remove = []
+    for i in ecr_images:
+        found = False
+        for ai in active_images:
+            if( i["digest"] == ai['digest']):
+                found = True
+        if (found == False):
+            items_to_remove.append(i)
+        else:
+            found = False
+
+    logger.info("Items to remove before: " + str(len(items_to_remove)))
+
+    #Since each image can have multiple tags, we need to go through images and find which ones have different tag but does not need to be removed
+    for d in digests_to_keep:
+        for idx,i in enumerate(items_to_remove):
+            if( d["digest"] == i["digest"]):
+                items_to_remove.pop(idx)
+
+    logger.info("Images to remove : "+ str(len(items_to_remove)))
+
+    return items_to_remove
+
+def remove_images(imageIds):
+    if (query_yes_no("Would you like to remove the following images? \n " + str(imageIds), default="no")):
+        for i in  imageIds:
+            ecr_client.batch_delete_image(
+                repositoryName = i['repoName'],
+                imageIds=[
+                    {
+                        'imageDigest': i['digest'],
+                        'imageTag': i['tag']
+                    }
+                ]
+            )
+
+def ecr_cleanup(repos):
+    ecs_images = []
+    ecr_images = list_ecr_images(repos)
+    task_def_images = []
+
+    for c in list_clusters():
+        ecs_images = ecs_images + list_running_task_images(c)
+
+    task_def_images = list_active_task_definitions(repos)
+    print(len(task_def_images))
+
+    logger.info("Number of ECR images in all ECR repos: " + str(len(ecr_images)))
+    logger.info("Number of images in task definitions: "+str(len(task_def_images)))
+    logger.info("Number of images in running tasks: "+str(len(ecs_images)))
+
+    #Find which images to remove
+    active_images = (task_def_images + ecs_images)
+    logger.info("Number of total active images: " + str(len(active_images)))
+    remove_images(get_list_of_old_images(active_images,ecr_images))

igor

@@ -1,11 +1,9 @@
 #!/usr/bin/env python3
 import click
-import time
-import d3b_cli_igor.common, d3b_cli_igor.log_ops.app_logs, d3b_cli_igor.app_ops.ecs_deployment, d3b_cli_igor.deploy_ops.deploy, d3b_cli_igor.deploy_ops.generate_config, d3b_cli_igor.utils.shortcuts, d3b_cli_igor.utils.diff, d3b_cli_igor.app_ops.ecs_get_info, d3b_cli_igor.app_ops.secrets, d3b_cli_igor.utils.generate_tf
-import boto3
 import boto3
 import sys 
-import d3b_cli_igor.common
+import time
+import d3b_cli_igor.common, d3b_cli_igor.log_ops.app_logs, d3b_cli_igor.app_ops.ecs_deployment, d3b_cli_igor.app_ops.ecr_actions, d3b_cli_igor.deploy_ops.deploy, d3b_cli_igor.deploy_ops.generate_config, d3b_cli_igor.utils.shortcuts, d3b_cli_igor.utils.diff, d3b_cli_igor.app_ops.ecs_get_info, d3b_cli_igor.app_ops.secrets, d3b_cli_igor.utils.generate_tf
 
 logger = d3b_cli_igor.common.get_logger(
     __name__, testing_mode=False, log_format="detailed"
@@ -158,6 +156,17 @@ def restart(app, environment, account):
     check_creds()
     d3b_cli_igor.app_ops.ecs_deployment.restart(app, environment, account)
 
+@click.option(
+    "--repos",
+    nargs=1,
+    required=False,
+    help="Enter Repository Name to Cleanup(comma separated)",
+)
+@click.command(name="ecr_cleanup")
+def ecr_cleanup(repos):
+    check_creds()
+    d3b_cli_igor.app_ops.ecr_actions.ecr_cleanup(repos.split(','))
+
 @click.command(name="get-info")
 @click.option(
     "--app",
@@ -194,6 +203,7 @@ def generate(project,region,account,environment,template):
 
 
 igor_cli.add_command(get_logs)
+igor_cli.add_command(ecr_cleanup)
 igor_cli.add_command(restart)
 igor_cli.add_command(get_info)
 igor_cli.add_command(secrets)