Configurar la entrada para el comando TOE de AWS run - Generador de Imágenes de EC2

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.

Configurar la entrada para el comando TOE de AWS run

Para agilizar la entrada de su TOE de AWS run comando desde la línea de comandos, puede incluir los ajustes de los parámetros y opciones de los comandos en un archivo de configuración de entrada en formato JSON con una extensión de .json archivo. TOE de AWS puede leer el archivo desde una de las siguientes ubicaciones:

  • Una ruta de archivos local (./config.json).

  • Un bucket de S3 (s3://<bucket-path>/<bucket-name>/config.json).

Cuando introduce el comando run, puede especificar el archivo de configuración de entrada mediante el parámetro --config. Por ejemplo:

awstoe run --config <file-path>/config.json
Archivo de configuración de entrada

El archivo JSON de configuración de entrada incluye pares clave-valor para todos los ajustes que puede proporcionar directamente a través de los parámetros y las opciones de los comandos run. Si especifica un ajuste tanto en el archivo de configuración de entrada como en el comando run, como parámetro u opción, se aplicarán las siguientes reglas de prioridad:

Reglas de prioridad

  1. Un ajuste que se proporciona directamente al run comando en el AWS CLI, mediante un parámetro o una opción, anula cualquier valor que esté definido en el archivo de configuración de entrada para el mismo ajuste.

  2. Un parámetro del archivo de configuración de entrada anula el valor predeterminado de un componente.

  3. Si no se pasa ninguna otra configuración al documento del componente, se puede aplicar un valor por defecto, si lo hay.

Hay dos excepciones a esta regla: los documentos y los parámetros. Estos ajustes funcionan de forma diferente en la configuración de entrada y como parámetros de comando. Si utiliza el archivo de configuración de entrada, no debe especificar estos parámetros directamente en el comando run. Si lo hace, se generará un error.

Ajustes de los componentes

El archivo de configuración de entrada contiene los siguientes ajustes. Para simplificar el archivo, puede omitir cualquier configuración opcional que no sea necesaria. Todos los ajustes son opcionales, a menos que se indique lo contrario.

  • cwIgnoreFailures(Booleano): ignore los errores de registro de los registros. CloudWatch

  • cwLogGroup(String): el LogGroup nombre de los CloudWatch registros.

  • cwLogRegion(Cadena): la AWS región que se aplica a los CloudWatch registros.

  • cwLogStream(Cadena): el LogStream nombre de los CloudWatch registros, que indica TOE de AWS dónde se debe transmitir el console.log archivo.

  • DocumentS3 BucketOwner (String): el ID de cuenta del propietario del bucket para los documentos basados en URI de S3.

  • documentos (conjunto de objetos, obligatorio): conjunto de objetos JSON que representa los documentos del componente YAML que ejecuta el TOE de AWS run comando. Debe especificarse al menos un documento componente.

    Cada objeto consiste en los siguientes campos:

    • Ruta (cadena, obligatoria): la ubicación del archivo del documento del componente YAML. Este debe ser uno de los siguientes:

      • Una ruta de archivo local (. /component-doc-example.yaml).

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

      • Versión de compilación de un componente de Image Builder ARN (arn:aws:imagebuilder:us-west- 2:123456789012:component/ /2021.12.02/1). my-example-component

    • Parámetros (matriz de objetos): matriz de objetos de pares clave-valor, cada uno de los cuales representa un parámetro específico del componente que el comando run transfiere al ejecutar el documento del componente. Los parámetros son opcionales para los componentes. El documento componente puede o no tener parámetros definidos.

      Cada objeto consiste en los siguientes campos:

      • Nombre (cadena, obligatorio): el nombre del parámetro del componente.

      • Valor (cadena, obligatorio): el valor que se va a transferir al documento del componente para el parámetro nombrado.

      Para obtener más información sobre los parámetros de los componentes, consulte la sección Parámetros de la página Utilice variables en su documento de componentes personalizados.

  • executonID (cadena): 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 TOE de AWS omite esta configuración, genera un GUID.

  • LogDirectory (String): 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 (.).

  • LogS3 BucketName (String): si los registros de los componentes están almacenados 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.

  • LogS3 BucketOwner (String): si los registros de los componentes se almacenan en Amazon S3 (recomendado), este es el ID de cuenta propietario del depósito donde se TOE de AWS escriben los archivos de registro.

  • LogS3 KeyPrefix (String): 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.

  • Parámetros (matriz de objetos): una matriz de objetos de pares clave-valor que representan parámetros que se aplican globalmente a todos los componentes que se incluyen en la ejecución del comando run actual.

    • Nombre (cadena, obligatorio): el nombre del parámetro global.

    • Valor (cadena, obligatorio): el valor que se va a transferir a todos los documentos de componentes del parámetro nombrado.

  • Fases (cadena): una lista separada por comas que especifica qué fases se van a ejecutar desde los documentos de componentes de YAML. Si un documento de componentes incluye fases adicionales, no se ejecutarán.

  • StateDirectory (cadena): la ruta del archivo donde se almacenan los archivos de seguimiento de estado.

  • Huella (booleano): permite el registro detallado en la consola.

Ejemplos

El siguiente ejemplo muestra un archivo de configuración de entrada que ejecuta las fases build y test de dos documentos componentes: sampledoc.yaml y conversation-intro.yaml. Cada documento componente tiene un parámetro que se aplica solo a sí mismo y ambos utilizan un parámetro compartido. El parámetro project se aplica a ambos documentos componentes.

{
   "documents": [
     {
       "path": "<file path>/awstoe/sampledoc.yaml>",
       "parameters": [
         {
           "name": "dayofweek",
           "value": "Monday"
         }
       ]
     },
     {
       "path": "<file path>/awstoe/conversation-intro.yaml>",
       "parameters": [
         {
           "name": "greeting",
           "value": "Hello, HAL."
         }
       ]
     }
   ],
   "phases": "build,test",
   "parameters": [
     {
       "name": "project",
       "value": "examples"
     }
   ],
   "cwLogGroup": "<log_group_name>",
   "cwLogStream": "<log_stream_name>",
   "documentS3BucketOwner": "<owner_aws_account_number>",
   "executionId": "<id_number>",
   "logDirectory": "<local_directory_path>",
   "logS3BucketName": "<bucket_name_for_log_files>",
   "logS3KeyPrefix": "<key_prefix_for_log_files>",
   "logS3BucketOwner": "<owner_aws_account_number>"
 }