Dodawanie i konfigurowanie wykazu z repozytoriów GitHub lub Azure Repos

W tym przewodniku wyjaśniono, jak dodać i skonfigurować katalog w centrum deweloperskim środowisk wdrażania platformy Azure. Wykaz to repozytorium hostowane w usłudze GitHub lub Azure DevOps.

Możesz użyć wykazu, aby udostępnić zespołom deweloperów wyselekcjonowane zestaw szablonów infrastruktury jako kodu (IaC) nazywanych definicjami środowisk.

Środowiska wdrażania obsługują katalogi hostowane w usłudze Azure Repos (usługa repozytorium na platformie Azure, często określane jako Azure DevOps) i wykazy hostowane w usłudze GitHub. Usługa Azure Repos obsługuje uwierzytelnianie, przypisując uprawnienia do tożsamości zarządzanej. Usługi Azure Repos i GitHub obsługują korzystanie z osobistego tokenu dostępu do uwierzytelniania. Aby dodatkowo zabezpieczyć szablony, wykaz jest szyfrowany; Środowiska wdrażania platformy Azure obsługują szyfrowanie magazynowane przy użyciu kluczy szyfrowania zarządzanych przez platformę, którymi zarządza firma Microsoft dla usług platformy 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.

Firma Microsoft oferuje katalog Szybki start, który można dodać do centrum deweloperów, oraz przykładowy wykaz, którego można użyć jako repozytorium. Możesz również użyć własnego repozytorium prywatnego lub rozwidlić i dostosować definicje środowiska w przykładowym wykazie.

Konfigurowanie tożsamości zarządzanej dla centrum deweloperów

Po utworzeniu centrum deweloperskiego, zanim będzie można dołączyć wykaz, musisz skonfigurować tożsamość zarządzaną, nazywaną również tożsamością usługi zarządzanej (MSI) dla centrum deweloperskiego. Tożsamość zarządzana przypisana przez system (tożsamość zarządzana przypisana przez system) lub tożsamość zarządzana przypisana przez użytkownika (tożsamość zarządzana przypisana przez użytkownika). Następnie przypiszesz role do tożsamości zarządzanej, aby umożliwić centrum deweloperom tworzenie typów środowisk w ramach subskrypcji i odczytywanie projektu usługi Azure Repos zawierającego repozytorium wykazu.

Jeśli centrum deweloperskie nie ma dołączonego tożsamości zarządzanej, wykonaj kroki opisane w temacie Konfigurowanie tożsamości zarządzanej, aby utworzyć tożsamość i przypisać role dla tożsamości zarządzanej centrum deweloperów.

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. Uwierzytelnianie można wybrać, przypisując uprawnienia do tożsamości usługi zarządzanej lub przy użyciu tokenu dostępu przechowywanego w magazynie kluczy.

Wybierz kartę typu repozytorium i uwierzytelniania, którego chcesz użyć.

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

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

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

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

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

    Uwaga

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

  2. Wybierz pozycję Ustawienia organizacji.

    Zrzut ekranu przedstawiający stronę organizacji usługi Azure DevOps z wyróżnioną pozycją Organizacja Ustawienia.

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

    Zrzut ekranu przedstawiający stronę Przegląd organizacji z wyróżnioną pozycją 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/nazwisko Wartość
    Użytkownicy lub jednostki usługi Wprowadź nazwę centrum deweloperskiego.
    W przypadku korzystania z przypisanej przez system tożsamości usługi zarządzanej określ nazwę centrum deweloperskiego, 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 pozycję Czytelnicy projektu.
    Wysyłanie zaproszeń e-mail (tylko do użytkowników) Wyczyść pole wyboru.

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

Dodawanie repozytorium jako katalogu

Środowiska wdrażania platformy Azure obsługują 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 deweloperów jako katalogu zapewnia zespołom deweloperów dostęp do szablonów i umożliwia im szybkie tworzenie spójnych środowisk.

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

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

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

    Zrzut ekranu przedstawiający okienko Wykazy.

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

    Pole Wartość
    Nazwa/nazwisko Wprowadź nazwę wykazu.
    Lokalizacja katalogu Wybierz pozycję Azure DevOps.
    Authentication type (Typ uwierzytelniania) Wybierz pozycję Tożsamość zarządzana.
    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 gałęzi. Wybierz folder, który przechowuje szablony IaC.

    Zrzut ekranu przedstawiający okienko Dodawanie wykazu z wyróżnionymi wpisami przykładów i pozycją Dodaj.

  4. W obszarze Wykazy centrum deweloperów sprawdź, czy katalog jest wyświetlany. Po pomyślnym nawiązaniu połączenia stan odczytuje powodzenie synchronizacji. Połączenie do katalogu może potrwać kilka minut po raz pierwszy.

Aktualizowanie wykazu

Jeśli zaktualizujesz zawartość lub definicję szablonu w dołączonym repozytorium, możesz udostępnić najnowszy zestaw definicji środowiska zespołom deweloperów, synchronizując katalog.

Aby zsynchronizować zaktualizowany wykaz w środowiskach wdrażania platformy Azure:

  1. W menu po lewej stronie centrum deweloperów w obszarze Konfiguracja środowiska wybierz pozycję Wykazy.

  2. Wybierz określony wykaz, a następnie wybierz pozycję Synchronizuj. Usługa skanuje repozytorium i udostępnia najnowszą listę definicji środowiska wszystkim skojarzonym projektom w centrum deweloperów.

Usuwanie wykazu

Wykaz można usunąć, aby usunąć go z centrum deweloperskiego środowisk wdrażania platformy Azure. Szablony w usuniętym wykazie nie są dostępne dla zespołów programistycznych podczas wdrażania nowych środowisk. Zaktualizuj odwołanie do definicji środowiska dla wszystkich istniejących środowisk utworzonych przy użyciu definicji środowiska w usuniętym wykazie. Jeśli odwołanie nie zostanie zaktualizowane i środowisko zostanie ponownie wdrożone, wdrożenie zakończy się niepowodzeniem.

Aby usunąć wykaz:

  1. W menu po lewej stronie centrum deweloperów w obszarze Konfiguracja środowiska wybierz pozycję Wykazy.

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

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

Błędy synchronizacji wykazu

Podczas dodawania lub synchronizowania wykazu może wystąpić błąd synchronizacji. Błąd synchronizacji wskazuje, że niektóre lub wszystkie definicje środowiska mają błędy. Użyj interfejsu wiersza polecenia platformy Azure lub interfejsu API REST, aby pobrać wykaz. Odpowiedź GET pokazuje typ błędu:

  • Ignorowane definicje środowiska, które zostały wykryte jako duplikaty.
  • Nieprawidłowe definicje środowiska, które nie powiodły się 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 środowiska o tej samej nazwie, wystąpi zignorowany błąd definicji środowiska. Ten problem można rozwiązać, zmieniając nazwy definicji środowiska, 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 środowiska definicji środowiska jest zgodny z wymaganym schematem.

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

    • Upewnij się, że typ aparatu pliku ś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 odwołania. 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.