ECS Taskdefinition Info

12 min

Resumo

Descreve uma definição de tarefa no ECS.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
aws_access_key aliases: ec2_access_key, access_key	string		AWS access key. Se não for definido, o valor da variável AWS_ACCESS_KEY_ID de ambiente AWS_ACCESS_KEY ou EC2_ACCESS_KEY será usado. Se o profile for definido, este parâmetro será ignorado.
aws_ca_bundle	path		A localização de um CA Bundle a ser usado ao validar certificados SSL.
aws_config	dictionary		Um dicionário para modificar a configuração do botocore. Os parâmetros podem ser encontrados em https://botocore.amazonaws.com. Apenas a chave 'user_agent' é usada para módulos boto. Consulte http://boto.cloudhackers.com para obter mais configurações de boto.
aws_secret_key aliases: ec2_secret_key, secret_key	string		AWS secret key. Se não for definido, o valor da variável de ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY ou EC2_SECRET_KEY será usado. Se o profile for definido, este parâmetro será ignorado.
debug_botocore_endpoint_logs	boolean	Escolhas: false ← (padrão) true	Use um registrador botocore.endpoint para analisar as chamadas de API exclusivas (em vez do total) “resource:action” feitas durante uma tarefa, enviando o conjunto para a chave resource_actions nos resultados da tarefa. Use o retorno de chamada aws_resource_action para gerar a lista total feita durante um playbook.
ec2_url aliases: aws_endpoint_url, endpoint_url	string		URL a ser usada para conectar-se ao EC2 ou à sua nuvem Eucalyptus (por padrão, o módulo usará endpoints do EC2). Ignorado para módulos onde a região é necessária. Deve ser especificado para todos os outros módulos se a região não for usada. Se não for definido, o valor da variável de ambiente EC2_URL, se houver, será usado.
profile aliases: aws_profile	string		O uso do profile substituirá aws_access_key , aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo em que o perfil foi descontinuado.
region aliases: aws_region, ec2_region	string		A região da AWS a ser usada. Se não for especificado, o valor da variável de ambiente AWS_REGION ou EC2_REGION, se houver, será usado. Consulte http://docs.aws.amazon.com
security_token aliases: aws_security_token, access_token fragmento	string		AWS STS security token. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN será usado. Se o profile for definido, este parâmetro será ignorado.
task_definition - required	string		O nome da definição de tarefa para obter detalhes
validate_certs	boolean	Escolhas: false true ← (padrão)	Quando definido como “false”, os certificados SSL não serão validados para comunicação com as APIs da AWS.

Notas

Observação

Para obter detalhes dos parâmetros e retornos, consulte http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition
Se os parâmetros não forem definidos no módulo, as seguintes variáveis de ambiente podem ser usadas em ordem decrescente de precedência:
- AWS_URL ou EC2_URL,
- AWS_PROFILE ou AWS_DEFAULT_PROFILE,
- AWS_ACCESS_KEY_ID ou AWS_ACCESS_KEY ou EC2_ACCESS_KEY,
- AWS_SECRET_ACCESS_KEY ou AWS_SECRET_KEY ou EC2_SECRET_KEY,
- AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN,
- AWS_REGION ou EC2_REGION, AWS_CA_BUNDLE
Quando nenhuma credencial é fornecida explicitamente, o AWS SDK (boto3) que o Ansible usa retornará aos seus arquivos de configuração (normalmente ~/.aws/credentials). Consulte https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html para obter mais informações.
Módulos baseados no AWS SDK original (boto) podem ler sua configuração padrão de arquivos diferentes. Consulte https://boto.readthedocs.io/en/latest/boto_config_tut.html para obter mais informações.
AWS_REGION ou EC2_REGION pode ser normalmente usado para especificar a região da AWS, quando necessário, mas isso também pode ser definido nos arquivos de configuração.

Exemplos

- ecs_taskdefinition_info:
    task_definition: test-td

Valores de retorno

Chave	Tipo	Retornado quando	Descrição
container_definitions	complex	Sucesso	Retorna uma lista de objetos complexos que representam os contêineres
family	string	sempre	A família de sua definição de tarefa, usada como o nome da definição
modo de rede	string	sempre	Modo de rede para os contêineres
placement_constraints	complex	sempre	Uma lista de objetos de restrição de posicionamento a serem usados para tarefas
requires_attributes	complex	quando presente	Os atributos de instância de contêiner exigidos por sua tarefa
revision	integer	sempre	Número de revisão que foi consultado
status	string	sempre	O status da definição da tarefa
task_definition_arn	string	sempre	ARN da definição da tarefa
task_role_arn	string	quando o papel é definido	O ARN da função do IAM que os contêineres nesta tarefa podem assumir
volumes	complex	sempre	A lista de volumes em uma tarefa

Subcampo da chave de retorno container_definitions

chave	Tipo	Retornado quando	Descrição
command	string	quando presente	O comando que é passado para o contêiner.
cpu	integer	sempre	O número de unidades de CPU reservadas para o contêiner.
disableNetworking	boolean	quando presente	Quando esse parâmetro é verdadeiro, a rede é desabilitada no contêiner.
dnsSearchDomains	string	quando presente	Uma lista de domínios de pesquisa DNS que são apresentados ao contêiner.
dnsServers	string	quando presente	Uma lista de servidores DNS que são apresentados ao contêiner.
dockerLabels	string	quando presente	Um mapa de chave/valor de rótulos para adicionar ao contêiner.
dockerSecurityOptions	string	quando presente	Uma lista de strings para fornecer rótulos personalizados para sistemas de segurança multinível SELinux e AppArmor.
entryPoint	string	quando presente	O ponto de entrada que é passado para o contêiner.
environment	complex	sempre	As variáveis de ambiente a serem passadas para um contêiner.
essential	boolean	sempre	Se este é um recipiente essencial ou não.
extraHosts	complex	quando presente	Uma lista de nomes de host e mapeamentos de endereço IP para anexar ao arquivo /etc/hosts no contêiner.
hostname	string	quando presente	O nome do host a ser usado para seu contêiner.
image	string	sempre	A imagem usada para iniciar um contêiner.
links	string	quando presente	Links para outros contêineres.
logConfiguration	string	quando presente	A especificação de configuração de log para o contêiner.
memoryReservation	integer	quando presente	O limite flexível (em MiB) de memória a ser reservado para o contêiner.
mountPoints	complex	sempre	Os pontos de montagem para volumes de dados em seu contêiner.
name	string	sempre	O nome de um contêiner.
options	string	quando presente	As opções de configuração para enviar ao driver de log.
portMappings	complex	sempre	A lista de mapeamentos de porta para o contêiner.
privileged	boolean	quando presente	Quando esse parâmetro é verdadeiro, o contêiner recebe privilégios elevados na instância do contêiner do host (semelhante ao usuário root).
readonlyRootFilesystem	boolean	quando presente	Quando esse parâmetro é verdadeiro, o contêiner recebe acesso somente leitura ao seu sistema de arquivos raiz.
ulimits	complex	quando presente	Uma lista de ulimits a serem definidos no contêiner.
user	string	quando presente	O nome de usuário a ser usado dentro do contêiner.
volumesFrom	string	sempre	Volumes de dados a serem montados de outro contêiner.
workingDirectory	complex	quando presente	O diretório de trabalho no qual executar comandos dentro do contêiner.

Subcampo da chave de retorno environment

chave	Tipo	Retornado quando	Descrição
name	string	quando presente	O nome da variável de ambiente.
value	string	quando presente	O valor da variável de ambiente.

Subcampo da chave de retorno extraHosts

chave	Tipo	Retornado quando	Descrição
hostname	string	quando presente	O nome do host a ser usado na entrada /etc/hosts.
ipAddress	string	quando presente	O endereço IP a ser usado na entrada /etc/hosts.

Subcampo da chave de retorno mountPoints

chave	Tipo	Retornado quando	Descrição
containerPath	string	quando presente	O caminho no contêiner no qual montar o volume do host.
readOnly	integer	quando presente	Se esse valor for true , o contêiner terá acesso somente leitura ao volume. Se esse valor for false , o contêiner poderá gravar no volume.
sourceVolume	string	quando presente	O nome do volume a ser montado.

Subcampo da chave de retorno portMappings

chave	Tipo	Retornado quando	Descrição
containerPort	integer	quando presente	O número da porta no contêiner.
hostPort	integer	quando presente	O número da porta na instância de contêiner a ser reservada para seu contêiner.
protocol	string	quando presente	O protocolo usado para o mapeamento de porta.

Subcampo da chave de retorno ulimits

chave	Tipo	Retornado quando	Descrição
hardLimit	integer	quando presente	O limite rígido para o tipo ulimit.
name	string	quando presente	O tipo do ulimit.
softLimit	integer	quando presente	O limite flexível para o tipo ulimit.

Subcampo da chave de retorno volumesFrom

chave	Tipo	Retornado quando	Descrição
readOnly	boolean	quando presente	Se esse valor for true , o contêiner terá acesso somente leitura ao volume. Se esse valor for false , o contêiner poderá gravar no volume.
sourceContainer	string	quando presente	O nome de outro contêiner dentro da mesma definição de tarefa do qual montar volumes.

ECS Taskdefinition Info

Resumo

Parâmetros﻿﻿

Notas﻿﻿

Exemplos﻿﻿

Valores de retorno﻿﻿

Subcampo da chave de retorno container_definitions ﻿﻿

Subcampo da chave de retorno environment ﻿﻿

Subcampo da chave de retorno extraHosts ﻿﻿

Subcampo da chave de retorno mountPoints ﻿﻿

Subcampo da chave de retorno portMappings ﻿﻿

Subcampo da chave de retorno ulimits ﻿﻿

Subcampo da chave de retorno volumesFrom ﻿﻿

Parâmetros

Notas

Exemplos

Valores de retorno

Subcampo da chave de retorno container_definitions

Subcampo da chave de retorno environment

Subcampo da chave de retorno extraHosts

Subcampo da chave de retorno mountPoints

Subcampo da chave de retorno portMappings

Subcampo da chave de retorno ulimits

Subcampo da chave de retorno volumesFrom