In diesem Artikel wird erläutert, wie Sie einen Katalog für Ihr Microsoft Dev Box Dev Center oder Projekt hinzufügen und konfigurieren.
Kataloge helfen Ihnen, eine Reihe kuratierter Bilddefinitionen für Ihre Entwicklungsteams bereitzustellen, um vorgefertigte Entwicklerfelder zu erstellen. Sie können Ihr eigenes Quellcodeverwaltungs-Repository von GitHub oder Azure Repos als Katalog anfügen.
Um Ihre Vorlagen weiter zu sichern, wird der Katalog verschlüsselt; Dev Box unterstützt ruhende Verschlüsselung mit plattformverwalteten Verschlüsselungsschlüsseln, die Microsoft für Azure Services verwaltet.
- Informationen zum Hosten eines Repositorys auf GitHub finden Sie unter Erste Schritte mit GitHub.
- Informationen zum Hosten eines Git-Repositorys in einem Azure Repos-Projekt finden Sie unter Azure Repos.
Durch das Anfügen von Katalogen auf Projektebene können Plattformtechniker Bilddefinitionen bereitstellen, die für die einzelnen Entwicklungsteams spezifisch sind. Darüber hinaus können Entwicklerteamleiter, die als Project-Administratoren zugewiesen wurden, die Bilddefinitionen verwalten, die ihren Teams zur Verfügung gestellt werden.
Plattformentwickler haben die volle Kontrolle über die Verwendung von Katalogen auf Projektebene. Die Verwendung von Katalogen auf Projektebene muss auf Dev Center-Ebene aktiviert werden, bevor ein Katalog einem Projekt hinzugefügt werden kann. Plattformtechniker können auch konfigurieren, welche Typen von Katalogelementen, z. B. Bilddefinitionen, auf Projektebene genutzt werden können.
Standardmäßig ist die Verwendung von Katalogen auf Projektebene deaktiviert, und keiner der Katalogelementtypen ist aktiviert. Unter zwei Bedingungen werden Umgebungsdefinitionen aus einem Katalog auf Projektebene synchronisiert und können verwendet werden. Zunächst müssen Sie projektbasierte Kataloge auf der entsprechenden Dev Center-Ebene aktivieren. Zweitens müssen Sie die Verwendung von Bilddefinitionen für das Projekt aktivieren.
Hinzufügen eines Katalogs zu einem Projekt
Sie müssen Kataloge auf Projektebene auf Dev Center-Ebene aktivieren, bevor Sie einem Projekt einen Katalog hinzufügen können. Sie sollten auch die Verwendung von Bilddefinitionen auf Projektebene aktivieren.
So aktivieren Sie das Verwenden von Katalogen auf Projektebene auf Dev Center-Ebene:
Navigieren Sie im Azure-Portal zu Ihrem Dev Center.
Wählen Sie im linken Menü unter "Einstellungen" die Dev Center-Einstellungen aus.
Wählen Sie unter Kataloge auf Projektebene die Option Kataloge pro Projekt aktivieren aus, und wählen Sie dann Anwenden aus.
So aktivieren Sie die Verwendung von Bilddefinitionen im Projekt:
Navigieren Sie im Azure-Portal zu Ihrem Projekt.
Wählen Sie im Menü auf der linken Seite unter Einstellungen Kataloge aus.
Wählen Sie auf der Seite Kataloge Katalogelementberechtigungen aus.
Wählen Sie im Bereich " Katalogelementeinstellungen " die Azure-Bereitstellungsimagedefinitionen aus, um die Verwendung von Bilddefinitionen auf Projektebene zu ermöglichen.
Jetzt können Sie dem Projekt einen Katalog hinzufügen.
Für Kataloge, bei denen eine verwaltete Identität oder ein persönliches Zugriffstoken (PAT) für die Authentifizierung verwendet werden, müssen Sie dem Projekt eine verwaltete Identität zuweisen. Für Kataloge, die ein PAT verwenden, müssen Sie das PAT in einem Schlüsseltresor speichern und der verwalteten Identität Zugriff auf das Schlüsseltresorgeheimnis gewähren.
Bevor Sie einen Katalog an ein Dev Center oder Projekt anfügen können, müssen Sie eine verwaltete Identitätkonfigurieren, die auch als verwaltete Dienstidentität (Managed Service Identity, MSI) bezeichnet wird. Sie können entweder eine systemseitig zugewiesene verwaltete Identität (systemseitig zugewiesene MSI) oder eine benutzerseitig zugewiesene verwaltete Identität (benutzerseitig zugewiesene MSI) verwenden. Anschließend weisen Sie der verwalteten Identität Rollen zu, damit das Dev Center oder Projekt Umgebungstypen in Ihrem Abonnement erstellen und das Azure Repos-Projekt lesen kann, das das Katalogrepository enthält.
Wenn keine MSI an Ihr Dev Center oder Projekt angefügt ist, führen Sie die Schritte unter Konfigurieren einer verwalteten Identität aus, um eine verwaltete Identität zu erstellen und Rollen für die verwaltete Identität zuzuweisen.
Weitere Informationen zu verwalteten Identitäten finden Sie unter Was sind verwaltete Identitäten für Azure-Ressourcen?.
Hinzufügen eines Katalogs
Sie können einen Katalog aus einem Azure Repos-Repository oder aus einem GitHub-Repository hinzufügen. Sie können sich authentifizieren, indem Sie einer MSI Berechtigungen zuweisen oder ein PAT verwenden, das Sie in einem Schlüsseltresor speichern.
Wählen Sie die Registerkarte für den Typ des Repositorys und der Authentifizierung aus, die Sie verwenden möchten.
Führen Sie zum Hinzufügen eines Katalogs die folgenden Aufgaben aus:
- Weisen Sie Berechtigungen in Azure Repos für die verwaltete Identität zu.
- Hinzufügen des Repositorys als Katalog
Zuweisen von Berechtigungen in Azure Repos für die verwaltete Identität
Sie müssen der verwalteten Identität Berechtigungen für das Repository in Azure Repos erteilen.
Melden Sie sich bei Ihrer Azure DevOps-Organisation an.
Hinweis
Ihre Azure DevOps-Organisation muss sich im selben Verzeichnis wie das Azure-Abonnement befinden, das Ihr Dev Center oder Projekt enthält.
Wählen Sie Organisationseinstellungen aus.
Wählen Sie auf der Seite Übersicht die Option Benutzer aus.
Wählen Sie auf der Seite Benutzer die Option Benutzer hinzufügen aus.
Vervollständigen Sie neue Benutzer hinzufügen, indem Sie die folgenden Informationen eingeben oder sie auswählen, und wählen Sie dann Hinzufügen aus:
| Name |
Wert |
| Benutzer oder Dienstprinzipale |
Geben Sie den Namen Ihres Dev Centers oder Projekts ein. Wenn Sie eine systemseitig zugewiesene MSI verwenden, geben Sie den Namen des Dev Centers oder Projekts und nicht die Objekt-ID des verwalteten Kontos an. Wenn Sie eine benutzerseitig zugewiesene MSI verwenden, verwenden Sie den Namen des verwalteten Kontos. |
| Zugriffsebene |
Wählen Sie "Einfach" aus. |
| Zu Projekten hinzufügen |
Wählen Sie das Projekt aus, das Ihr Repository enthält. |
| Azure DevOps-Gruppen |
Wählen Sie Projektleser aus. |
| Senden von E-Mail-Einladungen (nur an Benutzer) |
Deaktivieren Sie das Kontrollkästchen. |
Hinzufügen des Repositorys als Katalog
Dev Box unterstützt das Anfügen von Azure Repos-Repositorys und GitHub-Repositorys. Sie können eine Reihe kuratierter IaC-Vorlagen (Infrastructure-as-Code) in einem Repository speichern. Durch das Anfügen des Repositorys an ein Dev Center oder Projekt als Katalog erhalten Ihre Entwicklungsteams Zugriff auf die Vorlagen und ermöglicht es ihnen, schnell konsistente Entwicklerfelder zu erstellen.
In den folgenden Schritten wird ein Azure Repos-Repository angefügt.
Navigieren Sie im Azure-Portal zu Ihrem Dev Center oder Projekt.
Wählen Sie im linken Menü unter Umgebungskonfiguration die Option Kataloge und dann Hinzufügen aus.
Geben Sie unter Katalog hinzufügen die folgenden Informationen ein, und wählen Sie dann Hinzufügen aus:
| Feld |
Wert |
| Name |
Geben Sie einen Namen für den Katalog ein. |
| Katalogspeicherort |
Wählen Sie Azure DevOps aus. |
| Authentifizierungstyp |
Wählen Sie Verwaltete Identität aus. |
| Organisation |
Wählen Sie Ihre Azure DevOps-Organisation aus. |
| Projekt |
Wählen Sie in der Liste der Projekte das Projekt aus, welches das Repository speichert. |
| Repository |
Wählen Sie in der Liste der Repositorys das Repository aus, das Sie hinzufügen möchten. |
| Filiale |
Wählen Sie den Branch aus. |
| Ordnerpfad |
Dev Box ruft eine Liste der Ordner in Ihrem Branch ab. Wählen Sie den Ordner aus, der Ihre IaC-Vorlagen speichert. |
Vergewissern Sie sich im Dev Center oder Projekt unter Kataloge, dass Ihr Katalog angezeigt wird. Wenn die Verbindung erfolgreich hergestellt wurde, wird unter Status der Wert Synchronisierung erfolgreich angezeigt. Das Herstellen einer Verbindung mit einem Katalog kann beim ersten Mal ein paar Minuten dauern.
Führen Sie zum Hinzufügen eines Katalogs die folgenden Aufgaben aus:
- Rufen Sie die Klon-URL für Ihr Azure Repos-Repository ab.
- Erstellen eines persönlichen Zugriffstokens (Personal Access Token, PAT)
- Speichern des PAT als Schlüsseltresorgeheimnis in Azure Key Vault
- Hinzufügen des Repositorys als Katalog
Abrufen der Klon-URL für Ihr Azure Repos-Repository
Wechseln Sie zur Startseite Ihrer Teamsammlung (z. B. https://contoso-web-team.visualstudio.com), und wählen Sie dann das Projekt aus.
Abrufen der Klon-URL Ihres Azure Repos Git-Repositorys
Kopieren und speichern Sie die URL.
Erstellen eines persönlichen Zugriffstokens in Azure Repos
Wechseln Sie zur Startseite Ihrer Teamsammlung (z. B. https://contoso-web-team.visualstudio.com), und wählen Sie Ihr Projekt aus.
Erstellen Sie ein PAT.
Kopieren und speichern Sie das generierte Token zur späteren Verwendung.
Erstellen eines Schlüsseltresors
Sie benötigen eine Azure Key Vault-Instanz, um das PAT zu speichern, das verwendet wird, um Azure Zugriff auf Ihr Repository zu gewähren. Schlüsseltresore können den Zugriff entweder mit Zugriffsrichtlinien oder mit der rollenbasierten Zugriffssteuerung (RBAC) steuern. Wenn Sie bereits einen Schlüsseltresor haben, können Sie ihn verwenden. Sie sollten jedoch überprüfen, ob er Zugriffsrichtlinien oder RBAC-Zuweisungen verwendet, um den Zugriff zu steuern. Hilfe beim Konfigurieren einer Zugriffsrichtlinie für einen Schlüsseltresor finden Sie unter Zuweisen einer Key Vault Zugriffsrichtlinie.
Verwenden Sie die folgenden Schritte, um einen RBAC-Schlüsseltresor zu erstellen:
Melden Sie sich beim Azure-Portal an.
Geben Sie Key Vault in das Suchfeld ein.
Wählen Sie in der Ergebnisliste Key Vault aus.
Wählen Sie auf der Seite „Schlüsseltresor“ die Option Erstellen aus.
Geben Sie auf der Registerkarte Schlüsseltresor erstellen die folgenden Informationen ein:
| Name |
Wert |
| Name |
Geben Sie einen Namen für den Schlüsseltresor ein. |
| Abonnement |
Wählen Sie das Abonnement aus, in dem Sie den Schlüsseltresor erstellen möchten. |
| Ressourcengruppe |
Verwenden Sie entweder eine vorhandene Ressourcengruppe, oder wählen Sie Neu erstellen aus, und geben Sie einen Namen für die Ressourcengruppe ein. |
| Ort |
Wählen Sie den Standort oder die Region aus, an dem bzw. in der Sie den Schlüsseltresor erstellen möchten. |
Behalten Sie bei den anderen Optionen die Standardeinstellungen bei.
Wählen Sie auf der Registerkarte Zugriffsrichtlinie die Option Rollenbasierte Zugriffssteuerung in Azure und dann Überprüfen und erstellen aus.
Wählen Sie auf der Registerkarte "Überprüfen+ Erstellen " die Option "Erstellen" aus.
Wenn die Richtlinien Ihrer Organisation vorschreiben, dass Ihre Key Vault-Instanz nicht mit dem Internet verbunden werden darf, können Sie eine Firewallregel hinzufügen, um den öffentlichen Zugriff zu unterbinden oder einzuschränken, und Ihre Key Vault-Instanz so einstellen, dass vertrauenswürdige Microsoft-Dienste Ihre Firewallregeln umgehen können. Schlüsseltresore mit privaten Endpunkten und die Integration privater Links für dieses Szenario werden derzeit nicht unterstützt.
Wie Sie vertrauenswürdigen Microsoft-Diensten erlauben, die Firewall zu umgehen, erfahren Sie unter Konfigurieren von Azure Key Vault-Netzwerkeinstellungen.
Speichern des persönlichen Zugriffstokens im Schlüsseltresor
Wählen Sie in „Key Vault“ im linken Menü Geheimnisse aus.
Wählen Sie auf der Seite Geheimnisse die Option Generieren/Importieren aus.
Gehen Sie auf der Seite Geheimnis erstellen wie folgt vor:
- Geben Sie in das Feld Name einen aussagekräftigen Namen für Ihr Geheimnis ein.
- Fügen Sie in das Feld Geheimniswert das PAT ein, das Sie zuvor kopiert haben.
- Wählen Sie "Erstellen" aus.
Abrufen der Geheimnis-ID
Rufen Sie den Pfad zum Geheimnis ab, das Sie im Schlüsseltresor erstellt haben.
Navigieren Sie im Azure-Portal zu Ihrem Schlüsseltresor.
Wählen Sie auf der Seite„Key Vault“ im linken Menü Geheimnisse aus.
Wählen Sie auf der Seite Geheimnisse das zuvor erstellte Geheimnis aus.
Wählen Sie auf der Seite „Versionen“ AKTUELLE VERSION aus.
Wählen Sie auf der Seite „Aktuelle Version“ für Geheimnisbezeichner die Option „Kopieren“ aus.
Hinzufügen des Repositorys als Katalog
Navigieren Sie im Azure-Portal zu Ihrem Dev Center oder Projekt.
Stellen Sie sicher, dass die Identität, die an das Dev Center oder Projekt angefügt wurde, Zugriff auf das Schlüsseltresorgeheimnis hat, in dem Ihr persönliches Zugriffstoken gespeichert ist.
Wählen Sie im linken Menü unter Umgebungskonfiguration die Option Kataloge und dann Hinzufügen aus.
Geben Sie unter Katalog hinzufügen die folgenden Informationen ein, und wählen Sie dann Hinzufügen aus:
| Feld |
Wert |
| Name |
Geben Sie einen Namen für den Katalog ein. |
| Katalogspeicherort |
Wählen Sie Azure DevOps aus. |
| Authentifizierungstyp |
Wählen Sie Persönliches Zugriffstoken aus. |
| Organisation |
Wählen Sie die Organisation aus, in der das Katalogrepository gehostet wird. |
| Projekt |
Wählen Sie das Projekt aus, in der das Katalogrepository gespeichert ist. |
| Rep. |
Wählen Sie das Repository aus, in dem der Katalog gespeichert ist. |
| Ordnerpfad |
Wählen Sie den Ordner aus, der Ihre IaC-Vorlagen enthält. |
| Geheimnis-ID |
Geben Sie die Geheimnis-ID ein, die Ihr PAT für das Repository enthält. Wenn Sie einen Geheimnisbezeichner kopieren, enthält die Verbindungszeichenfolge am Ende einen Versionsbezeichner wie in diesem Beispiel: https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat/9376b432b72441a1b9e795695708ea5a. Durch das Entfernen des Versionsbezeichners wird sichergestellt, dass Dev Box die neueste Version des geheimen Schlüssels aus dem Schlüsseltresor abruft. Wenn Ihr PAT abläuft, muss nur der Schlüsseltresor aktualisiert werden. Beispiel eines Geheimnisbezeichners:https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat |
Vergewissern Sie sich unter Kataloge, dass Ihr Katalog angezeigt wird. Wenn die Verbindung erfolgreich hergestellt wurde, wird Verbunden als Status angezeigt.
Führen Sie zum Hinzufügen eines Katalogs die folgenden Aufgaben aus:
- Installieren und Konfigurieren der Microsoft DevCenter-App
- Weisen Sie in GitHub Berechtigungen für die Repositorys zu.
- Hinzufügen des Repositorys als Katalog
Installieren der Microsoft DevCenter-App
Melden Sie sich beim Azure-Portal an.
Navigieren Sie zu Ihrem Dev Center oder Projekt.
Wählen Sie im linken Menü unter Umgebungskonfiguration die Option Kataloge und dann Hinzufügen aus.
Geben Sie im Bereich Katalog hinzufügen die folgenden Informationen ein, oder wählen Sie sie aus:
| Feld |
Wert |
| Name |
Geben Sie einen Namen für den Katalog ein. |
| Katalogquelle |
Wählen Sie GitHub aus. |
| Authentifizierungstyp |
Wählen Sie GitHub-App aus. |
Wählen Sie zum Installieren der Microsoft DevCenter-App den Link Ihre Repositorys konfigurieren aus.
Wenn Sie aufgefordert werden, sich bei GitHub zu authentifizieren, führen Sie die Authentifizierung durch.
Wählen Sie auf der Seite Microsoft DevCenter die Option Konfigurieren aus.
Wählen Sie die GitHub-Organisation aus, die das Repository enthält, das Sie als Katalog hinzufügen möchten. Sie müssen ein Besitzer der Organisation sein, um diese App installieren zu können.
Wählen Sie auf der Seite „Microsoft DevCenter installieren“ die Option Nur ausgewählte Repositorys aus, wählen Sie das Repository aus, das Sie als Katalog hinzufügen möchten, und wählen Sie anschließend Installieren aus.
Sie können mehrere Repositorys auswählen, um sie als Kataloge hinzuzufügen. Sie müssen jedes Repository als separaten Katalog hinzufügen, wie in Hinzufügen des Repositorys als Katalog beschrieben.
Überprüfen Sie auf der Seite Microsoft DevCenter von Microsoft benötigt Berechtigung für Folgendes: die erforderlichen Berechtigungen, und wählen Sie dann Microsoft DevCenter autorisieren aus.
Hinzufügen des Repositorys als Katalog
Kehren Sie zum Azure-Portal zurück.
Geben Sie unter Katalog hinzufügen die folgenden Informationen ein, und wählen Sie dann Hinzufügen aus:
| Feld |
Wert |
| Repository |
Wählen Sie das Repository aus, das Sie als Katalog hinzufügen möchten. |
| Filiale |
Wählen Sie den Branch aus. |
| Ordnerpfad |
Wählen Sie den Ordner aus, der Unterordner enthält, die Ihre Bilddefinitionen enthalten. |
Vergewissern Sie sich unter Kataloge, dass Ihr Katalog angezeigt wird. Wenn die Verbindung erfolgreich hergestellt wurde, wird unter Status der Wert Synchronisierung erfolgreich angezeigt.
Führen Sie zum Hinzufügen eines Katalogs die folgenden Aufgaben aus:
- Abrufen der Klon-URL Ihres GitHub-Repositorys
- Erstellen eines persönlichen Zugriffstokens (Personal Access Token, PAT) in GitHub
- Speichern des PAT als Schlüsseltresorgeheimnis in Azure Key Vault
- Hinzufügen des Repositorys als Katalog
Abrufen der Klon-URL Ihres GitHub-Repositorys
Navigieren Sie zur Startseite des GitHub-Repositorys, das die Vorlagendefinitionen enthält.
Rufen Sie die Klon-URL des GitHub-Repositorys ab.
Kopieren und speichern Sie die URL.
Erstellen eines persönlichen Zugriffstokens in GitHub
Dev Box unterstützt die Authentifizierung bei GitHub-Repositorys mithilfe von klassischen Token oder feinkörnigen Token. In diesem Beispiel erstellen Sie ein differenziertes Token.
Navigieren Sie zur Startseite des GitHub-Repositorys, das die Vorlagendefinitionen enthält.
Wählen Sie das Profilbild in der oberen rechten Ecke von GitHub aus, und wählen Sie Einstellungen.
Wählen Sie auf der linken Randleiste Entwicklereinstellungen>Persönliche Zugriffstoken>Differenzierte Token aus.
Wählen Sie "Neues Token generieren" aus.
Geben Sie auf der Seite Neues differenziertes persönliches Zugriffstoken die folgenden Informationen an:
| Name |
Wert |
| Tokenname |
Geben Sie einen aussagekräftigen Namen für das Token ein. |
| Ablauf |
Wählen Sie den Tokenablaufzeitraum in Tagen aus. |
| Beschreibung |
Geben Sie eine Beschreibung für das Token ein. |
| Ressourcenbesitzer |
Wählen Sie den Besitzer des Repositorys aus. |
| Repositoryzugriff |
Wählen Sie Nur Repositorys auswählen aus. |
| Repositorys auswählen |
Wählen Sie das Repository aus, das die Bilddefinitionen enthält. |
| Repositoryberechtigungen |
Erweitern Sie Repositoryberechtigungen, und wählen Sie in der Liste Zugriff für Inhalt die Option Code lesen aus. |
Wählen Sie "Token generieren" aus.
Kopieren und speichern Sie das generierte Token zur späteren Verwendung.
Von Bedeutung
Wenn Sie mit einem privaten Repository arbeiten, das in einer GitHub-Organisation gespeichert ist, müssen Sie sicherstellen, dass das GitHub-PAT so konfiguriert ist, dass der Zugriff auf die richtige Organisation und die darin enthaltenen Repositorys ermöglicht wird.
- Für klassische Token innerhalb der Organisation muss nach ihrer Erstellung einmaliges Anmelden autorisiert werden.
- Bei differenzierten Token muss der Besitzer des Tokens auf die Organisation festgelegt werden, damit die Autorisierung funktioniert.
Falsch konfigurierte PATs können zu einem Fehler vom Typ Repository nicht gefunden führen.
Erstellen eines Schlüsseltresors
Sie benötigen eine Azure Key Vault-Instanz zum Speichern des PAT, das zum Erteilen von Azure-Zugriff auf Ihr Repository verwendet wird. Schlüsseltresore können den Zugriff entweder mit Zugriffsrichtlinien oder mit der rollenbasierten Zugriffssteuerung (RBAC) steuern. Wenn Sie bereits einen Schlüsseltresor haben, können Sie ihn verwenden. Sie sollten jedoch überprüfen, ob er Zugriffsrichtlinien oder RBAC-Zuweisungen verwendet, um den Zugriff zu steuern. Hilfe beim Konfigurieren einer Zugriffsrichtlinie für einen Schlüsseltresor finden Sie unter Zuweisen einer Key Vault-Zugriffsrichtlinie.
Verwenden Sie die folgenden Schritte, um einen RBAC-Schlüsseltresor zu erstellen:
Melden Sie sich beim Azure-Portal an.
Geben Sie Key Vault in das Suchfeld ein.
Wählen Sie in der Ergebnisliste Key Vault aus.
Wählen Sie auf der Seite „Schlüsseltresor“ die Option Erstellen aus.
Geben Sie auf der Registerkarte Schlüsseltresor erstellen die folgenden Informationen ein:
| Name |
Wert |
| Name |
Geben Sie einen Namen für den Schlüsseltresor ein. |
| Abonnement |
Wählen Sie das Abonnement aus, in dem Sie den Schlüsseltresor erstellen möchten. |
| Ressourcengruppe |
Verwenden Sie entweder eine vorhandene Ressourcengruppe, oder wählen Sie Neu erstellen aus, und geben Sie einen Namen für die Ressourcengruppe ein. |
| Ort |
Wählen Sie den Standort oder die Region aus, an dem bzw. in der Sie den Schlüsseltresor erstellen möchten. |
Behalten Sie bei den anderen Optionen die Standardeinstellungen bei.
Wählen Sie auf der Registerkarte Zugriffsrichtlinie die Option Rollenbasierte Zugriffssteuerung in Azure und dann Überprüfen und erstellen aus.
Wählen Sie auf der Registerkarte "Überprüfen+ Erstellen " die Option "Erstellen" aus.
Wenn die Richtlinien Ihrer Organisation vorschreiben, dass Ihre Key Vault-Instanz nicht mit dem Internet verbunden werden darf, können Sie eine Firewallregel hinzufügen, um den öffentlichen Zugriff zu unterbinden oder einzuschränken, und Ihre Key Vault-Instanz so einstellen, dass vertrauenswürdige Microsoft-Dienste Ihre Firewallregeln umgehen können. Schlüsseltresore mit privaten Endpunkten und die Integration privater Links für dieses Szenario werden derzeit nicht unterstützt.
Wie Sie vertrauenswürdigen Microsoft-Diensten erlauben, die Firewall zu umgehen, erfahren Sie unter Konfigurieren von Azure Key Vault-Netzwerkeinstellungen.
Speichern des persönlichen Zugriffstokens im Schlüsseltresor
Wählen Sie in „Key Vault“ im linken Menü Geheimnisse aus.
Wählen Sie auf der Seite Geheimnisse die Option Generieren/Importieren aus.
Gehen Sie auf der Seite Geheimnis erstellen wie folgt vor:
- Geben Sie in das Feld Name einen aussagekräftigen Namen für Ihr Geheimnis ein.
- Fügen Sie in das Feld Geheimniswert Ihr PAT ein.
- Wählen Sie "Erstellen" aus.
Abrufen der Geheimnis-ID
Rufen Sie den Pfad zum Geheimnis ab, das Sie im Schlüsseltresor erstellt haben.
Navigieren Sie im Azure-Portal zu Ihrem Schlüsseltresor.
Wählen Sie auf der Seite„Key Vault“ im linken Menü Geheimnisse aus.
Wählen Sie auf der Seite Geheimnisse das zuvor erstellte Geheimnis aus.
Wählen Sie auf der Seite „Versionen“ AKTUELLE VERSION aus.
Wählen Sie auf der Seite „Aktuelle Version“ für Geheimnisbezeichner die Option „Kopieren“ aus.
Hinzufügen des Repositorys als Katalog
Navigieren Sie im Azure-Portal zu Ihrem Dev Center oder Projekt.
Stellen Sie sicher, dass die verwaltete Identität, die an das Dev Center oder Projekt angefügt wurde, Zugriff auf das Schlüsseltresorgeheimnis hat, in dem Ihr persönliches Zugriffstoken gespeichert ist.
Wählen Sie im linken Menü unter Umgebungskonfiguration die Option Kataloge und dann Hinzufügen aus.
Geben Sie unter Katalog hinzufügen die folgenden Informationen ein, und wählen Sie dann Hinzufügen aus.
| Feld |
Wert |
| Name |
Geben Sie einen Namen für den Katalog ein. |
| Katalogspeicherort |
Wählen Sie GitHub aus. |
| Repository |
Geben oder fügen Sie die Klon-URL für Ihr GitHub-Repository oder für Ihr Azure Repos-Repository ein. Katalogbeispiel:https://github.com/Azure/deployment-environments.git |
| Filiale |
Geben Sie den Repositorybranch ein, mit dem eine Verbindung hergestellt werden soll. Katalogbeispiel:main |
| Ordnerpfad |
Geben Sie den relativen Ordnerpfad zur Klon-URI ein, der zu Unterordnern führt, die Ihre Bilddefinitionen enthalten. Der Ordnerpfad gilt für den Ordner mit Unterordnern, die Umgebungsdateien der Umgebungsdefinitionen enthalten, und nicht für den Ordner mit der Umgebungsdatei der Umgebungsdefinitionen selbst. Die folgende Abbildung zeigt die Struktur des Beispielkatalogordners. Katalogbeispiel:/Environments Der Ordnerpfad kann mit oder ohne Schrägstrich beginnen (/). |
| Geheimnis-ID |
Geben Sie die Geheimnis-ID ein, die Ihr PAT für das Repository enthält. Wenn Sie einen Geheimnisbezeichner kopieren, enthält die Verbindungszeichenfolge am Ende einen Versionsbezeichner wie in diesem Beispiel: https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat/9376b432b72441a1b9e795695708ea5a. Durch das Entfernen des Versionsbezeichners wird sichergestellt, dass Dev Box die neueste Version des Geheimnisses aus dem Schlüsseltresor abruft. Wenn Ihr PAT abläuft, muss nur der Schlüsseltresor aktualisiert werden. Beispiel eines Geheimnisbezeichners:https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat |
Vergewissern Sie sich unter Kataloge, dass Ihr Katalog angezeigt wird. Wenn die Verbindung erfolgreich hergestellt wurde, wird unter Status der Wert Synchronisierung erfolgreich angezeigt.
Anzeigen synchronisierter Katalogelemente
Unabhängig vom Typ des verwendeten Repositorys können Sie die Katalogelemente anzeigen, die aus dem Katalog synchronisiert werden.
Wählen Sie im linken Menü für das Dev Center oder Projekt unter Umgebungskonfiguration die Option Kataloge aus.
Wählen Sie im Bereich Kataloge den Katalognamen aus.
Es wird eine Liste der erfolgreich synchronisierten Katalogelemente angezeigt.
Aktualisieren eines Katalogs
Wenn Sie den Definitions- oder Vorlageninhalt im angefügten Repository aktualisieren, können Sie den neuesten Satz von Bilddefinitionen für Ihre Entwicklungsteams bereitstellen, indem Sie den Katalog synchronisieren. Sie können einen Katalog manuell oder automatisch synchronisieren.
Manuelles Synchronisieren eines Katalogs
Wenn Sie einen Katalog manuell synchronisieren, durchsucht Dev Box das Repository und stellt die neueste Liste der Bilddefinitionen für alle zugehörigen Projekte im Dev Center zur Verfügung.
Wählen Sie im linken Menü für das Dev Center unter Umgebungskonfiguration die Option Kataloge aus.
Wählen Sie den bestimmten Katalog aus, und wählen Sie dann in der Befehlsleiste Synchronisieren aus.
Automatisches Synchronisieren eines Katalogs
Wenn Sie einen Katalog so konfigurieren, dass er automatisch synchronisiert wird, durchsucht Dev Box alle 30 Minuten das Repository und stellt die neueste Liste der Bilddefinitionen für alle zugehörigen Projekte im Dev Center zur Verfügung.
Wählen Sie im linken Menü für das Dev Center oder Projekt unter Umgebungskonfiguration die Option Kataloge aus.
Wählen Sie den entsprechenden Katalog und dann „Bearbeiten“ aus.
Wählen Sie im Bereich Katalog bearbeiten die Option Diesen Katalog automatisch synchronisieren und dann Speichern aus.
Wenn eine autosynchrone Synchronisierung fehlschlägt, sollten Sie eine manuelle Synchronisierung ausführen. Dev Box macht keine weiteren autosynchronen Versuche, bis eine manuelle Synchronisierung erfolgreich ist.
Löschen eines Katalogs
Sie können einen Katalog löschen, um ihn aus dem Dev Box Dev Center oder Projekt zu entfernen. Vorlagen in einem gelöschten Katalog stehen Entwicklungsteams nicht zur Verfügung, wenn sie neue Entwicklungsumgebungen deployen. Aktualisieren Sie den Umgebungsdefinitionsverweis für alle vorhandenen Entwicklungsfelder, die mithilfe der Bilddefinitionen im gelöschten Katalog erstellt wurden. Wenn der Verweis nicht aktualisiert und die Umgebung neu bereitgestellt wird, schlägt die Bereitstellung fehl.
Katalog löschen:
Wählen Sie im linken Menü für das Dev Center oder Projekt unter Umgebungskonfiguration die Option Kataloge aus.
Wählen Sie den entsprechenden Katalog und dann Löschen aus.
Wählen Sie im Dialogfeld Katalog löschen die Option Weiter aus, um den Katalog zu löschen.
Problembehandlung bei Katalogsynchronisierungsfehlern
Wenn Sie einen Katalog hinzufügen oder synchronisieren, tritt möglicherweise ein Synchronisierungsfehler oder eine Synchronisierungswarnung auf. Ein Synchronisierungsfehler weist darauf hin, dass ein Katalog nicht erfolgreich synchronisiert werden konnte. Eine Synchronisierungswarnung bedeutet, dass einige oder alle Katalogelemente Fehler aufweisen. Sie können den Synchronisierungsstatus und die Fehler im Azure-Portal anzeigen oder die Azure CLI und REST-API verwenden, um die Fehler zu behandeln und zu beheben.
Anzeigen des Katalogsynchronisierungsstatus
Im Azure-Portal erhalten Sie weitere Informationen zum Katalogsynchronisierungsstatus sowie zu Warnungen oder Fehlern, indem Sie den Statuslink auswählen. Der Statuslink öffnet einen Bereich, in dem der Synchronisierungsstatus angezeigt wird, die Anzahl der hinzugefügten Bilddefinitionen und die Anzahl der Bilddefinitionen, die ignoriert oder fehlgeschlagen wurden.
Anzeigen von Katalogsynchronisierungsfehlern
Wählen Sie im linken Menü für das Dev Center oder Projekt unter Umgebungskonfiguration die Option Kataloge aus.
Wählen Sie in der Spalte Status den Statuslink für den Katalog aus, der nicht synchronisiert werden konnte.
Es wird ein Detailbereich angezeigt, in dem die Änderungen in der letzten Synchronisierung, die Anzahl der Synchronisierungsfehler und die Art der Fehler angezeigt werden.
Anzeigen von Katalogsynchronisierungswarnungen
Wählen Sie im linken Menü für das Dev Center oder Projekt unter Umgebungskonfiguration die Option Kataloge aus.
Wählen Sie in der Spalte Status den Statuslink für den Katalog aus, der synchronisiert wurde, aber eine Warnung meldet.
Es wird ein Detailbereich angezeigt, in dem die Änderungen in der letzten Synchronisierung, die Anzahl der Elementfehler und die Art und Quelle der Fehler angezeigt werden.
Sie können Elemente anzeigen, die erfolgreich aus einem Katalog synchronisiert wurden, der auch Synchronisierungsfehler meldet. Wählen Sie im Bereich Kataloge den Katalognamen aus.
Es wird eine Liste der erfolgreich synchronisierten Katalogelemente angezeigt.
Behandeln von Katalogsynchronisierungsfehlern mithilfe der Azure CLI
Verwenden Sie die Azure CLI oder die REST-API, um den Katalog abzurufen (mit GET). Die GET-Antwort zeigt die Art des Fehlers an:
- Ignorierte Bilddefinitionen, die als Duplikate erkannt wurden.
- Ungültige Bilddefinitionen, die aufgrund von Schema-, Verweis- oder Überprüfungsfehlern fehlgeschlagen sind.
Beheben von Fehlern aufgrund ignorierter Umgebungsdefinitionen
Ein ignorierter Umgebungsdefinitionsfehler tritt auf, wenn Sie zwei oder mehr Bilddefinitionen hinzufügen, die denselben Namen haben. Sie können dieses Problem beheben, indem Sie Bilddefinitionen umbenennen, sodass jede Umgebungsdefinition einen eindeutigen Namen im Katalog aufweist.
Beheben von Fehlern aufgrund ungültiger Umgebungsdefinitionen
Ein Fehler aufgrund ungültiger Umgebungsdefinitionen kann aus verschiedenen Gründen auftreten:
Manifestschemafehler. Stellen Sie sicher, dass die Umgebungsdatei der Umgebungsdefinitionen mit dem erforderlichen Schema übereinstimmt.
Überprüfungsfehler Überprüfen Sie die folgenden Elemente, um Überprüfungsfehler zu beheben:
- Vergewissern Sie sich, dass der Modultyp der Umgebungsdatei ordnungsgemäß konfiguriert ist.
- Stellen Sie sicher, dass der Name der Umgebungsdefinitionen zwischen 3 und 63 Zeichen lang ist.
- Stellen Sie sicher, dass der Name der Umgebungsdefinitionen nur Zeichen enthält, die für eine URL gültig sind. Dies sind alphanumerische Zeichen und folgende Symbole:
~!,.';:=-_+()*&$@.
Verweisfehler. Stellen Sie sicher, dass der von der Umgebungsdatei referenzierte Vorlagenpfad ein gültiger relativer Pfad zu einer Datei im Repository ist.
Verwandte Inhalte