Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
S
Synergy Courses
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Public Documentation
Synergy Courses
Commits
42c2209a
Commit
42c2209a
authored
May 25, 2026
by
Talgat Mustafinov
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Translated recommendations part
parent
acef5ebe
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
212 additions
and
223 deletions
+212
-223
recommendations/architectural_recommendations.rst
recommendations/architectural_recommendations.rst
+124
-130
recommendations/index.rst
recommendations/index.rst
+1
-1
recommendations/operational_recommendations.rst
recommendations/operational_recommendations.rst
+87
-92
No files found.
recommendations/architectural_recommendations.rst
View file @
42c2209a
Архитектур
ные рекомендации
Архитектур
алық ұсыныстар
=============================
=============================
Данный раздел содержит архитектурные рекомендации,
Бұл бөлім платформаны практикалық пайдалану тәжірибесіне
основанные на практическом опыте эксплуатации платформы
және аппараттық-бағдарламалық қамтамасыз етуге қойылатын
и экономически обоснованных требованиях
экономикалық негізделген талаптарға сүйенген
к аппаратному и программному обеспечению
.
архитектуралық ұсыныстарды қамтиды
.
Рекомендации ориентированы на разные сценарии использования
Ұсыныстар пайдаланудың әртүрлі сценарийлеріне бағытталған
и учитывают как нагрузочные характеристики,
және жүктеме сипаттамаларын да, масштабтау мен
так и требования к масштабируемости и надежности
.
сенімділік талаптарын да ескереді
.
Минимальные требования к инфраструктуре
Инфрақұрылымға қойылатын минималды талаптар
----------------------------------------
----------------------------------------
------
При выборе инфраструктуры рекомендуется исходить
Инфрақұрылымды таңдаған кезде платформаны пайдаланудың
из целевого сценария использования платформы
мақсатты сценарийі мен күтілетін жүктемеден шыққан жөн.
и предполагаемой нагрузки.
Enterprise Instance
Enterprise Instance
~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~
**Enterprise Instance**
предназначен для промышленной эксплуатации
**Enterprise Instance**
өнеркәсіптік пайдалануға арналған
и рассчитан на нагрузку до **1000 именованных пользователей**
және **1000 аталған пайдаланушыға** дейін
и до **300 конкурентных пользователей**
.
және **300 бір мезгілдегі пайдаланушыға** дейін жүктемеге есептелген
.
Целевой показатель SLA — время отклика до **3 секунд**
SLA мақсатты көрсеткіші — тұрақты жүктемеде
при стабильной нагрузке
.
**3 секундқа** дейін жауап беру уақыты
.
Минимальные требования к инфраструктуре
:
Инфрақұрылымға қойылатын минималды талаптар
:
* **CPU**: 16 vCPU
* **CPU**: 16 vCPU
* **RAM**: 64 GB
* **RAM**: 64 GB
* **Storage**: 1 TB NVMe
* **Storage**: 1 TB NVMe
* **Network**:
до 20 TB трафика
* **Network**:
20 TB трафикке дейін
Оценочная стоимость аренды виртуальной машины
Мұндай сипаттамалары бар виртуалды машинаны жалдаудың
с такими характеристиками составляет
болжамды құны айына шамамен **150–200 USD** құрайды.
порядка **150–200 USD в месяц**.
Данный вариант рекомендуется
Бұл нұсқа production-орталарына және корпоративтік
для production-окружений и корпоративных внедрений
.
енгізулерге ұсынылады
.
Dev Instance
Dev Instance
~~~~~~~~~~~~
~~~~~~~~~~~~
**Dev Instance**
предназначен для
:
**Dev Instance**
мыналарға арналған
:
*
разработки
;
*
әзірлеуге
;
*
демонстрации решений
;
*
шешімдерді демонстрациялауға
;
*
показа кейсов и прототипов
.
*
кейстер мен прототиптерді көрсетуге
.
Рассчитан на нагрузку до **5 конкурентных пользователей**
.
**5 бір мезгілдегі пайдаланушыға** дейін жүктемеге есептелген
.
Минимал
ьные требования
:
Минимал
ды талаптар
:
* **CPU**: 4 vCPU
* **CPU**: 4 vCPU
* **RAM**: 8 GB
* **RAM**: 8 GB
* **Storage**: ~25 GB
* **Storage**: ~25 GB
* **Network**: минимал
ьные, зависят от сценария использования
* **Network**: минимал
ды, пайдалану сценарийіне байланысты
В качестве Dev Instance
Dev Instance ретінде әзірлеушінің жұмыс ноутбугі
может использоваться рабочий ноутбук разработчика
немесе арзан виртуалды машина пайдаланылуы мүмкін.
или недорогая виртуальная машина.
Мультиинстанс-архитектура (process-to-process)
Мультиинстанс-архитектура (process-to-process)
----------------------------------------------
----------------------------------------------
В крупных организациях с выраженной организационной структурой
Айқын ұйымдық құрылымы бар ірі ұйымдарда
(
головная компания, дочерние организации, филиалы, департаменты
)
(
бас компания, еншілес ұйымдар, филиалдар, департаменттер
)
рекомендуется использовать мультиинстанс-подход
.
мультиинстанс-тәсілді пайдалану ұсынылады
.
Суть подхода заключается в том, что экземпляры Synergy
Тәсілдің мәні мынада: Synergy даналары ұйымдық құрылым
разворачиваются по логике организационной структуры:
логикасы бойынша орналастырылады — әрбір ұйымдық бірлікке
отдельный инстанс - на отдельную организационную единицу
(мысалы, әрбір еншілес ұйымға немесе ірі контурға)
(например, на каждую дочернюю организацию или крупный контур)
.
жеке инстанс бөлінеді
.
Данный подход позволяет
:
Бұл тәсіл мыналарға мүмкіндік береді
:
*
изолировать процессы и данные между организационными единицами
;
*
ұйымдық бірліктер арасындағы процестер мен деректерді оқшаулауға
;
*
повысить уровень безопасности за счет разделения контуров доступ
а;
*
кіру контурларын бөлу арқылы қауіпсіздік деңгейін арттыруғ
а;
*
повысить отказоустойчивость (сбой в одном инстансе
*
ақаулыққа төзімділікті жоғарылатуға (бір инстанстағы сәтсіздік
не останавливает работу остальных
);
қалғандарының жұмысын тоқтатпайды
);
*
упростить масштабирование за счет распределения нагрузки
*
жүктемені бірнеше инстанс арасында бөлу арқылы
по нескольким инстансам
;
масштабтауды жеңілдетуге
;
*
поддерживать независимые циклы изменений и сопровождения
*
әртүрлі контурлар үшін өзгерістер мен сүйемелдеудің
для разных контуров
.
тәуелсіз циклдерін қолдауға
.
При использовании мультиинстанс-архитектуры допускается построение
Мультиинстанс-архитектураны пайдаланған кезде инстанстар
process-to-process взаимодействия между инстансами,
арасында process-to-process өзара іс-қимыл құруға болады:
когда выполнение процесса в одном инстансе
бір инстанстағы процестің орындалуы екінші инстанстағы
может инициировать продолжение или отдельный участок процесса
процестің жалғасуын немесе жеке бөлігін бастауы мүмкін
в другом инстансе (в рамках общей бизнес-логики компании
).
(компанияның жалпы бизнес-логикасы шеңберінде
).
Сводный
инстанс
Жиынтық
инстанс
~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~
Дополнительно может быть выделен **сводный инстанс**,
Қосымша ретінде мыналар үшін жалпы деңгей ретінде
который используется как общий уровень для
:
пайдаланылатын **жиынтық инстанс** бөлінуі мүмкін
:
*
централизованных справочников
;
*
орталықтандырылған анықтамалықтар
;
*
сводной отчетности и аналитики
;
*
жиынтық есептілік пен аналитика
;
*
консолидации результатов процессов из дочерних контуров
.
*
еншілес контурлардағы процестер нәтижелерін шоғырландыру
.
Сводный инстанс позволяет обеспечить единые источники данных
Жиынтық инстанс жұмыс инстанстарының оқшаулануы мен
и единый слой отчетности,
дербестігін бұзбай, деректердің бірыңғай көздерін
не нарушая при этом изоляцию и автономность рабочих инстансов
.
және бірыңғай есептілік деңгейін қамтамасыз етеді
.
.. note::
.. note::
Выбор мультиинстанс-архитектуры рекомендуется
Мультиинстанс-архитектураны таңдау бірнеше ұйымдық контур
при наличии нескольких организационных контуров
болған кезде және кіру, жауапкершілік пен жүктемені
и необходимости разделения доступа, ответственности и нагрузки
.
бөлу қажет болғанда ұсынылады
.
Архитектурные рекомендации по пользовательским порталам
Пайдаланушы порталдарына арналған архитектуралық ұсыныстар
--------------------------------------------------------
--------------------------------------------------------
------
При проектировании внешних пользовательских порталов
Сыртқы пайдаланушы порталдарын жобалаған кезде
рекомендуется учитывать количество конкурентных пользователей
бір мезгілдегі пайдаланушылар санын
и профиль нагрузки
.
және жүктеме профилін ескеру ұсынылады
.
Сценарий до 1000 конкурентных пользователе
й
1000 бір мезгілдегі пайдаланушыға дейінгі сценари
й
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~
При нагрузке до **1000 конкурентных пользователей**
**1000 бір мезгілдегі пайдаланушыға** дейінгі жүктемеде
рекомендуется использовать стандартные средства платформы Synergy.
Synergy платформасының стандартты құралдарын
пайдалану ұсынылады.
В данном сценарии
:
Бұл сценарийде
:
* п
ользовательский портал реализуется непосредственно на Synergy
;
* п
айдаланушы порталы тікелей Synergy-де іске асырылады
;
*
формы, бизнес-валидации, маршруты и транзакции
*
пішіндер, бизнес-валидациялар, маршруттар және транзакциялар
выполняются внутри платформ
ы;
платформа ішінде орындалад
ы;
* инфра
структурные требования минимальн
ы;
* инфра
құрылымдық талаптар минималд
ы;
*
профиль нагрузки предсказуем
.
*
жүктеме профилі болжамды
.
Такой подход обеспечивает
:
Мұндай тәсіл мыналарды қамтамасыз етеді
:
*
быстрый
**time-to-market**;
*
жылдам
**time-to-market**;
*
упрощенную архитектуру
;
*
жеңілдетілген архитектура
;
*
снижение эксплуатационных затрат
.
*
пайдалану шығындарының азаюы
.
Сценарий свыше 1000 конкурентных пользователе
й
1000 бір мезгілдегі пайдаланушыдан асқан сценари
й
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~
Нагрузка свыше **1000 конкурентных пользователей**
**1000 бір мезгілдегі пайдаланушыдан** асқан жүктеме
относится к классу **highload**
**highload** класына жатады
и требует отдельного архитектурного проектирования
.
және жеке архитектуралық жобалауды қажет етеді
.
В данном случае рекомендуется
:
Бұл жағдайда ұсынылады
:
*
разрабатывать внешний пользовательский портал
*
сыртқы пайдаланушы порталын дербес highload-қолданба
как самостоятельное highload-приложение
;
ретінде әзірлеу
;
*
применять горизонтальное масштабирование
;
*
горизонталды масштабтауды қолдану
;
*
проектировать архитектуру под конкретный профиль нагрузки
.
*
архитектураны нақты жүктеме профиліне сай жобалау
.
Взаимодействие с Synergy
Бұл сценарийде Synergy-мен өзара іс-қимыл:
в этом сценарии должно выполняться:
* асинхрон
но
;
* асинхрон
ды түрде
;
*
через очереди сообщений
;
*
хабарлар кезегі арқылы
;
*
с обязательным использованием **rate limiting**
;
*
міндетті **rate limiting** пайдалана отырып
;
*
исключительно через API и события
.
*
тек API және оқиғалар арқылы орындалуы тиіс
.
В данной архитектуре Synergy
Бұл архитектурада Synergy **процестік және жұмыс ядросы**
выступает в роли **процессного и рабочего ядра**,
рөлін атқарады, ал сыртқы портал пайдаланушы
а внешний портал берет на себя
өзара іс-қимылының барлық жүктемесін өз мойнына алады.
всю нагрузку пользовательского взаимодействия.
Общие рекомендации
Жалпы ұсыныстар
------------------
------------------
При выборе архитектурного подхода рекомендуется
:
Архитектуралық тәсілді таңдаған кезде ұсынылады
:
* четко определять целевой профиль нагрузки;
* мақсатты жүктеме профилін нақты анықтау;
* избегать преждевременной оптимизации;
* мерзімінен бұрын оңтайландырудан аулақ болу;
* использовать стандартные средства Synergy
* орташа жүктемеде Synergy-дің стандартты құралдарын пайдалану;
при умеренных нагрузках;
* объективті қажеттілік болған кезде ғана
* выносить highload-компоненты во внешние сервисы
highload-компоненттерді сыртқы сервистерге шығару.
только при наличии объективной необходимости.
Соблюдение данных рекомендаций
Осы ұсыныстарды сақтау жүйенің иелену құны,
позволяет достичь оптимального баланса
өнімділігі және масштабталуы арасындағы
между стоимостью владения,
оңтайлы тепе-теңдікке қол жеткізуге мүмкіндік береді.
производительностью и масштабируемостью системы.
recommendations/index.rst
View file @
42c2209a
Архитектур
ные и эксплуатационные рекомендации
Архитектур
алық және пайдалану ұсыныстары
===============================================
===============================================
.. toctree::
.. toctree::
...
...
recommendations/operational_recommendations.rst
View file @
42c2209a
Рекомендации по эксплуатации
Пайдалану ұсыныстары
=============================
=============================
Данный раздел содержит рекомендации по эксплуатации приложений,
Бұл бөлім Synergy платформасында орналастырылған
развернутых на платформе Synergy
.
қолданбаларды пайдалануға арналған ұсыныстарды қамтиды
.
Рекомендации охватывают ключевые эксплуатационные аспекты,
Ұсыныстар негізгі пайдалану аспектілерін қамтиды:
такие как перенос приложений между средами
,
қолданбаларды орталар арасында ауыстыру
,
резерв
ное копирование и восстановление
,
резерв
тік көшіру және қалпына келтіру
,
а также общие подходы к сопровождению системы
сондай-ақ жүйені өнеркәсіптік пайдалануда
в промышленной эксплуатации
.
сүйемелдеудің жалпы тәсілдері
.
Импорт и экспорт приложений
Қолданбаларды импорттау және экспорттау
---------------------------
---------------------------
--------------
Платформа Synergy предоставляет встроенные механизмы
Synergy платформасы конфигурацияны әртүрлі орталар арасында
импорта и экспорта приложений,
ауыстыруға арналған (*мысалы: dev → test → prod*)
предназначенные для переноса конфигурации
қолданбаларды импорттау және экспорттаудың кірістірілген
между различными окружениями
механизмдерін ұсынады.
(например: *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
http://tdd.lan.arta.kz/docs/synergy/tags/hamming/release-notes/html/app_export_import.html
Рекомендации по использованию
Пайдалану ұсыныстары
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
П
ри эксплуатации рекомендуется
:
П
айдалану кезінде ұсынылады
:
*
использовать экспорт приложений
*
орталар арасында конфигурацияны ауыстырудың негізгі тәсілі
как основной способ переноса конфигурации между средами
;
ретінде қолданбаларды экспорттауды пайдалану
;
*
не выполнять ручные изменения конфигурации
*
production-ортасында конфигурацияға тікелей қолмен
напрямую в production-среде
;
өзгерістер енгізбеу
;
*
хранить экспортируемые архивы приложений
*
қолданбалардың экспортталған мұрағаттарын нұсқаларды
в системе контроля версий или защищенном хранилище
;
басқару жүйесінде немесе қорғалған қоймада сақтау
;
*
привязывать экспорт приложений
*
қолданбалар экспортын релиздер нұсқаларымен
к версиям релизов и этапам CI/CD
.
және CI/CD кезеңдерімен байланыстыру
.
Резерв
ное копирование и восстановление
Резерв
тік көшіру және қалпына келтіру
-----------------------------------------
-----------------------------------------
Резервное копирование является обязательным элементом
Резервтік көшіру Synergy платформасын пайдаланудың
эксплуатации платформы Synergy
міндетті элементі болып табылады және деректердің
и направлено на обеспечение сохранности данных
сақталуын, сондай-ақ ақаулар мен апаттар жағдайында
и возможности восстановления системы
жүйені қалпына келтіру мүмкіндігін қамтамасыз етуге бағытталған.
в случае сбоев или аварий.
Платформа
поддерживает резервное копирование
Платформа
деректерді, қоймаларды және конфигурацияны қоса
всех критически важных компонентов системы,
алғандағы жүйенің барлық маңызды компоненттерінің
включая данные, хранилища и конфигурацию
.
резервтік көшіруін қолдайды
.
Объекты резервного копирования
Резервтік көшіру объектілері
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
В резервное копирование должны входить
:
Резервтік көшіруге мыналар кіруі тиіс
:
* реляционные базы данных платформы;
* платформаның реляциялық деректер қорлары;
* файловое хранилище
* файлдық қойма (инсталляция түріне байланысты
(JackRabbit или Cassandra в зависимости от типа инсталляции);
JackRabbit немесе Cassandra);
* индексы поиска
* іздеу индекстері (Lucene немесе Elasticsearch);
(Lucene или Elasticsearch);
* платформа мен ортаның конфигурациялық файлдары.
* конфигурационные файлы платформы и окружения.
Общие рекомендации
Жалпы ұсыныстар
~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~
При организации резервного копирования рекомендуется
:
Резервтік көшіруді ұйымдастыру кезінде ұсынылады
:
* выполнять резервное копирование
* деректердің тұтастығын қамтамасыз ету үшін резервтік
при остановленных сервисах платформы
көшіруді платформа сервистері тоқтатылған кезде орындау;
для обеспечения целостности данных;
* резервтік көшірмелерді күн мен жүйе нұсқасына
* хранить резервные копии
байланыстыра отырып сақтау;
с привязкой к дате и версии системы;
* резервтік көшірмелерден қалпына келтіру мүмкіндігін
* регулярно проверять возможность восстановления
жүйелі түрде тексеру;
из резервных копий;
* production- және тесттік орталардың резервтік
* разделять резервные копии
көшірмелерін бөлу.
production- и тестовых окружений.
Подробные процедуры резервного копирования
Жүйені резервтік көшіру және қалпына келтірудің
и восстановления системы
егжей-тегжейлі процедуралары платформаның
описаны в эксплуатационной документации платформы
.
пайдалану құжаттамасында сипатталған
.
Эксплуатационные практики
Пайдалану практикалары
-------------------------
-------------------------
Для стабильной и предсказуемой работы системы рекомендуется:
Жүйенің тұрақты және болжамды жұмысы үшін ұсынылады:
* разделять окружения разработки, тестирования и эксплуатации;
* әзірлеу, тестілеу және пайдалану орталарын бөлу;
* минимизировать прямые изменения в production;
* production-ға тікелей өзгерістерді барынша азайту;
* использовать импорт/экспорт приложений
* жаңартулардың негізгі механизмі ретінде
как основной механизм обновлений;
қолданбаларды импорттау/экспорттауды пайдалану;
* регулярно контролировать состояние хранилищ и индексов;
* қоймалар мен индекстердің күйін жүйелі түрде бақылау;
* планировать резервное копирование
* резервтік көшіруді регламенттік жұмыстардың
как часть регламентных работ.
бір бөлігі ретінде жоспарлау.
Соблюдение данных рекомендаций
Осы ұсыныстарды сақтау пайдалану тәуекелдерін азайтуға,
позволяет снизить эксплуатационные риски,
жүйенің тұрақтылығын қамтамасыз етуге және бүкіл
обеспечить устойчивость системы
өмірлік цикл бойына қолданбаларды сүйемелдеуді
и упростить сопровождение приложений
жеңілдетуге мүмкіндік береді.
на протяжении всего жизненного цикла.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment