Generowanie materiałów źródłowych dla metryk

Ta strona demonstruje generowanie materiałów źródłowych dotyczących metryk.

Zanim zaczniesz

Wymagania:

• Potrzebujesz maszyny z systemem operacyjnym Linux lub macOS.

• Musisz mieć zainstalowane następujące narzędzia:

  • Python w wersji 3.7.x+
  • Git - Dokumentacja opisuje, jak zainstalować i rozpocząć pracę z systemem kontroli wersji Git.
  • Golang wersja 1.13+
  • Pip używany do instalacji PyYAML
  • PyYAML w wersji 5.1.2
  • make
  • gcc compiler/linker
  • Docker (Wymagany tylko do odniesień do poleceń kubectl)

• Twoja zmienna środowiskowa PATH musi zawierać wymagane narzędzia do budowania, takie jak binaria Go i python.

• Musisz wiedzieć, jak utworzyć pull requesta do repozytorium na GitHubie. Wymaga to utworzenia własnego forka repozytorium. Aby uzyskać więcej informacji, zobacz Praca z lokalnej kopii.

Sklonuj repozytorium Kubernetesa

Generowanie metryk odbywa się w repozytorium Kubernetesa. Aby sklonować repozytorium, przejdź do katalogu, w którym chcesz, aby klon istniał.

Następnie wykonaj następujące polecenie:

git clone https://www.github.com/kubernetes/kubernetes 

To tworzy folder kubernetes w bieżącym katalogu roboczym.

Generowanie metryk

W sklonowanym repozytorium Kubernetesa zlokalizuj katalog test/instrumentation/documentation. Dokumentacja metryk jest generowana w tym katalogu.

Przy każdej wersji dodawane są nowe metryki. Po uruchomieniu skryptu generatora dokumentacji metryk, skopiuj dokumentację metryk na stronę internetową Kubernetesa i opublikuj zaktualizowaną dokumentację metryk.

Aby wygenerować najnowsze metryki, upewnij się, że znajdujesz się w katalogu głównym sklonowanego katalogu Kubernetesa. Następnie wykonaj następujące polecenie:

./test/instrumentation/update-documentation.sh

Aby sprawdzić zmiany, wykonaj:

git status

Wynik jest podobny do:

./test/instrumentation/documentation/documentation.md
./test/instrumentation/documentation/documentation-list.yaml

Skopiuj wygenerowany plik dokumentacji metryk do repozytorium strony internetowej Kubernetesa

1. Ustaw zmienną środowiskową głównego katalogu strony Kubernetesa.

   Wykonaj następujące polecenie, aby ustawić główny katalog witryny:

   export WEBSITE_ROOT=<path to website root>
   

2. Skopiuj wygenerowany plik metryk do repozytorium witryny Kubernetesa.

   cp ./test/instrumentation/documentation/documentation.md "${WEBSITE_ROOT}/content/en/docs/reference/instrumentation/metrics.md"
   

   Informacja:

   Jeśli pojawi się błąd, sprawdź, czy masz uprawnienia do skopiowania pliku. Możesz użyć chown, aby zmienić własność pliku na swojego użytkownika.

Utwórz pull requesta

Aby utworzyć pull request, postępuj zgodnie z instrukcjami w Otwarcie pull requesta.

Co dalej?

• Współpraca z głównym projektem
• Generowanie materiałów źródłowych dla komponentów i narzędzi Kubernetesa
• Generowanie materiałów źródłowych dla poleceń kubectl