Skip to content

Commit 0e28f5c

Browse files
author
RoseHJM
committed
Changed title, adjusted intro, added error logs section & images
1 parent 40c14b2 commit 0e28f5c

File tree

3 files changed

+31
-2
lines changed

3 files changed

+31
-2
lines changed

articles/deployment-environments/how-to-configure-extensibility-custom-runner-bicep.md renamed to articles/deployment-environments/how-to-configure-extensibility-bicep-container-image.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ ms.topic: how-to
1111
#customer intent: As a developer, I want to learn how to build and utilize custom images within my environment definitions for deployment environments.
1212
---
1313

14-
# Custom image support in Azure Deployment Environments
14+
# Configure container image to execute deployments with ARM and Bicep
1515

1616
In this article, you learn how to build and utilize custom images within your environment definitions for deployments in Azure Deployment Environments (ADE).
1717

18-
ADE uses an extensibility model to enable you to create custom images to use in your environment definitions. By using the extensibility model, you can create your own custom images, and store them in a container registry like the [Microsoft Artifact Registry](https://mcr.microsoft.com/)(also known as the Microsoft Container Registry). You can then reference these images in your environment definitions to deploy your environments.
18+
ADE supports an extensibility model that enables you to create custom images that you can use in your environment definitions. To leverage this extensibility model, you can create your own custom images, and store them in a container registry like the [Microsoft Artifact Registry](https://mcr.microsoft.com/)(also known as the Microsoft Container Registry). You can then reference these images in your environment definitions to deploy your environments.
1919

2020
The ADE team provides a selection of images to get you started, including a core image, and an Azure Resource Manager (ARM)/Bicep image. You can access these sample images in the [Runner-Images](https://github.com/Azure/deployment-environments/tree/custom-runner-private-preview/Runner-Images) folder.
2121

@@ -213,6 +213,35 @@ When authoring environment definitions to use your custom image in their deploym
213213
runner: "{YOUR_REGISTRY}.azurecr.io/{YOUR_REPOSITORY}:{YOUR_TAG}"
214214
```
215215
216+
## Access operation logs and error details
217+
218+
ADE stores error details for a failed deployment the *$ADE_ERROR_LOG* file.
219+
220+
To troubleshoot a failed deployment:
221+
222+
1. Sign in to the [Developer Portal](https://devportal.microsoft.com/).
223+
1. Identify the environment that failed to deploy, and select **See details**.
224+
225+
:::image type="content" source="media/how-to-configure-extensibility-bicep-container-image/failed-deployment-card.png" alt-text="Screenshot showing failed deployment error details, specifically an invalid name for a storage account." lightbox="media/how-to-configure-extensibility-bicep-container-image/failed-deployment-card.png":::
226+
227+
1. Review the error details in the **Error Details** section.
228+
229+
:::image type="content" source="media/how-to-configure-extensibility-bicep-container-image/deployment-error-details.png" alt-text="Screenshot showing a failed deployment of an environment with the See Details button displayed." lightbox="media/how-to-configure-extensibility-bicep-container-image/deployment-error-details.png":::
230+
231+
Additionally, you can use the Azure CLI to view an environment's error details using the following command:
232+
```bash
233+
az devcenter dev environment show --environment-name {YOUR_ENVIRONMENT_NAME} --project {YOUR_PROJECT_NAME}
234+
```
235+
236+
To view the operation logs for an environment deployment or deletion, use the Azure CLI to retrieve the latest operation for your environment, and then view the logs for that operation ID.
237+
238+
```bash
239+
# Get list of operations on the environment, choose the latest operation
240+
az devcenter dev environment list-operation --environment-name {YOUR_ENVIRONMENT_NAME} --project {YOUR_PROJECT_NAME}
241+
# Using the latest operation ID, view the operation logs
242+
az devcenter dev environment show-logs-by-operation --environment-name {YOUR_ENVIRONMENT_NAME} --project {YOUR_PROJECT_NAME} --operation-id {LATEST_OPERATION_ID}
243+
```
244+
216245
## Related content
217246

218247
- [ADE CLI Custom Runner Image reference](https://aka.ms/deployment-environments/ade-cli-reference)
Loading
Loading

0 commit comments

Comments
 (0)