View a markdown version of this page

Cómo utiliza Image Builder el Ejecutor y orquestador de tareas de AWS aplicación para gestionar componentes - Generador de Imágenes de EC2
TOE de AWS downloadsRegiones admitidasReferencia de los comandos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Cómo utiliza Image Builder el Ejecutor y orquestador de tareas de AWS aplicación para gestionar componentes

EC2 Image Builder utiliza Ejecutor y orquestador de tareas de AWS la aplicación TOE de AWS() para organizar flujos de trabajo complejos, modificar las configuraciones del sistema y probar las imágenes sin necesidad de códigos o scripts de DevOps adicionales. Esta aplicación administra y ejecuta los componentes que implementan su esquema de documento declarativo.

TOE de AWS es una aplicación independiente que Image Builder instala en sus instancias de compilación y prueba al crear una imagen. También puede instalarla manualmente en instancias de EC2 para crear sus propios componentes personalizados. No requiere ninguna configuración adicional y también se puede ejecutar en las instalaciones.

Contenido

TOE de AWS downloads

Para instalarlo TOE de AWS, elija el enlace de descarga correspondiente a su arquitectura y plataforma. Si se conecta a un punto final de VPC para su servicio (Image Builder, por ejemplo), debe tener una política de punto final personalizada adjunta que incluya el acceso al depósito de S3 para TOE de AWS las descargas. De lo contrario, las instancias de compilación y prueba no podrán descargar el script de arranque (bootstrap.sh) ni instalar la TOE de AWS aplicación. Para obtener más información, consulte Creación de una política de puntos de conexión de VPC para Generador de Imágenes.

importante

AWS está eliminando gradualmente la compatibilidad con las versiones 1.0 y 1.1 de TLS. Para acceder al depósito de S3 para realizar TOE de AWS descargas, el software de su cliente debe usar la versión 1.2 o posterior de TLS. Para obtener más información, consulte esta entrada de blog de seguridad de AWS.

Arquitectura Plataforma Enlace de descarga Ejemplo
386

AL 2 y 2023

RHEL 7, 8 y 9

Ubuntu 16.04, 18.04, 20.04, 22.04 y 24.04

CentOS 7 y 8

SUSE 12 y 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 y 2023

RHEL 7, 8 y 9

Ubuntu 16.04, 18.04, 20.04, 22.04 y 24.04

CentOS 7 y 8

Flujo 8 de CentOS

SUSE 12 y 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 y 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 y 2023

RHEL 7, 8 y 9

Ubuntu 16.04, 18.04, 20.04, 22.04 y 24.04

CentOS 7 y 8

Flujo 8 de CentOS

SUSE 12 y 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

Regiones admitidas

TOE de AWS se admite como aplicación independiente en las siguientes regiones.

Región de AWS nombre Región de AWS

Este de EE. UU. (Ohio)

us-east-2

Este de EE. UU. (Norte de Virginia)

us-east-1

AWS GovCloud (US-East)

us-gov-east-1

AWS GovCloud (US-West)

us-gov-west-1

Oeste de EE. UU. (Norte de California)

 us-west-1

Oeste de EE. UU. (Oregón)

 us-west-2

África (Ciudad del Cabo)

 af-south-1

Asia-Pacífico (Hong Kong)

 ap-east-1

Asia-Pacífico (Osaka)

 ap-northeast-3

Asia-Pacífico (Seúl)

 ap-northeast-2

Asia Pacífico (Mumbai)

 ap-south-1

Asia-Pacífico (Hyderabad)

 ap-south-2

Asia-Pacífico (Singapur)

 ap-southeast-1

Asia-Pacífico (Sídney)

 ap-southeast-2

Asia-Pacífico (Yakarta)

 ap-southeast-3

Asia-Pacífico (Tokio)

 ap-northeast-1

Canadá (centro)

 ca-central-1

Europa (Fráncfort)

 eu-central-1

Europa (Zúrich)

 eu-central-2

Europa (Estocolmo)

 eu-north-1

Europa (Milán)

 eu-south-1

Europa (España)

 eu-south-2

Europa (Irlanda)

 eu-west-1

Europa (Londres)

 eu-west-2

Europa (París)

 eu-west-3

Israel (Tel Aviv)

 il-central-1

Medio Oriente (EAU)

 me-central-1

Medio Oriente (Baréin)

 me-south-1

América del Sur (São Paulo)

 sa-east-1

China (Pekín)

 cn-north-1

China (Ningxia)

 cn-northwest-1

TOE de AWS Referencia de los comandos  

TOE de AWS es una aplicación de administración de componentes de línea de comandos que se ejecuta en instancias de Amazon EC2. Cuando Image Builder lanza una instancia de compilación o prueba de EC2, se instala TOE de AWS en la instancia. A continuación, ejecuta TOE de AWS los comandos AWS CLI para instalar o validar los componentes que se especifican en la receta de la imagen o del contenedor.

nota

Algunos módulos de TOE de AWS acción requieren permisos elevados para ejecutarse en un servidor Linux. Para usar permisos elevados, añada el prefijo a la sintaxis del comando con sudo o ejecute el comando sudo su una vez al iniciar sesión antes de ejecutar los comandos que aparecen a continuación. Para obtener más información sobre los módulos de TOE de AWS acción, consulteMódulos de acción respaldados por TOE de AWS administrador de componentes.

run

Use el comando run para ejecutar los scripts de documentos de YAML para uno o más documentos componentes.

validar

Ejecute el comando validate para validar la sintaxis del documento YAML de uno o más documentos componentes.

comando awstoe run

Este comando ejecuta los scripts de los documentos de componentes de YAML en el orden en que se incluyen en el archivo de configuración especificado por el parámetro --config o en la lista de documentos de componentes especificada por el parámetro --documents.

nota

Debe especificar exactamente uno de los siguientes parámetros, nunca ambos:

--config

--documents

Sintaxis

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 y opciones

Parameters
--config ./config-example.json

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

El archivo de configuración (condicional). Este parámetro contiene la ubicación del archivo JSON que contiene los ajustes de configuración de los componentes que ejecuta este comando. Si especifica los ajustes del comando run en un archivo de configuración, no debe especificar el parámetro --documents. Para obtener más información sobre la configuración de entrada, consulte Configure la entrada para el TOE de AWS comando run.

Los campos de ubicación válidos se incluyen:

  • Una ruta de archivo local (./config-example.json)

  • Un URI de S3 (s3://bucket/key)

--cw-ignore-failures

Forma abreviada: N/A

Ignore los errores de registro de los CloudWatch registros.

--cw-log-group

Forma abreviada: N/A

El LogGroup nombre de los CloudWatch registros.

--cw-log-region

Forma abreviada: N/A

La AWS región que se aplica a los CloudWatch registros.

--cw-log-stream

Forma abreviada: N/A

El LogStream nombre de los CloudWatch registros, que indica TOE de AWS dónde transmitir el console.log archivo.

--document-s3-bucket-owner

Forma abreviada: N/A

El ID de cuenta del propietario del bucket para los URI-based documentos de S3.

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

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

Los documentos componentes (condicionales). Este parámetro contiene una lista de ubicaciones de archivos separadas por comas para que se ejecuten los documentos del componente YAML. Si especifica documentos YAML para el comando run mediante el parámetro --documents, no debe especificar el parámetro --config. No incluya espacios entre los elementos de la lista.

Los campos de ubicación válidos se incluyen:

  • rutas de archivos locales (./component-doc-example.yaml).

  • URI de S3 (s3://bucket/key).

  • ARN de la versión de compilación del componente Image Builder (arn:aws:imagebuilder:us-west-:component/ /2021.12. 2:123456789012 my-example-component 02/1).

--execution-id

Forma abreviada: -i

Este es el identificador único que se aplica a la ejecución del comando run actual. Este identificador se incluye en los nombres de los archivos de salida y de registro para identificarlos de forma exclusiva y vincularlos a la ejecución del comando actual. Si se omite esta configuración, TOE de AWS genera un GUID.

--log-directory

Forma abreviada: -i

El directorio de destino donde se TOE de AWS almacenan todos los archivos de registro de la ejecución de este comando. De forma predeterminada, este directorio está ubicado en el siguiente directorio principal: TOE_<DATETIME>_<EXECUTIONID>. Si no especifica el directorio de registro, TOE de AWS utiliza el directorio de trabajo actual (.).

--log-s3-nombre de bucket

Forma abreviada: -b

Si los registros de los componentes se almacenan en Amazon S3 (recomendado), TOE de AWS carga los registros de las aplicaciones de los componentes en el bucket de S3 mencionado en este parámetro.

--log-s3-bucket-owner

Forma abreviada: N/A

Si los registros de los componentes se almacenan en Amazon S3 (recomendado), este es el ID de la cuenta del propietario del depósito en el que se TOE de AWS escriben los archivos de registro.

--log-s3-key-prefix

Forma abreviada: -k

Si los registros de los componentes se almacenan en Amazon S3 (recomendado), este es el prefijo de clave de objeto S3 para la ubicación del registro en el bucket.

--parameters name1 =value1, name2 =value2...

Forma abreviada: N/A

Los parámetros son variables mutables que se definen en el documento del componente, con ajustes que la aplicación que realiza la llamada puede proporcionar en el tiempo de ejecución.

--phases

Forma abreviada: -p

Una lista separada por comas que especifica qué fases se van a ejecutar desde los documentos de los componentes de YAML. Si un documento de componentes incluye fases adicionales, no se ejecutarán.

--directorio de estados

Forma abreviada: -s

La ruta del archivo donde se almacenan los archivos de seguimiento de estado.

--módulos de acción bloqueados

Forma abreviada: N/A

Lista de módulos de acción separados por comas que no se pueden ejecutar en el documento componente. Si un documento contiene un módulo de acción bloqueado, la validación fallará antes de que comience la ejecución.

--version

Forma abreviada: -v

Especifica la versión de la aplicación del componente.

Opciones
--help

Forma abreviada: -h

Muestra un manual de ayuda para utilizar las opciones de la aplicación de administración de componentes.

--trace

Forma abreviada: -t

Permite el registro detallado en la consola.

Output

El run comando produce un resumen de la ejecución en JSON. El siguiente ejemplo muestra el resultado de una ejecución correcta.

{
    "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"
}

El status campo informa del resultado general de la ejecución:

  • success— Todas las fases y pasos se completaron correctamente.

  • failed— Uno o más pasos fallaron porque la onFailure acción esAbort.

  • timedOut— Uno o más pasos superaron su timeoutSeconds valor.

comando awstoe validate

Al ejecutar este comando, valida la sintaxis del documento YAML para cada uno de los documentos componentes especificados por el parámetro --documents.

Sintaxis

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

Parámetros y opciones

Parameters
--módulos de acción bloqueados

Forma abreviada: N/A

Lista de módulos de acción separados por comas que no se pueden ejecutar en el documento componente. Si un documento contiene un módulo de acción bloqueado, se produce un error en la validación.

--document-s3-bucket-owner

Forma abreviada: N/A

ID de cuenta de origen de los URI-based documentos de S3 proporcionados.

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

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

Los documentos que lo componen (obligatorios). Este parámetro contiene una lista de ubicaciones de archivos separadas por comas para que se ejecuten los documentos del componente YAML, sin espacios entre los elementos. Los campos de ubicación válidos se incluyen:

  • rutas de archivos locales () ./component-doc-example.yaml

  • URI de S3 (s3://bucket/key)

  • ARN de la versión de compilación del componente Image Builder (arn:aws:imagebuilder:us-west-:component/ /2021.12. 2:123456789012 my-example-component 02/1)

Opciones
--help

Forma abreviada: -h

Muestra un manual de ayuda para utilizar las opciones de la aplicación de administración de componentes.

--trace

Forma abreviada: -t

Permite el registro detallado en la consola.

Output

El validate comando produce un resultado de validación de JSON. El siguiente ejemplo muestra el resultado de una validación correcta.

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

En el siguiente ejemplo, se muestra el resultado cuando se produce un error en la validación.

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