Англійська для розробників Buildkite

Розмови Buildkite зосереджені на гібридній моделі — планка керування знаходиться на хостингу, але агенти, які фактично виконують збирання, є вашими — отже, словник охоплює керування агентами, кроки конвеєра і модель черги, яка з’ єднує обидва.

Ключовий словник

** Агент ** — процес, який ви запускаєте у вашій власній інфраструктурі, який обробляє завдання Buildkite і виконує їх, тобто кроки збирання виконуються у будь- якій точці, де ви розмістили агент, а не на серверах Buildkite. “Збирання стоять у черзі, оскільки у нас є лише два агенти онлайн — збільште кількість агентів, оскільки Buildkite сам по собі не є проблемою, а наша власна інфраструктура.”

** Pipeline ** — визначена послідовність кроків, які виконує Buildkite під час запуску, зазвичай виражена у YAML і здатна динамічно створювати наступні кроки під час виконання.

• “Цей конвеєр динамічно завантажує нові кроки на основі змін у diff — це не фіксоване число кроків, отже, перевірте скрипт створення, якщо щось відсутнє.” *

** Queue ** — групування з назвою, яке маршрутизує певні завдання до певних наборів агентів, надаючи змогу командам приділяти певних агентів певним типам робіт (наприклад, завданням GPU або збіркам macOS). “Явно позначте цей крок для черги GPU — інакше він призведе до появи загального агента, який не має апаратного забезпечення, якого потребує ця задача.”

** Гібридна архітектура ** — Buildkite розділений між хостованою площиною управління (планування, інтерфейс користувача, API) і самостійно хостованими агентами (фактичне виконання завдання), надаючи командам контроль над інфраструктурою без управління всім продуктом CI. “Ми не виставляємо початковий код на сторонні сервери збирання - гібридна архітектура означає, що наш код завжди торкається тільки агентів, які ми запускаємо самі.”

** Артефакт ** — файл, який було вивантажено з одного кроку і зроблено доступним для звантаження на наступних кроках або для перевірки після збирання, схожий за метою на артефакти в інших системах CI.

• “Відвантажити звіт про тестування як артефакт замість того, щоб просто надрукувати його у журнал — таким чином його можна буде звантажити і порівняти між запусками, а не просто прокрутити назад.” *

Звичайні фрази

• Чи є у нас недостатньо агентів, чи є щось інше, що спричиняє цей затримку черги збирання?»
• Чи генерує цей конвеєр кроки динамічно, чи список кроків фактично фіксований?
• Чи це завдання позначене для правильної черги, або воно може приземлитися на агенті без апаратного забезпечення, якого він потребує?»
• Чи варто цей вивід завантажувати як артефакт, чи достатньо друкувати його в журналі?»

Приклади висловлювань

Діагностика повільної черги CI: “Це не проблема конфігурації конвеєра — у нас просто немає достатньої кількості агентів у мережі, щоб не відставати від одночасних збирань, тому спочатку масштабуємо пул агентів.”

Пояснення моделі безпеки для переглядача безпеки: “Наш код ніколи не залишає нашу власну інфраструктуру — хостована сторона Buildkite обробляє тільки планування і інтерфейс користувача, а агенти, які фактично перевіряють код, працюють на серверах, які ми контролюємо.”

Перегляд неправильно адресованого завдання: “Цей крок, залежний від GPU, не має міток для черги GPU, тому він приземляється на загальному агенті і зазнає невдачі — правильно міткуйте його, і він буде маршрутизований до обладнання, яке може його запустити.”

Професійні поради

• Діагностуйте затримки черги, перевіряючи ** обсяг агента ** перед тим, як приймати проблему налаштування конвеєра — це більш поширена коренева причина.
• Зрозуміти і пояснити ** гібридну архітектуру ** чітко, коли рецензенти безпеки або відповідності запитують, де виконується код — це справжній відмінник, про який варто бути точним.
• Використовуйте ** черги ** навмисно для маршрутизації спеціалізованих завдань (графічний процесор, macOS, arm64) до агентів, призначених для них — неправильно адресовані завдання є частою, заплутаною причиною невдач.
• Вивантаження значущих виводів як ** артефактів ** замість покладання на журналування прокрутки назад — це робить результати порівнянними між запусками і спрощує спільне використання.

Практичні вправи

1. Поясніть співробітнику команди, чому зростаюча черга збирання вказує на обсяг агента, а не на налаштування конвеєра.
2. Опишете гібридну архітектуру Buildkite в одному або двох реченнях для когось, хто проводить перегляд безпеки.
3. Написати речення, у якому буде позначено, що завдання, залежне від графічного процесора, не було помічено для правильної черги.

Національний гідрографічний інститут: Відповідь і відповіді

Для людей, для яких англійська не є рідною мовою, працюючи з Buildkite, розуміння тонких відмінностей у фразуваннях є критичним. Це не просто переклад слів; це про передачу намірів, визнання контексту і сприяння ефективному спілкуванню в команді розробників. Здається незначною зміна у формулюванні може суттєво змінити те, як сприймається запит або зворотній зв’язок. Розглянемо деякі типові сценарії, де точна мова робить усю різницю.

Розглянемо наступний випадок: ви надіслали запит на звантаження з докладним описом змін, які ви внесли до файла Jenkins. Рецензент відповідає: “Відчувається добре, але могло б бути краще”. Що це справді означає? Это почти наверняка не личная критика твоих навыков программирования. Замість цього, він припускає, що є потенційні вразливості або області для поліпшення в дизайні конвеєра - можливо, що стосується обробки помилок, управління ресурсами або залежностей. Краще було б сказати: «Чи можемо ми додати певну явну обробку помилок навколо команди ssh, щоб елегантно обробляти помилки з’ єднання? Також, давайте переконаємося, що агент має достатньо пам’ яті, виділеної для виконання цього завдання.» Початкова формулювання є нечіткою і залишає місце для неправильного тлумачення. Аналогічно, при обговоренні складної проблеми під час розмови Slack з іншим розробником, заява «Це не працює» набагато менш корисна, ніж «Крок build постійно зазнає невдачі після 15 хвилин виконання; Я підозрюю, що агент може бути перевантажений»

Інша поширена ситуація виникає в перегляді коду. Отримати коментар на кшталт «Розгляньте переробку цього розділу» може бути залякуванням. Це часто ніжна пропозиція щодо поліпшення, але без подальшого контексту, це може означати, що потрібна значна переробка. Більш конструктивна відповідь полягала б у тому, щоб задати прояснюючі питання: «Чи можете ви розібратися, що саме ви хотіли б змінити? Чи є проблеми з продуктивністю або підтримкою, про які я повинен знати?» Ключовим тут є перетворення зворотнього зв’ язку від неоднозначної директиви на спільне дослідження потенційних рішень. Пам’ятайте, що гібридна архітектура Buildkite сильно залежить від чіткого спілкування між агентами і загонами - документація, коментарі і описи PR повинні бути точні, щоб уникнути неоднозначності.

Нарешті, при поясненні Buildkite зацікавленим сторонам, які не є технічними, використання мови, яка підкреслює * стабільність * і * надійність * є важливим. Фрази на кшталт «самостійно розміщений runner» можуть звучати залякуючою; замість цього, ви можете сказати «Ми запускаємо наш процес збирання на виделених серверах в рамках нашої власної інфраструктури, що дає нам повний контроль над продуктивністю і безпекою»

Ось приклад використання команди buildkite agent list:

buildkite agent list --agent-name my-agent-01

За допомогою цієї команди можна переглянути список доступних агентів, що є ключовим елементом для розуміння розподіленої архітектури Buildkite. Це практична ілюстрація того, як можна обговорювати розподіл ресурсів і управління агентами в команді.