eb config

Descrizione

Gestisce le impostazioni di configurazione attive e le configurazioni salvate dell'ambiente. È possibile utilizzare questo comando per caricare, scaricare o elencare le configurazioni salvate dell'ambiente. È inoltre possibile utilizzarlo per scaricare, visualizzare o aggiornare le impostazioni di configurazione attive.

Se la directory principale contiene un file platform.yaml che specifica una piattaforma personalizzata, questo comando modifica anche le impostazioni di configurazione del generatore. Questa operazione viene eseguita in base ai valori impostati in platform.yaml.

Nota

eb config non visualizza le proprietà di ambiente. Per impostare proprietà di ambiente che puoi leggere dalla tua applicazione, utilizza eb setenv.

Sintassi

Di seguito sono riportate alcune parti della sintassi utilizzata per il comando eb config per funzionare con le impostazioni di configurazione attive dell'ambiente. Per esempi specifici, consulta la sezione Esempi più avanti in questo argomento.

• eb config— Visualizza le impostazioni di configurazione attive dell'ambiente in un editor di testo configurato come variabile di ambiente EDITOR. Quando salvi le modifiche al file e chiudi l'editor, l'ambiente viene aggiornato con le impostazioni delle opzioni nel file.

  Nota

  Se non hai configurato una variabile di ambiente EDITOR, la CLI EB visualizza le impostazioni delle opzioni nell'editor di default per i file YAML.

• eb config environment-name— Visualizza e aggiorna la configurazione per l'ambiente denominato. La configurazione viene visualizzata in un editor di testo configurato o nei file YAML dell'editor predefinito.

• eb config save— Salva le impostazioni di configurazione attive per l'ambiente corrente in .elasticbeanstalk/saved_configs/ con il nome di file[configuration-name].cfg.yml. Per impostazione predefinita, la CLI EB salva le impostazioni di configurazione con un nome di configurazione basato sul nome dell'ambiente. Puoi specificare un nome di configurazione differente includendo l'opzione --cfg con il nome di configurazione desiderato quando esegui il comando.

  Puoi assegnare un tag alla configurazione salvata utilizzando l'opzione --tags.

• eb config --display— Scrive le impostazioni di configurazione attive di un ambiente su stdout anziché su un file. Per impostazione predefinita, vengono visualizzate le impostazioni di configurazione sul terminale.

• eb config --update configuration_string | file_path— Aggiorna le impostazioni di configurazione attive per l'ambiente corrente con le informazioni specificate in configuration_string o all'interno del file identificato da file_path.

Nota

Le opzioni --display e --update offrono flessibilità per la lettura e la revisione delle impostazioni di configurazione di un ambiente a livello di programmazione.

Quanto segue descrive la sintassi per l'utilizzo del comando eb config con le configurazioni salvate. Per alcuni esempi, consulta la sezione Esempi più avanti in questo argomento.

• eb config get config-name— Scarica la configurazione salvata con nome da Amazon S3.

• eb config delete config-name — Elimina la configurazione salvata con nome da Amazon S3. La elimina anche localmente, se lo hai già scaricato.

• eb config list – Elenca le configurazioni salvate presenti in Amazon S3.

• eb config put filename – Carica la configurazione salvata con nome in un bucket Amazon S3. Il nome di file deve avere l'estensione .cfg.yml. Per specificare il nome di file senza un percorso, puoi salvare il file nella cartella .elasticbeanstalk o nella cartella .elasticbeanstalk/saved_configs/ prima di eseguire il comando. In alternativa, puoi specificare il nome di file fornendo il percorso completo.

Opzioni

Nome	Descrizione
--cfg config-name	Il nome da utilizzare per una configurazione salvata. Questa opzione funziona solo con eb config save.
-d oppure --display	Visualizza le impostazioni di configurazione per l'ambiente corrente (scrive su stdout). Utilizza con l'opzione --format per specificare l'output da utilizzare in JSON o YAML. Se non lo specifichi, l'output è in formato YAML. Questa opzione funziona solo se utilizzi il comando eb config senza gli altri sottocomandi.
-f format_type oppure --format format_type	Specifica il formato di visualizzazione. I valori validi sono JSON o YAML. Il valore predefinito è YAML. Questa opzione funziona solo con l'opzione --display.
--tags key1=value1[,key2=value2 ...]	Tag da aggiungere alla configurazione salvata. Quando devi specificare i tag nell'elenco, specificali come coppie chiave=valore e separali con una virgola. Per ulteriori informazioni, consulta Tagging delle configurazioni salvate. Questa opzione funziona solo con eb config save.
--timeout timeout	Il numero di minuti prima che il comando scada.
-u configuration_string | file_path oppure --update configuration_string | file_path	Aggiorna le impostazioni di configurazione attive per l'ambiente corrente. Questa opzione funziona solo se utilizzi il comando eb config senza gli altri sottocomandi. Il parametro configuration_string | file_path è del tipo stringa. La stringa fornisce l'elenco degli spazi dei nomi e delle opzioni corrispondenti da aggiungere, aggiornare o rimuovere dalle impostazioni di configurazione per l'ambiente. In alternativa, la stringa di input può rappresentare un file che contiene le stesse informazioni. Per specificare un nome di file, la stringa di input deve seguire il formato "file://<path><filename>". Per specificare il nome del file senza un path, salva il file nella cartella in cui esegui il comando. In alternativa, puoi specificare il nome di file fornendo il percorso completo. Le informazioni di configurazione devono soddisfare le seguenti condizioni. Almeno una delle sezioni, OptionSettings oOptionsToRemove, è richiesta. Utilizza OptionSettings per aggiungere o modificare le opzioni. UtilizzaOptionsToRemove per rimuovere le opzioni da uno spazio dei nomi. Per esempi specifici, consulta la sezione Esempi più avanti in questo argomento. Formato YAML OptionSettings: namespace1: option-name-1: option-value-1 option-name-2: option-value-2 ... OptionsToRemove: namespace1: option-name-1 option-name-2 ... Formato JSON { "OptionSettings": { "namespace1": { "option-name-1": "option-value-1", "option-name-2": "option-value-2", ... } }, "OptionsToRemove": { "namespace1": { "option-name-1", "option-name-2", ... } } }
Opzioni comuni

Output

Se il comando eb config o eb config environment-name viene eseguito correttamente senza aggiungere sottocomandi o opzioni, il comando visualizza le impostazioni delle opzioni correnti nell'editor di testo configurato come variabile di ambiente EDITOR. Se non hai configurato una variabile di ambiente EDITOR, la CLI EB visualizza le impostazioni delle opzioni nell'editor di default per i file YAML.

Quando salvi le modifiche al file e chiudi l'editor, l'ambiente viene aggiornato con le impostazioni delle opzioni nel file. Viene visualizzato il seguente output per confermare l'aggiornamento della configurazione.

$ eb config myApp-dev
    Printing Status:
    2021-05-19 18:09:45    INFO    Environment update is starting.
    2021-05-19 18:09:55    INFO    Updating environment myApp-dev's configuration settings.
    2021-05-19 18:11:20    INFO    Successfully deployed new configuration to environment.

Se il comando viene eseguito correttamente con l'opzione --display, visualizza le impostazioni di configurazione per l'ambiente corrente (scrive su stdout).

Se il comando viene eseguito senza errori con il parametro get, visualizza il percorso della copia locale che hai scaricato.

Se il comando viene eseguito senza errori con il parametro save, visualizza il percorso del file salvato.

Esempi

Questa sezione descrive come modificare l'editor di testo utilizzato per visualizzare e modificare il file delle impostazioni.

Per Linux e UNIX, il seguente esempio imposta vim come editor:

$ export EDITOR=vim

Per Linux e UNIX, il seguente esempio imposta l'editor installato in /usr/bin/kate.

$ export EDITOR=/usr/bin/kate

Per Windows, il seguente esempio imposta Notepad++ come editor.

> set EDITOR="C:\Program Files\Notepad++\Notepad++.exe

Questa sezione fornisce esempi per il comando eb config quando viene eseguito con sottocomandi.

L'esempio seguente elimina la configurazione salvata denominata app-tmp.

$ eb config delete app-tmp

L'esempio seguente scarica la configurazione salvata denominata app-tmp dal bucket Amazon S3.

$ eb config get app-tmp

L'esempio seguente elenca i nomi delle configurazioni archiviate nel bucket Amazon S3.

$ eb config list

L'esempio seguente carica la copia locale della configurazione salvata denominata app-tmp nel bucket Amazon S3.

$ eb config put app-tmp

L'esempio seguente salva le impostazioni di configurazione dell'ambiente attualmente in esecuzione. Se non indichi un nome per la configurazione salvata, Elastic Beanstalk assegna un nome al file di configurazione in base al nome dell'ambiente. Ad esempio, con un ambiente denominato tmp-dev, il nome sarebbe tmp-dev.cfg.yml. Elastic Beanstalk salva il file nella cartella /.elasticbeanstalk/saved_configs/.

$ eb config save

L'esempio seguente mostra come utilizzare l'opzione --cfg per salvare le impostazioni di configurazione dell'ambiente tmp-dev in un file denominato v1-app-tmp.cfg.yml. Elastic Beanstalk salva il file nella cartella /.elasticbeanstalk/saved_configs/. Se non specifichi un nome di ambiente, Elastic Beanstalk salva le impostazioni di configurazione dell'ambiente attualmente in esecuzione.

$ eb config save tmp-dev --cfg v1-app-tmp

Questa sezione fornisce esempi per il comando eb config quando viene eseguito senza sottocomandi.

Il comando seguente visualizza le impostazioni delle opzioni dell'ambiente corrente in un editor di testo.

$ eb config

Il comando seguente visualizza le impostazioni delle opzioni per l'ambiente my-env in un editor di testo.

$ eb config my-env

Nell'esempio seguente vengono visualizzate le impostazioni delle opzioni per l'ambiente corrente. Viene emesso nel formato YAML perché non è stato specificato alcun formato specifico con l'opzione --format.

$ eb config --display

L'esempio seguente aggiorna le impostazioni delle opzioni per l'ambiente corrente con le specifiche del file denominato example.txt. Il file è in formato YAML o JSON. La CLI EB rileva automaticamente il formato del file.

• L'opzione Minsize è impostata su 1 per lo spazio dei nomi aws:autoscaling:asg.

• La dimensione del batch per lo spazio dei nomi aws:elasticbeanstalk:command è impostata a 30%.

• Rimuove l'impostazione dell'opzione di IdleTimeout: None dallo spazio dei nomi AWSEBV2LoadBalancer.aws:elbv2:loadbalancer.

$ eb config --update "file://example.txt"

Esempio - nome file: example.txt - formato YAML

OptionSettings:
  'aws:elasticbeanstalk:command':
    BatchSize: '30'
    BatchSizeType: Percentage
  'aws:autoscaling:asg':
    MinSize: '1'
OptionsToRemove:
  'AWSEBV2LoadBalancer.aws:elbv2:loadbalancer':
    IdleTimeout

Esempio - nome file: example.txt - formato JSON

{
    "OptionSettings": {
        "aws:elasticbeanstalk:command": {
            "BatchSize": "30",
            "BatchSizeType": "Percentage"
        },
        "aws:autoscaling:asg": {
            "MinSize": "1"
        }
    },
    "OptionsToRemove": {
        "AWSEBV2LoadBalancer.aws:elbv2:loadbalancer": {
            "IdleTimeout"
        }
    }
}

Gli esempi seguenti aggiornano le impostazioni delle opzioni per l'ambiente corrente. Il comando imposta l'opzione Minsize a 1 per lo spazio dei nomi aws:autoscaling:asg.

Nota

Questi esempi sono specifici di Windows PowerShell. Essi sfuggono alle occorrenze letterali delle doppie virgolette (") precedendolo con uno slash (\). Sistemi operativi e ambienti a riga di comando diversi potrebbero avere sequenze di escape diverse. Per questo motivo, consigliamo di utilizzare l'opzione file mostrata negli esempi precedenti. La specifica delle opzioni di configurazione in un file non richiede caratteri di escape ed è coerente tra i diversi sistemi operativi.

L'esempio seguente è in formato JSON. La CLI EB rileva se il formato è in JSON o YAML.

PS C:\Users\myUser\EB_apps\myApp-env>eb config --update '{\"OptionSettings\":{\"aws:autoscaling:asg\":{\"MaxSize\":\"1\"}}}'

L'esempio seguente è in formato YAML. Per inserire la stringa YAML nel formato corretto, il comando include la spaziatura e i ritorni di fine riga richiesti in un file YAML.

• Termina ogni riga con il tasto «invio» o «indietro».

• Inizia la seconda riga con due spazi e inizia la terza riga con quattro spazi.

PS C:\Users\myUser\EB_apps\myApp-env>eb config --update 'OptionSettings:
>>  aws:autoscaling:asg:
>>    MinSize: \"1\"'