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/dev-box/concept-what-are-team-customizations.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: RoseHJM
5
5
ms.author: rosemalcolm
6
6
ms.service: dev-box
7
7
ms.topic: concept-article
8
-
ms.date: 11/05/2024
8
+
ms.date: 11/06/2024
9
9
10
10
#customer intent: As a Project Admin or Dev Center Admin, I want to understand how to use Dev Box Team Customizations so that I can create efficient, ready-to-code configurations for my development teams.
11
11
---
@@ -32,9 +32,9 @@ When you configure Dev Box Team Customizations for your organization, careful pl
32
32
- Add tasks.
33
33
- Attach to dev center or project.
34
34
-**Create a team customizations file:**
35
-
- Create a team customizations file called definition.yaml.
35
+
- Create a team customizations file called imagedefinition.yaml.
36
36
-**Specify image in a dev box pool:**
37
-
- Create or modify a dev box pool and specify definition.yaml as the image definition.
37
+
- Create or modify a dev box pool and specify imagedefinition.yaml as the image definition.
38
38
-**Choose how you'll use the image definition:**
39
39
- Optimize for team customization.
40
40
- Build each time you create a dev box.
@@ -47,10 +47,12 @@ Dev Box customizations use a yaml formatted file to specify a list of tasks to a
47
47
You can use secrets from your Azure Key Vault in your customization file to clone private repositories, or with any custom task you author that requires an access token.
48
48
49
49
## What are tasks?
50
-
Dev Box customization tasks are wrappers for PowerShell scripts, allowing you as a platform team to define reusable components that your teams can use in their customizations. WinGet and PowerShell are available as primitive tasks out of the box
50
+
Dev Box customization tasks are wrappers for PowerShell scripts, allowing you as a platform team to define reusable components that your teams can use in their customizations. WinGet and PowerShell are available as primitive tasks out of the box.
51
+
52
+
When creating tasks, determine which need to run in a SYSTEM context and which can run after sign-in, in a user context. Team customizations can be run in a SYSTEM context and in a user context (after sign-in). Individual customizations can only run in a user context.
51
53
52
54
## Differences Between Team and Individual Customizations
53
-
Individual developers can attach a yaml-based customization file when creating their Dev Box to control the development environment on their Dev Box. An individual customization file should be used only for personal settings and apps. While teams of developers can share common yaml files, this approach can be inefficient and error-prone, and against compliance policies. Dev Box Team Customizations provides a workflow for developer team leaders, Project Admins, and dev center administrators to preconfigure customization files on Dev Box pools. This way, a developer creating a dev box doesn't need to find and upload a customization file for themselves.
55
+
Individual developers can attach a yaml-based customization file when creating their Dev Box to control the development environment on their Dev Box. Individual customizations should be used only for personal settings and apps. Tasks specified in the individual customization file run only in the user context, after sign-in. While teams of developers can share common yaml files, this approach can be inefficient and error-prone, and against compliance policies. Dev Box Team Customizations provides a workflow for developer team leaders, Project Admins, and dev center administrators to preconfigure customization files on Dev Box pools. This way, a developer creating a dev box doesn't need to find and upload a customization file for themselves.
54
56
55
57
## Key terms
56
58
When working with Dev Box Team Customizations, you should be familiar with the following key terms:
@@ -64,7 +66,7 @@ When working with Dev Box Team Customizations, you should be familiar with the f
64
66
- Consist of one or more PowerShell scripts and a task.yaml file.
65
67
-**Customization file**
66
68
- Yaml-based file defining tasks for dev boxes.
67
-
- When shared across a team, it's called an *image definition* and specifies OS, compute, and storage.
69
+
- When shared across a team, it's an *image definition* and specifies the base dev box image, along with its customization options.
68
70
69
71
## Related content
70
72
-[Quickstart: Create Dev Box Team Customizations](quickstart-team-customizations.md)
Copy file name to clipboardExpand all lines: articles/dev-box/how-to-configure-customization-imaging.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
@@ -69,11 +69,11 @@ On the Image definition page, you see the image definitions accessible to your p
69
69
70
70
:::image type="content" source="media/how-to-configure-customization-imaging/team-customizations-image-definitions-small.png" alt-text="Screenshot of the Image definition pane in the Azure portal, showing accessible image definitions for a project." lightbox="media/how-to-configure-customization-imaging/team-customizations-image-definitions.png":::
71
71
72
-
72
+
For more information about attaching catalogs, see [Add and configure a catalog from GitHub or Azure Repos](../deployment-environments/how-to-configure-catalog.md).
73
73
74
74
## Configure a dev box pool to use an image definition
75
75
76
-
Make customizations available to your development teams by configuring a dev box pool to use a customization file (*definition.yaml*). Store the customization file in a repository linked to a catalog in your dev center or project. Specify this file as the image definition for the pool, and the customizations are applied to new dev boxes.
76
+
Make customizations available to your development teams by configuring a dev box pool to use a customization file (*imagedefinition.yaml*). Store the customization file in a repository linked to a catalog in your dev center or project. Specify this file as the image definition for the pool, and the customizations are applied to new dev boxes.
77
77
78
78
The following steps show you how to create a dev box pool and specify an image definition.
Copy file name to clipboardExpand all lines: articles/dev-box/how-to-create-customization-tasks-catalog.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ To create and manage tasks for Dev Box Team Customizations, follow these steps:
54
54
1. Create a configuration file for those tasks by following the steps in [Write a customization file](./how-to-write-customization-file.md).
55
55
56
56
### Use secrets from an Azure Key Vault
57
-
You can use secrets from your Azure Key Vault in your yaml configurations to clone private repositories, or with any custom task you author that requires an access token.
57
+
You can use secrets from your Azure Key Vault in your yaml configurations to clone private repositories, or with any custom task you author that requires an access token. Your dev center needs access to your key vault. DevCenter does not support service tags, so if your key vault is kept private you must allow trusted Microsoft services to bypass the firewall.
58
58
59
59
To configure your Key Vault secrets for use in your yaml configurations,
Copy file name to clipboardExpand all lines: articles/dev-box/how-to-write-customization-file.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: RoseHJM
5
5
ms.author: rosemalcolm
6
6
ms.service: dev-box
7
7
ms.topic: how-to
8
-
ms.date: 11/05/2024
8
+
ms.date: 11/06/2024
9
9
10
10
#customer intent: As a dev center administrator or DevCenter Project Admin I want to create image definition files so that my development teams can create customized dev boxes.
11
11
---
@@ -57,7 +57,7 @@ There are two ways to use a customization file: team customizations which apply
57
57
- Contain tasks that are applied when a dev box is created.
58
58
- Are shared across a team or project.
59
59
- Include a field that specifies the base image.
60
-
- Are named *definition.yaml*.
60
+
- Are named *imagedefinition.yaml*.
61
61
- Are uploaded to the repository that hosts your catalog.
62
62
- Are automatically used when you create a dev box from a configured pool.
63
63
@@ -67,7 +67,7 @@ There are two ways to use a customization file: team customizations which apply
67
67
68
68
## Create a customization file
69
69
70
-
You can create and manage customization files with Visual Studio Code. You can use a Visual Studio Code extension to discover the tasks in the attached catalog, and test the customization file in Visual Studio Code.
70
+
You can create and manage customization files with Visual Studio Code. You can use the [Microsoft Dev Box Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=DevCenter.ms-devbox) to discover the tasks in the attached catalog, and test the customization file in Visual Studio Code.
71
71
72
72
1. Create a Dev Box (or use an existing Dev Box) for testing.
73
73
1. On the test dev box, install Visual Studio Code and then install the [Dev Box VS Code extension](https://aka.ms/devbox/preview/customizations/vsc-extension).
@@ -122,7 +122,8 @@ To invoke the Dev Box chat agent:
122
122
123
123
## Use secrets from an Azure Key Vault
124
124
You can use secrets from your Azure Key Vault in your yaml customizations to clone private repositories, or with any custom task you author that requires an access token.
125
-
To configure your Key Vault secrets for use in your yaml customizations,
125
+
126
+
To configure your Key Vault secrets for use in your yaml customizations:
126
127
1. Ensure that your dev center project's managed identity has the Key Vault Reader role and Key Vault Secrets User role on your key vault.
127
128
2. Grant the Secrets User role for the Key Vault secret to each user or user group who should be able to consume the secret during the customization of a dev box. The user or group granted the role must include the managed identity for the dev center, your own user account, and any user or group who needs the secret during the customization of a dev box.
128
129
@@ -155,7 +156,7 @@ tasks:
155
156
pat: '{{ado://YOUR_ADO_ORG}}'
156
157
```
157
158
158
-
If your organization's policies require you to keep your Key Vault private from the internet, you can set your Key Vault to allow trusted Microsoft services to bypass your firewall rule.
159
+
Your dev center needs access to your key vault. DevCenter does not support service tags, so if your key vault is kept private you must allow trusted Microsoft services to bypass the firewall.
To learn more about WinGet Configuration, see [WinGet Configuration](https://aka.ms/winget-configuration).
176
177
177
178
## Share a customization file from a code repository
178
-
Make your customization file available to dev box pools by naming it *definition.yaml* and uploading it to the repository that hosts your catalog. When you create a dev box pool, you can select the customization file from the catalog to apply to the dev boxes in the pool.
179
+
Make your customization file available to dev box pools by naming it *imagedefinition.yaml* and uploading it to the repository that hosts your catalog. When you create a dev box pool, you can select the customization file from the catalog to apply to the dev boxes in the pool.
179
180
180
181
## Related content
181
182
- [Microsoft Dev Box Team Customizations](concept-what-are-team-customizations.md)
0 commit comments