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-model-custom-image.md
+17-9Lines changed: 17 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,18 +55,27 @@ You can take one of the following approaches to use container images with ADE:
55
55
-**Use a sample container image** For simple scenarios, use the sample ARM-Bicep container image provided by ADE.
56
56
-**Create a custom container image** For more complex scenarios, create a custom container image that meets your specific requirements.
57
57
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.
59
68
60
69
### [Use a sample container image](#tab/sample/)
61
70
62
71
::: zone pivot="arm-bicep"
63
-
## Use a sample container image
72
+
###Use a sample container image
64
73
65
74
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.
66
75
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`.
68
77
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:
70
79
```yaml
71
80
name: WebApp
72
81
version: 1.0.0
@@ -81,7 +90,7 @@ For more information about how to create environment definitions that use the AD
81
90
::: zone-end
82
91
83
92
::: zone pivot="pulumi"
84
-
## Use a sample container image provided by Pulumi
93
+
### Use a sample container image provided by Pulumi
85
94
86
95
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.
87
96
@@ -99,9 +108,9 @@ templatePath: Pulumi.yaml
99
108
You can find a few sample environment definitions in the [Environments folder](https://github.com/pulumi/azure-deployment-environments/tree/main/Environments).
100
109
::: zone-end
101
110
102
-
### [Use a custom container image](#tab/custom/)
111
+
### [Create a custom image](#tab/custom/)
103
112
104
-
## Use a custom container image
113
+
### Create a custom image
105
114
106
115
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.
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:
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:
0 commit comments