Udostępnij przez

Dodawanie wykazów i zarządzanie nimi w usłudze Microsoft Dev Box

W tym artykule wyjaśniono, jak dodać i skonfigurować katalog dla centrum deweloperskiego lub projektu usługi Microsoft Dev Box.

Katalogi ułatwiają udostępnianie zestawu wyselekcjonowanych definicji obrazów dla zespołów programistycznych w celu utworzenia gotowych do użycia pól deweloperskich. Możesz dołączyć własne repozytorium kontroli wersji z GitHub lub Azure Repos jako katalog.

Aby dodatkowo zabezpieczyć szablony, katalog jest szyfrowany; Usługa Dev Box obsługuje szyfrowanie danych w spoczynku przy użyciu kluczy szyfrowania zarządzanych przez platformę, którymi zarządza firma Microsoft dla usług Azure.

  • Aby dowiedzieć się, jak hostować repozytorium w usłudze GitHub, zobacz Wprowadzenie do usługi GitHub.
  • Aby dowiedzieć się, jak hostować repozytorium Git w projekcie usługi Azure Repos, zobacz Azure Repos.

Konfigurowanie wykazów na poziomie projektu

Dołączanie katalogów na poziomie projektu umożliwia inżynierom platformy udostępnianie definicji obrazów specyficznych dla poszczególnych zespołów programistycznych. Ponadto umożliwia ona liderom zespołów deweloperów przypisanym jako administratorzy projektów zarządzanie definicjami obrazów udostępnionymi swoim zespołom.

Inżynierowie platformy mają pełną kontrolę nad używaniem katalogów na poziomie projektu. Użycie wykazów na poziomie projektu musi być włączone na poziomie centrum deweloperów, aby można było dodać katalog do projektu. Inżynierowie platformy mogą również skonfigurować, które typy elementów katalogu, takich jak definicje obrazów, mogą być używane na poziomie projektu.

Domyślnie używanie wykazów na poziomie projektu jest wyłączone i żaden z typów elementów wykazu nie jest włączony. Definicje środowiska z wykazu na poziomie projektu są synchronizowane i można ich używać w dwóch warunkach. Najpierw należy włączyć katalogi oparte na projekcie na odpowiednim poziomie centrum deweloperów. Po drugie, należy włączyć używanie definicji obrazów dla projektu.

Dodawanie wykazu do projektu

Przed dodaniem wykazu do projektu należy włączyć wykazy na poziomie projektu na poziomie centrum deweloperów. Należy również włączyć używanie definicji obrazów na poziomie projektu.

Aby włączyć korzystanie z katalogów na poziomie projektu na poziomie centrum deweloperów:

  1. W witrynie Azure Portal przejdź do centrum deweloperów.

  2. W menu po lewej stronie w obszarze Ustawienia wybierz pozycję Ustawienia Centrum deweloperów.

  3. W obszarze Katalogi na poziomie projektu wybierz pozycję Włącz wykazy dla każdego projektu, a następnie wybierz pozycję Zastosuj.

    Zrzut ekranu przedstawiający ustawienia Centrum programistycznego, z wybraną i wyróżnioną pozycją Włącz katalogi na projekt.

Aby włączyć używanie definicji obrazów w projekcie:

  1. W witrynie Azure Portal przejdź do projektu.

  2. W lewym menu, pod Ustawienia, wybierz Wykazy.

    Zrzut ekranu przedstawiający stronę Przegląd projektu, na której wyróżnione są katalogi.

  3. Na stronie Wykazy wybierz pozycję Uprawnienia do elementu wykazu.

    Zrzut ekranu przedstawiający okienko Wykazy z wyróżnionymi uprawnieniami elementu wykazu.

  4. W okienku Ustawienia elementów katalogu wybierz Definicje obrazów wdrażania Azure, aby umożliwić korzystanie z definicji obrazów na poziomie projektu.

    Zrzut ekranu przedstawiający okienko ustawień pozycji katalogowej z wybranymi definicjami obrazu wdrożenia Azure.

Teraz możesz dodać katalog do projektu.

W przypadku katalogów korzystających z tożsamości zarządzanej lub osobistego tokenu dostępu (PAT) do uwierzytelniania należy przypisać tożsamość zarządzaną dla projektu. W przypadku katalogów korzystających z PAT, należy przechowywać PAT w magazynie kluczy i udzielić tożsamości zarządzanej dostępu do tajemnicy w magazynie kluczy.

Konfigurowanie tożsamości zarządzanej

Aby można było dołączyć wykaz do centrum deweloperskiego lub projektu, należy skonfigurować tożsamość zarządzaną, nazywaną również Zarządzaną Tożsamością Usługi (MSI). Możesz dołączyć albo tożsamość zarządzaną przypisaną przez system (system-assigned MSI), albo tożsamość zarządzaną przypisaną przez użytkownika (user-assigned MSI). Następnie przypiszesz role do tożsamości zarządzanej, aby umożliwić centrum deweloperskiemu lub projektowi tworzenie typów środowisk w ramach subskrypcji i odczytywanie projektu usługi Azure Repos zawierającego repozytorium wykazu.

Jeśli centrum deweloperskie lub projekt nie ma dołączonej tożsamości MSI, wykonaj kroki opisane w sekcji Konfigurowanie tożsamości zarządzanej, aby utworzyć taką tożsamość i przypisać role dla tożsamości zarządzanej.

Aby dowiedzieć się więcej o tożsamościach zarządzanych, zobacz Co to są tożsamości zarządzane dla zasobów platformy Azure?

Dodawanie wykazu

Wykaz można dodać z repozytorium usługi Azure Repos lub repozytorium GitHub. Można uwierzytelniać się, przypisując uprawnienia do tożsamości usługi zarządzanej lub używając tokenu dostępu osobistego (PAT), który przechowujesz w magazynie kluczy.

Wybierz zakładkę dla typu repozytorium i uwierzytelniania, których chcesz użyć.

Aby dodać wykaz, wykonaj następujące zadania:

  • Przypisz uprawnienia w usłudze Azure Repos dla tożsamości zarządzanej.
  • Dodaj repozytorium jako katalog.

Przypisywanie uprawnień w usłudze Azure Repos dla tożsamości zarządzanej

Musisz przyznać tożsamości zarządzanej uprawnienia do repozytorium w usłudze Azure Repos.

  1. Zaloguj się do organizacji usługi Azure DevOps.

    Uwaga / Notatka

    Organizacja usługi Azure DevOps musi znajdować się w tym samym katalogu co subskrypcja platformy Azure zawierająca centrum deweloperskie lub projekt.

  2. Wybierz pozycję Ustawienia organizacji.

    Zrzut ekranu pokazujący stronę organizacji w Azure DevOps z wyróżnionymi Ustawieniami organizacji.

  3. Na stronie Przegląd wybierz pozycję Użytkownicy.

    Zrzut ekranu przedstawiający stronę Przegląd organizacji z wyróżnioną sekcją Użytkownicy.

  4. Na stronie Użytkownicy wybierz pozycję Dodaj użytkowników.

    Zrzut ekranu przedstawiający stronę Użytkownicy z wyróżnioną pozycją Dodaj użytkownika.

  5. Ukończ dodawanie nowych użytkowników , wprowadzając lub wybierając następujące informacje, a następnie wybierz pozycję Dodaj:

    Nazwa Wartość
    Użytkownicy lub jednostki usługi Wprowadź nazwę centrum deweloperskiego lub projektu.
    W przypadku korzystania z zarządzanej tożsamości przypisanej przez system, określ nazwę centrum deweloperskiego lub projektu, a nie identyfikator obiektu zarządzanego konta. W przypadku korzystania z tożsamości zarządzanej przypisanej przez użytkownika użyj nazwy konta zarządzanego.
    poziom dostępu Wybierz pozycję Podstawowa.
    Dodawanie do projektów Wybierz projekt zawierający repozytorium.
    Grupy usługi Azure DevOps Wybierz Czytelników projektu.
    Wysyłanie zaproszeń e-mail (tylko do użytkowników) Wyczyść pole wyboru.

    Zrzut ekranu przedstawiający Dodaj użytkowników, z wyróżnionymi przykładowymi wpisami i Dodaj.

Dodawanie repozytorium jako katalogu

Usługa Dev Box obsługuje dołączanie repozytoriów usługi Azure Repos i repozytoriów GitHub. Zestaw wyselekcjonowanych szablonów IaC można przechowywać w repozytorium. Dołączanie repozytorium do centrum deweloperskiego lub projektu jako katalogu zapewnia zespołom deweloperów dostęp do szablonów i umożliwia im szybkie tworzenie spójnych pól deweloperskich.

Poniższe kroki umożliwiają dołączenie repozytorium usługi Azure Repos.

  1. W witrynie Azure Portal przejdź do centrum deweloperskiego lub projektu.

  2. W menu po lewej stronie w obszarze Konfiguracja środowiska wybierz pozycję Wykazy, a następnie wybierz pozycję Dodaj.

    Zrzut ekranu przedstawiający okienko Katalogi.

  3. W obszarze Dodaj wykaz wprowadź następujące informacje, a następnie wybierz pozycję Dodaj:

    (No changes needed) Wartość
    Nazwa Wprowadź nazwę wykazu.
    Lokalizacja katalogu Wybierz pozycję Azure DevOps.
    Authentication type (Typ uwierzytelniania) Wybierz Tożsamość zarządzaną.
    Organizacja Wybierz organizację usługi Azure DevOps.
    Projekt Z listy projektów wybierz projekt, który przechowuje repozytorium.
    Repo Z listy repozytoriów wybierz repozytorium, które chcesz dodać.
    Gałąź Wybierz gałąź.
    ścieżka folderu Usługa Dev Box pobiera listę folderów w Twojej gałęzi. Wybierz folder, który przechowuje szablony IaC.

    Zrzut ekranu przedstawiający okienko Dodawanie wykazu z przykładowymi wpisami i wyróżnioną pozycją Dodaj.

  4. W obszarze Katalogi dla centrum developerskiego lub projektu sprawdź, czy Twój katalog się pojawia. Po pomyślnym nawiązaniu połączeniaStan wskazuje „Synchronizacja zakończona pomyślnie”. Nawiązywanie połączenia z wykazem może potrwać kilka minut po raz pierwszy.

Wyświetlanie zsynchronizowanych elementów wykazu

Niezależnie od typu używanego repozytorium można wyświetlić elementy wykazu synchronizowane z katalogu.

  1. W menu po lewej stronie centrum programistycznego lub projektu, w sekcji Konfiguracja środowiska, wybierz Katalogi.

  2. W okienku Wykazy wybierz nazwę katalogu.

    Zrzut ekranu przedstawiający okienko Wykaz z wyróżnioną nazwą dołączonego wykazu.

  3. Zostanie wyświetlona lista pomyślnie zsynchronizowanych elementów wykazu.

    Zrzut ekranu przedstawiający pomyślnie zsynchronizowane elementy wykazu z dołączonego wykazu.

Aktualizowanie wykazu

Jeśli zaktualizujesz definicję lub zawartość szablonu w dołączonym repozytorium, możesz podać najnowszy zestaw definicji obrazów zespołom deweloperów, synchronizując katalog. Katalog można zsynchronizować ręcznie lub automatycznie.

Ręczne synchronizowanie katalogu

Podczas ręcznej synchronizacji katalogu usługa Dev Box skanuje repozytorium i udostępnia najnowszą listę definicji obrazów wszystkim skojarzonym projektom w centrum deweloperów.

  1. W menu po lewej stronie w swoim centrum deweloperów, pod sekcją Konfiguracja środowiska, wybierz pozycję Wykazy.

  2. Wybierz określony wykaz, a następnie na pasku poleceń wybierz pozycję Synchronizuj.

    Zrzut ekranu przedstawiający przycisk Synchronizuj na pasku poleceń.

Automatyczne synchronizowanie wykazu

Podczas konfigurowania wykazu do automatycznego synchronizowania usługa Dev Box skanuje repozytorium co 30 minut i udostępnia najnowszą listę definicji obrazów wszystkim skojarzonym projektom w centrum deweloperów.

  1. W menu po lewej stronie centrum programistycznego lub projektu, w sekcji Konfiguracja środowiska, wybierz Katalogi.

  2. Wybierz określony wykaz, a następnie wybierz edytuj.

    Zrzut ekranu przedstawiający przycisk edycji wykazu.

  3. W okienku Edytowanie wykazu wybierz pozycję Automatycznie synchronizuj ten wykaz, a następnie wybierz pozycję Zapisz.

    Zrzut ekranu przedstawiający okienko edytowania szczegółów katalogu z wyróżnioną pozycją Automatycznie synchronizuj ten wykaz.

Jeśli automatyczna synchronizacja zakończy się niepowodzeniem, należy przeprowadzić ręczną synchronizację. Usługa Dev Box nie podejmuje dalszych prób automatycznego synchronizowania, dopóki synchronizacja ręczna nie powiedzie się.

Usuwanie wykazu

Możesz usunąć katalog z centrum deweloperskiego Dev Box lub projektu. Szablony w usuniętym wykazie nie są dostępne dla zespołów programistycznych podczas wdrażania nowych pól deweloperskich. Zaktualizuj odwołanie do definicji środowiska dla wszystkich istniejących pól deweloperskich utworzonych przy użyciu definicji obrazów w usuniętym wykazie. Jeśli odniesienie nie jest zaktualizowane przed ponownym wdrożeniem środowiska, proces wdrażania zakończy się niepowodzeniem.

Aby usunąć wykaz:

  1. W menu po lewej stronie centrum programistycznego lub projektu, w sekcji Konfiguracja środowiska, wybierz Katalogi.

  2. Wybierz określony wykaz, a następnie wybierz pozycję Usuń.

  3. W oknie dialogowym Usuwanie wykazu wybierz pozycję Kontynuuj, aby usunąć wykaz.

Rozwiązywanie problemów z błędami synchronizacji katalogu

Podczas dodawania lub synchronizowania wykazu może wystąpić błąd synchronizacji lub ostrzeżenie. Błąd synchronizacji wskazuje, że nie można pomyślnie zsynchronizować wykazu. Ostrzeżenie synchronizacji wskazuje, że niektóre lub wszystkie elementy wykazu mają błędy. Stan synchronizacji i błędy można wyświetlić w witrynie Azure Portal lub użyć interfejsu wiersza polecenia platformy Azure i interfejsu API REST, aby rozwiązać problemy i usunąć błędy.

Wyświetlanie stanu synchronizacji katalogu

W witrynie Azure Portal możesz uzyskać więcej informacji na temat stanu synchronizacji katalogu oraz wszelkich ostrzeżeń lub błędów, wybierając link stanu. Link stanu otwiera okienko pokazujące stan synchronizacji, liczbę dodanych definicji obrazów oraz liczbę definicji obrazów, które zostały zignorowane lub zakończyły się niepowodzeniem.

Wyświetlanie niepowodzeń synchronizacji katalogu

  1. W menu po lewej stronie centrum programistycznego lub projektu, w sekcji Konfiguracja środowiska, wybierz Katalogi.

  2. W kolumnie Stan wybierz link stanu katalogu, który nie może przeprowadzić synchronizacji.

    Zrzut ekranu przedstawiający panel Katalogi, z wyróżnioną pozycją Synchronizacja nieudana.

  3. Zostanie wyświetlone okienko szczegółów pokazujące zmiany w ostatniej synchronizacji, liczbę błędów synchronizacji i typ błędów.

    Zrzut ekranu przedstawiający okienko Niepowodzenia synchronizacji katalogu.

Wyświetlanie ostrzeżeń dotyczących synchronizacji katalogu

  1. W menu po lewej stronie centrum programistycznego lub projektu, w sekcji Konfiguracja środowiska, wybierz Katalogi.

  2. W kolumnie Stan wybierz link stanu dla katalogu, który został zsynchronizowany, ale zgłasza ostrzeżenie.

    Zrzut ekranu przedstawiający okienko Wykazy z wyróżnionymi błędami w trzech elementach.

  3. Zostanie wyświetlone okienko szczegółów pokazujące zmiany w ostatniej synchronizacji, liczbę błędów elementów oraz typ i źródło każdego błędu.

    Zrzut ekranu przedstawiający panel Błędy synchronizacji katalogu.

  4. Można wyświetlić elementy, które zostały pomyślnie zsynchronizowane z katalogu, który również zgłasza błędy synchronizacji. W okienku Wykazy wybierz nazwę katalogu.

    Zrzut ekranu przedstawiający okienko Wykaz z wyróżnioną nazwą wykazu.

  5. Zostanie wyświetlona lista pomyślnie zsynchronizowanych elementów wykazu.

    Zrzut ekranu przedstawiający pomyślnie zsynchronizowane elementy wykazu.

Rozwiązywanie problemów z błędami synchronizacji katalogu przy użyciu interfejsu wiersza polecenia platformy Azure

Użyj Azure CLI lub API REST, aby pobrać katalog. Odpowiedź GET pokazuje typ błędu:

  • Ignorowane definicje obrazów, które zostały wykryte jako duplikaty.
  • Nieprawidłowe definicje obrazów, które zakończyły się niepowodzeniem z powodu błędów schematu, odwołania lub walidacji.

Rozwiązywanie ignorowanych błędów definicji środowiska

Jeśli dodasz co najmniej dwie definicje obrazów o tej samej nazwie, wystąpi zignorowany błąd definicji środowiska. Ten problem można rozwiązać, zmieniając nazwy definicji obrazów, aby każda definicja środowiska ma unikatową nazwę w wykazie.

Rozwiązywanie nieprawidłowych błędów definicji środowiska

Z różnych powodów może wystąpić nieprawidłowy błąd definicji środowiska:

  • Błędy schematu manifestu. Upewnij się, że plik definiujący środowisko jest zgodny z wymaganym schematem.

  • Błędy walidacji. Sprawdź następujące elementy, aby usunąć błędy walidacji:

    • Upewnij się, że typ silnika pliku konfiguracyjnego środowiska jest poprawnie skonfigurowany.
    • Upewnij się, że nazwa definicji środowiska ma od 3 do 63 znaków.
    • Upewnij się, że nazwa definicji środowiska zawiera tylko znaki prawidłowe dla adresu URL, które są znakami alfanumerycznymi i tymi symbolami: ~!,.';:=-_+()*&$@

  • Błędy w odwołaniu. Upewnij się, że ścieżka szablonu, do którego odwołuje się plik środowiska, jest prawidłową ścieżką względną do pliku w repozytorium.

Treści powiązane

  • Last updated on