ecs_composex.ecs package

Subpackages

• ecs_composex.ecs.ecs_family package
  • Subpackages
    • ecs_composex.ecs.ecs_family.family_helpers package
      • Submodules
      • ecs_composex.ecs.ecs_family.family_helpers.compute_finalizers module
      • ecs_composex.ecs.ecs_family.family_helpers.network_finalizers module
      • Module contents
    • ecs_composex.ecs.ecs_family.family_logging package
      • Submodules
      • ecs_composex.ecs.ecs_family.family_logging.cw_logging module
      • Module contents
  • Submodules
  • ecs_composex.ecs.ecs_family.family_template module
    • set_template()
  • ecs_composex.ecs.ecs_family.task_execute_command module
    • apply_ecs_execute_command_permissions()
    • expand_policy_roles()
    • set_enable_execute_command()
  • ecs_composex.ecs.ecs_family.task_runtime module
    • define_family_runtime_cpu_arch()
    • define_family_runtime_os_family()
    • define_family_runtime_parameters()
  • Module contents
    • ComposeFamily
      • ComposeFamily.add_containers_images_cfn_parameters()
      • ComposeFamily.add_managed_sidecar()
      • ComposeFamily.add_service()
      • ComposeFamily.apply_ecs_execute_command_permissions()
      • ComposeFamily.composed_env_processing()
      • ComposeFamily.finalize_family_settings()
      • ComposeFamily.finalize_services_networking_settings()
      • ComposeFamily.generate_outputs()
      • ComposeFamily.handle_alarms()
      • ComposeFamily.handle_logging()
      • ComposeFamily.import_all_sidecars()
      • ComposeFamily.init_family()
      • ComposeFamily.init_network_settings()
      • ComposeFamily.init_task_definition()
      • ComposeFamily.logical_name
      • ComposeFamily.service_arn_param
      • ComposeFamily.service_definition
      • ComposeFamily.service_name_param
      • ComposeFamily.services
      • ComposeFamily.services_names
      • ComposeFamily.set_add_region_when_external()
      • ComposeFamily.set_enable_execute_command()
      • ComposeFamily.set_secrets_access()
      • ComposeFamily.set_services_family_links()
      • ComposeFamily.set_services_to_services_dependencies()
      • ComposeFamily.set_task_definition()
      • ComposeFamily.set_update_containers_priority()
      • ComposeFamily.sort_env_vars()
      • ComposeFamily.sort_secrets()
      • ComposeFamily.sort_secrets_env_vars()
      • ComposeFamily.state_facts()
      • ComposeFamily.task_ephemeral_storage
      • ComposeFamily.validate_compute_configuration_for_task()
      • ComposeFamily.want_xray
      • ComposeFamily.x_environment_processing()
    • ServiceStack
• ecs_composex.ecs.ecs_firelens package
  • Subpackages
    • ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced package
      • Submodules
      • ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced.advanced_firehose module
      • ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced.advanced_kinesis module
      • ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced.config_parameter module
      • ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced.firelens_config_sidecar module
      • Module contents
    • ecs_composex.ecs.ecs_firelens.helpers package
      • Submodules
      • ecs_composex.ecs.ecs_firelens.helpers.cloudwatch_helpers module
      • ecs_composex.ecs.ecs_firelens.helpers.firehose_helpers module
      • ecs_composex.ecs.ecs_firelens.helpers.kinesis_helpers module
      • Module contents
  • Submodules
  • ecs_composex.ecs.ecs_firelens.firelens_advanced_rendered_settings module
    • finalize_firelens_container_shorthands()
    • handle_firelens_advanced_settings()
  • ecs_composex.ecs.ecs_firelens.firelens_logger_helpers module
    • handle_cloudwatch()
    • handle_firehose_config()
    • handle_kinesis_config()
    • parse_set_update_firelens_configuration_options()
  • ecs_composex.ecs.ecs_firelens.firelens_managed_sidecar_service module
    • FluentBit
      • FluentBit.add_to_family()
      • FluentBit.firelens_config
      • FluentBit.fluentbit_firelens_defaults
      • FluentBit.set_as_dependency_to_family_services()
      • FluentBit.set_firelens_configuration()
    • render_agent_config()
  • ecs_composex.ecs.ecs_firelens.firelens_options_generic_helpers module
    • handle_cross_account_permissions()
  • Module contents
• ecs_composex.ecs.ecs_prometheus package
  • Submodules
  • ecs_composex.ecs.ecs_prometheus.config_ssm_parameters module
    • set_cw_config_parameter()
    • set_cw_prometheus_config_parameter()
  • ecs_composex.ecs.ecs_prometheus.emf_processors module
    • generate_ecs_sd_service_name_pattern()
    • generate_emf_processors()
    • get_ecs_envoy_processor()
    • get_jmx_processor()
    • get_ngnix_processor()
    • process_custom_rules()
  • ecs_composex.ecs.ecs_prometheus.helpers module
    • define_cloudwatch_agent()
    • set_ecs_cw_policy()
  • Module contents
    • add_cw_agent_to_family()
    • set_prometheus()
    • set_prometheus_containers_insights()
• ecs_composex.ecs.ecs_service package
  • Submodules
  • ecs_composex.ecs.ecs_service.helpers module
    • define_deployment_options()
    • define_family_deploy_percents()
    • define_placement_strategies()
    • set_service_default_tags_labels()
    • set_service_update_config()
  • Module contents
    • EcsService
      • EcsService.generate_service_definition()
• ecs_composex.ecs.helpers package
  • Module contents
    • add_iam_dependency()
    • handle_families_cross_dependencies()
    • set_families_ecs_service()
• ecs_composex.ecs.managed_sidecars package
  • Submodules
  • ecs_composex.ecs.managed_sidecars.aws_cw_agent module
    • get_cloudwatch_agent_sidecar()
  • ecs_composex.ecs.managed_sidecars.aws_xray module
    • import_xray_container()
    • set_xray()
  • ecs_composex.ecs.managed_sidecars.nginx_prometheus_exporter module
  • Module contents
    • ManagedSidecar
      • ManagedSidecar.add_to_family()
      • ManagedSidecar.set_as_dependency_to_family_services()
• ecs_composex.ecs.service_alarms package
  • Submodules
  • ecs_composex.ecs.service_alarms.service_predefined_alarms module
  • Module contents
    • assign_predefined_alerts()
    • define_default_alarm_settings()
    • define_predefined_alarm_settings()
    • define_predefined_alarms()
    • handle_alarms()
    • merge_alarm_settings()
    • set_merge_alarm_topics()
    • validate_service_predefined_alarms()
• ecs_composex.ecs.service_compute package
  • Submodules
  • ecs_composex.ecs.service_compute.helpers module
    • merge_capacity_providers()
  • Module contents
    • ServiceCompute
      • ServiceCompute.apply_capacity_providers_to_service()
      • ServiceCompute.cfn_launch_type
      • ServiceCompute.ecs_capacity_providers
      • ServiceCompute.launch_type
      • ServiceCompute.set_update_capacity_providers()
      • ServiceCompute.set_update_launch_type()
• ecs_composex.ecs.service_networking package
  • Submodules
  • ecs_composex.ecs.service_networking.helpers module
    • set_family_hostname()
    • update_family_subnets()
  • ecs_composex.ecs.service_networking.ingress_helpers module
    • add_service_to_service_ingress_rules()
    • find_namespace()
    • handle_aws_sources()
    • handle_dict_cloudmap_config()
    • handle_ext_sources()
    • handle_ingress_rules()
    • handle_services()
    • handle_str_cloudmap_config()
    • import_set_ecs_connect_settings()
    • merge_cloudmap_settings()
    • merge_family_network_setting()
    • merge_family_services_networking()
    • process_ecs_connect_settings()
    • set_compose_services_ingress()
    • set_ecs_connect_from_macro()
  • Module contents
    • ServiceNetworking
      • ServiceNetworking.add_lb_ingress()
      • ServiceNetworking.add_self_ingress()
      • ServiceNetworking.ecs_network_config
      • ServiceNetworking.eip_assign
      • ServiceNetworking.ingress_from_self
      • ServiceNetworking.merge_networks()
      • ServiceNetworking.merge_services_ports()
      • ServiceNetworking.network_mode
      • ServiceNetworking.sd_service
      • ServiceNetworking.security_groups
      • ServiceNetworking.self_key
      • ServiceNetworking.set_ecs_connect()
      • ServiceNetworking.subnets
      • ServiceNetworking.subnets_output
• ecs_composex.ecs.service_scaling package
  • Submodules
  • ecs_composex.ecs.service_scaling.helpers module
    • define_new_config()
    • define_step_adjustment()
    • define_tracking_target_configuration()
    • generate_alarm_scaling_out_policy()
    • generate_scaling_out_steps()
    • handle_defined_target_scaling_props()
    • handle_defined_x_aws_autoscaling()
    • handle_range()
    • handle_scheduled_actions()
    • handle_target_scaling()
    • merge_family_services_scaling()
    • rectify_scaling_steps()
    • reset_to_zero_policy()
    • validate_steps_definition()
  • Module contents
    • ServiceScaling
      • ServiceScaling.add_scheduled_actions()
      • ServiceScaling.add_target_scaling()
      • ServiceScaling.create_scalable_target()
      • ServiceScaling.defined
      • ServiceScaling.replicas
      • ServiceScaling.target_scaling_keys
• ecs_composex.ecs.task_compute package
  • Submodules
  • ecs_composex.ecs.task_compute.helpers module
    • handle_multi_services()
    • reset_for_single_main_container()
    • unlock_compute_for_main_container()
  • Module contents
    • TaskCompute
      • TaskCompute.cfn_family_cpu
      • TaskCompute.cfn_family_ram
      • TaskCompute.family_cpu
      • TaskCompute.family_ram
      • TaskCompute.fargate_cpu
      • TaskCompute.fargate_ram
      • TaskCompute.set_task_compute_parameter()
      • TaskCompute.unlock_compute_for_main_container()
      • TaskCompute.update_family_fargate()
• ecs_composex.ecs.task_iam package
  • Submodules
  • ecs_composex.ecs.task_iam.helpers module
    • add_policies_from_x_iam()
    • set_update_inline_policies()
    • set_update_managed_policies()
  • ecs_composex.ecs.task_iam.task_role module
    • EcsRole
      • EcsRole.arn
      • EcsRole.arn_param
      • EcsRole.generate_outputs()
      • EcsRole.init_role()
      • EcsRole.name
      • EcsRole.name_param
      • EcsRole.output_arn
      • EcsRole.output_name
      • EcsRole.role_type
      • EcsRole.set_new_resource_outputs()
  • Module contents
    • TaskIam
      • TaskIam.add_new_managed_policies()
      • TaskIam.add_new_managed_policy()
      • TaskIam.add_new_policy()
      • TaskIam.describe()
      • TaskIam.get_role_from_name()
      • TaskIam.init_update_policies()
      • TaskIam.inline_policies_names
      • TaskIam.managed_policies_list
      • TaskIam.permissions_boundary

Submodules

ecs_composex.ecs.ecs_conditions module

Parameters relating to ECS.

This is a crucial part as all the titles, maked _T are string which are then used the same way across all imports, which gives consistency for CFN to use the same names, which it heavily relies onto.

You can change the names values so you like so long as you keep it Alphanumerical [a-zA-Z0-9]

ecs_composex.ecs.ecs_conditions. use_external_lt_con ( if_true , if_false )

Function to return the If() to simplify !If USE_EXTERNAL_LT_T

Returns :

If(USE_EXTERNAL_LT_T, if_true, if_false)

Return type :

If

ecs_composex.ecs.ecs_params module

Parameters bound to ecs_composex.ecs This is a crucial part as all the titles, maked _T are string which are then used the same way across all imports, which gives consistency for CFN to use the same names, which it heavily relies onto.

You can change the names values so you like so long as you keep it [a-zA-Z0-9]

ecs_composex.ecs.ecs_params. get_import_service_group_id ( remote_service_name )

Function to return the ImportValue(Sub()) for given ecs_service name

ecs_composex.ecs.ecs_stack module

ecs_composex.ecs.ecs_stack. add_compose_families ( settings , families_sg_stack )

Using existing ComposeFamily in settings, creates the ServiceStack and template

Return type :

None

ecs_composex.ecs.ecs_stack. handle_families_dependencies ( settings , families_post )

Function to handle family to family services based on docker compose depends_on

Parameters :

• settings ( ecs_composex.common.settings.ComposeXSettings ) –

• families_post ( list ) –

Return type :

None

ecs_composex.ecs.ecs_stack. initialize_family_services ( settings , family )

Function to handle creation of services within the same family.

Parameters :

• family ( ecs_composex.ecs.ecs_family.ComposeFamily ) –

• settings ( ecs_composex.common.settings.ComposeXSettings ) –

Return type :

None

Returns :

Module contents

Core module for ECS ComposeX.

This module is going to parse each ecs_service and each x-resource key from the compose file (hence Compose-X) and determine its

• ServiceDefinition

• TaskDefinition

• TaskRole

• ExecutionRole

It is going to also, based on the labels set in the compose file

• Add the ecs_service to Service Discovery via AWS CloudMap

• Add load-balancers to dispatch traffic to the microservice

Services logic

• Define Container Definitions

** Compute ** Storage ** Docker Settings ** Logging Settings ** Env Vars ** Secrets

• Define Task Definition

** IAM Roles ** Containers ** Volumes (Docker volumes / EFS) ** AppMesh/Proxy Settings

• Define Service Definition

** Network settings (VPC/SG) ** Ingress settings (ALB/NLB/CloudMap)