ecs_composex.compose.compose_secrets package

Submodules

ecs_composex.compose.compose_secrets.ecs_family_helpers module

ecs_composex.compose.compose_secrets.ecs_family_helpers. identify_repo_credentials_secret ( settings , task , secret_name )

Function to identify the secret_arn

Parameters :

• settings –

• task ( ComposeFamily ) –

• secret_name –

Returns :

ecs_composex.compose.compose_secrets.ecs_family_helpers. set_repository_credentials ( family , settings )

Method to go over each service and identify which ones have credentials to pull the Docker image from a private repository

Parameters :

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

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

Returns :

ecs_composex.compose.compose_secrets.helpers module

Represent a service from the docker-compose services

ecs_composex.compose.compose_secrets.helpers. define_env_var_name ( secret_key )

Function to determine what the VarName key for secret will be

Parameters :

secret_key ( dict ) – Key definition as defined in compose file

Returns :

VarName value

Return type :

str

ecs_composex.compose.compose_secrets.helpers. to_capitalize ( name )

Function to capitalize/upper all letters and leave the rest empty

Parameters :

name –

Returns :

ecs_composex.compose.compose_secrets.helpers. to_java_properties ( name )

Replaces . with _ and set all cases to upper

Parameters :

name ( str ) –

Returns :

transformed test

Return type :

str

ecs_composex.compose.compose_secrets.helpers. to_title ( name )

Function to title the name

Parameters :

name ( str ) –

Returns :

ecs_composex.compose.compose_secrets.services_helpers module

ecs_composex.compose.compose_secrets.services_helpers. map_secrets ( service , secrets )

Map compose defined secret to service

Parameters :

• service –

• secrets ( list ) –

Return type :

None

ecs_composex.compose.compose_secrets.services_helpers. match_secrets_services_config ( service , s_secret , secrets )

Function to match the services and secrets :type service: :param service: :type s_secret: :param s_secret: :type secrets: :param secrets: :return:

Module contents

Package to manage docker-compose secrets

class ecs_composex.compose.compose_secrets. ComposeSecret ( name , definition , settings )

Bases: object

Class to represent a Compose secret.

add_json_keys ( )

Add secrets definitions based on JSON secret keys

define_links ( )

Defines which IAM role to assign the secrets access policy to. Defaults to exec role

define_names_from_import ( )

Define the names from docker-compose file content

define_names_from_lookup ( session )

Method to Lookup the secret based on its tags.

define_secret ( secret_name , json_key )

Return type :

troposphere.ecs.Secret

property env_var : Environment

json_keys_key = 'JsonKeys'

links_key = 'LinksTo'

main_key = 'secrets'

map_arn_name = 'Arn'

map_kms_name = 'KmsKeyId'

map_name = 'secrets'

map_name_name = 'Name'

x_key = 'x-secrets'