Configurare l'input per il comando AWSTOE run

Per semplificare l'input da riga di comando per il AWSTOE run comando, è possibile includere le impostazioni per i parametri e le opzioni del comando in un file di configurazione di input di JSON formato con estensione di file. .json AWSTOE può leggere il file da una delle seguenti posizioni:

• Un percorso di file locale (./config.json).

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

Quando si immette il run comando, è possibile specificare il file di configurazione di input utilizzando il --config parametro. Per esempio:

awstoe run --config <file-path>/config.json

File di configurazione di input

Il JSON file di configurazione di input include coppie chiave-valore per tutte le impostazioni che è possibile fornire direttamente tramite i parametri e le opzioni dei run comandi. Se specificate un'impostazione sia nel file di configurazione di input che nel run comando, come parametro o opzione, si applicano le seguenti regole di precedenza:

Regole di precedenza

1. Un'impostazione fornita direttamente al run comando in AWS CLI, tramite un parametro o un'opzione, sovrascrive qualsiasi valore definito nel file di configurazione di input per la stessa impostazione.

2. Un'impostazione nel file di configurazione di input sovrascrive il valore predefinito di un componente.

3. Se non vengono passate altre impostazioni nel documento del componente, è possibile applicare un valore predefinito, se esistente.

Esistono due eccezioni a questa regola: documenti e parametri. Queste impostazioni funzionano in modo diverso nella configurazione di input e come parametri di comando. Se si utilizza il file di configurazione di input, non è necessario specificare questi parametri direttamente nel run comando. Questa operazione genererà un errore.

Impostazioni dei componenti

Il file di configurazione di input contiene le seguenti impostazioni. Per semplificare il file, puoi omettere tutte le impostazioni opzionali che non sono necessarie. Tutte le impostazioni sono opzionali se non diversamente specificato.

• cwIgnoreFailures(Boolean) — Ignora gli errori di registrazione nei log. CloudWatch

• cwLogGroup(String) — Il nome dei log. LogGroup CloudWatch

• cwLogRegion(String) — La AWS regione che si applica ai CloudWatch registri.

• cwLogStream(String) — Il LogStream nome dei CloudWatch log, che indica AWSTOE dove trasmettere il file. console.log

• documentS3 BucketOwner (String) — L'ID dell'account del proprietario del bucket per i documenti basati su S3. URI

• documents (array di oggetti, obbligatorio) — Un array di JSON oggetti che rappresentano i documenti YAML componenti utilizzati dal AWSTOE run comando. È necessario specificare almeno un documento componente.

  Ogni oggetto è composto dai seguenti campi:

  • path (String, required) — La posizione del file del documento YAML componente. Deve essere uno dei seguenti:

    • Un percorso di file locale (./component-doc-example.yaml).

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

    • Una versione di build del componente Image Builder ARN (arn:aws:imagebuilder:us-west-2:123456789012³/my-example-component/2021,12/1).

  • parameters (array di oggetti) — Una matrice di oggetti a coppie chiave-valore, ciascuno dei quali rappresenta un parametro specifico del componente che il comando trasmette quando esegue il run documento del componente. I parametri sono facoltativi per i componenti. Il documento del componente può avere o meno dei parametri definiti.

    Ogni oggetto è composto dai seguenti campi:

    • name (String, required) — Il nome del parametro del componente.

    • value (String, required) — Il valore da passare al documento del componente per il parametro denominato.

    Per ulteriori informazioni sui parametri del componente, consulta la sezione Parametri della Usa le variabili nel tuo documento componente personalizzato pagina.

• executonId(Stringa) — Questo è l'ID univoco che si applica all'esecuzione del run comando corrente. Questo ID è incluso nei nomi dei file di output e di registro, per identificare in modo univoco tali file e collegarli all'esecuzione corrente del comando. Se questa impostazione viene omessa, AWSTOE genera unGUID.

• logDirectory(String) — La directory di destinazione in cui vengono AWSTOE archiviati tutti i file di registro dell'esecuzione di questo comando. Per impostazione predefinita, questa directory si trova all'interno della seguente directory principale:TOE_<DATETIME>_<EXECUTIONID>. Se non si specifica la directory di registro, AWSTOE utilizza la directory di lavoro corrente (.).

• LogS3 BucketName (String) — Se i log dei componenti sono archiviati in Amazon S3 (consigliato), AWSTOE carica i log delle applicazioni dei componenti nel bucket S3 denominato in questo parametro.

• LogS3 BucketOwner (String): se i log dei componenti sono archiviati in Amazon S3 (consigliato), questo è l'ID dell'account proprietario per il bucket in cui vengono scritti i file di registro. AWSTOE

• LogS3 KeyPrefix (String): se i log dei componenti sono archiviati in Amazon S3 (consigliato), questo è il prefisso della chiave dell'oggetto S3 per la posizione del registro nel bucket.

• parameters (array di oggetti) — Un array di oggetti a coppie chiave-valore che rappresentano parametri che si applicano globalmente a tutti i componenti inclusi nell'esecuzione corrente del comando. run

  • name (String, required) — Il nome del parametro globale.

  • value (String, required) — Il valore da passare a tutti i documenti componenti per il parametro denominato.

• phases (String) — Un elenco separato da virgole che specifica quali fasi eseguire dai documenti dei componenti. YAML Se un documento componente include fasi aggiuntive, queste non verranno eseguite.

• stateDirectory(String) — Il percorso del file in cui sono archiviati i file di tracciamento dello stato.

• trace (Boolean) — Abilita la registrazione dettagliata sulla console.

Esempi

L'esempio seguente mostra un file di configurazione di input che esegue le test fasi build and per due documenti componenti:, e. sampledoc.yaml conversation-intro.yaml Ogni documento componente ha un parametro che si applica solo a se stesso ed entrambi utilizzano un parametro condiviso. Il project parametro si applica a entrambi i documenti componenti.

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