Skip to content

Commit 388f235

Browse files
committed
ADE - extensibility updates
1 parent 4095994 commit 388f235

File tree

1 file changed

+38
-5
lines changed

1 file changed

+38
-5
lines changed

articles/deployment-environments/how-to-configure-extensibility-model-custom-image.md

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,21 @@ For more information about how to create environment definitions that use the AD
6969
### [Create a custom image by using a script](#tab/custom-script/)
7070
### Create a custom container image by using a script
7171
72-
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 images.
72+
Creating a custom container image allows you to customize your deployments to fit your requirements. You can build an image based on the ADE standard image and push it to your container registry by using a quick start script provided by Microsoft. You can find the script in the [Deployment Environments repo](https://aka.ms/ade/arm-bicep-repo-script). To use the quick start script, fork the repo and then run the script locally.
73+
74+
The script builds an image and pushes it to the specified Azure Container Registry (ACR) under the repository 'ade' and the tag 'latest'. This script requires your registry name and directory for your custom image, have the Azure CLI and Docker Desktop installed and in your PATH variables, and requires that you have permissions to push to the specified registry. You can call the script using the following command in PowerShell:
75+
76+
```azurepowershell
77+
.\quickstart-image-build.ps1 -Registry '{YOUR_REGISTRY}' -Directory '{DIRECTORY_TO_YOUR_IMAGE}'
78+
```
79+
80+
Additionally, if you would like to push to a specific repository and tag name, you can run:
7381

74-
After you complete the image customization, you can build the image and push it to your container registry by using a script provided by Microsoft to automate the process.
82+
```azurepowershell
83+
.\quickstart-image.build.ps1 -Registry '{YOUR_REGISTRY}' -Directory '{DIRECTORY_TO_YOUR_IMAGE}' -Repository '{YOUR_REPOSITORY}' -Tag '{YOUR_TAG}'
84+
```
7585

76-
[!INCLUDE [custom-image-create-arm](includes/custom-image-create-arm.md)]
86+
To use the image in your environment deployments, you need to add the location of the image to your manifest file [Connect the image to your environment definition](#connect-the-image-to-your-environment-definition) and you might need to configure permissions for the ACR to [make the custom image available to ADE](#make-the-custom-image-available-to-ade).
7787

7888
### Build a container image with a script
7989

@@ -107,9 +117,32 @@ After you complete the image customization, you can build the image and push it
107117
You can take one of the following approaches to use container images with ADE:
108118
- **Create a container image leveraging a GitHub workflow:** To start with, you can use the published GitHub workflow from the Leveraging ADE's Extensibility Model With Terraform repository.
109119
- **Create a custom container image:** You can create a workflow that creates a Terraform specific image customized with all the software, settings, and configuration that you need.
110-
111120

112-
## Create a container image using a GitHub workflow
121+
## Create a custom container image
122+
123+
### [Create a container image using a GitHub workflow](#tab/github-workflow/)
124+
125+
### Create a container image using a GitHub workflow
126+
127+
Creating a custom container image allows you to customize your deployments to fit your requirements. You can build an image based on the ADE standard image and push it to your container registry by using a quick start script provided by Microsoft. You can find the script in the [Deployment Environments with Terraform repo](https://aka.ms/ade/terraform-repo-script). To use the quick start script, fork the repo and then run the script locally.
128+
129+
The script builds an image and pushes it to the specified Azure Container Registry (ACR) under the repository 'ade' and the tag 'latest'. This script requires your registry name and directory for your custom image, have the Azure CLI and Docker Desktop installed and in your PATH variables, and requires that you have permissions to push to the specified registry. You can call the script using the following command in PowerShell:
130+
131+
```azurepowershell
132+
.\quickstart-image-build.ps1 -Registry '{YOUR_REGISTRY}' -Directory '{DIRECTORY_TO_YOUR_IMAGE}'
133+
```
134+
135+
Additionally, if you would like to push to a specific repository and tag name, you can run:
136+
137+
```azurepowershell
138+
.\quickstart-image.build.ps1 -Registry '{YOUR_REGISTRY}' -Directory '{DIRECTORY_TO_YOUR_IMAGE}' -Repository '{YOUR_REPOSITORY}' -Tag '{YOUR_TAG}'
139+
```
140+
141+
To use the image in your environment deployments, you need to add the location of the image to your manifest file [Connect the image to your environment definition](#connect-the-image-to-your-environment-definition) and you might need to configure permissions for the ACR to [make the custom image available to ADE](#make-the-custom-image-available-to-ade).
142+
143+
144+
### Create a container image manually
145+
113146
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 images.
114147

115148
After you complete the image customization, you must build the image and push it to your container registry.

0 commit comments

Comments
 (0)