CShark Көрсөтүү
Меню

CShark документациясы

CShark программалык камсыздоонун жашоо циклинин тейлөө процесстеринин сүрөттөлүшү

CSharkти иштеп чыгуу, жеткирүү, тейлөө, көйгөйлөрдү чечүү жана жакшыртуу процедурасы.

Версия 2.0.3

Берилген инстанцияны аныктоо

Берилген CShark инстанциясы үчүн параметрлер
Параметрлер параметриМааниси
Чыгуу версиясы2.0.3
Толук булак милдеттенмеси399717d1ed4c0e83e00150912a2a029eaec5c736
Камсыздоо каналыstable
Мисал вариантыdemo
Толук аталышcshark-2.0.3-demo-ubuntu-24.04-amd64-offline.tar
SHA-256 толук комплектccb36a121bf8e1b756f1190f9369e490585082417829458b9bc62108620850c6
SHA-256 ачык ачкычы0908f56ddcd6cd13fe95d81faae6543b9c5953937b164fb2c487eb00a5b8921d

1. Документтин максаты

Документ CShark программалык камсыздоосун иштеп чыгуу, жеткирүү, тейлөө, көйгөйлөрдү чечүү жана жакшыртуу процесстерин, ошондой эле бул процесстерди ишке ашыруу үчүн талап кылынган персоналдын компетенцияларын сүрөттөйт.

1.1. Уюштуруу деталдары

CShark тейлөө жөнүндө уюштуруу маалымат
Параметрлер параметриМааниси
Организациянын аты-жөнү:ООО "КОМПЕТЕНЦИЯ"
Өнүгүү инфраструктурасынын дареги115280, Москва, ул. Ленинская слобода, 21, 1 корпус
Иштеп чыгуучунун жумуш орду дареги115280, Москва, ул. Ленинская слобода, 21, 1 корпус
Техникалык колдоо дареги115280, Москва, ул. Ленинская слобода, 21, 1 корпус
Техникалык колдоо кызматынын иштөө убактысыДүйшөмбү-Жума, Москва убактысы боюнча 09:00-18:00
Техникалык колдоо телефон номери+7 495 532-61-18
Колдоо үчүн жооптууООО "КОМПЕТЕНЦИЯ"

Иштеп чыгуу, тестирлөө, DevOps жана системаны башкаруу функциялары, ошондой эле техникалык колдоо КОМПЕТЕНС ЖЧКсынын адистери тарабынан аткарылат. Функциялардын айкалышы ишти пландаштырууда жана иштеп чыгуу, текшерүү жана чыгаруу операцияларын өз убагында бөлүүдө эске алынат.

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. Миграцияларды жана артка кайтарууну башкаруу

Негизги шайкеш маалымат базасын схемасы менен гана иштейт. Эгерде схема колдонмонун версиясынын артында болсо, көчүрүү колдонулганга чейин баштоо бөгөттөлөт.

Жаңыртуудан мурун, кайра кайтаруу мүмкүнчүлүгү аныкталат. Кеңейтүү-тар өзгөрүүлөр (шайкеш көчүрүү) үчүн мурунку версия жаңы схемада убактылуу иштеши мүмкүн. Шайкеш келбеген өзгөртүү үчүн артка кайтаруу өзүнчө планды колдонуу менен гана аткарылып, текшерилген камдык көчүрмөнү калыбына келтирет.

10. Ишке мониторинг жүргүзүү

Системанын абалын көзөмөлдөйт:

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

Чектик маанилер жана сигналдын маршруту конкреттүү объекттин эксплуатациялык регламентинде белгиленет.

11. Сурамдарды каттоо жана классификациялоо

Хитке убакыт, версия, колдонуучунун ролу, аракеттердин ырааттуулугу, иш жүзүндөгү жана күтүлгөн натыйжалар, керек болсо журналдар жана скриншоттор камтылууга тийиш.

Артыкчылык боюнча суроо-талаптарды классификациялоо
Приоритеттик: 1.МисалКайра иштетүүнүн максаты
Критикалыксистема жеткиликсиз же маалымат жоголдудароо диагноз жана калыбына келтирүү
ЖогоркуНегизги оператор функциясы иштебейтубактылуу чечүү же артыкчылыктуу чыгарууда оңдоо
Ортоишти токтотпостон жарым-жартылай кемчиликпландаштырылган чыгарууда оңдоо
Төмөнколдонууга же документтерди жакшыртуупродукциянын планына киргизүү

Жооп берүү жана калыбына келтирүү үчүн конкреттүү мөөнөттөр колдоо келишиминде белгиленет.

12. Проблемаларды чечүү

Жок кылуу процесси төмөнкүлөрдү камтыйт:

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

Маалыматтарды кол менен өзгөртүүгө макулдашылган жол-жобо боюнча гана резервдик көчүрмөсү, буйруктар журналы жана андан кийинки текшерүүгө жол берилет.

13. Камдык көчүрмөнү сактоо жана калыбына келтирүү

Бизнес маалыматтары PostgreSQL маалымат базасын жана S3 шайкеш сактагычындагы медианы камтыйт.

Сунушталган негизги график:

  • маалымат базасы - күн сайын;
  • жалпыга маалымдоо каражаттарынын толук көчүрмөсү - жума сайын;
  • сыноону калыбына келтирүү - процедураны өзгөрткөндөн кийин жана мезгил-мезгили менен эксплуатациялык регламентке ылайык.

Көчүрмө убактылуу чөйрөгө калыбына келтирилгенден жана контролдук эсептегичтер текшерилгенден кийин гана текшерилди деп эсептелет. Медиа SHA-256 жана акыркы манифест дайджестке каршы текшерилген.

14. Коопсуздукту башкаруу

Колдоо процесси төмөнкүлөрдү камтыйт:

  • базалык сүрөттөрдү жана көз карандылыкты жаңылоо;
  • аялуулугун талдоо;
  • сырларды айлантуу;
  • колдонуучунун укуктарын текшерүү;
  • административдик аракеттердин аудити;
  • маалыматтарды сактоо мөөнөттөрүн көзөмөлдөө;
  • ачык отчеттордон сырларды жана жеке маалыматтарды алып салуу;
  • коопсуздук тактарын документтештирүү.

Критикалык коопсуздук жаңыртуулары пландаштырылган циклден тышкары чыгарылышы мүмкүн.

15. Программалык камсыздоону жакшыртуу

Жакшыртуулар колдонуучунун суроо-талаптарынан, байкоо жүргүзүүнүн натыйжаларынан, интерфейстин жана продукт планынын аудитинен түзүлөт. Ар бир жакшыртуу үчүн колдонуучунун көйгөйү, максаттуу натыйжасы, чектөөлөрү жана текшерүү ыкмасы жазылат.

Келечектеги өнүгүү багыттары автоматташтырылган жаңыртууларды, үй экранынын шаблондорун иштеп чыгууну, кошумча интеграцияларды, заряддоо инфраструктурасын жана коммерциялык модулдарды камтыйт. Алар өзүнчө релизге чейин учурдагы версиянын өзгөчөлүктөрү катары каралбайт.

16. Документтер

Жүрүм-туруму өзгөргөндө, төмөнкүлөр жаңыланат:

  • орнотуу көрсөтмөлөрү;
  • функционалдык мүнөздөмөлөрдүн сүрөттөлүшү;
  • нускама китепчеси;
  • администраторлор үчүн runbook;
  • OpenAPI жана окуя келишимдери;
  • чыгаруу эскертмелери;
  • нускамаларды сактоо жана калыбына келтирүү.

Документация учурдагы датаны жана ал шилтеме кылган версия идентификаторун сактайт.

17. Узатуу үчүн зарыл болгон персонал

Көмөкчү персоналдын ролдору, компетенциялары жана милдеттери
РольНегизги компетенцияларТиптүү тапшырмалар
Системалык администраторUbuntu, Docker Compose, тармак, TLS, камдык көчүрмөлөрорнотуу, жаңыртуу, мониторинг, калыбына келтирүү
CShark администраторуролдор, топология, түзмөктөр, орнотууларконфигурация жана колдонуучу колдоо
Колдоо боюнча адисWeb/API диагностикасы, журналдарды чогултуу, байланышкаттоо жана суроо-талаптарды алгачкы иштетүү
Backend иштеп чыгуучусуPython, FastAPI, PostgreSQL, NATS, миграциябизнес логикасын жана интеграциясын аныктоо
Frontend иштеп чыгуучусуTypeScript, React, Веб интерфейстериколдонуучу скрипттерин оңдоо жана өнүктүрүү
Сапат боюнча инженертест дизайны, API/UI жана регрессия текшерүүлөрүоңдоолорду жана релиздерди ырастоо
DevOps инженериCI/CD, сүрөттөр, байкоо, жеткирүү чынжырмонтаждоо жана жеткирүүнүн кайталанышы
Маалыматтык коопсуздук боюнча адисаялуу башкаруу, аудит, маалыматтарды коргоотобокелдиктерди баалоо жана коргоо чараларын контролдоо
Аналитик же Продукт Ээситалаптар жана кабыл алуунатыйжаларга артыкчылык берүү жана контролдоо

Чакан командада бир адис керектүү компетенцияларга ээ болсо, ролдорду айкалыштыра алат. Объекттин нормалдуу иштеши үчүн системалык администратор жана CShark администратору минималдуу талап кылынат; иштеп чыгуучулар жана сапат инженери жаңы версияларды оңдоого жана чыгарууга катышат.

18. Версия эскирүү

Колдоо токтотулганга чейин колдонуучуларга акыркы колдоого алынган версия, белгилүү чектөөлөр жана миграция жолу жөнүндө маалымат берилет. Мисал жок кылынганга чейин, керектүү маалыматтар экспорттолот, камдык көчүрмөлөр аткарылат жана интеграциялык ачкычтар жокко чыгарылат. Колдоо жана кабарлоо мөөнөттөрү келишим жана чыгаруу саясаты менен аныкталат.