Ir al contenido

Главное руководство: развертывание и управление Plane (издание Prime)

Полное техническое руководство по развертыванию Plane Commercial/Prime Edition в Linux, настройке DNS с Cloudflare и управлению с помощью prime-cli.

0просмотры

🗺️ Карта развертывания

Sección titulada «🗺️ Mapa de Ruta del Despliegue»
  1. Предварительные требования и подготовка среды
  2. Установка Docker Engine и Compose V2
  3. Настройка DNS и SSL (Cloudflare)
  4. Установка и Запуск Plane
  5. Справочник Инструмент Prime CLI
  6. Решение Общих Проблем

1. Предварительные требования и подготовка среды

Sección titulada «1. Requisitos Previos y Preparación del Entorno»

Чтобы гарантировать стабильный и безконфликтный запуск на основных портах (80 и 443), необходимо инициализировать экземпляр на чистом сервере:

  • Рекомендуемая Операционная Система: Ubuntu Server 20.04 LTS, 22.04 LTS или 24.04 LTS.
  • Минимальные Рекомендуемые Ресурсы: 4 ГБ оперативной памяти и 2 виртуальных ЦП (рекомендуется 8 ГБ оперативной памяти для активных производственных сред).
  • Выделенный Домен: Запись DNS, указывающая на публичный IP-хост (например, plane.portelcore.com).

2. Правильная установка Docker Engine и Compose V2

Sección titulada «2. Instalación Correcta de Docker Engine y Compose V2»

[!IMPORTANT] Не рекомендуется использовать прямое использование apt install docker.io в базовых репозиториях Ubuntu, поскольку это устанавливает устаревшие и несовместимые пакеты с бэкендом Plane. Следуйте этой стандартизированной процедуре для установки официального движка.

2.1. Отладка конфликтных версий (очистка)

Sección titulada «2.1. Depuración de Versiones Conflictivas (Limpieza)»
Ventana de terminal
sudo apt-get remove docker docker-engine docker.io containerd runc

2.2. Настройка официального репозитория Docker

Sección titulada «2.2. Configuración del Repositorio Oficial de Docker»

Добавьте GPG-ключи безопасного официального репозитория Docker:

Ventana de terminal
# Instalar dependencias previas
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg -y
# Crear el llavero seguro en el sistema
sudo install -m 0755 -d /etc/apt/keyrings
# Descargar e importar la clave GPG
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
# Añadir el repositorio a las fuentes estables de Apt
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

2.3. Установка движка и плагина Compose

Sección titulada «2.3. Instalación del Motor y Plugin Compose»
Ventana de terminal
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y

2.4. Валидация современной версии

Sección titulada «2.4. Validación de la Versión Modernizada»

Проверьте, что команда оркестровки Docker Compose V2 правильно интегрирована:

Ventana de terminal
docker compose version
# Salida esperada: Docker Compose version v2.x.x

3. Настройка DNS и SSL (Cloudflare)

Sección titulada «3. Configuración de DNS y SSL (Cloudflare)»

Чтобы развертывание работало правильно под параметром маршрутизации --behind-proxy, выполните настройку в вашем панели управления DNS Cloudflare:

  1. Запись DNS (A): Создайте запись A для вашего поддомена (plane) для разрешения по направлению к публичному IP-адресу вашего сервера.
  2. Состояние Прокси: Убедитесь, что оранжевое облако активировано (Proxied).
  3. Шифрование SSL/TLS: Настройте режим шифрования на Full или Full (Strict) в панели Cloudflare.

4.1. Создание рабочего каталога

Sección titulada «4.1. Creación del Directorio de Trabajo»
Ventana de terminal
mkdir plane-selfhost && cd plane-selfhost
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/install.sh -o setup.sh
chmod +x setup.sh

4.2. Выполнение установщика в режиме прокси

Sección titulada «4.2. Ejecución del Instalador en Modo Proxy»

Этот шаг критически важен для пропуска autogestión локальных сертификатов TLS в Plane и делегирования SSL нашему безопасному прокси:

Ventana de terminal
sudo ./setup.sh --behind-proxy --domain="plane.portelcore.com"

Сценарий скачает образы базовых служб (valkey, postgres, minio, core backend и frontend) и поднимет контейнеры на заднем плане.


5. Справочник по инструменту Prime CLI

Sección titulada «5. Manual de Referencia de la Herramienta Prime CLI»

Издание Plane Prime управляется централизованно через интерфейс командной строки prime-cli, установленную в /bin/prime-cli.

Синтаксис выполнения:

Ventana de terminal
sudo prime-cli [comando]

А. Управление жизненным циклом стека

Sección titulada «A. Control del Ciclo de Vida del Stack»
  • prime-cli start: Запускает все контейнеры, определенные в стеке. Полезно, если хост был перезапущен.
  • prime-cli stop: Останавливает контейнеры Plane в порядке. Должно выполняться всегда перед обслуживанием хоста.
  • prime-cli restart: Применяет полный перезапуск к операционным контейнерам при замедлении.

Б. Конфигурация и расширенное обслуживание

Sección titulada «B. Configuración y Mantenimiento Avanzado»
  • prime-cli configure: Открывает интерактивное меню в консоли для управления переменными среды, такими как SMTP, корпоративное хранилище S3/MinIO и секреты приложения.
  • prime-cli upgrade: Обновляет Plane до последней доступной версии официального канала, выполняя миграции базы данных. Рекомендуется создать полный резервный копию перед его выполнением.
  • prime-cli repair: Сбрасывает и ремонтирует зависимые или поврежденные изображения, если запуск приложения не удался.
  • prime-cli update-cli: Обновляет инструмент управления prime-cli независимо.

В. Стратегия резервного копирования

Sección titulada «C. Estrategia de Respaldos»
  • prime-cli backup: Генерирует сжатый файл .tar.gz или .zip с локальной базой данных MySQL/Postgres, файлами, прикрепленными к задачам, и конфигурацией файла .env. Хранится по умолчанию в /opt/plane/backups.
  • prime-cli restore: Перезаписывает текущее состояние, загружая предыдущую точку восстановления.

Г. Диагностика и мониторинг

Sección titulada «D. Diagnóstico y Monitoreo»
  • prime-cli monitor: Отображает свалку журналов всех сервисов в режиме реального времени
  • prime-cli healthcheck: Выполняет внутренние запросы состояния и отчеты о состоянии Redis/Valkey, Postgres, Backend и микросервисов frontend.

6. Решение общих проблем

Sección titulada «6. Resolución de Problemas Comunes»

Ошибка: «Permission Denied» в терминале Docker

Sección titulada «Error: “Permission Denied” en la Terminal de Docker»
  • Причина: Текущий пользователь консоли не имеет привилегий на локальный сокет /var/run/docker.sock.
  • Постоянное Решение: Добавьте вашего пользователя в оперативную группу Docker:
    Ventana de terminal
    sudo usermod -aG docker $USER
    newgrp docker

Ошибка: 502 Bad Gateway (Cloudflare Edge)

Sección titulada «Error: 502 Bad Gateway (Cloudflare Edge)»
  1. Проверьте состояние локальных контейнеров: sudo prime-cli healthcheck.
  2. Проверьте, что обратный прокси контейнера Plane отвечает на назначенном внутреннем порту HTTP на хосте.
  3. Убедитесь, что директивы сетевого брандмауэра (например, UFW) не блокируют внутреннюю связь.