Dodawanie i konfigurowanie wykazu z repozytoriów GitHub lub Azure Repos
Artykuł
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 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.
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ć.
Twoja organizacja usługi Azure DevOps musi znajdować się w tym samym katalogu co subskrypcja platformy Azure zawierająca centrum deweloperskie.
Wybierz pozycję Ustawienia organizacji.
Na stronie Przegląd wybierz pozycję Użytkownicy.
Na stronie Użytkownicy wybierz pozycję Dodaj użytkowników.
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.
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.
W witrynie Azure Portal przejdź do centrum deweloperów.
W menu po lewej stronie w obszarze Konfiguracja środowiska wybierz pozycję Wykazy, a następnie wybierz pozycję Dodaj.
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.
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.
Skopiuj i zapisz wygenerowany token, aby użyć go później.
Tworzenie magazynu kluczy
Potrzebujesz usługi Azure Key Vault do przechowywania tokenu dostępu używanego do udzielania dostępu platformy Azure do repozytorium. Magazyny kluczy mogą kontrolować dostęp za pomocą zasad dostępu lub kontroli dostępu opartej na rolach (RBAC). Jeśli masz istniejący magazyn kluczy, możesz go użyć, ale należy sprawdzić, czy używa zasad dostępu, czy przypisań kontroli dostępu opartej na rolach w celu kontrolowania dostępu. Aby uzyskać pomoc dotyczącą konfigurowania zasad dostępu dla magazynu kluczy, zobacz Przypisywanie zasad dostępu usługi Key Vault.
Aby utworzyć magazyn kluczy RBAC, wykonaj następujące czynności:
Na karcie Tworzenie magazynu kluczy podaj następujące informacje:
Nazwa/nazwisko
Wartość
Nazwa/nazwisko
Wprowadź nazwę magazynu kluczy.
Subskrypcja
Wybierz subskrypcję, w której chcesz utworzyć magazyn kluczy.
Grupa zasobów:
Użyj istniejącej grupy zasobów lub wybierz pozycję Utwórz nową i wprowadź nazwę grupy zasobów.
Lokalizacja
Wybierz lokalizację lub region, w którym chcesz utworzyć magazyn kluczy.
Pozostaw wartości domyślne pozostałych opcji.
Na karcie Zasady dostępu wybierz pozycję Kontrola dostępu oparta na rolach platformy Azure, a następnie wybierz pozycję Przejrzyj i utwórz.
Na karcie Przeglądanie i tworzenie wybierz pozycję Utwórz.
Przechowywanie osobistego tokenu dostępu w magazynie kluczy
W usłudze Key Vault w menu po lewej stronie wybierz pozycję Wpisy tajne.
Na stronie Wpisy tajne wybierz pozycję Generuj/Importuj.
Na stronie Tworzenie wpisu tajnego:
W polu Nazwa wprowadź opisową nazwę wpisu tajnego.
W polu Wartość wpisu tajnego wklej skopiowany wcześniej identyfikator PAT.
Wybierz pozycję Utwórz.
Uzyskiwanie identyfikatora wpisu tajnego
Pobierz ścieżkę do wpisu tajnego utworzonego w magazynie kluczy.
W witrynie Azure Portal przejdź do magazynu kluczy.
Na stronie magazynu kluczy z menu po lewej stronie wybierz pozycję Wpisy tajne.
Na stronie Wpisy tajne wybierz utworzony wcześniej wpis tajny.
Na stronie wersje wybierz bieżącą WERSJĘ.
Na bieżącej wersji dla identyfikatora wpisu tajnego wybierz pozycję Kopiuj.
Dodawanie repozytorium jako katalogu
W witrynie Azure Portal przejdź do centrum deweloperów.
Upewnij się, że tożsamość dołączona do centrum deweloperów ma dostęp do wpisu tajnego magazynu kluczy, w którym jest przechowywany osobisty token dostępu.
W menu po lewej stronie w obszarze Konfiguracja środowiska wybierz pozycję Wykazy, a następnie wybierz pozycję Dodaj.
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ę Osobisty token dostępu.
Organizacja
Wybierz organizację, która hostuje repozytorium wykazu.
Projekt
Wybierz projekt, który przechowuje repozytorium wykazu.
Rep
Wybierz repozytorium, które przechowuje wykaz.
Ścieżka folderu
Wybierz folder zawierający szablony IaC.
Identyfikator wpisu tajnego
Wprowadź identyfikator wpisu tajnego, który zawiera identyfikator pat dla repozytorium. Podczas kopiowania identyfikatora wpisu tajnego parametry połączenia zawiera identyfikator wersji na końcu, tak jak w tym przykładzie: https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat/9376b432b72441a1b9e795695708ea5a. Usunięcie identyfikatora wersji gwarantuje, że środowiska wdrażania pobiera najnowszą wersję wpisu tajnego z magazynu kluczy. Jeśli twój token dostępu wygaśnie, należy zaktualizować tylko magazyn kluczy. Przykładowy identyfikator wpisu tajnego:https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat
W obszarze Wykazy centrum deweloperów sprawdź, czy katalog jest wyświetlany. Jeśli połączenie zakończy się pomyślnie, stan to Połączenie.
Aby dodać wykaz, wykonaj następujące zadania:
Instalowanie i konfigurowanie aplikacji Microsoft Centrum deweloperów
Przypisz uprawnienia w usłudze GitHub dla repozytoriów.
Dodaj repozytorium jako wykaz.
Instalowanie aplikacji Microsoft Centrum deweloperów
W menu po lewej stronie w obszarze Konfiguracja środowiska wybierz pozycję Wykazy, a następnie wybierz pozycję Dodaj.
W okienku Dodawanie wykazu wprowadź lub wybierz następujące opcje:
Pole
Wartość
Nazwa/nazwisko
Wprowadź nazwę wykazu.
Źródło wykazu
Wybierz pozycję GitHub.
Authentication type (Typ uwierzytelniania)
Wybierz pozycję Aplikacja GitHub.
Aby zainstalować aplikację Microsoft Centrum deweloperów, wybierz pozycję Skonfiguruj repozytoria.
Jeśli zostanie wyświetlony monit o uwierzytelnienie w usłudze GitHub, uwierzytelnij się.
Na stronie Microsoft DevCenter wybierz pozycję Konfiguruj.
Wybierz organizację usługi GitHub zawierającą repozytorium, które chcesz dodać jako wykaz. Aby zainstalować tę aplikację, musisz być właścicielem organizacji.
Na stronie Instalowanie programu Microsoft DevCenter wybierz pozycję Tylko wybierz repozytoria, wybierz repozytorium, które chcesz dodać jako wykaz, a następnie wybierz pozycję Zainstaluj.
Możesz wybrać wiele repozytoriów, które mają zostać dodane jako wykazy. Każde repozytorium należy dodać jako oddzielny wykaz, zgodnie z opisem w temacie Dodawanie repozytorium jako katalogu.
Na stronie Microsoft DevCenter by Microsoft chcesz uzyskać uprawnienia do: przejrzyj wymagane uprawnienia, a następnie wybierz pozycję Autoryzuj Centrum deweloperów firmy Microsoft.
Dodawanie repozytorium jako katalogu
Wróć do witryny Azure Portal.
W obszarze Dodaj wykaz wprowadź następujące informacje, a następnie wybierz pozycję Dodaj:
Pole
Wartość
Repo
Wybierz repozytorium, które chcesz dodać jako wykaz.
W obszarze Wykazy centrum deweloperów sprawdź, czy katalog jest wyświetlany. Po pomyślnym nawiązaniu połączenia stan odczytuje powodzenie synchronizacji.
Aby dodać wykaz, wykonaj następujące zadania:
Pobierz adres URL klonowania repozytorium GitHub.
Utwórz osobisty token dostępu (PAT) w usłudze GitHub.
Zapisz klucz dostępu jako wpis tajny magazynu kluczy w usłudze Azure Key Vault.
Tworzenie osobistego tokenu dostępu w usłudze GitHub
Środowiska wdrażania platformy Azure obsługują uwierzytelnianie w repozytoriach GitHub przy użyciu tokenów klasycznych lub precyzyjnych tokenów. W tym przykładzie utworzysz szczegółowe tokeny.
Przejdź do strony głównej repozytorium GitHub zawierającego definicje szablonu.
W prawym górnym rogu witryny GitHub wybierz obraz profilu, a następnie wybierz pozycję Ustawienia.
Na lewym pasku bocznym wybierz pozycję Ustawienia>dewelopera Osobiste tokeny dostępu Szczegółowe tokeny.>
Wybierz pozycję Generuj nowy token.
Na stronie Nowy szczegółowe osobiste tokeny dostępu podaj następujące informacje:
Rozwiń pozycję Uprawnienia repozytorium, a w polu Zawartość z listy Dostęp wybierz pozycję Odczyt kodu.
Wybierz pozycję Generuj token.
Skopiuj i zapisz wygenerowany token, aby użyć go później.
Ważne
Podczas pracy z repozytorium prywatnym przechowywanym w organizacji usługi GitHub należy upewnić się, że identyfikator PAT usługi GitHub jest skonfigurowany w celu udzielenia dostępu do właściwej organizacji i repozytoriów w niej.
Tokeny klasyczne w organizacji muszą być autoryzowane za pomocą logowania jednokrotnego do określonej organizacji po ich utworzeniu.
Szczegółowe tokeny muszą mieć właściciela zestawu tokenów jako samą organizację, która ma być autoryzowana.
Niepoprawnie skonfigurowane sieci PATs mogą spowodować błąd nie znaleziono repozytorium.
Tworzenie magazynu kluczy
Potrzebujesz usługi Azure Key Vault do przechowywania patu, który jest używany do udzielania dostępu platformy Azure do repozytorium. Magazyny kluczy mogą kontrolować dostęp za pomocą zasad dostępu lub kontroli dostępu opartej na rolach (RBAC). Jeśli masz istniejący magazyn kluczy, możesz go użyć, ale należy sprawdzić, czy używa zasad dostępu, czy przypisań kontroli dostępu opartej na rolach w celu kontrolowania dostępu. Aby uzyskać pomoc dotyczącą konfigurowania zasad dostępu dla magazynu kluczy, zobacz Przypisywanie zasad dostępu do magazynu kluczy.
Aby utworzyć magazyn kluczy RBAC, wykonaj następujące czynności:
Na karcie Tworzenie magazynu kluczy podaj następujące informacje:
Nazwa/nazwisko
Wartość
Nazwa/nazwisko
Wprowadź nazwę magazynu kluczy.
Subskrypcja
Wybierz subskrypcję, w której chcesz utworzyć magazyn kluczy.
Grupa zasobów:
Użyj istniejącej grupy zasobów lub wybierz pozycję Utwórz nową i wprowadź nazwę grupy zasobów.
Lokalizacja
Wybierz lokalizację lub region, w którym chcesz utworzyć magazyn kluczy.
Pozostaw wartości domyślne pozostałych opcji.
Na karcie Zasady dostępu wybierz pozycję Kontrola dostępu oparta na rolach platformy Azure, a następnie wybierz pozycję Przejrzyj i utwórz.
Na karcie Przeglądanie i tworzenie wybierz pozycję Utwórz.
Przechowywanie osobistego tokenu dostępu w magazynie kluczy
W usłudze Key Vault w menu po lewej stronie wybierz pozycję Wpisy tajne.
Na stronie Wpisy tajne wybierz pozycję Generuj/Importuj.
Na stronie Tworzenie wpisu tajnego:
W polu Nazwa wprowadź opisową nazwę wpisu tajnego.
W polu Wartość wpisu tajnego wklej swój identyfikator dostępu.
Wybierz pozycję Utwórz.
Uzyskiwanie identyfikatora wpisu tajnego
Pobierz ścieżkę do wpisu tajnego utworzonego w magazynie kluczy.
W witrynie Azure Portal przejdź do magazynu kluczy.
Na stronie magazynu kluczy z menu po lewej stronie wybierz pozycję Wpisy tajne.
Na stronie Wpisy tajne wybierz utworzony wcześniej wpis tajny.
Na stronie wersje wybierz bieżącą WERSJĘ.
Na bieżącej wersji dla identyfikatora wpisu tajnego wybierz pozycję Kopiuj.
Dodawanie repozytorium jako katalogu
W witrynie Azure Portal przejdź do centrum deweloperów.
Upewnij się, że tożsamość zarządzana dołączona do centrum deweloperów ma dostęp do wpisu tajnego magazynu kluczy, w którym jest przechowywany osobisty token dostępu.
W menu po lewej stronie w obszarze Konfiguracja środowiska wybierz pozycję Wykazy, a następnie wybierz pozycję Dodaj.
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ę GitHub.
Repo
Wprowadź lub wklej adres URL klonowania repozytorium GitHub lub repozytorium usługi Azure Repos. Przykładowy wykaz:https://github.com/Azure/deployment-environments.git
Gałąź
Wprowadź gałąź repozytorium, z którymi chcesz nawiązać połączenie. Przykładowy wykaz:main
Ścieżka folderu
Wprowadź ścieżkę folderu względem identyfikatora URI klonowania zawierającego podfoldery zawierające definicje środowiska. Ścieżka folderu dotyczy folderu z podfolderami zawierającymi pliki środowiska definicji środowiska, a nie dla folderu z samym plikiem środowiska definicji środowiska. Na poniższej ilustracji przedstawiono przykładową strukturę folderów katalogu. Przykładowy wykaz:/Environments Ścieżka folderu może zaczynać się od ukośnika lub bez ukośnika (/).
Identyfikator wpisu tajnego
Wprowadź identyfikator wpisu tajnego, który zawiera identyfikator pat dla repozytorium. Podczas kopiowania identyfikatora wpisu tajnego parametry połączenia zawiera identyfikator wersji na końcu, tak jak w tym przykładzie: https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat/9376b432b72441a1b9e795695708ea5a. Usunięcie identyfikatora wersji gwarantuje, że środowiska wdrażania pobierają najnowszą wersję wpisu tajnego z magazynu kluczy. Jeśli twój token dostępu wygaśnie, należy zaktualizować tylko magazyn kluczy. Przykładowy identyfikator wpisu tajnego:https://contoso-kv.vault.azure.net/secrets/GitHub-repo-pat
W obszarze Wykazy centrum deweloperów sprawdź, czy katalog jest wyświetlany. Po pomyślnym nawiązaniu połączenia stan odczytuje powodzenie synchronizacji.
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:
W menu po lewej stronie centrum deweloperów w obszarze Konfiguracja środowiska wybierz pozycję Wykazy.
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:
W menu po lewej stronie centrum deweloperów w obszarze Konfiguracja środowiska wybierz pozycję Wykazy.
Wybierz określony wykaz, a następnie wybierz pozycję Usuń.
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.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź: https://aka.ms/ContentUserFeedback.