Генерація довідкової документації для метрик

Ця сторінка демонструє, як згенерувати довідкову документацію для метрик.

Перш ніж ви розпочнете

Вимоги:

• Вам потрібна машина, що працює під управлінням Linux або macOS.

• Вам потрібно встановити ці інструменти:

  • Python версії v3.7.x+
  • Git
  • Golang версії 1.13+
  • Pip для встановлення PyYAML
  • PyYAML версії v5.1.2
  • make
  • gcc компілятор/лінкер
  • Docker (Потрібен тільки для довідки по команді kubectl)

• Ваша змінна середовища PATH повинна включати необхідні інструменти для збірки, такі як бінарники Go та python.

• Вам потрібно знати, як створити pull request до репозиторію на GitHub. Це включає створення власного форку репозиторію. Для отримання додаткової інформації дивіться Робота з локальним клоном.

Клонування репозиторію Kubernetes

Генерація документації для метрик відбувається в репозиторії Kubernetes. Щоб клонувати репозиторій, перейдіть до теки, де ви хочете, щоб знаходилася клонована копія.

Потім виконайте наступну команду:

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

Це створить теку kubernetes у вашій поточній робочій теці.

Генерація документації для метрик

У клонованому репозиторії Kubernetes знайдіть теку test/instrumentation/documentation. Документація для метрик генерується в цій теці.

З кожним релізом додаються нові метрики. Після того, як ви запустите скрипт генерації документації для метрик, скопіюйте документацію для метрик на вебсайт Kubernetes і опублікуйте оновлену документацію для метрик.

Щоб згенерувати останні метрики, переконайтеся, що ви знаходитесь в кореневій теці клонованого репозиторію Kubernetes. Потім виконайте наступну команду:

./test/instrumentation/update-documentation.sh

Щоб перевірити наявність змін, виконайте команду:

git status

Вивід буде схожий на:

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

Скопіюйте згенерований файл документації для метрик в репозиторій вебсайту Kubernetes

1. Встановіть змінну середовища для кореневої теки вебсайту Kubernetes.

   Виконайте наступну команду, щоб встановити кореневу теку вебсайту:

   export WEBSITE_ROOT=<шлях до кореня вебсайту>
   

2. Скопіюйте згенерований файл метрик в репозиторій вебсайту Kubernetes.

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

   Примітка:

   Якщо ви отримали помилку, перевірте, чи маєте ви дозволи на копіювання файлу. Ви можете використати chown, щоб змінити власника файлу на вашого користувача.

Створіть pull request

Щоб створити pull request, дотримуйтесь інструкцій у розділі Відкриття pull request.

Що далі

• Внесок у код Kubernetes
• Генерація довідкової документації для компонентів і інструментів Kubernetes
• Генерація довідкової документації для команд kubectl