Skip to content

Commit 16fd6be

Browse files
author
RoseHJM
committed
Small flow updates
1 parent 0bab70a commit 16fd6be

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

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

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,18 +55,27 @@ You can take one of the following approaches to use container images with ADE:
5555
- **Use a sample container image** For simple scenarios, use the sample ARM-Bicep container image provided by ADE.
5656
- **Create a custom container image** For more complex scenarios, create a custom container image that meets your specific requirements.
5757

58-
Regardless of which approach you choose, you must specify the container image in your environment definition to deploy your Azure resources.
58+
The main steps you'll follow when using a container image are:
59+
1. Choose the image type you want to use: a sample image or a custom image.
60+
- If you use a custom image, you begin with a sample image and then customize it to fit your requirements.
61+
1. Build the image.
62+
1. Upload the image to a private registry or a public registry.
63+
1. Configure access to the registry.
64+
- For a public registry, configure anonymous pull.
65+
- For a private registry, give the DevCenter ACR permissions.
66+
1. Add your image location to the `runner` parameter in your environment definition
67+
1. Deploy environments that use your custom image.
5968

6069
### [Use a sample container image](#tab/sample/)
6170

6271
::: zone pivot="arm-bicep"
63-
## Use a sample container image
72+
### Use a sample container image
6473

6574
ADE supports ARM and Bicep without requiring any extra configuration. You can create an environment definition that deploys Azure resources for a deployment environment by adding the template files (like *azuredeploy.json* and *environment.yaml*) to your catalog. ADE then uses the sample ARM-Bicep container image to create the deployment environment.
6675

67-
In the *environment.yaml* file, the runner property specifies the location of the container image you want to use. To use the sample image published on the Microsoft Artifact Registry, use the respective identifiers runner.
76+
In the *environment.yaml* file, the `runner` property specifies the location of the container image you want to use. To use the sample image published on the Microsoft Artifact Registry, use the respective identifiers `runner`.
6877

69-
The following example shows a runner that references the sample ARM-Bicep container image:
78+
The following example shows a `runner` that references the sample ARM-Bicep container image:
7079
```yaml
7180
name: WebApp
7281
version: 1.0.0
@@ -81,7 +90,7 @@ For more information about how to create environment definitions that use the AD
8190
::: zone-end
8291
8392
::: zone pivot="pulumi"
84-
## Use a sample container image provided by Pulumi
93+
### Use a sample container image provided by Pulumi
8594
8695
The Pulumi team provides a prebuilt image to get you started, which you can see in the [Runner-Image](https://github.com/pulumi/azure-deployment-environments/tree/main/Runner-Image) folder. This image is publicly available at Pulumi's Docker Hub as [`pulumi/azure-deployment-environments`](https://hub.docker.com/repository/docker/pulumi/azure-deployment-environments), so you can use it directly from your ADE environment definitions.
8796

@@ -99,9 +108,9 @@ templatePath: Pulumi.yaml
99108
You can find a few sample environment definitions in the [Environments folder](https://github.com/pulumi/azure-deployment-environments/tree/main/Environments).
100109
::: zone-end
101110

102-
### [Use a custom container image](#tab/custom/)
111+
### [Create a custom image](#tab/custom/)
103112

104-
## Use a custom container image
113+
### Create a custom image
105114

106115
Creating a custom container image allows you to customize your deployments to fit your requirements. You can create custom images based on the ADE sample images.
107116

@@ -442,7 +451,6 @@ echo "$ADE_OPERATION_PARAMETERS" | jq -r 'to_entries|.[]|[.key, .value] | @tsv'
442451
done
443452
```
444453

445-
446454
Additionally, to utilize ADE privileges to deploy infrastructure inside your subscription, your script needs to use ADE Managed Service Identity (MSI) when provisioning infrastructure by using the Pulumi Azure Native or Azure Classic provider. If your deployment needs special permissions to complete your deployment, such as particular roles, assign those permissions to the project environment type's identity that is being used for your environment deployment. ADE sets the relevant environment variables, such as the client, tenant, and subscription IDs within the core image's entrypoint, so run the following commands to ensure the provider uses ADE MSI:
447455

448456
```bash
@@ -470,7 +478,7 @@ echo "{\"outputs\": ${stackout:-{\}}}" > $ADE_OUTPUTS
470478
::: zone-end
471479
---
472480

473-
## Build a custom image
481+
## Build an image
474482

475483
You can build your image using the Docker CLI. Ensure the [Docker Engine is installed](https://docs.docker.com/desktop/) on your computer. Then, navigate to the directory of your Dockerfile, and run the following command:
476484

0 commit comments

Comments
 (0)