AWSTOE downloads Regioni supportate Riferimento ai comandi

In che modo Image Builder utilizza AWS Task Orchestrator and Executor applicazione per gestire i componenti

EC2 Image Builder AWS Task Orchestrator and Executor utilizza AWSTOE l'applicazione () per orchestrare flussi di lavoro complessi, modificare le configurazioni di sistema e testare le immagini senza la necessità di script o codice devops aggiuntivi. Questa applicazione gestisce ed esegue componenti che implementano lo schema dichiarativo del documento.

AWSTOE è un'applicazione autonoma che Image Builder installa nelle sue istanze di build e test quando si crea un'immagine. Puoi anche installarla manualmente sulle istanze EC2 per creare componenti personalizzati. Non richiede alcuna configurazione aggiuntiva e può essere eseguito anche in locale.

Indice

AWSTOE downloads

Per l'installazione AWSTOE, scegli il link per il download adatto alla tua architettura e piattaforma. Se ti colleghi a un endpoint VPC per il tuo servizio (Image Builder, ad esempio), devi allegare una policy endpoint personalizzata che includa l'accesso al bucket S3 per i download. AWSTOE In caso contrario, le istanze di build e test non saranno in grado di scaricare lo script bootstrap () e installare l'applicazione. bootstrap.sh AWSTOE Per ulteriori informazioni, consulta Crea una policy per gli endpoint VPC per Image Builder.

Importante

AWS sta eliminando gradualmente il supporto per le versioni TLS 1.0 e 1.1. Per accedere al bucket S3 per i AWSTOE download, il software client deve utilizzare la versione TLS 1.2 o successiva. Per ulteriori informazioni, consulta questo post sul blog AWS sulla sicurezza.

Architecture	Platform (Piattaforma)	Collegamento per il download	Esempio
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

Regioni supportate

AWSTOE è supportata come applicazione autonoma nelle seguenti regioni.

Regione AWS nome	Regione AWS
Stati Uniti orientali (Ohio)	us-east-2
US East (N. Virginia)	us-east-1
AWS GovCloud (US-East)	us-gov-east-1
AWS GovCloud (US-West)	us-gov-west-1
Stati Uniti occidentali (California settentrionale)	us-west-1
US West (Oregon)	us-west-2
Africa (Città del Capo)	af-south-1
Asia Pacific (Hong Kong)	ap-east-1
Asia Pacifico (Osaka-Locale)	ap-northeast-3
Asia Pacifico (Seoul)	ap-northeast-2
Asia Pacifico (Mumbai)	ap-south-1
Asia Pacifico (Hyderabad)	ap-south-2
Asia Pacifico (Singapore)	ap-southeast-1
Asia Pacific (Sydney)	ap-southeast-2
Asia Pacifico (Giacarta)	ap-southeast-3
Asia Pacifico (Tokyo)	ap-northeast-1
Canada (Central)	ca-central-1
Europa (Francoforte)	eu-central-1
Europa (Zurigo)	eu-central-2
Europa (Stoccolma)	eu-north-1
Europe (Milan)	eu-south-1
Europa (Spagna)	eu-south-2
Europa (Irlanda)	eu-west-1
Europe (London)	eu-west-2
Europe (Paris)	eu-west-3
Israele (Tel Aviv)	il-central-1
Medio Oriente (Emirati Arabi Uniti)	me-central-1
Medio Oriente (Bahrein)	me-south-1
Sud America (San Paolo)	sa-east-1
Cina (Pechino)	cn-north-1
China (Ningxia)	cn-northwest-1

AWSTOE riferimento ai comandi

AWSTOE è un'applicazione di gestione dei componenti a riga di comando che viene eseguita su istanze Amazon EC2. Quando Image Builder avvia una build o un'istanza di test EC2, viene installata AWSTOE sull'istanza. Quindi esegue AWSTOE i comandi AWS CLI per installare o convalidare i componenti specificati nell'immagine o nella ricetta del contenitore.

Nota

Alcuni moduli di AWSTOE azione richiedono autorizzazioni elevate per essere eseguiti su un server Linux. Per utilizzare autorizzazioni elevate, inserisci come prefisso la sintassi del comando o esegui sudo il sudo su comando una sola volta quando accedi prima di eseguire i comandi collegati di seguito. Per ulteriori informazioni sui moduli di AWSTOE azione, vedere. Moduli d'azione supportati da AWSTOE gestore dei componenti

run: Utilizzate il run comando per eseguire gli script dei documenti YAML per uno o più documenti componenti.
validate: Esegui il validate comando per convalidare la sintassi del documento YAML per uno o più documenti componenti.

comando awstoe run

Questo comando esegue gli script dei documenti dei componenti YAML nell'ordine in cui sono inclusi nel file di configurazione specificato dal --config parametro o nell'elenco dei documenti dei componenti specificato dal parametro. --documents

Nota

È necessario specificare esattamente uno dei seguenti parametri, mai entrambi:

--config

--documenti

Sintassi


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]

Parametri e opzioni

Parameters

--config ./config-example.json

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

Il file di configurazione (condizionale). Questo parametro contiene la posizione del file JSON che contiene le impostazioni di configurazione per i componenti in esecuzione con questo comando. Se si specificano le impostazioni dei run comandi in un file di configurazione, non è necessario specificare il --documents parametro. Per ulteriori informazioni sulla configurazione degli input, vedereConfigurare l'input per il AWSTOE comando run.

Le località valide includono:

Un percorso di file locale (./config-example.json)
Un URI S3 () s3://bucket/key

--cw-ignore-failures

Forma breve: N/A

Ignora gli errori di registrazione nei registri. CloudWatch

--cw-log-group

Forma breve: N/A

Il LogGroup nome per i CloudWatch log.

--cw-log-region

Forma breve: N/A

La AWS regione che si applica ai CloudWatch registri.

--cw-log-stream

Forma breve: N/A

Il LogStream nome dei CloudWatch log, che indica AWSTOE dove trasmettere il console.log file.

--document-s3-bucket-owner

Forma breve: N/A

L'ID dell'account del proprietario del bucket per i documenti S3 URI-based .

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

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

I documenti componenti (condizionali). Questo parametro contiene un elenco separato da virgole di posizioni di file per l'esecuzione dei documenti del componente YAML. Se si specificano documenti YAML per il run comando utilizzando il --documents parametro, non è necessario specificare il parametro. --config Non includete spazi tra gli elementi dell'elenco.

Le posizioni valide includono:

percorsi di file locali (./component-doc-example.yaml).
URI S3 ()s3://bucket/key.
ARN della versione di build del componente Image Builder (arn:aws:imagebuilder:us-west/ /2021.12. 2:123456789012 my-example-component 02/1).

--id-esecuzione

Forma breve: -i

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 un GUID.

--log-directory

Forma breve: -l

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 (.).

--log-s3-bucket-name

Forma breve: -b

Se i log dei componenti sono archiviati in Amazon S3 (consigliato) AWSTOE , carica i log delle applicazioni dei componenti nel bucket S3 indicato in questo parametro.

--log-s3-bucket-owner

Forma breve: N/A

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

--log-s3-key-prefix

Forma breve: -k

Se i log dei componenti sono archiviati in Amazon S3 (consigliato), questo è il prefisso della chiave oggetto S3 per la posizione del registro nel bucket.

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

Forma breve: N/A

I parametri sono variabili mutabili definite nel documento del componente, con impostazioni che l'applicazione chiamante può fornire in fase di esecuzione.

--phases

Forma breve: -p

Un elenco separato da virgole che specifica quali fasi eseguire dai documenti del componente YAML. Se un documento componente include fasi aggiuntive, queste non verranno eseguite.

--state-directory

Forma breve: -s

Il percorso del file in cui sono archiviati i file di tracciamento dello stato.

--blocked-action-modules

Forma breve: N/A

Un elenco separato da virgole di moduli di azione che non possono essere eseguiti nel documento del componente. Se un documento contiene un modulo di azioni bloccato, la convalida fallisce prima dell'inizio dell'esecuzione.

--version

Forma breve: -v

Specifica la versione dell'applicazione del componente.

Opzioni

--help

Forma breve: -h

Visualizza un manuale di aiuto per l'utilizzo delle opzioni dell'applicazione di gestione dei componenti.

--trace

Forma breve: -t

Abilita la registrazione dettagliata sulla console.

Output

Il run comando produce un riepilogo dell'esecuzione JSON. L'esempio seguente mostra l'output di un'esecuzione riuscita.


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

Il status campo riporta il risultato complessivo dell'esecuzione:

success— Tutte le fasi e i passaggi sono stati completati con successo.
failed— Uno o più passaggi non sono riusciti perché l'onFailureazione èAbort.
timedOut— Uno o più passaggi hanno superato il loro timeoutSeconds valore.

comando awstoe validate

Quando si esegue questo comando, convalida la sintassi del documento YAML per ciascuno dei documenti componenti specificati dal parametro. --documents

Sintassi


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

Parametri e opzioni

Parameters

--blocked-action-modules

Forma breve: N/A

Un elenco separato da virgole di moduli di azione che non possono essere eseguiti nel documento del componente. Se un documento contiene un modulo di azioni bloccato, la convalida ha esito negativo.

--document-s3-bucket-owner

Forma breve: N/A

ID dell'account di origine dei URI-based documenti S3 fornito.

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

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

I documenti che lo compongono (obbligatorio). Questo parametro contiene un elenco separato da virgole delle posizioni dei file in cui eseguire i documenti del componente YAML, senza spazi tra gli elementi. Le posizioni valide includono:

percorsi di file locali (./component-doc-example.yaml)
URI S3 () s3://bucket/key
ARN della versione di build del componente Image Builder (arn:aws:imagebuilder:us-west/ /2021.12. 2:123456789012 my-example-component 02/1)

Opzioni

--help

Forma breve: -h

Visualizza un manuale di aiuto per l'utilizzo delle opzioni dell'applicazione di gestione dei componenti.

--trace

Forma breve: -t

Abilita la registrazione dettagliata sulla console.

Output

Il validate comando produce un risultato di convalida JSON. L'esempio seguente mostra l'output di una convalida riuscita.


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

L'esempio seguente mostra l'output quando la convalida fallisce.


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

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Crea componenti personalizzati con Image Builder

Configurazione manuale