Commit 42c2209a authored by Talgat Mustafinov's avatar Talgat Mustafinov

Translated recommendations part

parent acef5ebe
Архитектурные рекомендации
Архитектуралық ұсыныстар
=============================
Данный раздел содержит архитектурные рекомендации,
основанные на практическом опыте эксплуатации платформы
и экономически обоснованных требованиях
к аппаратному и программному обеспечению.
Бұл бөлім платформаны практикалық пайдалану тәжірибесіне
және аппараттық-бағдарламалық қамтамасыз етуге қойылатын
экономикалық негізделген талаптарға сүйенген
архитектуралық ұсыныстарды қамтиды.
Рекомендации ориентированы на разные сценарии использования
и учитывают как нагрузочные характеристики,
так и требования к масштабируемости и надежности.
Ұсыныстар пайдаланудың әртүрлі сценарийлеріне бағытталған
және жүктеме сипаттамаларын да, масштабтау мен
сенімділік талаптарын да ескереді.
Минимальные требования к инфраструктуре
----------------------------------------
Инфрақұрылымға қойылатын минималды талаптар
----------------------------------------------
При выборе инфраструктуры рекомендуется исходить
из целевого сценария использования платформы
и предполагаемой нагрузки.
Инфрақұрылымды таңдаған кезде платформаны пайдаланудың
мақсатты сценарийі мен күтілетін жүктемеден шыққан жөн.
Enterprise Instance
~~~~~~~~~~~~~~~~~~~
**Enterprise Instance** предназначен для промышленной эксплуатации
и рассчитан на нагрузку до **1000 именованных пользователей**
и до **300 конкурентных пользователей**.
**Enterprise Instance** өнеркәсіптік пайдалануға арналған
және **1000 аталған пайдаланушыға** дейін
және **300 бір мезгілдегі пайдаланушыға** дейін жүктемеге есептелген.
Целевой показатель SLA — время отклика до **3 секунд**
при стабильной нагрузке.
SLA мақсатты көрсеткіші — тұрақты жүктемеде
**3 секундқа** дейін жауап беру уақыты.
Минимальные требования к инфраструктуре:
Инфрақұрылымға қойылатын минималды талаптар:
* **CPU**: 16 vCPU
* **RAM**: 64 GB
* **Storage**: 1 TB NVMe
* **Network**: до 20 TB трафика
* **CPU**: 16 vCPU
* **RAM**: 64 GB
* **Storage**: 1 TB NVMe
* **Network**: 20 TB трафикке дейін
Оценочная стоимость аренды виртуальной машины
с такими характеристиками составляет
порядка **150–200 USD в месяц**.
Мұндай сипаттамалары бар виртуалды машинаны жалдаудың
болжамды құны айына шамамен **150–200 USD** құрайды.
Данный вариант рекомендуется
для production-окружений и корпоративных внедрений.
Бұл нұсқа production-орталарына және корпоративтік
енгізулерге ұсынылады.
Dev Instance
~~~~~~~~~~~~
**Dev Instance** предназначен для:
**Dev Instance** мыналарға арналған:
* разработки;
* демонстрации решений;
* показа кейсов и прототипов.
* әзірлеуге;
* шешімдерді демонстрациялауға;
* кейстер мен прототиптерді көрсетуге.
Рассчитан на нагрузку до **5 конкурентных пользователей**.
**5 бір мезгілдегі пайдаланушыға** дейін жүктемеге есептелген.
Минимальные требования:
Минималды талаптар:
* **CPU**: 4 vCPU
* **RAM**: 8 GB
* **Storage**: ~25 GB
* **Network**: минимальные, зависят от сценария использования
* **CPU**: 4 vCPU
* **RAM**: 8 GB
* **Storage**: ~25 GB
* **Network**: минималды, пайдалану сценарийіне байланысты
В качестве Dev Instance
может использоваться рабочий ноутбук разработчика
или недорогая виртуальная машина.
Dev Instance ретінде әзірлеушінің жұмыс ноутбугі
немесе арзан виртуалды машина пайдаланылуы мүмкін.
Мультиинстанс-архитектура (process-to-process)
----------------------------------------------
В крупных организациях с выраженной организационной структурой
(головная компания, дочерние организации, филиалы, департаменты)
рекомендуется использовать мультиинстанс-подход.
Суть подхода заключается в том, что экземпляры Synergy
разворачиваются по логике организационной структуры:
отдельный инстанс - на отдельную организационную единицу
(например, на каждую дочернюю организацию или крупный контур).
Данный подход позволяет:
* изолировать процессы и данные между организационными единицами;
* повысить уровень безопасности за счет разделения контуров доступа;
* повысить отказоустойчивость (сбой в одном инстансе
не останавливает работу остальных);
* упростить масштабирование за счет распределения нагрузки
по нескольким инстансам;
* поддерживать независимые циклы изменений и сопровождения
для разных контуров.
При использовании мультиинстанс-архитектуры допускается построение
process-to-process взаимодействия между инстансами,
когда выполнение процесса в одном инстансе
может инициировать продолжение или отдельный участок процесса
в другом инстансе (в рамках общей бизнес-логики компании).
Сводный инстанс
Айқын ұйымдық құрылымы бар ірі ұйымдарда
(бас компания, еншілес ұйымдар, филиалдар, департаменттер)
мультиинстанс-тәсілді пайдалану ұсынылады.
Тәсілдің мәні мынада: Synergy даналары ұйымдық құрылым
логикасы бойынша орналастырылады — әрбір ұйымдық бірлікке
(мысалы, әрбір еншілес ұйымға немесе ірі контурға)
жеке инстанс бөлінеді.
Бұл тәсіл мыналарға мүмкіндік береді:
* ұйымдық бірліктер арасындағы процестер мен деректерді оқшаулауға;
* кіру контурларын бөлу арқылы қауіпсіздік деңгейін арттыруға;
* ақаулыққа төзімділікті жоғарылатуға (бір инстанстағы сәтсіздік
қалғандарының жұмысын тоқтатпайды);
* жүктемені бірнеше инстанс арасында бөлу арқылы
масштабтауды жеңілдетуге;
* әртүрлі контурлар үшін өзгерістер мен сүйемелдеудің
тәуелсіз циклдерін қолдауға.
Мультиинстанс-архитектураны пайдаланған кезде инстанстар
арасында process-to-process өзара іс-қимыл құруға болады:
бір инстанстағы процестің орындалуы екінші инстанстағы
процестің жалғасуын немесе жеке бөлігін бастауы мүмкін
(компанияның жалпы бизнес-логикасы шеңберінде).
Жиынтық инстанс
~~~~~~~~~~~~~~~
Дополнительно может быть выделен **сводный инстанс**,
который используется как общий уровень для:
Қосымша ретінде мыналар үшін жалпы деңгей ретінде
пайдаланылатын **жиынтық инстанс** бөлінуі мүмкін:
* централизованных справочников;
* сводной отчетности и аналитики;
* консолидации результатов процессов из дочерних контуров.
* орталықтандырылған анықтамалықтар;
* жиынтық есептілік пен аналитика;
* еншілес контурлардағы процестер нәтижелерін шоғырландыру.
Сводный инстанс позволяет обеспечить единые источники данных
и единый слой отчетности,
не нарушая при этом изоляцию и автономность рабочих инстансов.
Жиынтық инстанс жұмыс инстанстарының оқшаулануы мен
дербестігін бұзбай, деректердің бірыңғай көздерін
және бірыңғай есептілік деңгейін қамтамасыз етеді.
.. note::
Выбор мультиинстанс-архитектуры рекомендуется
при наличии нескольких организационных контуров
и необходимости разделения доступа, ответственности и нагрузки.
Мультиинстанс-архитектураны таңдау бірнеше ұйымдық контур
болған кезде және кіру, жауапкершілік пен жүктемені
бөлу қажет болғанда ұсынылады.
Архитектурные рекомендации по пользовательским порталам
--------------------------------------------------------
Пайдаланушы порталдарына арналған архитектуралық ұсыныстар
--------------------------------------------------------------
При проектировании внешних пользовательских порталов
рекомендуется учитывать количество конкурентных пользователей
и профиль нагрузки.
Сыртқы пайдаланушы порталдарын жобалаған кезде
бір мезгілдегі пайдаланушылар санын
және жүктеме профилін ескеру ұсынылады.
Сценарий до 1000 конкурентных пользователей
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1000 бір мезгілдегі пайдаланушыға дейінгі сценарий
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
При нагрузке до **1000 конкурентных пользователей**
рекомендуется использовать стандартные средства платформы Synergy.
**1000 бір мезгілдегі пайдаланушыға** дейінгі жүктемеде
Synergy платформасының стандартты құралдарын
пайдалану ұсынылады.
В данном сценарии:
Бұл сценарийде:
* пользовательский портал реализуется непосредственно на Synergy;
* формы, бизнес-валидации, маршруты и транзакции
выполняются внутри платформы;
* инфраструктурные требования минимальны;
* профиль нагрузки предсказуем.
* пайдаланушы порталы тікелей Synergy-де іске асырылады;
* пішіндер, бизнес-валидациялар, маршруттар және транзакциялар
платформа ішінде орындалады;
* инфрақұрылымдық талаптар минималды;
* жүктеме профилі болжамды.
Такой подход обеспечивает:
Мұндай тәсіл мыналарды қамтамасыз етеді:
* быстрый **time-to-market**;
* упрощенную архитектуру;
* снижение эксплуатационных затрат.
* жылдам **time-to-market**;
* жеңілдетілген архитектура;
* пайдалану шығындарының азаюы.
Сценарий свыше 1000 конкурентных пользователей
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1000 бір мезгілдегі пайдаланушыдан асқан сценарий
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Нагрузка свыше **1000 конкурентных пользователей**
относится к классу **highload**
и требует отдельного архитектурного проектирования.
**1000 бір мезгілдегі пайдаланушыдан** асқан жүктеме
**highload** класына жатады
және жеке архитектуралық жобалауды қажет етеді.
В данном случае рекомендуется:
Бұл жағдайда ұсынылады:
* разрабатывать внешний пользовательский портал
как самостоятельное highload-приложение;
* применять горизонтальное масштабирование;
* проектировать архитектуру под конкретный профиль нагрузки.
* сыртқы пайдаланушы порталын дербес highload-қолданба
ретінде әзірлеу;
* горизонталды масштабтауды қолдану;
* архитектураны нақты жүктеме профиліне сай жобалау.
Взаимодействие с Synergy
в этом сценарии должно выполняться:
Бұл сценарийде Synergy-мен өзара іс-қимыл:
* асинхронно;
* через очереди сообщений;
* с обязательным использованием **rate limiting**;
* исключительно через API и события.
* асинхронды түрде;
* хабарлар кезегі арқылы;
* міндетті **rate limiting** пайдалана отырып;
* тек API және оқиғалар арқылы орындалуы тиіс.
В данной архитектуре Synergy
выступает в роли **процессного и рабочего ядра**,
а внешний портал берет на себя
всю нагрузку пользовательского взаимодействия.
Бұл архитектурада Synergy **процестік және жұмыс ядросы**
рөлін атқарады, ал сыртқы портал пайдаланушы
өзара іс-қимылының барлық жүктемесін өз мойнына алады.
Общие рекомендации
Жалпы ұсыныстар
------------------
При выборе архитектурного подхода рекомендуется:
Архитектуралық тәсілді таңдаған кезде ұсынылады:
* четко определять целевой профиль нагрузки;
* избегать преждевременной оптимизации;
* использовать стандартные средства Synergy
при умеренных нагрузках;
* выносить highload-компоненты во внешние сервисы
только при наличии объективной необходимости.
* мақсатты жүктеме профилін нақты анықтау;
* мерзімінен бұрын оңтайландырудан аулақ болу;
* орташа жүктемеде Synergy-дің стандартты құралдарын пайдалану;
* объективті қажеттілік болған кезде ғана
highload-компоненттерді сыртқы сервистерге шығару.
Соблюдение данных рекомендаций
позволяет достичь оптимального баланса
между стоимостью владения,
производительностью и масштабируемостью системы.
Осы ұсыныстарды сақтау жүйенің иелену құны,
өнімділігі және масштабталуы арасындағы
оңтайлы тепе-теңдікке қол жеткізуге мүмкіндік береді.
Архитектурные и эксплуатационные рекомендации
Архитектуралық және пайдалану ұсыныстары
===============================================
.. toctree::
......
Рекомендации по эксплуатации
Пайдалану ұсыныстары
=============================
Данный раздел содержит рекомендации по эксплуатации приложений,
развернутых на платформе Synergy.
Бұл бөлім Synergy платформасында орналастырылған
қолданбаларды пайдалануға арналған ұсыныстарды қамтиды.
Рекомендации охватывают ключевые эксплуатационные аспекты,
такие как перенос приложений между средами,
резервное копирование и восстановление,
а также общие подходы к сопровождению системы
в промышленной эксплуатации.
Ұсыныстар негізгі пайдалану аспектілерін қамтиды:
қолданбаларды орталар арасында ауыстыру,
резервтік көшіру және қалпына келтіру,
сондай-ақ жүйені өнеркәсіптік пайдалануда
сүйемелдеудің жалпы тәсілдері.
Импорт и экспорт приложений
---------------------------
Қолданбаларды импорттау және экспорттау
-----------------------------------------
Платформа Synergy предоставляет встроенные механизмы
импорта и экспорта приложений,
предназначенные для переноса конфигурации
между различными окружениями
(например: *dev → test → prod*).
Synergy платформасы конфигурацияны әртүрлі орталар арасында
ауыстыруға арналған (*мысалы: dev → test → prod*)
қолданбаларды импорттау және экспорттаудың кірістірілген
механизмдерін ұсынады.
Экспорт приложения позволяет:
Қолданбаны экспорттау мыналарға мүмкіндік береді:
* сохранить структуру приложения и все объекты конфигурации;
* зафиксировать состояние приложения на определенной версии;
* перенести приложение на другой экземпляр платформы;
* использовать экспорт как элемент процессов CI/CD.
* қолданба құрылымы мен конфигурация объектілерінің барлығын сақтауға;
* қолданбаның белгілі бір нұсқадағы күйін бекітуге;
* қолданбаны платформаның басқа данасына ауыстыруға;
* экспортты CI/CD процестерінің элементі ретінде пайдалануға.
Импорт приложения обеспечивает:
Қолданбаны импорттау мыналарды қамтамасыз етеді:
* восстановление приложения из архива;
* развертывание приложения на новом сервере;
* синхронизацию конфигурации между средами;
* перенос решений между инсталляциями заказчика.
* қолданбаны мұрағаттан қалпына келтіруді;
* қолданбаны жаңа серверге орналастыруды;
* орталар арасында конфигурацияны синхрондауды;
* тапсырыс берушінің инсталляциялары арасында шешімдерді ауыстыруды.
Поддерживаемые сценарии
~~~~~~~~~~~~~~~~~~~~~~~
Қолданылатын сценарийлер
~~~~~~~~~~~~~~~~~~~~~~~~~
Механизм импорта и экспорта поддерживает следующие сценарии:
Импорт пен экспорт механизмі мынадай сценарийлерді қолдайды:
* экспорт приложения полностью или частично;
* экспорт с данными или без данных;
* контроль целостности выгрузки;
* импорт приложения с сохранением зависимостей и структуры.
* қолданбаны толық немесе ішінара экспорттау;
* деректермен немесе деректерсіз экспорттау;
* жүктеменің тұтастығын бақылау;
* тәуелділіктер мен құрылымды сақтай отырып қолданбаны импорттау.
Детальное описание механизма,
пошаговые инструкции и ограничения
приведены в официальной документации платформы Synergy:
Механизмнің егжей-тегжейлі сипаттамасы,
қадамдық нұсқаулар және шектеулер
Synergy платформасының ресми құжаттамасында берілген:
http://tdd.lan.arta.kz/docs/synergy/tags/hamming/release-notes/html/app_export_import.html
Рекомендации по использованию
Пайдалану ұсыныстары
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
При эксплуатации рекомендуется:
Пайдалану кезінде ұсынылады:
* использовать экспорт приложений
как основной способ переноса конфигурации между средами;
* не выполнять ручные изменения конфигурации
напрямую в production-среде;
* хранить экспортируемые архивы приложений
в системе контроля версий или защищенном хранилище;
* привязывать экспорт приложений
к версиям релизов и этапам CI/CD.
* орталар арасында конфигурацияны ауыстырудың негізгі тәсілі
ретінде қолданбаларды экспорттауды пайдалану;
* production-ортасында конфигурацияға тікелей қолмен
өзгерістер енгізбеу;
* қолданбалардың экспортталған мұрағаттарын нұсқаларды
басқару жүйесінде немесе қорғалған қоймада сақтау;
* қолданбалар экспортын релиздер нұсқаларымен
және CI/CD кезеңдерімен байланыстыру.
Резервное копирование и восстановление
Резервтік көшіру және қалпына келтіру
-----------------------------------------
Резервное копирование является обязательным элементом
эксплуатации платформы Synergy
и направлено на обеспечение сохранности данных
и возможности восстановления системы
в случае сбоев или аварий.
Резервтік көшіру Synergy платформасын пайдаланудың
міндетті элементі болып табылады және деректердің
сақталуын, сондай-ақ ақаулар мен апаттар жағдайында
жүйені қалпына келтіру мүмкіндігін қамтамасыз етуге бағытталған.
Платформа поддерживает резервное копирование
всех критически важных компонентов системы,
включая данные, хранилища и конфигурацию.
Платформа деректерді, қоймаларды және конфигурацияны қоса
алғандағы жүйенің барлық маңызды компоненттерінің
резервтік көшіруін қолдайды.
Объекты резервного копирования
Резервтік көшіру объектілері
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
В резервное копирование должны входить:
Резервтік көшіруге мыналар кіруі тиіс:
* реляционные базы данных платформы;
* файловое хранилище
(JackRabbit или Cassandra в зависимости от типа инсталляции);
* индексы поиска
(Lucene или Elasticsearch);
* конфигурационные файлы платформы и окружения.
* платформаның реляциялық деректер қорлары;
* файлдық қойма (инсталляция түріне байланысты
JackRabbit немесе Cassandra);
* іздеу индекстері (Lucene немесе Elasticsearch);
* платформа мен ортаның конфигурациялық файлдары.
Общие рекомендации
Жалпы ұсыныстар
~~~~~~~~~~~~~~~~~~
При организации резервного копирования рекомендуется:
Резервтік көшіруді ұйымдастыру кезінде ұсынылады:
* выполнять резервное копирование
при остановленных сервисах платформы
для обеспечения целостности данных;
* хранить резервные копии
с привязкой к дате и версии системы;
* регулярно проверять возможность восстановления
из резервных копий;
* разделять резервные копии
production- и тестовых окружений.
* деректердің тұтастығын қамтамасыз ету үшін резервтік
көшіруді платформа сервистері тоқтатылған кезде орындау;
* резервтік көшірмелерді күн мен жүйе нұсқасына
байланыстыра отырып сақтау;
* резервтік көшірмелерден қалпына келтіру мүмкіндігін
жүйелі түрде тексеру;
* production- және тесттік орталардың резервтік
көшірмелерін бөлу.
Подробные процедуры резервного копирования
и восстановления системы
описаны в эксплуатационной документации платформы.
Жүйені резервтік көшіру және қалпына келтірудің
егжей-тегжейлі процедуралары платформаның
пайдалану құжаттамасында сипатталған.
Эксплуатационные практики
Пайдалану практикалары
-------------------------
Для стабильной и предсказуемой работы системы рекомендуется:
* разделять окружения разработки, тестирования и эксплуатации;
* минимизировать прямые изменения в 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