Commit b358193a authored by Talgat Mustafinov's avatar Talgat Mustafinov

Add recommendations part

parent 8546cccd
...@@ -5,4 +5,5 @@ ...@@ -5,4 +5,5 @@
:maxdepth: 2 :maxdepth: 2
architectural_recommendations architectural_recommendations
operational_recommendations
Рекомендации по эксплуатации
=============================
Данный раздел содержит рекомендации по эксплуатации приложений,
развернутых на платформе Synergy.
Рекомендации охватывают ключевые эксплуатационные аспекты,
такие как перенос приложений между средами,
резервное копирование и восстановление,
а также общие подходы к сопровождению системы
в промышленной эксплуатации.
Импорт и экспорт приложений
---------------------------
Платформа Synergy предоставляет встроенные механизмы
импорта и экспорта приложений,
предназначенные для переноса конфигурации
между различными окружениями
(например: *dev → test → prod*).
Экспорт приложения позволяет:
* сохранить структуру приложения и все объекты конфигурации;
* зафиксировать состояние приложения на определенной версии;
* перенести приложение на другой экземпляр платформы;
* использовать экспорт как элемент процессов CI/CD.
Импорт приложения обеспечивает:
* восстановление приложения из архива;
* развертывание приложения на новом сервере;
* синхронизацию конфигурации между средами;
* перенос решений между инсталляциями заказчика.
Поддерживаемые сценарии
~~~~~~~~~~~~~~~~~~~~~~~
Механизм импорта и экспорта поддерживает следующие сценарии:
* экспорт приложения полностью или частично;
* экспорт с данными или без данных;
* контроль целостности выгрузки;
* импорт приложения с сохранением зависимостей и структуры.
Детальное описание механизма,
пошаговые инструкции и ограничения
приведены в официальной документации платформы Synergy:
http://tdd.lan.arta.kz/docs/synergy/tags/hamming/release-notes/html/app_export_import.html
Рекомендации по использованию
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
При эксплуатации рекомендуется:
* использовать экспорт приложений
как основной способ переноса конфигурации между средами;
* не выполнять ручные изменения конфигурации
напрямую в production-среде;
* хранить экспортируемые архивы приложений
в системе контроля версий или защищенном хранилище;
* привязывать экспорт приложений
к версиям релизов и этапам CI/CD.
Резервное копирование и восстановление
-----------------------------------------
Резервное копирование является обязательным элементом
эксплуатации платформы Synergy
и направлено на обеспечение сохранности данных
и возможности восстановления системы
в случае сбоев или аварий.
Платформа поддерживает резервное копирование
всех критически важных компонентов системы,
включая данные, хранилища и конфигурацию.
Объекты резервного копирования
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
В резервное копирование должны входить:
* реляционные базы данных платформы;
* файловое хранилище
(JackRabbit или Cassandra в зависимости от типа инсталляции);
* индексы поиска
(Lucene или Elasticsearch);
* конфигурационные файлы платформы и окружения.
Общие рекомендации
~~~~~~~~~~~~~~~~~~
При организации резервного копирования рекомендуется:
* выполнять резервное копирование
при остановленных сервисах платформы
для обеспечения целостности данных;
* хранить резервные копии
с привязкой к дате и версии системы;
* регулярно проверять возможность восстановления
из резервных копий;
* разделять резервные копии
production- и тестовых окружений.
Подробные процедуры резервного копирования
и восстановления системы
описаны в эксплуатационной документации платформы.
Эксплуатационные практики
-------------------------
Для стабильной и предсказуемой работы системы рекомендуется:
* разделять окружения разработки, тестирования и эксплуатации;
* минимизировать прямые изменения в production;
* использовать импорт/экспорт приложений
как основной механизм обновлений;
* регулярно контролировать состояние хранилищ и индексов;
* планировать резервное копирование
как часть регламентных работ.
Соблюдение данных рекомендаций
позволяет снизить эксплуатационные риски,
обеспечить устойчивость системы
и упростить сопровождение приложений
на протяжении всего жизненного цикла.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment