ECS Task

6 min

Resumo

Cria ou exclui instâncias de definições de tarefas.

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.comg.Config . 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.
cluster - required	string		O nome do cluster no qual executar a tarefa.
container_instances	list / elements=string		A lista de instâncias de contêiner nas quais implantar a tarefa.
count	integer		Quantas novas instâncias devem ser iniciadas.
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.
launch_type	string	Escolhas: EC2 FARGATE	O tipo de inicialização no qual executar seu serviço.
network_configuration	dictionary		Configuração de rede do serviço. Aplicável apenas para definições de tarefas criadas com network_mode=awsvpc .
operation - required	string	Escolhas: run start stop	Qual operação de tarefa executar. Quando operation=run task_definition deve ser definido. Quando operation=start , task_definition e container_instances devem ser configurados. Quando operation=stop , task_definition e task devem ser definidos.
overrides	dictionary		Um dicionário de valores para passar para as novas instâncias.
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 profile 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	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.
started_by	string		Um valor que mostra quem ou o que iniciou a tarefa (para fins informativos).
tags	dictionary		Tags que serão adicionadas às tarefas ecs ao iniciar e executar
task	string		O ARN da tarefa a ser interrompida.
task_definition	string		A definição de tarefa para iniciar, executar ou parar.
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.

Subcampos do parâmetro network_configuration

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
assign_public_ip	boolean	Escolhas: false true	Se a interface de rede elástica da tarefa recebe um endereço IP público.
security_groups	list / elements=string		Uma lista de nomes de grupos ou IDs de grupos para a tarefa.
sub-redes	list / elements=string		Uma lista de IDs de sub-rede à qual a tarefa está anexada.

Notas

Observação

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

# Exemplo simples de tarefa de execução
- name: Run task
  ecs_task:
    operation: run
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    count: 1
    started_by: atmosphere_user
  register: task_output

# Exemplo simples de iniciar tarefa

- name: Start a task
  ecs_task:
      operation: start
      cluster: console-sample-app-static-cluster
      task_definition: console-sample-app-static-taskdef
      task: "arn:aws:ecs:us-west-2:172139249013:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
      tags:
        resourceName: a_task_for_atmosphere_to_run
        type: long_running_task
        network: internal
        version: 1.4
      container_instances:
      - arn:aws:ecs:us-west-2:172139249013:container-instance/79c23f22-876c-438a-bddf-55c98a3538a8
      started_by: atmosphere_user
      network_configuration:
        subnets:
        - subnet-abcd1234
        security_groups:
        - sg-aaaa1111
        - my_security_group
  register: task_output

- name: RUN a task on Fargate
  ecs_task:
      operation: run
      cluster: console-sample-app-static-cluster
      task_definition: console-sample-app-static-taskdef
      task: "arn:aws:ecs:us-west-2:172139249013:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
      started_by: atmosphere_user
      launch_type: FARGATE
      network_configuration:
        subnets:
        - subnet-abcd1234
        security_groups:
        - sg-aaaa1111
        - my_security_group
  register: task_output

- name: RUN a task on Fargate with public ip assigned
  ecs_task:
      operation: run
      count: 2
      cluster: console-sample-app-static-cluster
      task_definition: console-sample-app-static-taskdef
      task: "arn:aws:ecs:us-west-2:172139249013:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
      started_by: atmosphere_user
      launch_type: FARGATE
      network_configuration:
        assign_public_ip: yes
        subnets:
        - subnet-abcd1234
  register: task_output

- name: Stop a task
  ecs_task:
      operation: stop
      cluster: console-sample-app-static-cluster
      task_definition: console-sample-app-static-taskdef
      task: "arn:aws:ecs:us-west-2:172139249013:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"

Valores de retorno

Chave	Tipo	Retornado quando	Descrição
task	complex	sucesso	detalhes sobre a tarefa que foi iniciada
clusterArn	string	somente quando os detalhes são verdadeiros	O nome de recurso da Amazon (ARN) do cluster que hospeda a tarefa.
containerInstanceArn	string	somente quando os detalhes são verdadeiros	O nome de recurso da Amazon (ARN) do contêiner que executa a tarefa.
containers	list/elements=dictionary	somente quando os detalhes são verdadeiros	Os detalhes do recipiente.
createdAt	string	somente quando os detalhes são verdadeiros	O carimbo de data/hora de quando a tarefa foi criada.
desiredStatus	string	somente quando os detalhes são verdadeiros	O status desejado da tarefa.
lastStatus	string	somente quando os detalhes são verdadeiros	O último status registrado da tarefa.
launchType	string	sempre	O tipo de inicialização no qual executar sua tarefa.
overrides	list/elements=dictionary	somente quando os detalhes são verdadeiros	As substituições de contêiner definidas para esta tarefa.
startedAt	string	somente quando os detalhes são verdadeiros	O carimbo de data/hora de quando a tarefa foi iniciada.
startedBy	string	somente quando os detalhes são verdadeiros	O usado que iniciou a tarefa.
stoppedAt	string	somente quando os detalhes são verdadeiros	O carimbo de data/hora de quando a tarefa foi interrompida.
stoppedReason	string	somente quando os detalhes são verdadeiros	A razão pela qual a tarefa foi interrompida.
taskArn	string	sempre	O nome de recurso da Amazon (ARN) que identifica a tarefa.
taskDefinitionArn	string	somente quando os detalhes são verdadeiros	O nome de recurso da Amazon (ARN) da definição de tarefa.