AWSTOE downloads Regiões aceitas Referência de comando

Como o Image Builder usa o AWS Task Orchestrator and Executor aplicativo para gerenciar componentes

O EC2 Image Builder usa AWS Task Orchestrator and Executor o aplicativo AWSTOE() para orquestrar fluxos de trabalho complexos, modificar configurações do sistema e testar suas imagens sem a necessidade de scripts ou códigos adicionais de DevOps. Essa aplicação gerencia e executa componentes que implementam seu esquema de documento declarativo.

AWSTOE é um aplicativo independente que o Image Builder instala em suas instâncias de compilação e teste quando você cria uma imagem. Você também pode instalá-lo manualmente em instâncias do EC2 para criar seus componentes personalizados. Ele não requer nenhuma configuração adicional e também pode ser executado no ambiente on-premises.

Conteúdo

AWSTOE downloads

Para instalar AWSTOE, escolha o link de download para sua arquitetura e plataforma. Se você se conectar a um VPC endpoint para seu serviço (Image Builder, por exemplo), ele deverá ter uma política de endpoint personalizada anexada que inclua acesso ao bucket do S3 para downloads. AWSTOE Caso contrário, suas instâncias de compilação e teste não poderão baixar o script bootstrap (bootstrap.sh) e instalar o AWSTOE aplicativo. Para obter mais informações, consulte Criar uma política de endpoint da VPC o Image Builder.

Importante

AWS está eliminando gradualmente o suporte para as versões 1.0 e 1.1 do TLS. Para acessar o bucket do S3 para AWSTOE downloads, seu software cliente deve usar o TLS versão 1.2 ou posterior. Para obter mais informações, consulte esta publicação do blog de Segurança da AWS.

Arquitetura	Plataforma	Link para fazer download	Exemplo
386	AL 2 e 2023 RHEL 7, 8 e 9 Ubuntu 16.04, 18.04, 20.04, 22.04 e 24.04 CentOS 7 e 8 SUSE 12 e 15	`https://awstoe-<region>.s3.<region>.amazonaws.com/latest/linux/386/awstoe`	https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/386/awstoe
AMD64	AL 2 e 2023 RHEL 7, 8 e 9 Ubuntu 16.04, 18.04, 20.04, 22.04 e 24.04 CentOS 7 e 8 CentOS Stream 8 SUSE 12 e 15	`https://awstoe-<region>.s3.<region>.amazonaws.com/latest/linux/amd64/awstoe`	https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/amd64/awstoe
AMD64	macOS 10.14.x (Mojave), 10.15.x (Catalina), 11.x (Big Sur), 12.x (Monterey)	`https://awstoe-region.s3.region.amazonaws.com/latest/darwin/amd64/awstoe`	https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/darwin/amd64/awstoe
AMD64	Windows Server 2012 R2, 2016, 2019 e 2022	`https://awstoe-<region>.s3.<region>.amazonaws.com/latest/windows/amd64/awstoe.exe`	https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/windows/amd64/awstoe.exe
ARM64	AL 2 e 2023 RHEL 7, 8 e 9 Ubuntu 16.04, 18.04, 20.04, 22.04 e 24.04 CentOS 7 e 8 CentOS Stream 8 SUSE 12 e 15	`https://awstoe-<region>.s3.<region>.amazonaws.com/latest/linux/arm64/awstoe`	https://awstoe-us-east-1.s3.us-east-1.amazonaws.com/latest/linux/arm64/awstoe

Regiões aceitas

AWSTOE é suportado como um aplicativo independente nas seguintes regiões.

Região da AWS nome	Região da AWS
Leste dos EUA (Ohio)	us-east-2
Leste dos EUA (Norte da Virgínia)	us-east-1
AWS GovCloud (US-East)	us-gov-east-1
AWS GovCloud (US-West)	us-gov-west-1
Oeste dos EUA (N. da Califórnia)	us-west-1
Oeste dos EUA (Oregon)	us-west-2
África (Cidade do Cabo)	af-south-1
Ásia-Pacífico (Hong Kong)	ap-east-1
Ásia-Pacífico (Osaka)	ap-northeast-3
Ásia-Pacífico (Seul)	ap-northeast-2
Ásia Pacífico (Mumbai)	ap-south-1
Ásia-Pacífico (Hyderabad)	ap-south-2
Ásia-Pacífico (Singapura)	ap-southeast-1
Ásia-Pacífico (Sydney)	ap-southeast-2
Ásia-Pacífico (Jacarta)	ap-southeast-3
Ásia-Pacífico (Tóquio)	ap-northeast-1
Canadá (Central)	ca-central-1
Europa (Frankfurt)	eu-central-1
Europa (Zurique)	eu-central-2
Europa (Estocolmo)	eu-north-1
Europa (Milão)	eu-south-1
Europa (Espanha)	eu-south-2
Europa (Irlanda)	eu-west-1
Europa (Londres)	eu-west-2
Europa (Paris)	eu-west-3
Israel (Tel Aviv)	il-central-1
Oriente Médio (Emirados Árabes Unidos)	me-central-1
Oriente Médio (Bahrein)	me-south-1
América do Sul (São Paulo)	sa-east-1
China (Pequim)	cn-north-1
China (Ningxia)	cn-northwest-1

AWSTOE Referência de comando

AWSTOE é um aplicativo de gerenciamento de componentes de linha de comando executado em instâncias do Amazon EC2. Quando o Image Builder inicia uma instância de compilação ou teste do EC2, ele é instalado AWSTOE na instância. Em seguida, ele executa AWSTOE comandos no AWS CLI para instalar ou validar os componentes especificados na imagem ou na receita do contêiner.

nota

Alguns módulos de AWSTOE ação exigem permissões elevadas para serem executados em um servidor Linux. Para usar permissões elevadas, prefixe a sintaxe do comando com sudo ou execute o comando sudo su uma vez ao fazer login antes de executar os comandos vinculados abaixo. Para obter mais informações sobre módulos de AWSTOE ação, consulteMódulos de ação suportados por AWSTOE gerenciador de componentes.

run: Use o run comando para executar os scripts do documento YAML para um ou mais documentos componentes.
validar: Use o validate comando para validar a sintaxe do documento YAML para um ou mais documentos componentes.

comando awstoe run

Este comando executa os scripts do documento do componente YAML na ordem em que são incluídos no arquivo de configuração especificado pelo parâmetro --config ou na lista de documentos do componente especificada pelo parâmetro --documents.

nota

Você deve especificar exatamente um dos seguintes parâmetros, nunca os dois:

--config

--documents

Sintaxe


awstoe run [--config <file path>] [--cw-ignore-failures <?>] 
      [--cw-log-group <?>] [--cw-log-region us-west-2] [--cw-log-stream <?>] 
      [--document-s3-bucket-owner <owner>] [--documents <file path,file path,...>] 
      [--execution-id <?>] [--log-directory <file path>] 
      [--log-s3-bucket-name <name>] [--log-s3-bucket-owner <owner>] 
      [--log-s3-key-prefix <?>] [--parameters name1=value1,name2=value2...]
      [--phases <phase name>] [--blocked-action-modules <module,module,...>]
      [--state-directory <directory path>] [--version <?>]
      [--help] [--trace]

Parâmetros e opções

Parâmetros

--config ./config-example.json

Forma abreviada: -c ./config-example.json

O arquivo de configuração (condicional). Esse parâmetro contém a localização do arquivo JSON que contém as definições de configuração dos componentes que esse comando está executando. Se você especificar as configurações de run comando em um arquivo de configuração, não deverá especificar o --documents parâmetro. Para obter mais informações sobre a configuração de entrada, consulte Configure a entrada para o AWSTOE executar comando.

Localizações válidas incluem:

Um caminho de arquivo local (./config-example.json)
Uma URI do S3 (s3://bucket/key)

--cw-ignore-failures

Forma abreviada: N/A

Ignore as falhas de CloudWatch registro dos registros.

--cw-log-group

Forma abreviada: N/A

O LogGroup nome dos CloudWatch Logs.

--cw-log-region

Forma abreviada: N/A

A AWS região que se aplica aos CloudWatch registros.

--cw-log-stream

Forma abreviada: N/A

O LogStream nome dos CloudWatch registros, que direciona para AWSTOE onde transmitir o console.log arquivo.

--document-s3-proprietário do bucket

Forma abreviada: N/A

O ID da conta do proprietário do bucket para URI-based documentos do S3.

--documentos ./doc-1.yaml,./doc-n.yaml

Forma abreviada: -d ./doc-1.yaml,./doc-n

Os documentos do componente (condicionais). Esse parâmetro contém uma lista separada por vírgulas dos locais dos arquivos para execução dos documentos do componente YAML. Se você especificar documentos YAML para o run comando usando o --documents parâmetro, não deverá especificar o --config parâmetro. Não inclua espaços entre os itens na lista.

Localizações válidas incluem:

caminhos de arquivo locais (./component-doc-example.yaml).
URIs do S3 ()s3://bucket/key.
ARNs da versão de compilação do componente Image Builder (arn:aws:imagebuilder:us-west-/ /2021.12. 2:123456789012 my-example-component 02/1).

--execution-id

Forma abreviada: -i

Esse é o ID exclusivo que se aplica à execução do comando run atual. Este ID é incluído nos nomes dos arquivos de saída e log, para identificar esses arquivos de forma exclusiva e vinculá-los à execução atual do comando. Se essa configuração for omitida, AWSTOE gera um GUID.

--log-directory

Forma abreviada: -l

O diretório de destino onde AWSTOE armazena todos os arquivos de log da execução desse comando. Este arquivo está localizado no diretório a seguir, por padrão: TOE_<DATETIME>_<EXECUTIONID>. Se você não especificar o diretório de log, AWSTOE usa o diretório de trabalho atual (.).

--log-s3-nome do bucket

Forma abreviada: -b

Se os registros do componente estiverem armazenados no Amazon S3 (recomendado), AWSTOE carrega os registros do aplicativo do componente para o bucket do S3 nomeado nesse parâmetro.

--log-s3-proprietário do bucket

Forma abreviada: N/A

Se os registros do componente estiverem armazenados no Amazon S3 (recomendado), esse é o ID da conta do proprietário do bucket em que AWSTOE grava os arquivos de log.

--log-s3-key-prefix

Forma abreviada: -k

Se os registros do componente estiverem armazenados no Amazon S3 (recomendado), esse é o prefixo da chave de objeto do S3 para a localização do log no bucket.

--parâmetros name1 =value1, name2 =value2...

Forma abreviada: N/A

Os parâmetros são variáveis mutáveis definidas no documento do componente, com configurações que o aplicativo de chamada pode fornecer em tempo de execução.

--phases

Forma abreviada: -p

Uma lista separada por vírgulas que especifica quais fases devem ser executadas a partir dos documentos do componente YAML. Se um documento do componente incluir fases adicionais, elas não serão executadas.

--diretório estadual

Forma abreviada: -s

O caminho do arquivo em que os arquivos de rastreamento de estado são armazenados.

--módulos de ação bloqueada

Forma abreviada: N/A

Uma lista separada por vírgula dos módulos de ação que não podem ser executados no documento do componente. Se um documento contiver um módulo de ação bloqueado, a validação falhará antes do início da execução.

--version

Forma abreviada: -v

Especifica a versão do aplicativo do componente.

Opções

--help

Forma abreviada: -h

Exibe um manual de ajuda para usar as opções do aplicativo de gerenciamento de componentes.

--trace

Forma abreviada: -t

Ativa o registro detalhado no console do.

Output

O run comando produz um resumo da execução do JSON. O exemplo a seguir mostra a saída de uma execução bem-sucedida.


{
    "executionId": "12345678-abcd-efgh-1234-example12345",
    "status": "success",
    "failedStepCount": 0,
    "executedStepCount": 3,
    "ignoredFailedStepCount": 0,
    "skippedStepCount": 0,
    "failureMessage": "",
    "logUrl": "s3://my-bucket/my-prefix/12345678-abcd-efgh-1234-example12345"
}

O status campo relata o resultado geral da execução:

success— Todas as fases e etapas foram concluídas com sucesso.
failed— Uma ou mais etapas falharam porque a onFailure ação falhouAbort.
timedOut— Uma ou mais etapas excederam seu timeoutSeconds valor.

comando awstoe validate

Ao executar esse comando, ele valida a sintaxe do documento YAML para cada um dos documentos de componente especificados pelo parâmetro --documents.

Sintaxe


awstoe validate [--blocked-action-modules <module,module,...>]
      [--document-s3-bucket-owner <owner>]
      --documents <file path,file path,...> [--help] [--trace]

Parâmetros e opções

Parâmetros

--módulos de ação bloqueada

Forma abreviada: N/A

Uma lista separada por vírgula dos módulos de ação que não podem ser executados no documento do componente. Se um documento contiver um módulo de ação bloqueado, a validação falhará.

--document-s3-proprietário do bucket

Forma abreviada: N/A

ID da conta de origem dos URI-based documentos do S3 fornecidos.

--documentos ./doc-1.yaml,./doc-n.yaml

Forma abreviada: -d ./doc-1.yaml,./doc-n

Os documentos do componente (obrigatório). Esse parâmetro contém uma lista separada por vírgulas de localizações de arquivos para os documentos do componente YAML serem executados, sem espaços entre os itens. Localizações válidas incluem:

caminhos de arquivo locais (./component-doc-example.yaml)
URIs do S3 (s3://bucket/key)
ARNs da versão de compilação do componente Image Builder (arn:aws:imagebuilder:us-west-/ /2021.12. 2:123456789012 my-example-component 02/1)

Opções

--help

Forma abreviada: -h

Exibe um manual de ajuda para usar as opções do aplicativo de gerenciamento de componentes.

--trace

Forma abreviada: -t

Ativa o registro detalhado no console do.

Output

O validate comando produz um resultado de validação JSON. O exemplo a seguir mostra a saída de uma validação bem-sucedida.


{
    "validationStatus": "success",
    "message": "Validation successful."
}

O exemplo a seguir mostra a saída quando a validação falha.


{
    "validationStatus": "failed",
    "message": "Document has 0 phases. Phases list must not be empty."
}

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Criar componentes personalizados com o Image Builder

Configuração manual