Zápis souboru přizpůsobení pro vývojové pole
V tomto článku se dozvíte, jak vytvořit a otestovat soubor přizpůsobení pro vývoj pomocí editoru Visual Studio Code (VS Code) a Centrum vývojářů.
Soubor přizpůsobení v Microsoft Dev Boxu můžete použít dvěma způsoby. Přizpůsobení týmu se použije automaticky, když je vývojáři nakonfigurují ve fondu. Individuální přizpůsobení se použijí, když uživatel vytvoří vývojové pole.
Tento článek vám pomůže definovat nové úlohy v souboru vlastního nastavení, použít je na vývojová pole a otestovat tato přizpůsobení přímo ve VS Code.
Důležité
Funkce přizpůsobení týmu Dev Boxu je aktuálně ve verzi Preview. Další informace o stavu Preview najdete v dodatečných podmínkách použití pro Microsoft Azure Preview. Dokument definuje právní podmínky, které se vztahují na funkce Azure, které jsou v beta verzi, ve verzi Preview nebo jinak ještě nejsou vydané v obecné dostupnosti.
Požadavky
Pokud chcete dokončit kroky v tomto článku, musíte:
- Nakonfigurujte vývojové centrum s definicí vývojového pole, fondem vývojových boxů a projektem vývojového boxu, abyste mohli vytvořit vývojové pole.
- Buďte členem skupiny zabezpečení Dev Box Users alespoň pro jeden projekt.
- Katalog je připojený k vývojovému centru s úlohami, které můžete použít v souboru vlastního nastavení. Pokud katalog nemáte, přečtěte si téma Přidání a konfigurace katalogu z GitHubu nebo Azure Repos.
Oprávnění potřebná ke konfiguraci vlastních nastavení
Pokud chcete provést požadované akce pro vytváření a aplikování vlastních nastavení na vývojové pole, potřebujete následující oprávnění:
| Akce | Oprávnění nebo role |
|---|---|
| Povolte katalogy na úrovni projektu pro vývojové centrum. | Inženýr platformy s přístupem k zápisu v předplatném. |
| Povolte nastavení synchronizace katalogu pro projekt. | Inženýr platformy s přístupem k zápisu v předplatném. |
| Připojte katalog k projektu. | Oprávnění správce projektu nebo přispěvatele k projektu |
| Vytvořte soubor vlastního nastavení. | Není zadán žádný. Soubor vlastního nastavení může vytvořit kdokoli. |
| Pomocí portálu pro vývojáře nahrajte a použijte soubor YAML během vytváření vývojového pole. | Uživatel Dev Boxu. |
| Přidejte úkoly do katalogu. | Oprávnění k přidání do úložiště, které je hostitelem katalogu. |
Co je soubor s vlastním nastavením?
Přizpůsobení Dev Boxu používá soubor ve formátu YAML k určení seznamu úkolů, které se mají použít, když vývojář vytvoří vývojové pole. Tyto úlohy můžou být stejně jednoduché jako instalace balíčku nebo stejně sofistikované jako spuštění komplexní sady skriptů pro nastavení základu kódu. Úkoly identifikují katalog a poskytují parametry, jako je název softwaru, který se má nainstalovat. Soubor přizpůsobení se pak zpřístupní vývojářům, kteří vytvářejí vývojové rámečky.
Následující příklad používá winget úlohu k instalaci VS Code a git-clone úlohy klonování úložiště:
# From https://github.com/microsoft/devcenter-examples
$schema: 1.0
tasks:
- name: winget
parameters:
package: Microsoft.VisualStudioCode
runAsUser: true
- name: git-clone
description: Clone this repository into C:\Workspaces
parameters:
repositoryUrl: https://github.com/OrchardCMS/OrchardCore.git
directory: C:\Workspaces
Soubor přizpůsobení můžete použít dvěma způsoby: individuální přizpůsobení platí pro jeden vývojový box a přizpůsobení týmu platí pro celý tým.
Jednotlivé soubory přizpůsobení
- Obsahují úlohy, které se použijí při vytvoření vývojového pole vývojáře.
- Nahraje vývojář během vytváření vývojového pole.
Soubory pro přizpůsobení týmu
- Obsahují úlohy, které se použijí při vytvoření vývojového pole vývojáře.
- Sdílí se napříč týmem nebo projektem.
- Zahrňte pole, které určuje základní image.
- Jsou pojmenovány imagedefinition.yaml.
- Nahrají se do úložiště, které je hostitelem katalogu.
- Automaticky se používají, když vývojář vytvoří vývojové pole z nakonfigurovaného fondu.
Důležité
Definice obrázků můžou jako základní image používat jenom image z Marketplace Dev Boxu. Pokud chcete získat seznam imagí, ke kterým má váš dev center přístup, použijte tento příkaz Azure CLI:
az devcenter admin image list --dev-center-name CustomizationsImagingHQ --resource-group TeamCustomizationsImagingRG --query "[].name"
Vytvoření souboru vlastního nastavení
Soubory přizpůsobení můžete vytvářet a spravovat pomocí nástroje VS Code. Rozšíření Microsoft Dev Box v editoru VS Code můžete použít ke zjištění úloh v připojeném katalogu a otestování souboru přizpůsobení.
Vytvoření vývojového pole (nebo použití existujícího vývojového pole) k testování
V testovacím vývojovém poli nainstalujte VS Code a pak nainstalujte rozšíření Dev Box.
Stáhněte si ukázkový soubor přizpůsobení YAML z úložiště ukázek a otevřete ho ve VS Code.
Objevte úkoly dostupné v katalogu pomocí palety příkazů. Výběr palety příkazů Zobrazit>vývojové>pole: Zobrazení dostupných úkolů pro toto vývojové pole
Otestujte přizpůsobení v editoru VS Code pomocí palety příkazů. Výběr možnosti Zobrazit>paletu>příkazů Dev Box: Použití úloh přizpůsobení
Soubor přizpůsobení se spustí okamžitě a použije zadané úlohy do testovacího vývojového pole. Zkontrolujte změny a v terminálu VS Code zkontrolujte případné chyby nebo upozornění vygenerovaná během provádění úlohy.
Když se soubor přizpůsobení úspěšně spustí, nahrajte ho do katalogu.
Klonování privátního úložiště pomocí souboru přizpůsobení
Tajné kódy z trezoru klíčů Azure můžete použít ve vlastních přizpůsobeních YAML ke klonování privátních úložišť nebo s jakoukoli vlastní úlohou, kterou vytvoříte, která vyžaduje přístupový token. V souboru vlastního nastavení týmu můžete pro přístup k privátnímu úložišti použít token PAT uložený v trezoru klíčů.
Použití tajných kódů trezoru klíčů v souborech pro přizpůsobení týmu
Pokud chcete naklonovat privátní úložiště, uložte pat jako tajný klíč trezoru klíčů a použijte ho při vyvolání git-clone úlohy v přizpůsobení.
Konfigurace tajných kódů trezoru klíčů pro použití v přizpůsobení YAML:
- Ujistěte se, že spravovaná identita projektu vývojového centra má ve vašem trezoru klíčů roli Čtenář služby Key Vault a role Uživatele tajných kódů služby Key Vault.
- Udělte roli uživatele tajných kódů služby Key Vault pro tajný klíč trezoru klíčů jednotlivým uživatelům nebo skupinám uživatelů, kteří by měli být schopni tajné kódy využívat během přizpůsobení vývojového pole. Uživatel nebo skupina, kterým byla role udělena, musí obsahovat spravovanou identitu pro vývojové centrum, vlastní uživatelský účet a všechny uživatele nebo skupiny, které během přizpůsobení vývojového pole potřebují tajný kód.
Další informace naleznete v tématu:
- Konfigurace spravované identity pro dev center
- Udělení přístupu spravované identity k tajnému klíči trezoru klíčů
Na tajný kód v přizpůsobení YAML můžete odkazovat v následujícím formátu, který jako příklad používá git-clone úlohu:
$schema: "1.0"
tasks:
- name: git-clone
description: Clone this repository into C:\Workspaces
parameters:
repositoryUrl: https://myazdo.visualstudio.com/MyProject/_git/myrepo
directory: C:\Workspaces
pat: '{{KEY_VAULT_SECRET_URI}}'
Použití tajných kódů trezoru klíčů v jednotlivých souborech přizpůsobení
Pokud chcete naklonovat privátní úložiště Azure Repos z individuálního souboru přizpůsobení, nemusíte v Azure Key Vaultu konfigurovat tajný kód. Místo toho můžete použít {{ado}} nebo {{ado://your-ado-organization-name}} jako parametr. Tento parametr načte přístupový token vaším jménem při vytváření vývojového pole. Přístupový token má oprávnění jen pro čtení k vašemu úložišti.
Úloha git-clone v katalogu rychlého startu používá přístupový token ke klonování úložiště. Tady je příklad:
tasks:
- name: git-clone
description: Clone this repository into C:\Workspaces
parameters:
repositoryUrl: https://myazdo.visualstudio.com/MyProject/_git/myrepo
directory: C:\Workspaces
pat: '{{ado://YOUR_ADO_ORG}}'
Vaše vývojové centrum potřebuje přístup k vašemu trezoru klíčů. Vývojová centra nepodporují značky služeb, takže pokud je váš trezor klíčů soukromý, musíte povolit důvěryhodné služby Microsoft obejít bránu firewall.
Informace o tom, jak povolit důvěryhodné služby Microsoft obejít bránu firewall, najdete v tématu Konfigurace nastavení sítě služby Azure Key Vault.
Přizpůsobení vývojového pole pomocí existujících konfiguračních souborů WinGet
Konfigurace WinGet používá přístup ke konfiguraci jako kódu k definování jedinečných sad softwarových a konfiguračních nastavení potřebných k tomu, aby vaše prostředí Windows bylo připravené ke stavu kódu. Tyto konfigurační soubory můžete také použít k nastavení vývojového pole pomocí úlohy WinGet zahrnuté v katalogu Rychlý start od Microsoftu.
Následující příklad ukazuje soubor přizpůsobení vývojového pole, který volá existující soubor DSC (WinGet Desired State Configuration):
tasks:
- name: winget
parameters:
configure: "projectConfiguration.dsc.yaml"
Další informace najdete v tématu Konfigurace WinGet.
Sdílení souboru přizpůsobení z úložiště kódu
Zpřístupnění souboru vlastního nastavení pro fondy dev boxů jeho pojmenováním imagedefinition.yaml a jeho nahráním do úložiště, které je hostitelem vašeho katalogu. Když vytvoříte fond vývojových boxů, můžete vybrat soubor přizpůsobení z katalogu, který se má použít u vývojových polí ve fondu.