CShark бағдарламалық жасақтамасының өмірлік цикліне техникалық қызмет көрсету процестерінің сипаттамасы

Қамтамасыз етілген дананы анықтау

1. Құжаттың мақсаты

Құжат CShark бағдарламалық жасақтамасын әзірлеу, жеткізу, қолдау, ақауларды жою және жетілдіру процестерін, сондай-ақ осы процестерді жүзеге асыру үшін қажетті персонал құзыреттерін сипаттайды.

1.1. Ұйымдастырушылық мәліметтер

Әзірлеу, тестілеу, DevOps және жүйелік әкімшілендіру функцияларын, сондай-ақ техникалық қолдауды COMPETENCE LLC мамандары орындайды. Функциялардың үйлесімі жұмысты жоспарлау және әзірлеу, тексеру және шығару операцияларын уақытында бөлу кезінде ескеріледі.

2. Өмірлік цикл кезеңдері

Өмірлік цикл мыналарды қамтиды:

1. талаптарды жинау және талдау;
2. дизайнды өзгерту;
3. кодты әзірлеу және қарау;
4. нұсқаны құру;
5. жеткізу жиынтығын құрастыру және бақылау;
6. орнату немесе жаңарту;
7. операциялық мониторинг;
8. сұраныстар мен ақауларды өңдеу;
9. түзетулер мен жақсартуларды шығару;
10. нұсқаны қолдауды және тасымалдауды тоқтату.

Әрбір өзгертуде идентификатор, оның мақсатының сипаттамасы, қабылдау критерийлері және жеткізу нұсқасына сілтеме болуы керек.

3. Талаптар мен өзгерістерді басқару

Талап көздеріне шарттық міндеттемелер, операциялық сұраныстар, қауіпсіздік талаптары, сынақ нәтижелері және өнім жоспары жатады.

Іске асыруға дейін өзгерту:

• арнайы тексерілетін нәтиже ретінде сипатталған;
• басымдылық және тәуекел бойынша жіктеледі;
• ағымдағы деректермен және интеграциялармен үйлесімділік сыналған;
• қабылдау критерийлерін алады;
• нұсқа жоспарына енгізілген.

4. Даму

Бастапқы код нұсқаны басқару жүйесінде сақталады. Әзірлеу зардап шеккен компоненттерді міндетті талдаумен оқшауланған өзгерістермен жүзеге асырылады.

Өзгерістерді пайдалану үшін:

• статикалық талдау және пішімдеу;
• бірлік сынақтары;
• нақты PostgreSQL және NATS-пен интеграциялық сынақтар;
• келісім API және оқиға сынақтары;
• деректер базасының көшуін тексеру;
• интерфейстік сынақтар;
• сақтық көшірме жасау және қалпына келтіру сценарийлері;
• орнату жинағын тексеру.

Өзгеріс тек оны жергілікті түрде іске қосу арқылы аяқталған болып саналмайды; оның тәуекелін сәйкестендіру үшін қайталанатын тексерулер қажет.

5. Сапаны бақылау

Нұсқаны шығармас бұрын келесі әрекеттер орындалады:

1. автоматтандырылған сынақтардың толық кешенін тексеру;
2. контейнер кескіндерінің жинақталуын тексеру;
3. OpenAPI және жасалған клиентті тексеру;
4. құпия ағып кетулерді сканерлеу;
5. таза және бар дерекқордағы тасымалдауларды тексеру;
6. Орналастырылған дананы жылдам тестілеу;
7. өзгертілген пайдаланушы сценарийлерін визуалды тексеру;
8. жеткізу мұрағатын және бақылау сомасын тексеру;
9. құжаттаманы жаңарту.

Табылған блоктау ақауы түзету немесе бекітілген шектеуі бар портқа ресми шешім қабылданғанға дейін шығаруды тоқтатады.

6. Нұсқалау және жеткізу жиынтығы

Нұсқа сілтемелері:

• бастапқы код идентификаторы;
• контейнер кескіндерінің нұсқалары;
• деректер базасының схемасын қайта қарау;
• мұрағаттық манифест;
• бақылау сомасы;
• орнатушы;
• құжаттама және өзгертулер тізімі.

Жабық цикл үшін жергілікті Docker кескіндерімен және APT тәуелділіктерімен желіден тыс жиынтық жасалады. Жинақ сыртқы репозиторийлерге рұқсатсыз таза Ubuntu Server 24.04 LTS AMD64 серверінде сыналған.

7. Жеткізу және орнату

Жеткізу қауіпсіз сервер арқылы немесе офлайн мұрағатты тасымалдау арқылы жүзеге асырылады. SHA-256 қаптамадан шығарар алдында тексеріледі. Орнатушы ішкі манифестті қайта тексереді, тәуелділіктерді орнатады, тасымалдауларды қолданады және жылдам тестілеуді орындайды.

Орнату нәтижелері мен журналдар диагностикалық мақсаттар үшін сақталады. Қате орын алса, контейнерлер тоқтап, деректер автоматты түрде жойылмайды.

8. Жүйені жаңарту

Ағымдағы жаңарту процесі басқарылатын әкімшілік операция болып табылады:

1. орнатылған нұсқаны қабылдау;
2. бос орынды және жүйе күйін тексеру;
3. сақтық көшірмені жасау және тексеру;
4. жаңа нұсқаның анықталған жинағын алу;
5. бақылау сомасы және босату туралы ескертулер;
6. деректер схемасының үйлесімділігін тексеру;
7. тасымалдауларды бөлек қадамда қолдану;
8. контейнерлерді жаңа нұсқаға ауыстыру;
9. денсаулықты тексеру және түтінге қарсы тест жүргізу;
10. жаңарту нәтижесін жазып алыңыз.

Пайдаланушы интерфейсінен автоматты жаңарту перспективалы мүмкіндік болып табылады. Шығарылғанға дейін жаңартуды жүйе әкімшісі бекітілген нұсқауларға сәйкес жүзеге асырады.

9. Тасымалдауларды және кері қайтаруды басқару

Core тек үйлесімді дерекқор схемасымен жұмыс істейді. Схема қолданба нұсқасының артында болса, тасымалдаулар қолданылғанша іске қосу блокталады.

Жаңарту алдында қайтымды кері қайтару мүмкіндігі анықталады. Кеңейту-тар өзгертулер үшін (үйлесімді тасымалдаулар) алдыңғы нұсқа жаңа схемада уақытша жұмыс істей алады. Үйлесімсіз өзгерту үшін кері қайтару тек тексерілген сақтық көшірмені қалпына келтіре отырып, бөлек жоспарды пайдаланып орындалады.

10. Жұмысты бақылау

Жүйе күйін бақылайды:

• /api/health;
• контейнер күйлері;
• жариялау және оқиғаларды өңдеу көрсеткіштері;
• Шлюз кезегінің тереңдігі;
• NATS күйі;
• PostgreSQL және S3 қолжетімділігі;
• Core, Gateway және Infrastructure журналдары;
• бос дискілік кеңістік;
• құрылғы күйі.

Шекті мәндер мен ескерту маршруты нақты объектінің пайдалану ережелерінде белгіленеді.

11. Сұраныстарды тіркеу және жіктеу

Хит уақытты, нұсқаны, пайдаланушы рөлін, әрекеттер тізбегін, нақты және күтілетін нәтижелерді, қажет болған жағдайда журналдарды және скриншоттарды қамтуы керек.

Жауап беру және қалпына келтірудің нақты уақыт шеңберлері қолдау көрсету келісімімен белгіленеді.

12. Ақаулықтарды жою

Жою процесі мыналарды қамтиды:

1. апелляцияны тіркеу;
2. бастапқы күйді және журналдарды сақтау;
3. әсер ету классификациясы;
4. қауіпсіз стендте ойнату;
5. себебін локализациялау;
6. түзетуді дайындау;
7. регрессиялық тесттер;
8. өңделген нұсқасын шығару;
9. келісілген терезеге сәйкес орнату;
10. нәтижені пайдаланушының растауы;
11. білім қорын жаңарту.

Деректерді қолмен өзгертуге сақтық көшірме, пәрмендер журналы және кейінгі тексеру бар келісілген процедураға сәйкес ғана рұқсат етіледі.

13. Сақтық көшірме жасау және қалпына келтіру

Бизнес деректері PostgreSQL дерекқорын және S3-үйлесімді жадтағы медианы қамтиды.

Ұсынылатын негізгі кесте:

• мәліметтер базасы – күнделікті;
• ақпарат құралдарының толық көшірмесі – апта сайын;
• сынақты қалпына келтіру - процедураны өзгерткеннен кейін және пайдалану ережелеріне сәйкес мерзімді түрде.

Көшірме уақытша ортаға қалпына келтірілгеннен кейін және бақылау есептегіштерін тексергеннен кейін ғана тексерілген болып саналады. Медиа SHA-256 және соңғы манифест дайджестімен тексерілген.

14. Қауіпсіздікті басқару

Қолдау процесі мыналарды қамтиды:

• негізгі кескіндер мен тәуелділіктерді жаңарту;
• осалдықты талдау;
• құпияларды айналдыру;
• пайдаланушы құқықтарын тексеру;
• әкімшілік әрекеттердің аудиті;
• мәліметтерді сақтау мерзімдерін бақылау;
• құпияларды және жеке деректерді жария есептерден алып тастау;
• қауіпсіздік патчтарын құжаттау.

Қауіпсіздіктің маңызды жаңартулары жоспарланған циклден тыс шығарылуы мүмкін.

15. Бағдарламалық қамтамасыз етуді жетілдіру

Жақсартулар пайдаланушы сұраулары, бақылау нәтижелері, интерфейс және өнім жоспарының аудиттері арқылы жасалады. Әрбір жақсарту үшін пайдаланушының мәселесі, мақсатты нәтиже, шектеулер және тексеру әдісі жазылады.

Болашақ даму бағыттарына автоматтандырылған жаңартулар, негізгі экран үлгілерін әзірлеу, қосымша интеграциялар, зарядтау инфрақұрылымы және коммерциялық модульдер кіреді. Олар бөлек шығарылымға дейін ағымдағы нұсқаның мүмкіндіктері болып саналмайды.

16. Құжаттама

Мінез өзгерген кезде келесілер жаңартылады:

• орнату нұсқаулары;
• функционалдық сипаттамаларды сипаттау;
• нұсқаулық;
• әкімшілерге арналған runbook;
• OpenAPI және оқиға келісімшарттары;
• шығару жазбалары;
• сақтық көшірме жасау және қалпына келтіру нұсқаулары.

Құжаттама ағымдағы күнді және ол сілтеме жасайтын нұсқа идентификаторын сақтайды.

17. Жол жүруге қажетті персонал

Шағын ұжымда бір маман қажетті құзыреттерге ие болса, рөлдерді біріктіре алады. Нысанның қалыпты жұмыс істеуі үшін жүйелік әкімші және CShark әкімшісі ең аз қажет; әзірлеушілер мен сапа инженері жаңа нұсқаларды түзетуге және шығаруға қатысады.

18. Нұсқаның ескіруі

Қолдау тоқтатылмас бұрын пайдаланушыларға қолдау көрсетілетін соңғы нұсқа, белгілі шектеулер және тасымалдау жолы туралы ақпарат беріледі. Дана жойылмас бұрын, қажетті деректер экспортталады, сақтық көшірмелер орындалады және біріктіру кілттері кері қайтарылады. Қолдау және хабарландыру мерзімдері келісім-шартпен және шығару саясатымен анықталады.