Udostępnij za pośrednictwem


Samouczek: Połącz wiki Azure DevOps z Azure SRE Agent

W tym samouczku połączysz witrynę typu wiki usługi Azure DevOps jako źródło wiedzy dla agenta usługi Azure SRE. Po wykonaniu tych kroków agent może przeszukiwać wiki zespołu pod kątem Runbooków i procedur, gdy odpowiada na pytania podczas dochodzeń.

W tym poradniku nauczysz się, jak:

  • Połącz wiki Azure DevOps za pomocą łącznika dokumentacji
  • Wybieranie między tożsamością zarządzaną a uwierzytelnianiem osobistego tokenu dostępu
  • Zweryfikuj połączenie, zadając agentowi pytanie korzystające z zawartości typu wiki

Szacowany czas: 10 minut

Wymagania wstępne

Przed rozpoczęciem upewnij się, że masz następujące zasoby i dostęp:

  • Agent SRE platformy Azure (już utworzony).
  • Projekt usługi Azure DevOps z witryną typu wiki zawierającą zawartość.
  • Jedną z następujących opcji uwierzytelniania:
    • Tożsamość zarządzana: dodaj tożsamość zarządzaną agenta jako użytkownika w organizacji usługi Azure DevOps (Ustawienia Organizacji>Użytkownicy>Dodaj użytkowników>, następnie wprowadź identyfikator klienta tożsamości).
    • Osobisty token dostępu (PAT): Wygeneruj w usłudze Azure DevOps z zakresem Code (Read).

Uzyskiwanie adresu URL witryny typu wiki

Aby połączyć witrynę typu wiki, musisz najpierw uzyskać adres URL z usługi Azure DevOps.

  1. Przejdź do projektu usługi Azure DevOps.
  2. Wybierz Wiki na pasku bocznym po lewej stronie.
  3. Skopiuj adres URL z paska adresu przeglądarki.

Adres URL wygląda następująco:

https://dev.azure.com/{your-org}/{your-project}/_wiki/wikis/{wiki-name}

Obsługiwane są również starsze adresy URL:

https://{your-org}.visualstudio.com/{your-project}/_wiki/wikis/{wiki-name}

Wskazówka

Aby zaindeksować tylko określoną sekcję witryny typu wiki, przejdź najpierw do tej sekcji w usłudze Azure DevOps, a następnie skopiuj adres URL. Identyfikator strony w adresie URL nakazuje agentowi przeszukiwanie tylko tej strony i jej podstron. Takie podejście jest przydatne w przypadku dużych witryn typu wiki, w których istotne są tylko sekcje takie jak /Operations lub /Runbooks .

Otwórz stronę Łączniki

Przejdź do konfiguracji łączników w portalu agenta usługi Azure SRE.

  1. Przejdź do sre.azure.com.
  2. Wybierz swój agent.
  3. Na lewym pasku bocznym rozwiń Builder.
  4. Wybierz Łączniki.

Zostanie wyświetlona lista istniejących łączników z nazwami, typami usług i stanem połączenia.

Uruchom kreator dodawania łącznika

Wybierz opcję Dodaj łącznik na pasku narzędzi, aby otworzyć trzyetapowego kreatora:

  1. Wybierz łącznik: wybierz typ łącznika.
  2. Konfigurowanie łącznika: konfigurowanie nazwy, adresu URL i uwierzytelniania.
  3. Przejrzyj i dodaj: potwierdź i utwórz.

Wybieranie łącznika dokumentacji

W selektorze łączników znajdź i wybierz Łącznik dokumentacji z podtytułem Azure DevOps. Opis łącznika brzmi: "Agent odwołuje się do dokumentacji i plików w celu zrozumienia projektów i procesów".

Wybierz przycisk Dalej , aby przejść do formularza konfiguracji.

Konfigurowanie łącznika

W tytule formularza zostanie wyświetlony komunikat Konfigurowanie łącznika usługi Azure DevOps. Wypełnij następujące pola:

Pole Co należy wprowadzić
Nazwa Nazwa opisowa (na przykład ops-wiki lub team-runbooks)
Azure DevOps URL Adres URL wiki z poprzedniego kroku

Wybierz metodę uwierzytelniania

Wybierz jedną z następujących opcji uwierzytelniania.

  1. Wybierz pozycję Tożsamość zarządzana (wybrana domyślnie).
  2. Wybierz tożsamość zarządzaną z listy rozwijanej tożsamość zarządzana (domyślnie przypisana przez system).
  3. Opcjonalnie wybierz pozycję Użyj tożsamości zarządzanej jako poświadczenia tożsamości federacyjnej.

Opcja B: Osobisty token dostępu (PAT)

  1. Wybierz Osobisty token dostępu (PAT).
  2. Wklej osobisty token dostępu do usługi Azure DevOps w polu Osobisty token dostępu .

Wybierz przycisk Dalej , aby przejść do kroku przeglądu.

Przegląd i tworzenie łącznika

Przejrzyj szczegóły łącznika na ekranie podsumowania, a następnie wybierz przycisk Prześlij, aby utworzyć łącznik.

Nowy łącznik zostanie wyświetlony na liście łączników ze stanem Połączono (zielony znacznik wyboru).

Uwaga / Notatka

Wstępne indeksowanie może potrwać kilka minut w zależności od rozmiaru witryny typu wiki. Agent może używać zawartości typu wiki po zakończeniu indeksowania.

Weryfikowanie połączenia

Przetestuj nowe połączenie typu wiki, zadając agentowi pytanie, na które może odpowiedzieć zawartość witryny typu wiki.

  1. Wybierz pozycję Nowy wątek czatu na pasku bocznym.
  2. Zadaj pytanie, na które może odpowiedzieć zawartość witryny typu wiki.

Przykład:

What are our standard procedures for handling a database failover?

Twój agent przeszukuje Twój wiki oraz inne źródła wiedzy i dołącza cytaty prowadzące do oryginalnej strony wiki w swojej odpowiedzi. Odpowiedź zawiera link cytatu z powrotem do źródłowej strony typu wiki w usłudze Azure DevOps.

Troubleshooting

Skorzystaj z poniższej tabeli, aby rozwiązać typowe problemy z łącznikiem typu wiki usługi Azure DevOps.

Problematyka Rozwiązanie
Łącznik pokazuje rozłączone Sprawdź format adresu URL wiki i poświadczenie uwierzytelniania.
Zawartość wiki nie pojawia się w odpowiedziach Poczekaj kilka minut na ukończenie początkowego indeksowania, a następnie spróbuj ponownie.
Błąd sprawdzania poprawności adresu URL Upewnij się, że adres URL jest zgodny https://dev.azure.com/{org}/{project}/_wiki/wikis/{wiki-name} lub https://dev.azure.com/{org}/{project}/_git/{repo}. Akceptowane są również starsze visualstudio.com adresy URL.
Uwierzytelnianie PAT kończy się niepowodzeniem Sprawdź, czy Twój token dostępu osobistego ma zakres kodu (odczyt) i nie wygasł.
Tożsamość zarządzana zawodzi Sprawdź, czy tożsamość zarządzana agenta została dodana jako użytkownik w organizacji usługi Azure DevOps (Ustawienia organizacji>Użytkownicy).

Następne kroki