Referencia de variables de la CLI del entorno de implementación de Azure

Artículo
04/17/2024

Entornos de implementación de Azure (ADE) establece muchas variables relacionadas con el entorno al que puede hacer referencia al crear imágenes personalizadas. Puede usar las variables siguientes dentro de los scripts de operación (deploy.sh o delete.sh) para que las imágenes sean flexibles para el entorno con el que interactúan.

Para los archivos usados por ADE dentro del contenedor, todos existen en una ade subcarpeta fuera del directorio inicial.

Esta es la lista de variables de entorno disponibles:

ADE_ERROR_LOG

Hace referencia al archivo ubicado en /ade/temp/error.log. El error.log archivo almacena cualquier salida de error estándar que rellene los detalles del error de un entorno en el resultado de una implementación o eliminación con errores. El archivo se usa con ade execute, que registra cualquier salida estándar y contenido de error estándar en un archivo de registro administrado por ADE. Al usar el comando , redirija el ade execute registro de errores estándar a esta ubicación de archivo mediante el comando siguiente:

ade execute --operation $ADE_OPERATION_NAME --command "{YOUR_COMMAND}" 2> >(tee -a $ADE_ERROR_LOG)

Con este método, puede ver el error de implementación o eliminación en el portal para desarrolladores. Esto conduce a iteraciones de depuración más rápidas y correctas al crear la imagen personalizada y un diagnóstico más rápido de la causa principal de la operación con errores.

ADE_OUTPUTS

Hace referencia al archivo ubicado en /ade/temp/output.json. El output.json archivo almacena las salidas de la implementación de un entorno en el almacenamiento persistente, de modo que se pueda acceder a ellas mediante la CLI de Azure en una fecha posterior. Al almacenar la salida en una imagen personalizada, asegúrese de que la salida se carga en el archivo especificado, como se muestra en el ejemplo siguiente:

echo "$deploymentOutput" > $ADE_OUTPUTS

ADE_STORAGE

Hace referencia al directorio ubicado en /ade/storage. Durante el punto de entrada de la imagen principal, ADE extrae un archivo con storage.zip nombre especial del contenedor de almacenamiento del entorno y rellena este directorio y, a continuación, al finalizar la operación, vuelve a cargar el directorio como un archivo ZIP en el contenedor de almacenamiento. Si tiene archivos a los que le gustaría hacer referencia dentro de la imagen personalizada en las implementaciones posteriores, como los archivos de estado, colóquelos en este directorio.

ADE_CLIENT_ID

Hace referencia al identificador de objeto de Managed Service Identity (MSI) del tipo de entorno de proyecto del entorno. Esta variable se puede usar para validar a la CLI de Azure para que los permisos se usen en el contenedor, como la implementación de la infraestructura.

ADE_TENANT_ID

Hace referencia al GUID de inquilino del entorno.

ADE_SUBSCRIPTION_ID

Hace referencia al GUID de suscripción del entorno.

ADE_TEMPLATE_FILE

Hace referencia a dónde reside el archivo de plantilla principal especificado en la propiedad "templatePath" de la definición de entorno dentro del contenedor. Esta ruta de acceso refleja aproximadamente el control de código fuente de donde el catálogo, en función del nivel de ruta de acceso de archivo en el que se ha conectado el catálogo. El archivo se encuentra aproximadamente en /ade/repository/{CATALOG_NAME}/{PATH_TO_TEMPLATE_FILE}. Este método se usa principalmente durante el paso de implementación principal como archivo al que se hace referencia para basar la implementación desactivada.

A continuación se facilita un ejemplo mediante el uso de la CLI de Azure:

az deployment group create --subscription $ADE_SUBSCRIPTION_ID \
    --resource-group "$ADE_RESOURCE_GROUP_NAME" \
    --name "$deploymentName" \
    --no-prompt true --no-wait \
    --template-file "$ADE_TEMPLATE_FILE" \
    --parameters "$deploymentParameters" \
    --only-show-errors

Los archivos adicionales, como admitir archivos IaC o archivos que quiera usar en la imagen personalizada, se almacenan en su ubicación relativa al archivo de plantilla dentro del contenedor, ya que están dentro del catálogo. Por ejemplo, tome el siguiente directorio:

├───SampleCatalog
   ├───EnvironmentDefinition1
      │   file1.bicep
      │   main.bicep
      │   environment.yaml
      │
      └───TestFolder
              test1.txt
              test2.txt

En este caso, $ADE_TEMPLATE_FILE=/ade/repository/SampleCatalog/EnvironmentDefinition1/main.bicep. Además, los archivos como file1.bicep se ubicarían en el contenedor en /ade/repository/SampleCatalog/EnvironmentDefinition1/file1.bicepy test2.txt se ubicarían en /ade/repository/SampleCatalog/EnvironmentDefinition1/TestFolder/test2.txt.

ADE_ENVIRONMENT_NAME

Nombre del entorno proporcionado en el momento de la implementación.

ADE_ENVIRONMENT_LOCATION

Ubicación donde se va a implementar el entorno. Esta ubicación es la región del proyecto.

ADE_RESOURCE_GROUP_NAME

Nombre del grupo de recursos creado por ADE para implementar los recursos.

ADE_ENVIRONMENT_TYPE

Nombre del tipo de entorno del proyecto que se usa para implementar este entorno.

ADE_OPERATION_PARAMETERS

Objeto JSON de los parámetros proporcionados para implementar el entorno. A continuación se muestra un ejemplo del objeto parameters:

{
    "location": "locationInput",
    "name": "nameInput",
    "sampleObject": {
        "sampleProperty": "sampleValue"
    },
    "sampleArray": [
        "sampleArrayValue1",
        "sampleArrayValue2"
    ]
}

ADE_OPERATION_NAME

Tipo de operación que se realiza en el entorno. En la actualidad, este valor es "deploy" o "delete".

ADE_HTTP__OPERATIONID

Identificador de operación asignado a la operación que se realiza en el entorno. El identificador de operación se usa como validación para usar la CLI de ADE y es el identificador principal para recuperar registros de las operaciones anteriores.

ADE_HTTP__DEVCENTERID

Identificador de Centro de desarrollo del entorno. El identificador de Centro de desarrollo también se usa como validación para usar la CLI de ADE.

Compartir a través de