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
+18-18Lines changed: 18 additions & 18 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: 10/2/2024
8
+
ms.date: 11/05/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
---
@@ -24,9 +24,9 @@ When you configure Dev Box Team Customizations for your organization, careful pl
24
24
-**Configure your dev center:**
25
25
- Enable project-level catalogs.
26
26
- Assign permissions for Project Admins.
27
-
-**Decide whether to use a catalog:**
28
-
- Dev center (quick start catalog)
29
-
-Simple PowerShell or WinGet statements.
27
+
-**Decide whether to use a catalog with custom reusable components:**
28
+
- Dev center
29
+
- PowerShell or WinGet statements.
30
30
- Your own catalog
31
31
- Host in Azure Repos or GitHub.
32
32
- Add tasks.
@@ -47,24 +47,24 @@ 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
-
A task performs a specific action, like installing software. You can store a collection of curated tasks in a catalog attached to your dev center, with each task in a separate folder. Each task consists of one or more PowerShell scripts, along with a task.yaml file that provides parameters and defines how the scripts run.
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
51
52
52
## 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. 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.
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.
54
54
55
55
## Key terms
56
-
**Catalog**
57
-
- Repository for storing tasks
58
-
-Hosted on GitHub or Azure Repos
59
-
- Attached to dev center or project to make tasks accessible to the developer team
60
-
**Tasks**
61
-
- Perform specific actions, like installing software
62
-
-Consist of one or more PowerShell scripts and a task.yaml file
63
-
**Customization file**
64
-
- Yaml-based file defining tasks for dev boxes
65
-
**Image definition**
66
-
- Dev box definition or definition.yaml
67
-
- Specifies OS, compute, storage
56
+
When working with Dev Box Team Customizations, you should be familiar with the following key terms:
57
+
58
+
-**Catalog**
59
+
- Can be stored in your code repository, or in a separate repository of customization files.
60
+
- Hosted on GitHub or Azure Repos.
61
+
- Attached to dev center or project to make tasks accessible to the developer team.
62
+
-**Tasks**
63
+
- Perform specific actions, like installing software.
64
+
- Consist of one or more PowerShell scripts and a task.yaml file.
65
+
-**Customization file**
66
+
- 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.
68
68
69
69
## Related content
70
70
-[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
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,15 @@ author: RoseHJM
5
5
ms.author: rosemalcolm
6
6
ms.service: dev-box
7
7
ms.topic: how-to
8
-
ms.date: 11/01/2024
8
+
ms.date: 11/05/2024
9
9
10
10
#customer intent: As a dev center administrator or Project Admin, I want to configure dev box pools to use image definition files so that my development teams can create customized dev boxes.
11
11
---
12
12
13
-
# Configure imaging for Dev Box Team Customizations
14
-
Using a customization file simplifies the creation of dev boxes for your team. With Microsoft Dev Box customizations, you can either apply the customization file directly when creating a dev box or use it to create an image. Creating an image optimizes customizations and provides a reusable image for your team, saving time during dev box creation. In this article, you learn how to configure a pool to use a customization file as an image and build a reusable image.
13
+
# Create a shared Customization
14
+
Using a customization file simplifies the creation of dev boxes for your team. With dev box customizations, you can create a shared team customization by creating a customization file called an *image definition*. Creating a reusable image from this image definition optimizes customizations and saves time during dev box creation. In this article, you learn how to configure a pool to use an image definition and build reusable images for your development teams.
15
15
16
-
Process overview:
16
+
To configure imaging for Dev Box Team Customizations, follow these steps:
17
17
1. Enable project-level catalogs.
18
18
1. Configure catalog sync settings for the project.
19
19
1. Attach a catalog that contains a definition file.
@@ -37,7 +37,7 @@ To manage a dev box pool, you need the following permissions:
37
37
38
38
| Action | Permissions required |
39
39
|---|---|
40
-
|_Create, delete, or update a dev box pool_| - Owner or Contributor permissions on an Azure subscription or a specific resource group. </br>- DevCenter Project Admin permissions for the project. |
40
+
|_Create, delete, or update a dev box pool_| - Owner or Contributor permissions on an Azure subscription or a specific resource group. </br>- DevCenter Project Admin permissions for the project. |
41
41
42
42
## Enable project-level catalogs
43
43
@@ -127,7 +127,7 @@ To build an image from a customization file, follow these steps:
127
127
128
128
:::image type="content" source="./media/how-to-configure-customization-imaging/customizations-image-build-progress-small.png" alt-text="Screenshot of the Image definition page, with the image status Progressing highlighted." lightbox="./media/how-to-configure-customization-imaging/customizations-image-build-progress.png":::
129
129
130
-
When the build completes successfully, the image is available for use in the dev box pool. You can now create dev boxes from the pool, and the customizations are applied to each dev box.
130
+
When the build completes successfully, the dev box pool automatically uses the image for new dev boxes. You don't need to do any extra configuration to assign the image to the pool. You can now create dev boxes from the pool, and the customizations are applied to each dev box.
131
131
132
132
## Related content
133
133
-[Microsoft Dev Box Team Customizations](concept-what-are-team-customizations.md)
Copy file name to clipboardExpand all lines: articles/dev-box/how-to-create-customization-tasks-catalog.md
+5-16Lines changed: 5 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,14 +5,14 @@ author: RoseHJM
5
5
ms.author: rosemalcolm
6
6
ms.service: dev-box
7
7
ms.topic: how-to
8
-
ms.date: 10/26/2024
8
+
ms.date: 11/05/2024
9
9
10
10
#customer intent: As a dev center administrator or Project Admin, I want to create additional tasks in a catlog so that I can create a specific customization in a customization or image definition file.
11
11
---
12
12
13
13
# Create Tasks for Dev Box Team Customizations
14
14
15
-
Creating tasks for Dev Box Team Customizations allows you to define specific actions for your dev boxes, ensuring a consistent and efficient development environment. Creating new tasks in a catalog allows you to create customizations tailored to your development teams and add guardrails around the configurations that are possible. This article guides you through creating a catalog for customization tasks, adding tasks, and attaching the catalog to a dev center or project.
15
+
Creating tasks for Dev Box Team Customizations allows you to define specific actions for your dev boxes, ensuring a consistent and efficient development environment. Creating new tasks in a catalog allows you to create reusable components tailored to your development teams and add guardrails around the configurations that are possible. This article guides you through creating a catalog for customization tasks, adding tasks, and attaching the catalog to a dev center or project.
@@ -28,6 +28,8 @@ To complete the steps in this article, you must have:
28
28
## What are tasks?
29
29
A task performs a specific action, like installing software. Each task consists of one or more PowerShell scripts, along with a task.yaml file that provides parameters and defines how the scripts run. You can also include a PowerShell command in the task.yaml file. You can store a collection of curated tasks in a catalog attached to your dev center, with each task in a separate folder. Dev Box supports using a GitHub repository or an Azure Repos repository as a catalog and scans a specified folder of the catalog recursively to find task definitions.
30
30
31
+
WinGet and PowerShell are available from any dev center without requiring a catalog. If your customizations use only Winget or PowerShell, you can create tasks that use them in a customization file. If you need to use other tools or scripts, you can create tasks in a catalog.
32
+
31
33
Microsoft provides a quick start catalog to help you get started with customizations. It includes a default set of tasks that define common tasks:
32
34
33
35
- Install software with WinGet package manager
@@ -38,7 +40,7 @@ Microsoft provides a quick start catalog to help you get started with customizat
38
40
39
41
## Create tasks in a catalog
40
42
41
-
Tasks, such as installing software or running scripts, are organized into a catalog. You create and manage tasks in a catalog, define new tasks, and attach your catalog to a dev center. With Microsoft's quick start catalog, you can get started with common tasks like installing software with WinGet, deploying desired state configurations, cloning repositories, configuring applications, and running PowerShell scripts.
43
+
Tasks, such as installing software or running scripts, are organized into a catalog. You create and manage tasks in a catalog, define new tasks, and attach your catalog to a dev center. With Microsoft's quick start catalog, you can get started with common tasks like installing software, deploying desired state configurations, cloning repositories, and configuring applications.
42
44
43
45
### Define new tasks
44
46
To create and manage tasks for Dev Box Team Customizations, follow these steps:
@@ -51,19 +53,6 @@ To create and manage tasks for Dev Box Team Customizations, follow these steps:
51
53
52
54
1. Create a configuration file for those tasks by following the steps in [Write a customization file](./how-to-write-customization-file.md).
53
55
54
-
### Customize your dev box by using existing WinGet Configuration files
55
-
WinGet Configuration takes a config-as-code approach to defining the unique sets of software and configuration settings needed to get your Windows environment in a ready-to-code state. These configuration files can also be used to set up a Dev Box, by using a WinGet task included in the Microsoft provided quickstart catalog mentioned earlier.
56
-
The following example shows a dev box customization file that calls an existing WinGet DSC file.
57
-
58
-
```yml
59
-
tasks:
60
-
- name: winget
61
-
parameters:
62
-
configure: "projectConfiguration.dsc.yaml"
63
-
```
64
-
65
-
To learn more about WinGet Configuration, see [WinGet Configuration](https://aka.ms/winget-configuration).
66
-
67
56
### Use secrets from an Azure Key Vault
68
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.
0 commit comments