ecs_composex.compose.compose_services.service_image package

Submodules

ecs_composex.compose.compose_services.service_image.docker_opts module

Helper functions around ECR and docker images, done early to ensure viability of the execution before doing all the resources allocations / lookups

ecs_composex.compose.compose_services.service_image.docker_opts. evaluate_ecr_configs ( settings )

Function to go over each service of each family in its final state and evaluate the ECR Image validity.

Return type :

int

ecs_composex.compose.compose_services.service_image.ecr_helpers module

ecs_composex.compose.compose_services.service_image.ecr_helpers. define_ecr_session ( account_id , repo_name , region , settings , role_arn = None )

Function to determine the boto3 session to use for subsequent API calls to ECR :type account_id: :param account_id: :type repo_name: :param repo_name: :type region: :param region: :type settings: :param settings: :param str role_arn: :return:

ecs_composex.compose.compose_services.service_image.ecr_helpers. define_service_image ( service , settings )

Function to parse and identify the image for the service in AWS ECR

Parameters :

• service ( ecs_composex.common.compose_services.ComposeService ) –

• settings ( ecs_composex.common.settings.ComposeXSettings ) – The settings for the execution

Returns :

ecs_composex.compose.compose_services.service_image.ecr_helpers. identify_service_image ( service , repo_name , image_sha , image_tag , session )

Function to identify the image in repository that matches the one defined in service for a private ECR Based image.

Parameters :

• repo_name ( str ) –

• image_sha ( str ) –

• image_tag ( str ) –

• session ( boto3.session.Session ) –

Returns :

The image definition

Return type :

dict

ecs_composex.compose.compose_services.service_image.ecr_helpers. interpolate_ecr_uri_tag_with_digest ( image_url , image_digest )

Function to replace the tag from image_url

Parameters :

• image_url ( str ) –

• image_digest ( str ) –

Returns :

ecs_composex.compose.compose_services.service_image.ecr_scans_eval module

Module contents

class ecs_composex.compose.compose_services.service_image. ServiceImage ( service , image_param = None )

Bases: object

Variables :

• _image –

• image_uri ( str ) –

property image : Union [ str , Ref ]

property image_param : Parameter

interpolate_image_digest ( settings = None )

if service x-ecr is set, and image URI indicates a resolvable image, sets image_digest

property private_ecr : Optional [ Match ]

private_ecr_digest ( settings )

property public_ecr : Optional [ Match ]

retrieve_image_digest ( )

Retrieves the docker images digest from the repository to use instead of the image tag.

property service : ComposeService

ecs_composex.compose.compose_services.service_image. get_image_from_ssm_parameter ( ssm_parameter , session = None )

Return type :

typing.Optional [ str ]