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/concept-extensibility-model.md
+9-23Lines changed: 9 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,12 +13,12 @@ ms.date: 10/17/2024
13
13
14
14
# What is the ADE Extensibility Model?
15
15
16
-
Azure Deployment Environments (ADE) enables you to provide a curated set of infrastructure-as-code (IaC) templates that your development teams use to perform deployments. ADE offers power and flexibility for organizations through an extensibility model which enables platform engineers to define pre-approved templates using their preferred IaC framework.
17
-
The following diagram shows the full workflow for ADE. The catalog stores IaC templates, which reference container images for use in deployments. Platform engineers curate these images and templates, and configure environment settings based on the stage of development, enabling developers to create highly specific deployment environments. Developers can create ad hoc environments for dev/test purposes or shared environments as part of their CI/CD pipeline, or as part of an automated pipeline.
16
+
Azure Deployment Environments (ADE) enables you to provide a curated set of infrastructure-as-code (IaC) templates that your development teams use to perform deployments. ADE offers power and flexibility for organizations through an extensibility model which enables platform engineers to define preapproved templates using their preferred IaC framework.
17
+
The following diagram shows the full workflow for ADE. The catalog stores IaC templates, which reference container images for use in deployments. Platform engineers curate these images and templates, and configure environment settings based on the stage of development, enabling developers to create highly specific deployment environments. Developers can create improvised environments for dev/test purposes or shared environments as part of their CI/CD pipeline, or as part of an automated pipeline.
The extensibility model enables platform engineers to define the app infrastructure using their preferred IaC framework including ARM, Bicep, Terraform, and Pulumi. Platform engineers create and customize container images for different scenarios. They push these images to a container registry and reference them in the environment definition’s metadata file. This ensures that whenever a deployment is made, the deployment execution happens based on how the container image is configured. The following diagram shows the relationship between the custom images stored in a container registry, and the environment definition within the catalog.
21
+
The extensibility model enables platform engineers to define the app infrastructure using their preferred IaC framework including Azure Resource Manager (ARM), Bicep, Terraform, and Pulumi. Platform engineers create and customize container images for different scenarios. They push these images to a container registry and reference them in the environment definition’s metadata file. This ensures that whenever a deployment is made, the deployment execution happens based on how the container image is configured. The following diagram shows the relationship between the custom images stored in a container registry, and the environment definition within the catalog.
@@ -30,49 +30,35 @@ You can choose from multiple options for creating and building custom images, de
30
30
**1. Use a standard image**
31
31
For first party frameworks - ARM and Bicep - ADE provides standard images that customers can take advantage of and can just use identifiers ARM or Bicep to configure the respective IaC template as an environment definition. For ARM or Bicep deployments, you can use the standard image by referencing it in the environment.yaml file and defining resources in the template file (*azuredeploy.json*, *main.bicep*).
32
32
33
-
For instructions, see: aka.ms/arm-bicep-standard.
33
+
For instructions, see: [Use a standard container image](aka.ms/arm-bicep-standard).
34
34
35
35
**1. Create a custom image using a script**
36
36
To make the process of building a custom image and pushing it to a container registry easier, Microsoft provides a script that builds and pushes the image to a registry that you specify.
37
37
38
-
For instructions, see: aka.ms/arm-bicep-custom-script.
38
+
For instructions, see: [Create a custom container image by using a script](aka.ms/arm-bicep-custom-script).
39
39
40
40
**1. Create a custom image manually**
41
41
For more complex scenarios, start with the standard image and customize it by installing software packages and adjusting settings. Build the image and upload it to a container registry where ADE can access it. Specify the image's location in the environment.yaml file.
42
42
43
-
For instructions, see: aka.ms/arm-bicep-custom.
43
+
For instructions, see: [Create a custom container image manually](aka.ms/arm-bicep-custom-manual).
44
44
45
45
### Terraform
46
-
**1. Leverage a GitHub workflow to create Terraform specific container image**
47
-
You can leverage the published GitHub workflow to help create a container image that is Terraform specific. You can upload the new image to a container registry and use it by referencing it in the environment.yaml file and defining resources in the template file (*main.tf*).
48
-
49
-
For instructions, see: aka.ms/terraform-workflow-standard.
50
-
51
-
**1. Create a Terraform specific container image with a script**
52
-
You can use a GitHub workflow to create a custom Terraform image that includes the software, settings, and other customizations you need for your Terraform specific image. You can then upload the new image to a container registry and use it by referencing it in the environment.yaml file.
53
-
54
-
For instructions, see: aka.ms/terraform-workflow-custom.
55
46
56
47
**1. Create a Terraform specific container image manually**
57
48
You can use a GitHub workflow to create a custom Terraform image that includes the software, settings, and other customizations you need for your Terraform specific image. You can then upload the new image to a container registry and use it by referencing it in the environment.yaml file.
58
49
59
-
For instructions, see: aka.ms/terraform-workflow-custom.
50
+
For instructions, see: [Create a container image using a GitHub workflow](aka.ms/terraform-workflow-custom-manual).
60
51
61
52
### Pulumi
62
53
**1. Use a standard image**
63
54
The Pulumi team provides a prebuilt image to get you started, which you can use directly from your ADE environment definitions. For Pulumi images, you can use the standard image by referencing it in the environment.yaml file and defining the resources to deploy in the project file (*pulumi.yaml*).
64
55
65
-
For instructions, see: aka.ms/pulumi-standard.
66
-
67
-
**1. Create a custom image using a script**
68
-
To make the process of building a custom image and pushing it to a container registry easier, Pulumi provides a script that builds and pushes the image to a registry that you specify.
69
-
70
-
For instructions, see: aka.ms/pulumi-custom-script.
56
+
For instructions, see: [Use a standard container image provided by Pulumi](aka.ms/pulumi-standard).
71
57
72
58
**1. Create a custom image manually**
73
59
For more complex scenarios, start with the standard image and customize it by installing software packages and adjusting settings. Build the image and upload it to a container registry where ADE can access it. Specify the image's location in the environment.yaml file.
74
60
75
-
For instructions, see: aka.ms/pulumi-custom.
61
+
For instructions, see: [Create a custom image](aka.ms/pulumi-custom-manual).
Copy file name to clipboardExpand all lines: articles/deployment-environments/how-to-configure-extensibility-model-custom-image.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ You can take one of the following approaches to use container images with ADE:
47
47
48
48
## Use a standard container image
49
49
50
-
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 standard ARM-Bicep container image to create the deployment environment.
50
+
ADE supports Azure Resource Manager (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 standard ARM-Bicep container image to create the deployment environment.
51
51
52
52
In the *environment.yaml* file, the `runner` property specifies the location of the container image you want to use. To use the standard image published on the Microsoft Artifact Registry, use the respective identifiers `runner`.
53
53
@@ -109,7 +109,7 @@ You can take one of the following approaches to use container images with ADE:
109
109
- **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
110
111
111
112
-
## Create a container image leveraging a GitHub workflow
112
+
## Create a container image using a GitHub workflow
113
113
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.
114
114
115
115
After you complete the image customization, you must build the image and push it to your container registry.
0 commit comments