eb config

Descripción

Administra la configuración activa Configuración del entorno y las configuraciones guardadas Configuración guardada del entorno. Puede utilizar este comando para cargar, descargar o enumerar las configuraciones guardadas del entorno. También puede usarlo para descargar, mostrar o actualizar los ajustes de configuración activos.

Si el directorio raíz contiene un archivo platform.yaml que especifica una plataforma personalizada, este comando también cambia la configuración del creador. Esto se hace en función de los valores que se establece platform.yaml.

nota

eb configno muestra las propiedades del entorno. Para configurar las propiedades del entorno desde las que puede leer dentro de la aplicación, utiliceeb setenv en su lugar.

Sintaxis

A continuación se presentan partes de la sintaxis que se utiliza para que el comando eb config funcione con los valores de configuración Configuración del entorno activos del entorno. Para obtener ejemplos específicos, consulte la sección Ejemplos , más adelante en este tema.

• eb config: muestra los valores de configuración activos del entorno en un editor de texto que ha configurado como variable de entorno EDITOR. Cuando guarda los cambios en el archivo y cierra el editor, el entorno se actualiza con la configuración de opciones que ha guardado en el archivo.

  nota

  Si no ha configurado una variable de entorno EDITOR, la CLI de EB muestra la configuración de opciones en el editor predeterminado para los archivos YAML.

• eb config environment-name: muestra y actualiza la configuración del entorno designado. La configuración se muestra en un editor de texto configurado o en los archivos YAML del editor predeterminado.

• eb config save: guarda los valores de configuración activos del entorno actual en el que se.elasticbeanstalk/saved_configs/ encuentra el nombre del archivo[configuration-name].cfg.yml. De forma predeterminada, la CLI de EB guarda las opciones de configuración con un nombre-configuración basado en el entorno. Puede especificar otro nombre de configuración incluyendo la opción --cfg con el nombre de configuración que desee cuando ejecute el comando.

  Puede etiquetar su configuración guardada mediante la opción --tags.

• eb config --display: escribe la configuración activa de un entorno en stdout en lugar de un archivo. De forma predeterminada, muestra los ajustes de configuración en el terminal.

• eb config --update configuration_string | file_path: actualiza la configuración activa del entorno actual con la información especificada en configuration_string o dentro del archivo identificado por file_path.

nota

Las opciones --display y --update proporcionan flexibilidad para leer y revisar los ajustes de configuración del entorno mediante programación.

A continuación se describe la sintaxis de utilizar el comando eb config para trabajar con configuraciones guardadas. Para ver ejemplos, consulte la sección Ejemplos más adelante en este tema.

• eb config get config-name: descarga la configuración guardada con nombre de Amazon S3.

• eb config delete config-name : elimina la configuración guardada con nombre de Amazon S3. También lo elimina localmente, si ya lo descargó.

• eb config list: muestra las configuraciones guardadas que tiene en Amazon S3.

• eb config put filename: carga la configuración guardada designada en un bucket de Amazon S3. El nombre de archivo debe tener la extensión de archivo .cfg.yml. Para especificar el nombre de archivo sin una ruta, puede guardar el archivo en la carpeta .elasticbeanstalk o en la carpeta .elasticbeanstalk/saved_configs/ antes de ejecutar el comando. También puede especificar el nombre de archivo proporcionando la ruta completa.

Opciones

Nombre	Descripción
--cfg config-name	Nombre que se utilizará para una configuración guardada. Esta opción funciona solo con eb config save.
-d o bien --display	Muestra los valores de configuración del entorno actual (escribe en stdout). Utilícelo con la opción --format para especificar la salida que debe estar en JSON o YAML. Si no lo especifica, la salida está en formato YAML. Esta opción solo funciona si utiliza el comando eb config sin ninguno de los demás subcomandos.
-f format_type o bien --format format_type	Especifica el formato de visualización. Los valores válidos son JSON o YAML. El valor predeterminado es YAML. Esta opción solo funciona con la opción --display .
--tags key1=value1[,key2=value2 ...]	Puede agregar etiquetas a su configuración guardada. Al especificar etiquetas en la lista, hágalo como pares clave=valor y separe cada una con una coma. Para obtener más información, consulte Etiquetado de configuraciones guardadas. Esta opción funciona solo con eb config save.
--timeout timeout	Número de minutos que deben transcurrir antes de que se agote el tiempo de espera del comando.
-u configuration_string | file_path o bien --update configuration_string | file_path	Actualiza la configuración activa del entorno actual. Esta opción solo funciona si utiliza el comando eb config sin ninguno de los demás subcomandos. El parámetro configuration_string | file_path es de la cadena de tipo. La cadena proporciona la lista de espacios de nombres y las opciones correspondientes para agregar, actualizar o quitar de la configuración del entorno. Como alternativa, la cadena de entrada puede representar un archivo que contiene la misma información. Para especificar un nombre de archivo, la cadena de entrada debe seguir el format "file://<path><filename>". Para especificar el nombre de archivo sin unpath, guárdelo en la carpeta en la que ejecuta el comando. Como alternativa, especifique el nombre del archivo al proporcionar la ruta completa. La información de configuración debe cumplir las siguientes condiciones. Se requiere al menos una de las seccionesOptionSettings o OptionsToRemove. Se utilizaOptionSettings para agregar o cambiar opciones. Se utilizaOptionsToRemove para quitar opciones de un espacio de nombres. Para obtener ejemplos específicos, consulte la sección Ejemplos , más adelante en este tema. 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", ... } } }
Opciones comunes

Salida

Si el comando eb config o eb config environment-name se ejecuta correctamente sin agregar subcomandos ni opciones, el comando muestra la configuración de la opción actual en el editor de texto que configuró como variable de entorno EDITOR. Si no ha configurado una variable de entorno EDITOR, la CLI de EB muestra la configuración de opciones en el editor predeterminado para los archivos YAML.

Cuando guarda los cambios en el archivo y cierra el editor, el entorno se actualiza con la configuración de opciones que ha guardado en el archivo. Se muestra el siguiente resultado para confirmar la actualización de la configuración.

$ 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.

Si el comando se ejecuta correctamente con la opción --display , muestra los valores de configuración del entorno actual (escribe en stdout).

Si el comando se ejecuta correctamente con el parámetro get, muestra la ubicación de la copia local que ha descargado.

Si el comando se ejecuta correctamente con el parámetro save, muestra la ubicación del archivo guardado.

Ejemplos

En esta sección se describe cómo cambiar el editor de texto que utiliza para ver y editar el archivo de configuración de opciones.

Para Linux y UNIX, el siguiente ejemplo cambia el editor a vim:

$ export EDITOR=vim

Para Linux y UNIX, el siguiente ejemplo cambia el editor a lo que esté instalado en /usr/bin/kate.

$ export EDITOR=/usr/bin/kate

Para Windows, el siguiente ejemplo cambia el editor a Notepad++.

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

En esta sección se proporcionan ejemplos del comando eb config cuando se ejecuta con subcomandos.

En el ejemplo siguiente se elimina la configuración guardada denominad app-tmp.

$ eb config delete app-tmp

El siguiente ejemplo descarga la configuración guardada con el nombre app-tmp de su bucket de Amazon S3.

$ eb config get app-tmp

El siguiente ejemplo muestra los nombres de las configuraciones guardadas almacenadas en el bucket de Amazon S3.

$ eb config list

El siguiente ejemplo carga la copia local de la configuración guardada con el nombre app-tmp en su bucket de Amazon S3.

$ eb config put app-tmp

El siguiente ejemplo guarda las opciones de configuración del entorno en ejecución actual. Si no proporciona un nombre para utilizarlo en la configuración guardada, Elastic Beanstalk nombra el archivo de configuración según el nombre del entorno. Por ejemplo, un entorno llamado tmp-dev se denominaría tmp-dev.cfg.yml. Elastic Beanstalk guarda el archivo en la carpeta /.elasticbeanstalk/saved_configs/ .

$ eb config save

En el ejemplo siguiente, se utiliza la opción --cfg para guardar los valores de configuración del entorno tmp-dev en un archivo denominadov1-app-tmp.cfg.yml. Elastic Beanstalk guarda el archivo en la carpeta /.elasticbeanstalk/saved_configs/. Si no especifica un nombre de entorno, Elastic Beanstalk guarda los valores de configuración del entorno en ejecución actual.

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

En esta sección se proporcionan ejemplos del comando eb config cuando se ejecuta sin subcomandos.

El siguiente comando muestra la configuración de opciones del entorno actual en un editor de texto.

$ eb config

El siguiente comando muestra la configuración de opciones del entorno my-env en un editor de texto.

$ eb config my-env

En el ejemplo siguiente se muestra la configuración de opciones del entorno actual. Se produce en formato YAML porque no se especificó ningún formato puntual con la opción --format .

$ eb config --display

En el siguiente ejemplo se actualiza la configuración de opciones del entorno actual con las especificaciones del archivo denominad example.txt. El archivo está en formato YAML o JSON. La CLI de EB detecta automáticamente el formato de archivo.

• La opción Minsize se establece en 1 para el espacio de nombre aws:autoscaling:asg.

• El tamaño del lote del espacio de nombresaws:elasticbeanstalk:command se establece en 30 %.

• Elimina la configuración de opción de IdleTimeout: ninguno del espacio de nombresAWSEBV2LoadBalancer.aws:elbv2:loadbalancer.

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

ejemplo - nombre de archivo:example.txt , formato YAML

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

ejemplo - nombre de archivo:example.txt , formato JSON

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

En los ejemplos siguientes se actualizan la configuración de opciones del entorno actual. El comando establece la opción Minsize en 1 para el espacio de nombres aws:autoscaling:asg .

nota

Estos ejemplos son específicos de Windows PowerShell. Escapa de las apariciones literales del carácter de comilla doble (") al precederlo con un carácter de barra inclinada (\). Los distintos sistemas operativos y entornos de línea de comandos pueden tener secuencias de escape diferentes. Por este motivo, recomendamos utilizar la opción de archivo que se muestra en los ejemplos anteriores. La especificación de las opciones de configuración en un archivo no requiere caracteres de escape y es coherente en distintos sistemas operativos.

El siguiente ejemplo está en formato JSON. La CLI de EB detecta si el formato está en JSON o YAML.

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

El siguiente ejemplo está en formato YAML. Para ingresar la cadena YAML en el formato correcto, el comando incluye el espaciado y las devoluciones de final de línea que se requieren en un archivo YAML.

• Finaliza cada línea con la tecla “enter” (ingresar) o “return” (volver).

• Comience la segunda línea con dos espacios y la tercera línea con cuatro espacios.

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