CShark Namoyish
Menyu

CShark hujjatlari

CShark dasturiy ta'minotining hayot aylanishiga texnik xizmat ko'rsatish jarayonlarining tavsifi

CSharkni ishlab chiqish, yetkazib berish, saqlash, muammolarni bartaraf etish va takomillashtirish tartibi.

2.0.3 versiyasi

Taqdim etilgan namunani aniqlash

Taqdim etilgan CShark misoli uchun imkoniyatlar
Parametr parametri.Ma'nosi
Chiqarish versiyasi2.0.3
To'liq manba majburiyati399717d1ed4c0e83e00150912a2a029eaec5c736
Ta'minot kanalistable
Namuna variantidemo
Toʻliq toʻplam nomicshark-2.0.3-demo-ubuntu-24.04-amd64-offline.tar
SHA-256 to'liq to'plamiccb36a121bf8e1b756f1190f9369e490585082417829458b9bc62108620850c6
SHA-256 ochiq kalit0908f56ddcd6cd13fe95d81faae6543b9c5953937b164fb2c487eb00a5b8921d

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

CShark texnik xizmat ko'rsatish haqida tashkiliy ma'lumot
Parametr parametri.Ma'nosi
Tashkilot tashkilotiMChJ "KOMPETENTSIA"
Rivojlanish infratuzilmasi manzili115280, Moskva, st. Leninskaya Sloboda, 21, 1-bino
Ishlab chiquvchining ish joyi manzili115280, Moskva, st. Leninskaya Sloboda, 21, 1-bino
Texnik yordam manzili115280, Moskva, st. Leninskaya Sloboda, 21, 1-bino
Texnik qo'llab-quvvatlash xizmatining ish vaqtiDushanba-Juma, Moskva vaqti bilan 09:00-18:00
Texnik yordam telefon raqami+7 495 532-61-18
Qo'llab-quvvatlash uchun javobgarMChJ "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:

  1. talablarni yig'ish va tahlil qilish;
  2. dizaynni o'zgartirish;
  3. kodni ishlab chiqish va ko'rib chiqish;
  4. versiya yaratish;
  5. etkazib berish to'plamini yig'ish va nazorat qilish;
  6. o'rnatish yoki yangilash;
  7. operativ monitoring;
  8. so'rovlar va kamchiliklarni qayta ishlash;
  9. tuzatishlar va yaxshilanishlarni chiqarish;
  10. 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:

  1. avtomatlashtirilgan testlarning to'liq to'plamini tekshirish;
  2. konteyner tasvirlarining yig'ilishini tekshirish;
  3. OpenAPI va yaratilgan mijozni tekshirish;
  4. maxfiy qochqinlarni skanerlash;
  5. toza va mavjud ma'lumotlar bazasida migratsiyani tekshirish;
  6. O'rnatilgan namunani tezkor sinovdan o'tkazish;
  7. o'zgartirilgan foydalanuvchi skriptlarini vizual tekshirish;
  8. yetkazib berish arxivini va nazorat summalarini tekshirish;
  9. 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:

  1. o'rnatilgan versiyani qabul qilish;
  2. bo'sh joy va tizim holatini tekshirish;
  3. zaxira nusxasini yaratish va tekshirish;
  4. yangi versiyaning aniqlangan to'plamini olish;
  5. nazorat summalari va reliz yozuvlari;
  6. ma'lumotlar sxemasining mosligini tekshirish;
  7. migratsiyalarni alohida bosqichda qo'llash;
  8. konteynerlarni yangi versiyaga o'tkazish;
  9. sog'lig'ini tekshirish va chekish testini o'tkazish;
  10. 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.

So'rovlarni ustuvorlik bo'yicha tasniflash
Avvallik:MisolQayta ishlash maqsadi
Tanqidiytizim mavjud emas yoki ma'lumotlar yo'qolishidarhol tashxis qo'yish va tiklanish
YuqoriAsosiy operator funktsiyasi ishlamaydivaqtinchalik hal qilish yoki ustuvor versiyada tuzatish
O'rtaishni to'xtatmasdan qisman nuqsonrejalashtirilgan relizda tuzatish
Pastqulaylik yoki hujjatlarni yaxshilashmahsulot 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:

  1. murojaatni ro'yxatdan o'tkazish;
  2. asl holatini va jurnallarni saqlash;
  3. ta'sir tasnifi;
  4. xavfsiz stendda ijro etish;
  5. sababni lokalizatsiya qilish;
  6. tuzatishni tayyorlash;
  7. regressiya testlari;
  8. qayta ko'rib chiqilgan versiyasini chiqarish;
  9. kelishilgan oynaga muvofiq o'rnatish;
  10. foydalanuvchi tomonidan natijani tasdiqlash;
  11. 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

Yordamchi xodimlarning roli, vakolatlari va vazifalari
RolAsosiy vakolatlarOddiy vazifalar
Tizim administratoriUbuntu, Docker Compose, tarmoq, TLS, zaxirao'rnatish, yangilash, monitoring, tiklash
CShark administratorirollar, topologiya, qurilmalar, sozlamalarkonfiguratsiya va foydalanuvchini qo'llab-quvvatlash
Yordam bo'yicha mutaxassisVeb/API diagnostikasi, jurnallarni yig'ish, aloqaro'yxatga olish va so'rovlarni dastlabki qayta ishlash
Backend dasturchisiPython, FastAPI, PostgreSQL, NATS, migratsiyabiznes mantiqiy va integratsiyani tuzatish
Frontend dasturchisiTypeScript, React, Web interfeyslarifoydalanuvchi skriptlarini tuzatish va ishlab chiqish
Sifat muhandisitest dizayni, API/UI va regressiya tekshiruvlarituzatishlar va nashrlarni tasdiqlash
DevOps muhandisiCI/CD, tasvirlar, kuzatuvchanlik, ta'minot zanjiriyig'ish va etkazib berishning takrorlanishi
Axborot xavfsizligi bo'yicha mutaxassiszaifliklarni boshqarish, audit, ma'lumotlarni himoya qilishxavflarni baholash va himoya choralarini nazorat qilish
Tahlilchi yoki mahsulot egasitalablar va qabul qilishnatijalarni 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.