Taqdim etilgan namunani aniqlash
| Parametr parametri. | Ma'nosi |
|---|---|
| Chiqarish versiyasi | 2.0.3 |
| To'liq manba majburiyati | 399717d1ed4c0e83e00150912a2a029eae |
| Ta'minot kanali | stable |
| Namuna varianti | demo |
| Toʻliq toʻplam nomi | cshark-2.0.3-demo-ubuntu-24.04- |
| SHA-256 to'liq to'plami | ccb36a121bf8e1b756f1190f9369e49058 |
| SHA-256 ochiq kalit | 0908f56ddcd6cd13fe95d81faae6543b9c |
1. Hujjatning maqsadi
Hujjat CShark dasturiy ta'minotini ishlab chiqish, yetkazib berish, texnik xizmat ko'rsatish, nosozliklarni bartaraf etish va takomillashtirish jarayonlarini, shuningdek, ushbu jarayonlarni amalga oshirish uchun zarur bo'lgan xodimlarning vakolatlarini tavsiflaydi.
1.1. Tashkiliy tafsilotlar
| Parametr parametri. | Ma'nosi |
|---|---|
| Tashkilot tashkiloti | MChJ "KOMPETENTSIA" |
| Rivojlanish infratuzilmasi manzili | 115280, Moskva, st. Leninskaya Sloboda, 21, 1-bino |
| Ishlab chiquvchining ish joyi manzili | 115280, Moskva, st. Leninskaya Sloboda, 21, 1-bino |
| Texnik yordam manzili | 115280, Moskva, st. Leninskaya Sloboda, 21, 1-bino |
| Texnik qo'llab-quvvatlash xizmatining ish vaqti | Dushanba-Juma, Moskva vaqti bilan 09:00-18:00 |
| Texnik yordam telefon raqami | +7 495 532-61-18 |
| Qo'llab-quvvatlash uchun javobgar | MChJ "KOMPETENTSIA" |
Rivojlanish, sinovdan o'tkazish, DevOps va tizimni boshqarish funktsiyalari, shuningdek, texnik yordam COMPETENCE MChJ mutaxassislari tomonidan amalga oshiriladi. Funktsiyalarning kombinatsiyasi ishni rejalashtirish va ishlab chiqish, tekshirish va chiqarish operatsiyalarini o'z vaqtida ajratishda hisobga olinadi.
2. Hayotiy tsikl bosqichlari
Hayotiy tsikl quyidagilarni o'z ichiga oladi:
- talablarni yig'ish va tahlil qilish;
- dizaynni o'zgartirish;
- kodni ishlab chiqish va ko'rib chiqish;
- versiya yaratish;
- etkazib berish to'plamini yig'ish va nazorat qilish;
- o'rnatish yoki yangilash;
- operativ monitoring;
- so'rovlar va kamchiliklarni qayta ishlash;
- tuzatishlar va yaxshilanishlarni chiqarish;
- versiyani qo'llab-quvvatlash va ko'chirishni to'xtatish.
Har bir o'zgartirishda identifikator, uning maqsadi tavsifi, qabul qilish mezonlari va yetkazib berish versiyasiga havola bo'lishi kerak.
3. Talablar va o'zgarishlarni boshqarish
Talablar manbalariga shartnoma majburiyatlari, operatsion talablar, xavfsizlik talablari, sinov natijalari va mahsulot rejasi kiradi.
Amalga oshirishdan oldin o'zgartirish:
- muayyan sinov natijasi sifatida tavsiflanadi;
- ustuvorlik va xavf bo'yicha tasniflanadi;
- joriy ma'lumotlar va integratsiyalarga muvofiqligi uchun sinovdan o'tgan;
- qabul qilish mezonlarini oladi;
- versiya rejasiga kiritilgan.
4. Rivojlanish
Manba kodi versiyani boshqarish tizimida saqlanadi. Rivojlanish ta'sirlangan komponentlarni majburiy tahlil qilish bilan alohida o'zgarishlarda amalga oshiriladi.
O'zgartirishlar uchun foydalaning:
- statik tahlil va formatlash;
- birlik sinovlari;
- haqiqiy PostgreSQL va NATS bilan integratsiya testlari;
- shartnoma API va voqea testlari;
- ma'lumotlar bazasi migratsiyasini tekshirish;
- interfeys sinovlari;
- zaxira va tiklash stsenariylari;
- o'rnatish to'plamini tekshirish.
O'zgartirish faqat mahalliy sifatida ishga tushirilganda to'liq hisoblanmaydi; uning xavfiga mos kelishi uchun takroriy tekshiruvlar talab qilinadi.
5. Sifat nazorati
Versiyani chiqarishdan oldin quyidagilar amalga oshiriladi:
- avtomatlashtirilgan testlarning to'liq to'plamini tekshirish;
- konteyner tasvirlarining yig'ilishini tekshirish;
- OpenAPI va yaratilgan mijozni tekshirish;
- maxfiy qochqinlarni skanerlash;
- toza va mavjud ma'lumotlar bazasida migratsiyani tekshirish;
- O'rnatilgan namunani tezkor sinovdan o'tkazish;
- o'zgartirilgan foydalanuvchi skriptlarini vizual tekshirish;
- yetkazib berish arxivini va nazorat summalarini tekshirish;
- hujjatlarni yangilash.
Aniqlangan blokirovka nuqsoni tuzatish yoki belgilangan cheklovli portga rasmiy qaror qabul qilinmaguncha chiqarishni to'xtatadi.
6. Versiyalash va yetkazib berish to‘plami
Versiya havolalari:
- manba kodi identifikatori;
- konteyner tasvirlarining versiyalari;
- ma'lumotlar bazasi sxemasini qayta ko'rib chiqish;
- arxiv manifesti;
- nazorat summalari;
- o'rnatuvchi;
- hujjatlar va o'zgarishlar ro'yxati.
Yopiq tsikl uchun mahalliy Docker tasvirlari va APT bog'liqliklari bilan oflayn to'plam yaratiladi. To'plam tashqi omborlarga kirish imkonisiz toza Ubuntu Server 24.04 LTS AMD64 da sinovdan o'tkaziladi.
7. Yetkazib berish va o'rnatish
Yetkazib berish xavfsiz server orqali yoki oflayn arxivni uzatish orqali amalga oshiriladi. SHA-256 qadoqdan chiqarishdan oldin tekshiriladi. O'rnatuvchi ichki manifestni qayta tasdiqlaydi, bog'liqliklarni o'rnatadi, migratsiyalarni qo'llaydi va tezkor testlarni amalga oshiradi.
O'rnatish natijalari va jurnallar diagnostika maqsadida saqlanadi. Agar xatolik yuzaga kelsa, konteynerlar to'xtaydi va ma'lumotlar avtomatik ravishda o'chirilmaydi.
8. Tizimni yangilash
Joriy yangilash jarayoni boshqariladigan ma'muriy operatsiya hisoblanadi:
- o'rnatilgan versiyani qabul qilish;
- bo'sh joy va tizim holatini tekshirish;
- zaxira nusxasini yaratish va tekshirish;
- yangi versiyaning aniqlangan to'plamini olish;
- nazorat summalari va reliz yozuvlari;
- ma'lumotlar sxemasining mosligini tekshirish;
- migratsiyalarni alohida bosqichda qo'llash;
- konteynerlarni yangi versiyaga o'tkazish;
- sog'lig'ini tekshirish va chekish testini o'tkazish;
- yangilanish natijasini yozib oling.
Foydalanuvchi interfeysidan avtomatik yangilanish istiqbolli xususiyatdir. Chiqarilishidan oldin yangilanish tizim ma'muri tomonidan tasdiqlangan ko'rsatmalarga muvofiq amalga oshiriladi.
9. Migratsiya va orqaga qaytishlarni boshqarish
Yadro faqat mos keladigan ma'lumotlar bazasi sxemasi bilan ishlaydi. Agar sxema ilova versiyasi orqasida bo'lsa, migratsiya qo'llanilmaguncha ishga tushirish bloklanadi.
Yangilashdan oldin, orqaga qaytish imkoniyati aniqlanadi. Kengaytirilgan tor o'zgarishlar (mos keladigan migratsiya) uchun oldingi versiya vaqtinchalik yangi sxemada ishlashi mumkin. Mos kelmaydigan o'zgartirish uchun orqaga qaytarish faqat tasdiqlangan zaxirani tiklagan holda alohida reja yordamida amalga oshiriladi.
10. Operatsion monitoring
Tizim holatini kuzatib boradi:
/api/health;- konteyner holati;
- nashr qilish va hodisalarni qayta ishlash ko'rsatkichlari;
- Shlyuz navbatining chuqurligi;
- NATS holati;
- PostgreSQL va S3 mavjudligi;
- Core, Gateway va Infrastructure jurnallari;
- bo'sh disk maydoni;
- qurilma holati.
Chegara qiymatlari va ogohlantirish marshruti ma'lum bir ob'ektning operatsion qoidalarida o'rnatiladi.
11. So'rovlarni ro'yxatga olish va tasniflash
Xit vaqt, versiya, foydalanuvchi roli, harakatlar ketma-ketligi, haqiqiy va kutilgan natijalar, kerak bo'lganda jurnallar va skrinshotlarni o'z ichiga olishi kerak.
| Avvallik: | Misol | Qayta ishlash maqsadi |
|---|---|---|
| Tanqidiy | tizim mavjud emas yoki ma'lumotlar yo'qolishi | darhol tashxis qo'yish va tiklanish |
| Yuqori | Asosiy operator funktsiyasi ishlamaydi | vaqtinchalik hal qilish yoki ustuvor versiyada tuzatish |
| O'rta | ishni to'xtatmasdan qisman nuqson | rejalashtirilgan relizda tuzatish |
| Past | qulaylik yoki hujjatlarni yaxshilash | mahsulot rejasiga kiritish |
Javob berish va tiklash uchun aniq muddatlar qo'llab-quvvatlash shartnomasida belgilanadi.
12. Muammolarni bartaraf etish
Yo'q qilish jarayoni quyidagilarni o'z ichiga oladi:
- murojaatni ro'yxatdan o'tkazish;
- asl holatini va jurnallarni saqlash;
- ta'sir tasnifi;
- xavfsiz stendda ijro etish;
- sababni lokalizatsiya qilish;
- tuzatishni tayyorlash;
- regressiya testlari;
- qayta ko'rib chiqilgan versiyasini chiqarish;
- kelishilgan oynaga muvofiq o'rnatish;
- foydalanuvchi tomonidan natijani tasdiqlash;
- bilimlar bazasini yangilash.
Ma'lumotlarga qo'lda o'zgartirishlar faqat kelishilgan tartibda, zaxira nusxasi, buyruqlar jurnali va keyingi tekshirish bilan ruxsat etiladi.
13. Zaxiralash va tiklash
Biznes ma'lumotlariga PostgreSQL ma'lumotlar bazasi va S3-mos keladigan xotiradagi media kiradi.
Tavsiya etilgan asosiy jadval:
- ma'lumotlar bazasi - har kuni;
- ommaviy axborot vositalarining to'liq nusxasi - har hafta;
- sinovni tiklash - protsedurani o'zgartirgandan keyin va vaqti-vaqti bilan operatsion qoidalarga muvofiq.
Nusxa faqat vaqtinchalik muhitga qayta tiklangandan va nazorat hisoblagichlari tekshirilgandan so'ng tasdiqlangan hisoblanadi. Media SHA-256 va yakuniy manifest dayjestiga muvofiq tasdiqlangan.
14. Xavfsizlikni boshqarish
Qo'llab-quvvatlash jarayoni quyidagilarni o'z ichiga oladi:
- asosiy tasvirlar va bog'liqliklarni yangilash;
- zaiflik tahlili;
- sirlarni aylantirish;
- foydalanuvchi huquqlarini tekshirish;
- ma'muriy harakatlar auditi;
- ma'lumotlarni saqlash muddatlarini nazorat qilish;
- oshkora hisobotlardan sir va shaxsiy ma'lumotlarni chiqarib tashlash;
- xavfsizlik yamoqlarini hujjatlashtirish.
Muhim xavfsizlik yangilanishlari rejalashtirilgan tsikldan tashqarida chiqarilishi mumkin.
15. Dasturiy ta'minotni takomillashtirish
Yaxshilanishlar foydalanuvchi so'rovlari, kuzatuvchanlik natijalari, interfeys va mahsulot rejasini tekshirish natijasida hosil bo'ladi. Har bir yaxshilanish uchun foydalanuvchi muammosi, maqsadli natija, cheklovlar va tekshirish usuli qayd etiladi.
Kelajakdagi rivojlanish sohalariga avtomatlashtirilgan yangilanishlar, uy ekrani shablonlarini ishlab chiqish, qo'shimcha integratsiyalar, zaryadlash infratuzilmasi va tijorat modullari kiradi. Ular alohida nashrga qadar joriy versiyaning xususiyatlari hisoblanmaydi.
16. Hujjatlar
Xulq-atvor o'zgarganda, quyidagilar yangilanadi:
- o'rnatish bo'yicha ko'rsatmalar;
- funktsional xususiyatlarning tavsifi;
- qo'llanma;
- administratorlar uchun runbook;
- OpenAPI va voqea shartnomalari;
- nashr yozuvlari;
- zaxiralash va tiklash bo'yicha ko'rsatmalar.
Hujjatlar joriy sanani va u tegishli bo'lgan versiya identifikatorini saqlaydi.
17. Eskort uchun zarur bo'lgan xodimlar
| Rol | Asosiy vakolatlar | Oddiy vazifalar |
|---|---|---|
| Tizim administratori | Ubuntu, Docker Compose, tarmoq, TLS, zaxira | o'rnatish, yangilash, monitoring, tiklash |
| CShark administratori | rollar, topologiya, qurilmalar, sozlamalar | konfiguratsiya va foydalanuvchini qo'llab-quvvatlash |
| Yordam bo'yicha mutaxassis | Veb/API diagnostikasi, jurnallarni yig'ish, aloqa | ro'yxatga olish va so'rovlarni dastlabki qayta ishlash |
| Backend dasturchisi | Python, FastAPI, PostgreSQL, NATS, migratsiya | biznes mantiqiy va integratsiyani tuzatish |
| Frontend dasturchisi | TypeScript, React, Web interfeyslari | foydalanuvchi skriptlarini tuzatish va ishlab chiqish |
| Sifat muhandisi | test dizayni, API/UI va regressiya tekshiruvlari | tuzatishlar va nashrlarni tasdiqlash |
| DevOps muhandisi | CI/CD, tasvirlar, kuzatuvchanlik, ta'minot zanjiri | yig'ish va etkazib berishning takrorlanishi |
| Axborot xavfsizligi bo'yicha mutaxassis | zaifliklarni boshqarish, audit, ma'lumotlarni himoya qilish | xavflarni baholash va himoya choralarini nazorat qilish |
| Tahlilchi yoki mahsulot egasi | talablar va qabul qilish | natijalarni ustuvorlashtirish va nazorat qilish |
Kichkina jamoada bitta mutaxassis zarur vakolatlarga ega bo'lsa, rollarni birlashtirishi mumkin. Ob'ektning normal ishlashi uchun tizim administratori va CShark administratori minimal darajada talab qilinadi; Ishlab chiquvchilar va sifat muhandisi yangi versiyalarni tuzatish va chiqarishda ishtirok etadilar.
18. Versiyaning eskirishi
Qo'llab-quvvatlash to'xtatilishidan oldin foydalanuvchilarga eng so'nggi qo'llab-quvvatlanadigan versiya, ma'lum cheklovlar va migratsiya yo'li haqida ma'lumot beriladi. Namuna o'chirilishidan oldin kerakli ma'lumotlar eksport qilinadi, zaxira nusxalari amalga oshiriladi va integratsiya kalitlari bekor qilinadi. Qo'llab-quvvatlash va xabar berish muddatlari shartnoma va chiqarish siyosati bilan belgilanadi.