Параметры проекта Kapsule Orbit

Каждый параметр проекта Kapsule Orbit находится на вкладке Settings, организованной по группам для удобства поиска: общая информация, сборка и развертывание, безопасность, уведомления, интеграции, лимиты использования, автоматизация развертывания, сетевые настройки, наблюдаемость, общий доступ и опасная зона в конце.

Где находятся параметры

Откройте Kapsule Orbit, щелкните проект и выберите Settings в полосе вкладок проекта. На странице указано, что она предназначена для настройки имени проекта, команд сборки и интеграции Git, но это описание существенно недооценивает её возможности.

Эта статья служит справочником. Если предмет имеет собственную статью, ссылка на неё предоставляется вместо повторения информации.

Основные настройки

Информация о проекте отображает слаг URL, дату создания, подключённый репозиторий и производственный URL, а также позволяет изменить Имя проекта и Описание.

Git содержит Production branch (производственную ветку). Отправки в эту ветку запускают производственные развертывания.

Статус-значок предоставляет живой SVG со статусом развертывания и кнопками копирования для URL, markdown и HTML, готовыми для вставки в ваш README. См. Просмотр README проекта в Kapsule Orbit.

Страница статуса проекта ссылается на конфигурацию страницы статуса. См. Orbit Status Page.

Сборка и развертывание

Параметры сборки - это пять полей, которые Kapsule Orbit автоматически обнаруживает и вы можете переопределить: команда установки, команда сборки, выходной каталог, корневой каталог и версия Node.js. Оставьте поле пустым, чтобы сохранить обнаруженное значение. Полные сведения см. в разделе Configuring Your Build Command and Output Directory.

Runtime содержит четыре переключателя, достойные внимания:

• Режим сервера сохраняет машину сборки в активном состоянии, запуская вашу команду запуска после каждого развертывания. Требуется для всего, что отображается на сервере, а не экспортируется как статические файлы.
• Предпросмотры ветвей автоматически создают окружение для каждой отправки ветви, которая не является производственной или staging, каждая на собственном URL в branch-*.kaps.run. См. Branch Previews.
• Автоматический откат при ошибке восстанавливает последнее здоровое производственное развертывание в случае сбоя развертывания.
• Запланированная пересборка пересобирает production через определённый интервал: от ежечасно до еженедельно, что подходит для сайтов с управлением контентом, которым требуется обновление без отправки в git.

Автоматический повтор сборки повторно ставит в очередь сборки, которые не удались из-за инфраструктурных ошибок, таких как проблема сети или timeout, до трёх раз. Он не повторяет ошибки кода, поэтому не может скрывать неработающую сборку.

Игнорируемые пути и Шаблоны игнорирования ветвей предотвращают ненужные сборки: glob-шаблоны для файлов, изменения которых не должны развертываться, и для ветвей, таких как dependabot/*, которые никогда не должны вызывать развертывание.

Развертывание по git-тегам устанавливает шаблон тега, который превращает отправку тега в производственное развертывание. См. Orbit Releases.

Автоматизация развертывания и защита

Защита развертывания имеет два уровня: Требовать утверждение для production, которое приостанавливает развертывания production, инициированные отправкой, до утверждения кем-либо, и Требовать успешности staging перед production, которая удерживает production до тех пор, пока staging не развернёт тот же коммит успешно.

Обязательные проверки CI управляют развертываниями на основе вашего собственного CI. На GitHub вы указываете имена задач, все из которых должны пройти; на GitLab любое непустое значение ожидает завершения всего конвейера. Ошибка CI отменяет развертывание.

График блокировки развертывания блокирует развертывания, инициированные отправкой, вне утверждённых окон: либо выходные дни, либо диапазон часов в UTC. Ручные развертывания и хуки развертывания не затрагиваются.

Защита ветвей добавляет правила с glob-шаблонами, которые блокируют развертывания на совпадающих ветвях до прохождения требуемых внешних проверок и, при необходимости, утверждения человеком.

Автоматическое повышение staging повышает staging до production автоматически, когда он работает настроенное количество часов без сбоев здоровья и проходит smoke-тесты.

Все эти параметры сведены в одном представлении на вкладке Orbit Deployment Pipeline.

Проверки здоровья и качества

Проверка здоровья получает путь, который вы выбираете, после каждого производственного развертывания. Ответ, отличный от 2xx, в течение 15 секунд восстанавливает предыдущее здоровое развертывание.

Smoke-тесты выполняют GET-запросы к до десяти путям, разделённым запятой, после каждого успешного развертывания и записывают результат (успех или ошибка). В сочетании с автоматическим откатом неудавшийся smoke-тест откатывает развертывание.

Бюджеты производительности предупреждают или отклоняют сборки, превышающие пороговое значение: общий размер артефакта в МБ, размер отдельного файла в кБ, соответствующий glob-шаблону, или время сборки в секундах. Каждый бюджет настроен на предупреждение или отклонение сборки.

Staging

Staging имеет собственный набор карточек: ветка staging, защита доступа с паролем, список разрешённых IP-адресов, принимающий адреса IPv4 и CIDR-диапазоны по одному в строке, автоматический откат при ошибке, наследует ли staging переменные окружения production с более низким приоритетом, и переопределения сборки для установки, сборки, выходного и корневого каталога.

Пароль и список разрешённых IP-адресов - это два параметра, которые следует установить в любом окружении staging, не предназначенном для общего доступа. Оставьте оба пустыми, и URL staging будет доступен для всех, у кого он есть.

Сетевые настройки

Пользовательские домены добавляет и проверяет домены для production-окружения, включая подготовку сертификатов. См. Adding a Custom Domain to Orbit.

Перенаправления и переписи - это основанные на пути правила, применяемые перед подачей, проверяемые по порядку с выигрышем первого совпадения. Перенаправление отправляет браузер на новый URL как 301 или 302; переписи служат другой путь без изменения URL. Шаблоны поддерживают точные совпадения, подстановочные символы, именованные параметры и splats. См. Redirects and Rewrites in Orbit.

Заголовки ответов применяют пользовательские HTTP-заголовки к совпадающим путям с предустановками для HSTS, CSP, no-embed, no-sniff, политики referrer и CORS. Применяются все совпадающие правила, и более поздние записи перезаписывают более ранние для одного и того же ключа.

Защита от перекоса сохраняет старые артефакты сборки в хранилище в течение периода хранения после активации нового развертывания, чтобы посетитель, загрузивший предыдущую версию, мог получить её ресурсы вместо ошибки 404.

Хранилище конфигурации содержит пары ключ-значение, которые ваше развертывание читает во время выполнения, для флагов функций и параметров, которые изменяются без переразвёртывания. Оно управляется в Storage, а не здесь, и оно бесплатно: нет комиссии за чтение и нет комиссии за запись. Значения хранятся в открытом виде, поэтому никогда не помещайте секрет в хранилище. До 100 записей на проект, ключи до 200 символов и значения до 4096. Каждую ночь делается снимок каждой записи, и тридцать ночей хранятся на каждом плане, поэтому удалённую запись можно восстановить: см. Snapshots and restore.

Использование и лимиты

Использование сборки показывает сборки, которые запустил этот проект.

Лимит расходов устанавливает максимальный ежемесячный перерасход, включая перерасход build-minute и bandwidth сверх вашего плана. Минимум US$6.32 и максимум US$6,315.79. Оповещения срабатывают на 50% и 80%, и при 100% обслуживание приостанавливается до увеличения лимита. См. Orbit Spending Cap.

Лимит расходов на сборку - это отдельный, более грубый лимит: ежемесячный потолок на общие build-minute, после которого новые сборки перестают ставиться в очередь до следующего месяца или вы не поднимете его.

Удержание артефактов устанавливает, сколько успешных артефактов сборки сохранять на окружение. Старые удаляются ежедневно, а текущее активное развертывание всегда сохраняется независимо от лимита.

Истечение предпросмотра приостанавливает окружения предпросмотра через 7, 14, 30 или 60 дней, или никогда. Приостановленные предпросмотры имеют своё хранилище освобождено в течение 24 часов.

Оповещение о размере артефакта отправляет вам письмо, когда артефакт сборки превышает установленный вами размер.

Уведомления, интеграции и наблюдаемость

Уведомления о развертывании по электронной почте имеет три параметра: все развертывания, только сбои или отключено. URL вебхука для уведомлений можно установить вместе с ним, отправляя при каждом успехе или ошибке.

Каналы уведомлений - более богатая версия с выбором для каждого события, историей доставки и кнопкой теста. Полный контроль над вебхуком находится на собственной вкладке: см. Orbit Webhooks.

Хуки развертывания создают секретные URL, которые запускают развертывание, когда что-то отправляет к ним POST. См. Triggering Deployments Via Deploy Hooks.

Дренажи логов отправляют логи сборки на вашу платформу наблюдаемости после каждого развертывания с встроенной поддержкой Datadog, Logtail, Axiom и New Relic, или пользовательского вебхука, при необходимости отфильтрованные по одному окружению.

Веб-аналитика даёт вам фрагмент сбора Core Web Vitals. См. Orbit Web Vitals.

Триггеры Cron планирует HTTP-запросы к выбранному окружению, до десяти на проект. Более крупная версия, только для production, находится на собственной вкладке: см. Orbit Cron Jobs.

Общий доступ и команда

Команда управляет сотрудниками с тремя ролями: admin, developer и viewer.

Ссылки общего доступа генерируют временные ссылки без пароля, чтобы внешний рецензент мог просмотреть окружение без пароля или учётной записи. Каждая ссылка может истечь через 1 час, 24 часа или 7 дней, или никогда, и показывает количество посещений. Отозовите её в любой момент.

Группа развертывания подключает этот проект к группе, чтобы связанные проекты развертывались вместе, при необходимости отфильтрованные по ветвям.

Клонировать окружение и Клонировать проект дублируют конфигурацию. Клонирование проекта копирует параметры сборки, конфигурацию окружения и неконфиденциальные переменные окружения; секреты не копируются.

Опасная зона

Очистить кэш сборки удаляет кэшированные зависимости для каждого окружения, чтобы следующее развертывание запустило полную установку с нуля. Это нельзя отменить, хотя кэш восстанавливается при следующей сборке.

Передать проект перемещает проект на другой аккаунт Kapsule. См. Transferring an Orbit Project.

Архивировать проект прекращает обслуживание трафика немедленно. Его можно восстановить в течение 30 дней из списка Kapsule Orbit, после чего он окончательно удаляется.

Куда идти дальше

• Orbit Deployment Pipeline для просмотра эффекта каждого параметра в одном представлении.
• Shared Environment Variable Groups для значений, используемых в нескольких проектах.
• Orbit Plan Limits для информации о том, что позволяет ваш план.