Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 39 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
name: Release

on:
pull_request:
branches: [main]
push:
tags: ['v*']
workflow_dispatch:
Expand Down Expand Up @@ -37,10 +39,13 @@ jobs:
"value=$version" >> $env:GITHUB_OUTPUT
- run: dotnet test proadmin/PilotProAdmin.sln -c Release --nologo
- run: dotnet test proadmin/migration/PilotMigration.sln -c Release --nologo
- name: Check release restore
shell: pwsh
run: ./stack/build/selftest/release-restore-selftest.ps1
- shell: pwsh
env:
RELEASE_VERSION: ${{ steps.version.outputs.value }}
run: ./scripts/package-release.ps1 -Version $env:RELEASE_VERSION
run: ./scripts/package-release.ps1 -Version $env:RELEASE_VERSION -Repository "ghcr.io/$($env:GITHUB_REPOSITORY.ToLowerInvariant())" -WithPortable
- uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7
with:
name: windows-release
Expand Down Expand Up @@ -98,15 +103,40 @@ jobs:
docker rm --force --volumes "$service"
trap - EXIT
done
service=pilotproadmin-cluster-readiness
docker run --detach --name "$service" --publish 127.0.0.1::8080 \
--add-host pilot:127.0.0.1 \
--env ClusterReadiness__Databases=smoke \
--env ClusterReadiness__Login=smoke --env ClusterReadiness__Password=smoke \
"$repository-migration:$RELEASE_VERSION" --cluster-readiness
trap 'docker logs "$service"; docker rm --force --volumes "$service"' EXIT
port=$(docker port "$service" 8080/tcp)
result=$(curl --fail --silent --show-error --retry 20 --retry-all-errors --retry-delay 1 --max-time 3 "http://$port/health")
test "$result" = ok
test "$(curl --silent --show-error --output /dev/null --write-out '%{http_code}' --max-time 5 "http://$port/ready")" = 503
for attempt in {1..25}; do
if [[ "$(docker inspect --format '{{.State.Health.Status}}' "$service")" == healthy ]]; then break; fi
sleep 1
done
test "$(docker inspect --format '{{.State.Health.Status}}' "$service")" = healthy
docker rm --force --volumes "$service"
trap - EXIT
- name: Push images
if: github.event_name == 'push' && github.ref_type == 'tag'
if: github.ref_type == 'tag'
env:
GHCR_TOKEN: ${{ github.token }}
run: |
repository="ghcr.io/${GITHUB_REPOSITORY,,}"
printf '%s' "$GHCR_TOKEN" | docker login ghcr.io --username "$GITHUB_ACTOR" --password-stdin
docker push "$repository:$RELEASE_VERSION"
docker push "$repository-migration:$RELEASE_VERSION"
anonymous_config=$(mktemp -d)
for image in "$repository:$RELEASE_VERSION" "$repository-migration:$RELEASE_VERSION"; do
if ! docker --config "$anonymous_config" manifest inspect "$image" >/dev/null; then
echo "::error::GHCR image $image is not readable without login. Set both packages to Public in GitHub Packages and rerun this tag."
exit 1
fi
done
- name: Package images for offline loading
shell: bash
run: |
Expand All @@ -123,7 +153,7 @@ jobs:
compression-level: 0

publish:
if: github.event_name == 'push' && github.ref_type == 'tag'
if: github.ref_type == 'tag'
needs: [windows, containers]
runs-on: ubuntu-latest
permissions:
Expand All @@ -140,12 +170,17 @@ jobs:
- name: Publish GitHub Release
env:
GH_TOKEN: ${{ github.token }}
RELEASE_VERSION: ${{ needs.windows.outputs.version }}
run: |
cd artifacts
sha256sum --check SHA256SUMS.txt
sha256sum --check SHA256SUMS-CONTAINERS.txt
sha256sum --check SHA256SUMS-CLUSTER.txt
assets=(./*.zip ./*.tar.gz SHA256SUMS.txt SHA256SUMS-CONTAINERS.txt SHA256SUMS-CLUSTER.txt)
assets=("PilotProAdmin-v$RELEASE_VERSION-lite.zip"
"PilotProAdmin-v$RELEASE_VERSION-win-x64-portable.zip"
"PilotProAdmin-v$RELEASE_VERSION-linux-amd64-images.tar.gz"
"PilotProAdmin-v$RELEASE_VERSION-cluster.tar.gz"
SHA256SUMS.txt SHA256SUMS-CONTAINERS.txt SHA256SUMS-CLUSTER.txt)
if gh release view "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" >/dev/null 2>&1; then
gh release upload "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" --clobber "${assets[@]}"
else
Expand Down
8 changes: 5 additions & 3 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ dotnet docfx docfx.json --warningsAsErrors

## Сборка релиза

Команда для локальной проверки Windows-архивов:
Команда для локальной сборки и проверки lite:

```powershell
./scripts/package-release.ps1 -Version 1.0.2
./scripts/package-release.ps1 -Version 1.0.3
```

Workflow Release можно запустить вручную с основной ветки, чтобы собрать архивы, проверить оба контейнера и запустить самопроверку кластерного установщика. Тег вида `v1.0.2` публикует ZIP для Windows, архив образов Linux и комплект кластерной установки в GitHub Releases. Образы также загружаются в GitHub Container Registry организации. Версию веб-приложения задаёт `proadmin/src/ProAdmin/PilotProAdmin.csproj`.
На Windows добавьте `-WithPortable`, чтобы собрать и проверить запуск приложений из архива Portable.

Workflow Release проверяет контейнеры и сборку архивов в PR в `main`. Его также можно запустить вручную. После слияния тег `v1.0.3` публикует Docker Lite, архив Docker-образов, Windows Portable и комплект кластера с контрольными суммами. Оба образа получают тег `1.0.3` в GHCR. Workflow проверяет доступ к ним без учётных данных. Версию задаёт `proadmin/src/ProAdmin/PilotProAdmin.csproj`.
92 changes: 28 additions & 64 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,46 @@
# Быстрый старт
# Быстрый старт на Windows

PilotProAdmin подключается к действующему Pilot-Server. Админка и сервис миграции поставляются вместе. Сервис миграции можно запускать отдельно, если нужны импорт, экспорт или копирование баз.
Для запуска без Docker используйте [Windows Portable](https://pilotopentools.github.io/PilotProAdmin/windows-portable.html).

## Windows x64
1. Установите и запустите [Docker Desktop для Windows](https://docs.docker.com/desktop/setup/install/windows-install/) на компьютере x64. Используйте режим Linux containers. В PowerShell команда `docker info` должна показывать сведения о сервере Docker.
2. Скачайте и распакуйте `PilotProAdmin-vX.Y.Z-lite.zip` со [страницы релизов](https://github.com/PilotOpenTools/PilotProAdmin/releases). Внутри два файла: `README.md` и `install.ps1`. Сверьте SHA-256 архива с `SHA256SUMS.txt` через `Get-FileHash`.
3. Откройте PowerShell в распакованной папке и выполните:

Скачайте архив на странице [релизов](https://github.com/PilotOpenTools/PilotProAdmin/releases/latest) и распакуйте.
```powershell
.\install.ps1
```

| Архив | Требования |
| --- | --- |
| `PilotProAdmin-vX.Y.Z-win-x64-lite.zip` | Установлен ASP.NET Core Runtime 10 x64 |
| `PilotProAdmin-vX.Y.Z-win-x64-portable.zip` | Среда .NET включена в архив |
Если Windows заблокировала загруженный скрипт, после проверки архива выполните `Unblock-File -LiteralPath .\install.ps1`.
4. Ответьте на вопросы установщика. Если порт занят, нажмите Enter, чтобы принять предложенный свободный порт, или укажите свой. Установщик запускает PilotProAdmin и PilotMigration одной версии и выводит адреса сервисов.
5. Откройте адрес админки из вывода скрипта. В мастере первого входа проверьте адрес GitLab и введите установочный ключ `ADMIN_SETUP_KEY` из `PilotProAdmin-install\.env`. Войдите с Personal Access Token GitLab с правом `api`. Затем проверьте адреса контуров Pilot, задайте служебные учётные записи для выкладки из GitLab CI, проверьте адрес Grafana и укажите группы и проекты GitLab.

Сверьте SHA-256 ZIP с `SHA256SUMS.txt`. В PowerShell 7 откройте каталог архива. Для подключения первого Pilot задайте свой установочный ключ и запустите приложение.
## Откуда взять образы

```powershell
$env:App__SetupKey = Read-Host 'Установочный ключ PilotProAdmin' -MaskInput
Set-Location PilotProAdmin
.\PilotProAdmin.exe --urls http://127.0.0.1:5300
```

Откройте <http://127.0.0.1:5300> и войдите учётной записью администратора первой базы Pilot. Для миграции запустите `PilotMigration/PilotMigration.exe` с `--urls http://127.0.0.1:5320` и настройте общий ключ [по инструкции](configuration.md#миграция).

## Docker Linux amd64

Скачайте публичный образ из GitHub Container Registry. Вход в GitHub не требуется.

```bash
docker pull ghcr.io/pilotopentools/pilotproadmin:1.0.2
```

Задайте установочный ключ и запустите админку.

```bash
read -rsp 'Установочный ключ PilotProAdmin: ' App__SetupKey
printf '\n'
export App__SetupKey
docker run --detach --name pilotproadmin \
--publish 127.0.0.1:5300:8080 \
--volume pilotproadmin-data:/data \
--env App__SetupKey \
ghcr.io/pilotopentools/pilotproadmin:1.0.2
unset App__SetupKey
```
Lite скачивает PilotProAdmin и PilotMigration из GHCR. Если на целевой машине GHCR недоступен, скачайте также `PilotProAdmin-vX.Y.Z-linux-amd64-images.tar.gz` и проверьте его по `SHA256SUMS-CONTAINERS.txt`. Положите архив рядом с `install.ps1` или передайте полный путь:

Ввод ключа после `read` скрыт. Откройте <http://127.0.0.1:5300>. Укажите адрес Pilot, доступный из контейнера. Если Pilot запущен на той же машине, адрес зависит от настроек сети Docker.

### Сервис миграции

Если нужен импорт, экспорт или перенос базы, скачайте образ сервиса.

```bash
docker pull ghcr.io/pilotopentools/pilotproadmin-migration:1.0.2
```powershell
.\install.ps1 -ImageArchive 'D:\Downloads\PilotProAdmin-vX.Y.Z-linux-amd64-images.tar.gz'
```

Выделите сервису отдельный том, подключите его к сети админки и задайте общий ключ API. При обновлении используйте одинаковый тег для обоих образов. [Настройка миграции](configuration.md#миграция).
Архив содержит оба приложения. Для локального GitLab, статистики и серверов Pilot нужны доступ к их реестрам и зависимости сборщиков либо заранее подготовленные образы. Для полностью офлайн установки полного стенда используйте [отдельный комплект стека](https://pilotopentools.github.io/PilotProAdmin/stack/Install/docs/installation.html).

### Офлайн-установка
## Чистая установка

На машине с интернетом скачайте `PilotProAdmin-v1.0.2-linux-amd64-images.tar.gz` и `SHA256SUMS-CONTAINERS.txt` со [страницы релиза](https://github.com/PilotOpenTools/PilotProAdmin/releases/tag/v1.0.2). Перенесите оба файла на сервер, проверьте контрольную сумму и загрузите образы.
- Для GitLab выберите существующий экземпляр или установку на этой машине. Для нового GitLab начальный пароль `root` находится в `GITLAB_ROOT_PASSWORD` в `.env`. Создайте токен с правом `api` и группы для нужных типов проектов. Если вход выполняет пользователь без прав администратора GitLab, у него должен быть доступ хотя бы к одной из групп, указанных в мастере.
- Для статистики можно подключить Grafana, развернуть локальную Grafana со сборщиками или настроить позже. Локальные сборщики в этой схеме используют PostgreSQL рабочего контура Pilot.
- Для каждого контура Pilot (тест, стейдж, прод) можно подключить существующий сервер, развернуть локальный Pilot-Server с PostgreSQL и RustFS или отложить настройку. Для скачивания образа Pilot может потребоваться доступ к реестру поставщика. Свой образ можно указать через `-PilotImage`. Для нового сервера установите лицензию и подключите базу в Pilot-myAdmin. После этого добавьте имя базы к адресу контура в админке. [Установка Pilot-Server](https://pilotopentools.github.io/PilotProAdmin/stack/Install/docs/installation.html).
- Учётные записи для выкладки модулей из CI можно изменить или отключить в разделе «Настройки». Для работы CI также нужны ключи выкладки в переменных групп GitLab. При подключении внешнего Pilot доступ к PostgreSQL и архивам для PilotMigration настраивается отдельно. [Настройка стека и интеграций](https://pilotopentools.github.io/PilotProAdmin/stack/Install/docs/installation.html).

```bash
sha256sum --check SHA256SUMS-CONTAINERS.txt
docker load --input PilotProAdmin-v1.0.2-linux-amd64-images.tar.gz
```

Запустите админку той же командой `docker run`. Архив содержит оба образа с тегом `1.0.2`.
## Установка из резервной копии

## Кластер Pilot
На исходной машине откройте «Миграция → Подготовить перенос данных» в админке. Скачайте комплект, распакуйте его рядом с доступным Docker Desktop и запустите `prepare-transfer.ps1` по инструкции из комплекта. Скрипт напечатает путь к папке с `manifest.json`.

Скачайте `PilotProAdmin-v1.0.2-cluster.tar.gz` и `SHA256SUMS-CLUSTER.txt` со [страницы релиза](https://github.com/PilotOpenTools/PilotProAdmin/releases/tag/v1.0.2). Сверьте контрольную сумму и распакуйте архив на узлах Linux.
Выберите восстановление и укажите каталог полной резервной копии с `manifest.json`, либо передайте его при запуске:

```bash
sha256sum --check SHA256SUMS-CLUSTER.txt
tar -xzf PilotProAdmin-v1.0.2-cluster.tar.gz
```powershell
.\install.ps1 -Backup 'D:\Backup\2026-11-18_0300' -InstallDirectory 'D:\PilotProAdmin'
```

Комплект содержит скрипты и Compose для узлов и балансировщика. Подготовьте образ Pilot-Server из своего дистрибутива, PostgreSQL, Redis и общий файловый архив. [Установка кластера](https://pilotopentools.github.io/PilotProAdmin/stack/Install/docs/cluster-installation.html)

## Полный стенд
Для восстановления выберите новый каталог установки. Скрипт поднимает локальные GitLab, Grafana со сборщиками и три контура Pilot вместе с PostgreSQL и RustFS. Он берёт версию и редакцию GitLab из имени штатного архива резервной копии. [Требования GitLab к восстановлению](https://docs.gitlab.com/administration/backup_restore/restore_gitlab/).

Шаблоны Compose для контуров Pilot, GitLab и мониторинга, варианты ролей и сборка офлайн-комплекта описаны в [инструкции по установке](https://pilotopentools.github.io/PilotProAdmin/stack/Install/docs/installation.html). Для сборки комплекта нужны исходные образы и файлы вашего дистрибутива Pilot. [Варианты развёртывания](https://pilotopentools.github.io/PilotProAdmin/deployment.html).
После установки сохраните каталог `PilotProAdmin-install` или выбранный через `-InstallDirectory`. В нём остаются Compose, `.env` с реквизитами и папки данных. Часть данных хранится в томах Docker. При обновлении распакуйте новый lite и запустите установщик с тем же `-InstallDirectory`. Для переноса кластера используйте [инструкцию по кластерной установке](https://pilotopentools.github.io/PilotProAdmin/stack/Install/docs/cluster-installation.html).
Loading