Skip to content

Commit c1d4111

Browse files
authored
Merge pull request #229791 from ktoliver/67052
[AQ] edit pass: 7 articles in Deployment Environments doc set
2 parents 240d72b + 31aafa4 commit c1d4111

10 files changed

+209
-218
lines changed
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
---
22
title: Azure Deployment Environments and Microsoft Dev Box common elements
3-
description: Discover the components shared by Azure Deployment Environments and Microsoft Dev Box.
3+
description: Discover the components that are shared by Azure Deployment Environments Preview and Microsoft Dev Box.
44
ms.service: deployment-environments
55
ms.custom: ignite-2022
66
ms.topic: conceptual
77
ms.author: rosemalcolm
88
author: RoseHJM
99
ms.date: 01/26/2022
1010
---
11-
# Components common to Azure Deployment Environments and Microsoft Dev Box
11+
# Components common to Azure Deployment Environments and Microsoft Dev Box
1212

1313
> [!TIP]
14-
> Welcome to the **Azure Deployment Environments** documentation. If you're looking for information about **Microsoft Dev Box**, follow this link: [*Components common to Microsoft Dev Box and Azure Deployment Environments*](../dev-box/concept-common-components.md).
14+
> Welcome to the *Azure Deployment Environments Preview* documentation.
15+
>
16+
> If you're looking for information about *Microsoft Dev Box*, go to [Components common to Microsoft Dev Box and Azure Deployment Environments](../dev-box/concept-common-components.md).
1517
16-
[!INCLUDE [ade-mdb-common-components](../../includes/ade-mdb-common-components/ade-mdb-common-components.md)]
18+
[!INCLUDE [ade-mdb-common-components](../../includes/ade-mdb-common-components/ade-mdb-common-components.md)]

articles/deployment-environments/how-to-configure-catalog.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.topic: how-to
1212

1313
# Add and configure a catalog
1414

15-
Learn how to add and configure a [catalog](./concept-environments-key-concepts.md#catalogs) in your Azure Deployment Environments Preview dev center. You can use a catalog to provide your development teams with a curated set of infrastructure as code (IaC) templates called [*catalog items*](./concept-environments-key-concepts.md#catalog-items).
15+
Learn how to add and configure a [catalog](./concept-environments-key-concepts.md#catalogs) in your Azure Deployment Environments Preview dev center. You can use a catalog to provide your development teams with a curated set of infrastructure as code (IaC) templates called [catalog items](./concept-environments-key-concepts.md#catalog-items).
1616

1717
For more information about catalog items, see [Add and configure a catalog item](./configure-catalog-item.md).
1818

@@ -27,9 +27,9 @@ In this article, you learn how to:
2727

2828
> [!div class="checklist"]
2929
>
30-
> - Add a catalog
31-
> - Update a catalog
32-
> - Delete a catalog
30+
> - Add a catalog.
31+
> - Update a catalog.
32+
> - Delete a catalog.
3333
3434
> [!IMPORTANT]
3535
> Azure Deployment Environments currently is in preview. For legal terms that apply to Azure features that are in beta, in preview, or otherwise are not yet released into general availability, see the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
@@ -39,7 +39,7 @@ In this article, you learn how to:
3939
To add a catalog, you complete these tasks:
4040

4141
- Get the clone URL for your repository.
42-
- Create a personal access token
42+
- Create a personal access token.
4343
- Store the personal access token as a key vault secret in Azure Key Vault.
4444
- Add your repository as a catalog.
4545

@@ -53,13 +53,13 @@ You can choose from two types of repositories:
5353
#### Get the clone URL of a GitHub repository
5454

5555
1. Go to the home page of the GitHub repository that contains the template definitions.
56-
1. [Get the clone URL](/azure/devops/repos/git/clone#get-the-clone-url-of-a-github-repo).
56+
1. [Get the GitHub repo clone URL](/azure/devops/repos/git/clone#get-the-clone-url-of-a-github-repo).
5757
1. Copy and save the URL. You use it later.
5858

5959
#### Get the clone URL of an Azure DevOps repository
6060

6161
1. Go to the home page of your team collection (for example, `https://contoso-web-team.visualstudio.com`), and then select your project.
62-
1. [Get the clone URL](/azure/devops/repos/git/clone#get-the-clone-url-of-an-azure-repos-git-repo).
62+
1. [Get the Git repo clone URL](/azure/devops/repos/git/clone#get-the-clone-url-of-an-azure-repos-git-repo).
6363
1. Copy and save the URL. You use it later.
6464

6565
### Create a personal access token
@@ -70,24 +70,23 @@ Next, create a personal access token. Depending on the type of repository you us
7070

7171
1. Go to the home page of the GitHub repository that contains the template definitions.
7272
1. In the upper-right corner of GitHub, select the profile image, and then select **Settings**.
73-
1. In the left sidebar, select **Developer settings**.
74-
1. In the left sidebar, select **Personal access tokens**.
73+
1. On the left sidebar, select **Developer settings** > **Personal access tokens**.
7574
1. Select **Generate new token**.
76-
1. In **New personal access token**, in **Note**, enter a description for your token.
75+
1. On **New personal access token**, in **Note**, enter a description for your token.
7776
1. In the **Expiration** dropdown, select an expiration for your token.
7877
1. For a private repository, under **Select scopes**, select the **repo** scope.
7978
1. Select **Generate token**.
8079
1. Save the generated token. You use the token later.
8180

8281
#### Create a personal access token in Azure DevOps
8382

84-
1. Go to the home page of your team collection (for example, `https://contoso-web-team.visualstudio.com`), and then select your project.
83+
1. Go to the home page of your team collection (for example, `https://contoso-web-team.visualstudio.com`) and select your project.
8584
1. Create a [personal access token](/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate#create-a-pat).
8685
1. Save the generated token. You use the token later.
8786

8887
### Store the personal access token as a key vault secret
8988

90-
To store the personal access token, you generated as a [key vault secret](../key-vault/secrets/about-secrets.md) and copy the secret identifier:
89+
To store the personal access token that you generated as a [key vault secret](../key-vault/secrets/about-secrets.md) and copy the secret identifier:
9190

9291
1. Create a [key vault](../key-vault/general/quick-create-portal.md#create-a-vault).
9392
1. Add the personal access token as a [secret to the key vault](../key-vault/secrets/quick-create-portal.md#add-a-secret-to-key-vault).
@@ -97,46 +96,46 @@ To store the personal access token, you generated as a [key vault secret](../key
9796

9897
1. In the [Azure portal](https://portal.azure.com/), go to your dev center.
9998
1. Ensure that the [identity](./how-to-configure-managed-identity.md) that's attached to the dev center has [access to the key vault secret](./how-to-configure-managed-identity.md#grant-the-managed-identity-access-to-the-key-vault-secret) where your personal access token is stored.
100-
1. In the left menu under **Environment configuration**, select **Catalogs**, and then select **Add**.
101-
1. In **Add catalog**, enter the following information, and then select **Add**:
99+
1. On the left menu under **Environment configuration**, select **Catalogs**, and then select **Add**.
100+
1. On **Add catalog**, enter the following information, and then select **Add**:
102101

103102
| Field | Value |
104103
| ----- | ----- |
105104
| **Name** | Enter a name for the catalog. |
106-
| **Git clone URI** | Enter or paste the [clone URL](#get-the-clone-url-for-your-repository) for either your GitHub repository or your Azure DevOps repository.<br/>*Sample Catalog Example:* https://github.com/Azure/deployment-environments.git |
107-
| **Branch** | Enter the repository branch to connect to.<br/>*Sample Catalog Example:* main|
108-
| **Folder path** | Enter the folder path relative to the clone URI that contains subfolders with your catalog items. </br> This folder path should be the path to the folder that contains the subfolders with the catalog item manifests, and not the path to the folder with the catalog item manifest itself.<br/>*Sample Catalog Example:* /Environments</br> The folder path can begin with or without a '/'.|
109-
| **Secret identifier**| Enter the [secret identifier](#create-a-personal-access-token) that contains your personal access token for the repository.</br>When you copy a Secret Identifier, the connection string includes a version identifier at the end, like this: https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat/9376b432b72441a1b9e795695708ea5a. </br>Removing the version identifier ensures that Deployment Environments fetches the latest version of the secret from the key vault. If your PAT expires, only the key vault needs to be updated. </br> *Example secret identifier: https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat*|
105+
| **Git clone URI** | Enter or paste the [clone URL](#get-the-clone-url-for-your-repository) for either your GitHub repository or your Azure DevOps repository.<br />*Sample catalog example:* `https://github.com/Azure/deployment-environments.git` |
106+
| **Branch** | Enter the repository branch to connect to.<br />*Sample catalog example:* `main`|
107+
| **Folder path** | Enter the folder path relative to the clone URI that contains subfolders that hold your catalog items. <br /> This folder path should be the path to the folder that contains the subfolders that have the catalog item manifests, and not the path to the folder that has the catalog item manifest itself.<br />*Sample catalog example:* `/Environments`<br /> The folder path can begin with or without a forward slash (`/`).|
108+
| **Secret identifier**| Enter the [secret identifier](#create-a-personal-access-token) that contains your personal access token for the repository.<br /> When you copy a secret identifier, the connection string includes a version identifier at the end, like in this example: `https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat/9376b432b72441a1b9e795695708ea5a`.<br />Removing the version identifier ensures that Deployment Environments fetches the latest version of the secret from the key vault. If your personal access token expires, only the key vault needs to be updated. <br />*Example secret identifier:* `https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat`|
110109

111110
:::image type="content" source="media/how-to-configure-catalog/add-catalog-form-inline.png" alt-text="Screenshot that shows how to add a catalog to a dev center." lightbox="media/how-to-configure-catalog/add-catalog-form-expanded.png":::
112111

113-
1. In **Catalogs** for the dev center, verify that your catalog appears. If the connection is successful, **Status** is **Connected**.
112+
1. On **Catalogs** for the dev center, verify that your catalog appears. If the connection is successful, **Status** is **Connected**.
114113

115114
## Update a catalog
116115

117-
If you update the ARM template contents or definition in the attached repository, you can provide the latest set of catalog items to your development teams by syncing the catalog.
116+
If you update the Azure Resource Manager template (ARM template) contents or definition in the attached repository, you can provide the latest set of catalog items to your development teams by syncing the catalog.
118117

119118
To sync an updated catalog:
120119

121-
1. In the left menu for your dev center, under **Environment configuration**, select **Catalogs**,
120+
1. On the left menu for your dev center, under **Environment configuration**, select **Catalogs**,
122121
1. Select the specific catalog, and then select **Sync**. The service scans through the repository and makes the latest list of catalog items available to all the associated projects in the dev center.
123122

124123
## Delete a catalog
125124

126-
You can delete a catalog to remove it from the dev center. Templates in a deleted catalog are not available to development teams when they deploy new environments. Update the catalog item reference for any existing environments that were created by using the catalog items in the deleted catalog. If the reference isn't updated and the environment is redeployed, the deployment fails.
125+
You can delete a catalog to remove it from the dev center. Templates in a deleted catalog aren't available to development teams when they deploy new environments. Update the catalog item reference for any existing environments that were created by using the catalog items in the deleted catalog. If the reference isn't updated and the environment is redeployed, the deployment fails.
127126

128127
To delete a catalog:
129128

130-
1. In the left menu for your dev center, under **Environment configuration**, select **Catalogs**.
129+
1. On the left menu for your dev center, under **Environment configuration**, select **Catalogs**.
131130
1. Select the specific catalog, and then select **Delete**.
132131
1. In the **Delete catalog** dialog, select **Continue** to delete the catalog.
133132

134133
## Catalog sync errors
135134

136135
When you add or sync a catalog, you might encounter a sync error. A sync error indicates that some or all the catalog items have errors. Use the Azure CLI or the REST API to GET the catalog. The GET response shows you the type of errors:
137136

138-
- Ignored catalog items that were detected to be duplicates
139-
- Invalid catalog items that failed due to schema, reference, or validation errors
137+
- Ignored catalog items that were detected to be duplicates.
138+
- Invalid catalog items that failed due to schema, reference, or validation errors.
140139

141140
### Resolve ignored catalog item errors
142141

@@ -152,7 +151,7 @@ An invalid catalog item error might occur for various reasons:
152151

153152
- Ensure that the manifest's engine type is correctly configured as `ARM`.
154153
- Ensure that the catalog item name is between 3 and 63 characters.
155-
- Ensure that the catalog item name includes only characters that are valid for a URL: alphanumeric characters and the symbols `~` `!` `,` `.` `'` `;` `:` `=` `-` `_` `+` `)` `(` `*` `&` `$` `@`.
154+
- Ensure that the catalog item name includes only characters that are valid for a URL, which are alphanumeric characters and these symbols: `~` `!` `,` `.` `'` `;` `:` `=` `-` `_` `+` `(` `)` `*` `&` `$` `@`
156155

157156
- **Reference errors**. Ensure that the template path that the manifest references is a valid relative path to a file in the repository.
158157

0 commit comments

Comments
 (0)