You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/deployment-environments/how-to-configure-extensibility-bicep-container-image.md
+16-21Lines changed: 16 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Learn how to use the ADE extensibility model to build and utilize c
5
5
ms.service: deployment-environments
6
6
author: RoseHJM
7
7
ms.author: rosemalcolm
8
-
ms.date: 05/23/2024
8
+
ms.date: 05/28/2024
9
9
ms.topic: how-to
10
10
11
11
#customer intent: As a developer, I want to learn how to build and utilize custom images within my environment definitions for deployment environments.
@@ -30,12 +30,10 @@ The ADE team provides a selection of images to get you started, including a core
30
30
## Use container images with ADE
31
31
32
32
You can take one of the following approaches to use container images with ADE:
33
-
34
-
- Use the standard image provided by ADE
35
-
- Customize a container image
36
-
- Build a custom container image using the script provided by ADE
37
-
38
-
For simple scenarios, you can use the standard Bicep container image provided by ADE. For more complex scenarios, you can customize a container image or build a custom container image using the script provided by ADE.
33
+
-**Use the standard container image:** For simple scenarios, use the standard Bicep container image provided by ADE.
34
+
-**Create a custom container image:** For more complex scenarios, create a custom container image that meets your specific requirements.
35
+
36
+
Regardless of which approach you choose, you must specify the container image in your environment definition to deploy your Azure resources.
39
37
40
38
## Use the standard Bicep container image
41
39
@@ -54,22 +52,24 @@ The following example shows a runner that references the sample Bicep container
54
52
```
55
53
You can see the standard Bicep container image in the ADE sample repository under the [Runner-Images folder for the ARM-Bicep](https://github.com/Azure/deployment-environments/tree/main/Runner-Images/ARM-Bicep) image.
56
54
55
+
For more information about how to create environment definitions that use the ADE container images to deploy your Azure resources, see [Add and configure an environment definition](configure-environment-definition.md).
56
+
57
57
## Create a custom bicep container image
58
58
59
-
Creating a custom container image allows you to customize your deployments and deletions to fit your workflow. You can create custom images based on the ADE standard container images.
59
+
Creating a custom container image allows you to customize your deployments to fit your requirements. You can create custom images based on the ADE standard container images.
60
+
61
+
After you complete the image customization, you must build the image and push it to your container registry.
60
62
61
-
### Create and build a Docker image
63
+
### Create and customize a container image with Docker
62
64
63
65
In this example, you learn how to build a Docker image to utilize ADE deployments and access the ADE CLI, basing your image off of one of the ADE authored images.
64
66
65
67
The ADE CLI is a tool that allows you to build custom images by using ADE base images. You can use the ADE CLI to customize your deployments and deletions to fit your workflow. The ADE CLI is preinstalled on the sample images. To learn more about the ADE CLI, see the [CLI Custom Runner Image reference](https://aka.ms/deployment-environments/ade-cli-reference).
66
68
67
-
To build an image configured for ADE, follow these steps:
69
+
To create an image configured for ADE, follow these steps:
68
70
1. Base your image on an ADE-authored sample image or the image of your choice by using the FROM statement.
69
71
1. Install any necessary packages for your image by using the RUN statement.
70
72
1. Create a *scripts* folder at the same level as your Dockerfile, store your *deploy.sh* and *delete.sh* files within it, and ensure those scripts are discoverable and executable inside your created container. This step is necessary for your deployment to work using the ADE core image.
71
-
1. Build and push your image to your container registry, and ensure it's accessible to ADE.
72
-
1. Reference your image in the `runner` property of your environment definition.
73
73
74
74
### Select a sample container image by using the FROM statement
75
75
@@ -255,26 +255,21 @@ When you're ready to push your image to your registry, run the following command
## Connect the image to your environment definition
259
-
260
-
When authoring environment definitions to use your custom image in their deployment, edit the `runner` property on the manifest file (environment.yaml or manifest.yaml).
## Connect the image to your environment definition
271
265
272
266
When authoring environment definitions to use your custom image in their deployment, edit the `runner` property on the manifest file (environment.yaml or manifest.yaml).
To learn more about how to create environment definitions that use the ADE container images to deploy your Azure resources, see [Add and configure an environment definition](configure-environment-definition.md).
0 commit comments