Українська
Доступ для GitHub
Завдання розгортання працює на виконавці GitHub і має увійти на ваш сервер. Цей розділ дає йому саме такий доступ – власний ключ, ідентичність сервера й захищене місце для обох, – а потім розбирає завдання, що їх використовує.
Крок 1. Ключ розгортання
Навіщо. Виконавцю потрібен ключ SSH. Це не має бути ваш ключ: він відчиняє й інші ваші сервери та репозиторії, а скасувати доступ виконавця, не заблокувавши себе, не вийшло б. Ключ розгортання (deploy key) – це пара ключів, створена для однієї мети. Якщо він витече, ви видаляєте один рядок на сервері, і більше нічого не страждає.
Що зробити. На своєму комп’ютері, у папці поза репозиторієм (наприклад, у домашній папці), створіть пару без парольної фрази – виконавець не може її ввести:
powershell
ssh-keygen -t ed25519 -N "" -f chatex-deployКоманда записує два файли: chatex-deploy, приватний ключ, який іде в секрет GitHub на кроці 3 і більше нікуди, та chatex-deploy.pub, публічний ключ, який іде на сервер.
На сервері дозвольте публічному ключу вхід. Вставте вміст chatex-deploy.pub (один рядок, що починається з ssh-ed25519) у цю команду:
bash
echo '<contents of chatex-deploy.pub>' >> /root/.ssh/authorized_keys>> дописує рядок; один > перезаписав би файл і видалив ваш власний ключ.
Перевірка
Зі свого комп’ютера увійдіть за новим ключем:
powershell
ssh -i chatex-deploy root@<droplet ip>Ви входите без пароля. Введіть exit, щоб вийти.
Крок 2. Ключ хоста
Навіщо. SSH автентифікує в обидва боки. Сервер доводить свою ідентичність ключем хоста (host key); на вашому комп’ютері known_hosts запам’ятав його під час першого входу (тема 23). Виконавець – щоразу нова машина й ніколи не бачив вашого сервера. Якби він приймав будь-який ключ, який пропонує адреса, зловмисник, що перенаправив адресу – викрадений запис DNS, ворожа мережа, – отримав би реліз і міг би підсовувати розгортанню підроблені відповіді. Тому ми заздалегідь даємо виконавцю ключ сервера, і він відхиляє всі інші.
Що зробити. На своєму комп’ютері запитайте в сервера його ключ хоста Ed25519:
powershell
ssh-keyscan -t ed25519 <droplet ip>Вивід має рядок коментаря в потоці помилок, # <droplet ip>:22 SSH-2.0-OpenSSH_10.2p1 Ubuntu-…, і один рядок вигляду <droplet ip> ssh-ed25519 AAAAC3NzaC1lZDI1NTE5…. Цей рядок – значення секрету SSH_KNOWN_HOSTS.
Порівняйте, перш ніж довіряти
Сам ssh-keyscan довіряє мережі. Порівняйте його результат із ключем, який сервер повідомляє про себе в сеансі, якому ви вже довіряєте:
bash
ssh-keygen -lf /etc/ssh/ssh_host_ed25519_key.pubВідбиток (SHA256:…) має збігатися з тим, який ssh-keygen -lf показує для зчитаного рядка, або з тим, що у вашому файлі known_hosts. Завдання розгортання знову друкує обидві сторони у своєму журналі.
Крок 3. Середовище production
Навіщо. Завданню розгортання потрібні чотири секрети й одне публічне значення. GitHub зберігає секрети зашифрованими, після збереження ніколи не показує їх знову й маскує в журналах. Середовище (environment) йде ще на крок далі: його секрети доступні лише завданням, що оголошують environment: production, і лише після проходження правил захисту середовища. Нам потрібне правило обов’язкового рецензента: кожне розгортання чекає, доки ви його схвалите.
Що зробити. На GitHub відкрийте Settings → Environments → New environment, назвіть його production і додайте такі значення (табл. 24.1) у Environment secrets та Environment variables.
Таблиця 24.1. Секрети й змінні середовища production
| Назва | Вид | Значення |
|---|---|---|
SSH_HOST | секрет | IP-адреса дроплета |
SSH_USER | секрет | root |
SSH_PRIVATE_KEY | секрет | вміст chatex-deploy (приватний ключ), усі рядки разом із -----BEGIN і -----END |
SSH_KNOWN_HOSTS | секрет | вивід ssh-keyscan -t ed25519 <droplet ip> |
PUBLIC_URL | змінна | https://<your domain>, без скісної риски наприкінці |
У розділі Deployment protection rules на тій самій сторінці увімкніть Required reviewers, додайте себе й збережіть правила захисту.
Видаліть локальний файл chatex-deploy зараз або тримайте його в менеджері паролів: єдина потрібна копія є в GitHub.
Середовища й тарифні плани
Плани GitHub тут відрізняються. На момент написання середовища, їхні секрети й обов’язкові рецензенти доступні в публічних репозиторіях на кожному плані. У приватному репозиторії середовища та їхні секрети потребують GitHub Pro (безкоштовного для студентів із GitHub Student Developer Pack), а обов’язкові рецензенти на планах Free, Pro і Team недоступні взагалі. Найпростіший шлях для цього курсу – зробити ваш репозиторій публічним: він не містить жодного секрету – саме для цього призначено chatex.env.example і цей розділ, – і тоді набір правил із теми 22 теж застосовується. Перегляньте Managing environments for deployment для вашого плану. Без правила схвалення робочий процес усе одно працює; він просто розгортає кожне злиття, не чекаючи.
Крок 4. Завдання розгортання
Навіщо. Тепер завдання deploy.yml, яке ми пропустили в розділі Робочий процес розгортання, можна прочитати з усіма його частинами на місці.
yaml
deploy:
name: Deploy
needs: package
runs-on: ubuntu-latest
timeout-minutes: 15
environment:
name: production
url: ${{ vars.PUBLIC_URL }}
env:
SSH_HOST: ${{ secrets.SSH_HOST }}
SSH_USER: ${{ secrets.SSH_USER }}
RELEASE: ${{ github.sha }}
steps:
- uses: actions/download-artifact@v8
with:
name: chatex-release
path: releaseenvironment: name: productionприв’язує завдання до середовища: GitHub призупиняється тут, доки рецензент не схвалить, і лише тоді віддає завданню секрети середовища.urlпоказує адресу сайту як посилання на сторінці запуску.env:передає хост, користувача й хеш коміту кожному кроку як змінні середовища. Кроки використовують"$SSH_HOST"в оболонці замість виразів усередині команд – безпечний шаблон із теми 22.download-artifactзавантажує реліз, який вивантажило завдання пакування, уrelease/.
Налаштування SSH
yaml
- name: Set up SSH
env:
SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
SSH_KNOWN_HOSTS: ${{ secrets.SSH_KNOWN_HOSTS }}
run: |
install -m 700 -d ~/.ssh
printf '%s\n' "$SSH_PRIVATE_KEY" | tr -d '\r' > ~/.ssh/deploy_key
chmod 600 ~/.ssh/deploy_key
host=$(printf '%s' "$SSH_HOST" | tr -d '[:space:]')
user=$(printf '%s' "$SSH_USER" | tr -d '[:space:]')
# ...
printf 'Host deploy-target\n HostName %s\n User %s\n IdentityFile ~/.ssh/deploy_key\n IdentitiesOnly yes\n StrictHostKeyChecking yes\n' \
"$host" "$user" > ~/.ssh/config- Приватний ключ записується в
~/.ssh/deploy_keyз режимом600; SSH відхиляє ключі, які можуть читати інші.tr -d '\r'прибирає закінчення рядків Windows, що потрапляють, коли ключ вставляють із редактора Windows, – класична причинаerror in libcrypto. hostіuserпозбавляються пробілів і розривів рядків, які вставлений секрет часто містить.- Файл
known_hosts(рядки, пропущені вище) будується зSSH_KNOWN_HOSTSчерезawk: рядки коментарів і порожні пропускаються, а з кожного іншого рядка лишаються лише тип ключа й сам ключ, прив’язані доSSH_HOST. Тож неважливо, чи містить секрет ім’я хоста, IP, коментарі чи закінчення рядків Windows. Порожній результат провалює крок ізSSH_KNOWN_HOSTS contains no host key lines. - Відбитки обох сторін друкуються: зафіксовані ключі та те, що сервер справді пропонує (
ssh-keyscan). Відбитки публічні, і розбіжність тоді видно в журналі одразу. - Конфігурація SSH визначає псевдонім
deploy-targetіз хостом, користувачем і ключем.IdentitiesOnly yesвикористовує лише цей ключ;StrictHostKeyChecking yesвідхиляє будь-який сервер, чий ключ відсутній уknown_hosts, замість того щоб питати.
У журналі запуску крок друкує, наприклад:
Pinned host keys:
SHA256:DE86BpW+JqcfKLcLqOlShgkKAsdWshOwqvqMPhPTlk4 (ED25519)
Keys the server offers:
SHA256:FmmRxq1IGX36rJosgWw43kDvGaw4wA3RsS5hkFXbCQE (RSA)
SHA256:boPTHa48CvkJEvzIT3OQJqcvid5s565DajU8yK56qbU (ECDSA)
SHA256:DE86BpW+JqcfKLcLqOlShgkKAsdWshOwqvqMPhPTlk4 (ED25519)Зафіксований відбиток Ed25519 з’являється серед запропонованих: виконавець спілкується з правильним сервером.
Вивантаження, активація й димовий тест
yaml
# Uploads go to incoming/; chatex-activate moves them into releases/.
- name: Upload release
run: rsync -rltz --delete --chmod=Du=rwx,Dgo=rx,Fu=rw,Fgo=r release/ "deploy-target:/opt/chatex/incoming/$RELEASE/"
- name: Activate release
run: |
# RELEASE is meant to expand on the runner.
# shellcheck disable=SC2029
ssh deploy-target sudo /usr/local/bin/chatex-activate "$RELEASE"
- name: Smoke test
env:
PUBLIC_URL: ${{ vars.PUBLIC_URL }}
run: curl --fail --silent --show-error --retry 10 --retry-delay 3 --retry-all-errors "$PUBLIC_URL/health"rsyncкопіює реліз через SSH у/opt/chatex/incoming/<sha>/:-rрекурсивно,-lсимволічні посилання як посилання,-tіз часом зміни,-zзі стисненням.--deleteвидаляє в цілі файли, яких немає в релізі, тож повторне вивантаження того самого коміту – точна копія.--chmodзадає передбачувані права – папкиrwxr-xr-x, файлиrw-r--r--– якими б вони не були на виконавці; скрипт активації виправляє власників і біт виконанняefbundle. Вивантаження вincoming/не пускає недокопійовану копію доreleases/.ssh deploy-target sudo /usr/local/bin/chatex-activate "$RELEASE"запускає на сервері скрипт із попереднього розділу за його повним шляхом.$RELEASEрозкриває оболонка виконавця до того, як SSH надішле команду, – це задумано, про що й каже коментарshellcheck.sudoнічого не змінює дляroot, але той самий рядок без змін працює для користувача розгортання, якому дозволено лише цю команду. Вивід скрипта з’являється в журналі завдання, а його код завершення визначає колір кроку.- Димовий тест запитує публічну адресу – через DNS, TLS і Nginx, – чи сайт справний: до десяти повторів з інтервалом три секунди, також за помилок з’єднання (
--retry-all-errors).--failперетворює помилку HTTP на невдалий крок. Це друга перевірка стану: скрипт перевіряв зсередини сервера, ця перевіряє те, що бачать користувачі.
Кожен крок залежить від попереднього: якщо вивантаження провалилося, нічого не активується; якщо активація провалилася (і відкотилася), димовий тест не запускається, а завдання червоне.
Перевірка
Робочий процес ще не запускався, тож перевірте конфігурацію: на GitHub Settings → Environments → production перелічує чотири секрети, одну змінну й обов’язкового рецензента. Порівняйте свої робочі процеси з еталоном:
powershell
git diff --no-index .github/workflows/deploy.yml D:\Work\Chatex-Reference\.github\workflows\deploy.ymlКоманда нічого не виводить.