Riferimento al file di configurazione di App Runner

Nota

I file di configurazione sono applicabili solo ai servizi basati sul codice sorgente. Non è possibile utilizzare i file di configurazione con servizi basati su immagini.

Questo argomento è una guida di riferimento completa alla sintassi e alla semantica di un file di configurazione. AWS App Runner Per una panoramica dei file di configurazione di App Runner, vedere. Impostazione delle opzioni del servizio App Runner utilizzando un file di configurazione

Il file di configurazione di App Runner è un file YAML. Assegnagli un apprunner.yaml nome e inseriscilo nella directory dei sorgenti del repository dell'applicazione.

Panoramica della struttura

Il file di configurazione di App Runner è un file YAML. Assegnagli un apprunner.yaml nome e inseriscilo nella directory dei sorgenti del repository dell'applicazione.

Il file di configurazione di App Runner contiene le seguenti parti principali:

• Sezione superiore: contiene le chiavi di primo livello

• Sezione di compilazione: configura la fase di compilazione

• Sezione Esegui: configura la fase di runtime

Sezione superiore

Le chiavi nella parte superiore del file forniscono informazioni generali sul file e sul runtime del servizio. Sono disponibili le seguenti chiavi:

• version— Obbligatorio. La versione del file di configurazione di App Runner. Idealmente, usa la versione più recente.

  Sintassi

  version: version

  Esempio

  version: 1.0

• runtime— Richiesto. Il nome del runtime utilizzato dall'applicazione. Per informazioni sui runtime disponibili per le diverse piattaforme di programmazione offerte da App Runner, consulta. Servizio App Runner basato su codice sorgente

  Nota

  La convenzione di denominazione di un runtime gestito è. <language-name><major-version>

  Sintassi

  runtime: runtime-name

  Esempio

  runtime: python3

Compila la sezione

La sezione build configura la fase di compilazione dell'implementazione del servizio App Runner. È possibile specificare comandi di compilazione e variabili di ambiente. I comandi di compilazione sono obbligatori.

La sezione inizia con la build: chiave e contiene le seguenti sottochiavi:

• commands— Obbligatorio. Speciifica i comandi che App Runner esegue durante le varie fasi di compilazione. Include le seguenti sottochiavi:

  • pre-build— Facoltativo. I comandi che App Runner esegue prima della compilazione. Ad esempio, installa npm dipendenze o librerie di test.

  • build— Obbligatorio. I comandi che App Runner esegue per creare l'applicazione. Ad esempio, usapipenv.

  • post-build— Facoltativo. I comandi che App Runner esegue dopo la compilazione. Ad esempio, usa Maven per impacchettare gli artefatti della build in un file JAR o WAR o per eseguire un test.

  Sintassi

  build:
    commands:
      pre-build:
        - command
        - …
      build:
        - command
        - …
      post-build:
        - command
        - …

  Esempio

  build:
    commands:
      pre-build:
        - yum install openssl
      build:
        - pip install -r requirements.txt
      post-build:
        - python manage.py test

• env— Facoltativo. Specifica variabili di ambiente personalizzate per la fase di compilazione. Definito come mappature scalari nome-valore. Puoi fare riferimento a queste variabili per nome nei comandi di build.

  Nota

  Ci sono due env voci distinte in due posizioni diverse in questo file di configurazione. Un set si trova nella sezione Build e l'altro nella sezione Run.

  • Il env set nella sezione Build può essere referenziato dai pre-run comandipre-build, buildpost-build, e durante il processo di compilazione.

    Importante: si noti che i pre-run comandi si trovano nella sezione Esegui di questo file, anche se possono accedere solo alle variabili di ambiente definite nella sezione Build.

  • Il env set nella sezione Run può essere referenziato dal run comando nell'ambiente di runtime.

  Sintassi

  build:
    env:
      - name: name1
        value: value1
      - name: name2
        value: value2
      - …

  Esempio

  build:
    env:
      - name: DJANGO_SETTINGS_MODULE
        value: "django_apprunner.settings"
      - name: MY_VAR_EXAMPLE
        value: "example"

Sezione Esegui

La sezione run configura la fase di esecuzione del contenitore della distribuzione dell'applicazione App Runner. È possibile specificare la versione di runtime, i comandi pre-esecuzione (solo formato rivisto), il comando di avvio, la porta di rete e le variabili di ambiente.

La sezione inizia con la run: chiave e contiene le seguenti sottochiavi:

• runtime-version— Facoltativo. Specificate una versione di runtime che desiderate bloccare per il servizio App Runner.

  Per impostazione predefinita, solo la versione principale è bloccata. App Runner utilizza le versioni secondarie e le patch più recenti disponibili per il runtime in ogni distribuzione o aggiornamento del servizio. Se si specificano versioni principali e secondarie, entrambe vengono bloccate e App Runner aggiorna solo le versioni patch. Se si specificano versioni principali, secondarie e patch, il servizio è bloccato su una versione di runtime specifica e App Runner non la aggiorna mai.

  Sintassi

  run:
    runtime-version: major[.minor[.patch]]

  Nota

  I runtime di alcune piattaforme hanno componenti di versione diversi. Per i dettagli, consulta gli argomenti specifici della piattaforma.

  Esempio

  runtime: python3
  run:
    runtime-version: 3.7

• pre-run— Facoltativo. Solo utilizzo rivisto della build. Speciifica i comandi che App Runner esegue dopo aver copiato l'applicazione dall'immagine di compilazione all'immagine di esecuzione. È possibile inserire i comandi qui per modificare l'immagine di esecuzione al di fuori della directory. /app Ad esempio, se è necessario installare dipendenze globali aggiuntive che risiedono all'esterno della /app directory, immettete i comandi richiesti in questa sottosezione a tale scopo. Per ulteriori informazioni sul processo di compilazione di App Runner, consulta. Versioni di runtime gestite e build di App Runner

  Nota

  • Importante: anche se i pre-run comandi sono elencati nella sezione Esegui, possono fare riferimento solo alle variabili di ambiente definite nella sezione Build di questo file di configurazione. Non possono fare riferimento alle variabili di ambiente definite in questa sezione Run.

  • Il pre-run parametro è supportato solo dalla build aggiornata di App Runner. Non inserire questo parametro nel file di configurazione se l'applicazione utilizza versioni di runtime supportate dalla build originale di App Runner. Per ulteriori informazioni, consulta Versioni di runtime gestite e build di App Runner.

  Sintassi

  run:
    pre-run:
        - command
        - …

• command— Obbligatorio. Il comando utilizzato da App Runner per eseguire l'applicazione dopo aver completato la compilazione dell'applicazione.

  Sintassi

  run:
    command: command

• network— Facoltativo. Specifica la porta che l'applicazione ascolta. Include le voci seguenti:

  • port— Facoltativo. Se specificato, questo è il numero di porta che l'applicazione ascolta. Il valore predefinito è 8080.

  • env— Facoltativo. Se specificato, App Runner passa il numero di porta al contenitore in questa variabile di ambiente, oltre a (non invece di) passare lo stesso numero di porta nella variabile di ambiente predefinita,PORT. In altre parole, se si specificaenv, App Runner passa il numero di porta in due variabili di ambiente.

  Sintassi

  run:
    network:
      port: port-number
      env: env-variable-name

  Esempio

  run:
    network:
      port: 8000
      env: MY_APP_PORT

• env— Facoltativo. Definizione di variabili di ambiente personalizzate per la fase di esecuzione. Definito come mappature scalari nome-valore. È possibile fare riferimento a queste variabili per nome nell'ambiente di runtime.

  Nota

  In questo file di configurazione sono presenti due env voci distinte in due posizioni diverse. Un set si trova nella sezione Build e l'altro nella sezione Run.

  • Il env set nella sezione Build può essere referenziato dai pre-run comandipre-build, buildpost-build, e durante il processo di compilazione.

    Importante: si noti che i pre-run comandi si trovano nella sezione Esegui di questo file, anche se possono accedere solo alle variabili di ambiente definite nella sezione Build.

  • Il env set nella sezione Run può essere referenziato dal run comando nell'ambiente di runtime.

  Sintassi

  run:
    env:
      - name: name1
        value: value1
      - name: name2
        value: value2   
    secrets:
      - name: name1
        value-from: arn:aws:secretsmanager:region:aws_account_id:secret:secret-id
      - name: name2
        value-from: arn:aws:ssm:region:aws_account_id:parameter/parameter-name
      - …

  Esempio

  run:
    env:
      - name: MY_VAR_EXAMPLE
        value: "example"
    secrets:
      - name: my-secret
        value-from: "arn:aws:secretsmanager:us-east-1:123456789012:secret:testingstackAppRunnerConstr-kJFXde2ULKbT-S7t8xR:username::"
      - name: my-parameter
        value-from: "arn:aws:ssm:us-east-1:123456789012:parameter/parameter-name"
      - name: my-parameter-only-name
        value-from: "parameter-name"