Pereiti prie pagrindinio turinio
BilgeQor

Platformos inžinerija

Saugios serverinės dalies ir API kūrimas

Lietuvoje į NIS2 orientuotas skaitmeninių paslaugų atsparumas yra esamas parengties pagrindas pokalbiui su „BilgeQor“ apie saugios serverinės dalies ir API kūrimą, pirmiausia pateikus užklausą. Rašytinė apimtis riboja darbą iki aiškiai apibrėžto serverinės dalies / API komponento, duomenų ir integracijų ribų, testavimo, veikimo matomumo ir dokumentuoto perdavimo. Prieigai prie eksploatacinės aplinkos ar jos pakeitimams reikia rašytinio leidimo; nežadami saugumo, našumo, prieinamumo ar atitikties rezultatai.

Apibrėžtos apimties paslauga, prasidedanti užklausa. Prieš pradedant darbus patvirtiname serverinės dalies ribas, prieigą, priklausomybes, priėmimo kriterijus, eksploatacinės aplinkos apribojimus ir pasiūlymą; vieša kaina ar paketo lygis nerodomi.

Apibrėžtos apimties serverinės dalies ir API įgyvendinimo planas su veikiančiais komponentais, dokumentuotomis ribomis, patikros įrodymais ir praktišku perdavimo procesu.

Tikslus technologijų rinkinys pasirenkamas patvirtinus apimtį raštu. Tokie technologijų pavyzdžiai kaip Rust, Go, TypeScript ar Node.js, Python, PostgreSQL, Redis, ClickHouse, Neo4j, įvykių pranešimų siuntimas, OAuth2/OIDC, JWT, RBAC/ABAC ir diegimas konteineriuose yra neįpareigojantys variantai, o ne pažadėtas produkto rezultatas.

Tinka, kai

  • Apibrėžtam serverinės dalies, API, darbo eigos, duomenų ribų ar integracijos poreikiui reikia ribotos apimties įgyvendinimo plano
  • Autentifikavimui, autorizavimui, nuomininkų modeliui, audituojamumui ar veikimui sutrikimų atveju reikia aiškiai apibrėžtų inžinerinių sprendimų
  • Jūsų komandai reikia įgyvendinimo komponentų, taip pat bandymų, operacinių užrašų ir dokumentais patvirtinto perdavimo

Netinkama, kai

  • Jums reikia neriboto viso produkto įgyvendinimo, naudotojo sąsajos arba mobiliosios kliento programėlės, arba debesijos platformos programos be atskiro apimties patvirtinimo
  • Tikimasi pasenusios sistemos gelbėjimo ar visiško modernizavimo be apibrėžtų ribų, prieigos plano ir priėmimo proceso
  • Tikimasi prieigos prie eksploatacinės aplinkos, jos pakeitimų, saugumo testavimo arba nuolatinės 24/7 eksploatavimo funkcijos be aiškaus įgaliojimo ir atskiro susitarimo

Kam tai skirta

  • Produktų ir platformų komandos, kurioms reikia įgyvendinti aiškiai apibrėžtą serverinės dalies arba API funkcionalumą
  • Komandos, kurioms prieš tęsiant įgyvendinimą reikia dokumentuotų tapatybės patvirtinimo, prieigos teisių suteikimo, klientų aplinkų, duomenų ir integravimo ribų
  • Operatoriai, kuriems reikia veikiančių komponentų kartu su testais, parengimu diegti, stebimumo užrašais ir perdavimo medžiaga
  • Pirkėjai, kurie per apimties peržiūrą gali patvirtinti už sprendimus atsakingus asmenis, prieigą, duomenis, priklausomybes ir priėmimo kriterijus

Ką gaunate

Veikiantys serverinės dalies arba API komponentai raštu nustatytose paslaugos ribose
REST, GraphQL arba įvykiais grindžiamos API sąsajos sutarties ir, pagal poreikį, galinių taškų arba pranešimų dokumentacija
Pastabos apie tapatybės patvirtinimo, seansų, vaidmenimis arba taisyklėmis pagrįsto prieigos teisių suteikimo ir klientų aplinkų izoliavimo ribas, kai tai aktualu
Sutartos apimties verslo taisyklių, darbo procesų koordinavimo, duomenų modelio, ilgalaikio duomenų saugojimo ir migravimo dokumentacija
Pastabos apie integraciją su trečiosiomis šalimis ir vidinę integraciją, įskaitant veikimą gedimo atveju ir pakartotinių bandymų elgseną, kai tai sutarta
Užklausų dažnio ribojimo, idempotentiškumo, atsparumo piktnaudžiavimui, audito įvykių ir atsekamumo priemonės, kai taikoma
Automatizuotų testų santrauka ir pakartojami sutartų komponentų patikros veiksmai
Konfigūracijos pavyzdžiai ir diegimo paketas arba pakartojami diegimo etapai
Pastabos apie veikimo būklės patikras, žurnalų registravimą ir pradinį stebimumą
Eksploatacinės pastabos, priėmimo kriterijai, techninis perdavimas ir rekomendacijos dėl tolesnių veiksmų

Tipiškos metodikos pavyzdys

Čia parodyta saugios serverinės dalies darbų perdavimo paketo struktūra. Tai metodikos iliustracija, o ne kliento atvejo tyrimas, teiginys apie užbaigtą užduotį ar garantuotas darbų rezultatas.

Neutralus pavyzdysMetodikos pavyzdys — ne projektas klientuiPatvirtinta atliekant taikymo srities peržiūrąVaidmenys ir prieiga patvirtinti nustatant apimtį
Patvirtinta pristatymo riba

Komandai reikia vienos apibrėžtos paslaugos ribos, API sutarties ir veiklos perdavimo kelio prieš priimant platesnį sprendimą dėl produkto ar platformos. Sistemų, prieigos, duomenų, tikslų ir apribojimų vietoje lieka tik laikini žymenys, kol patvirtinama apimtis.

Metodikos struktūra
  • Patvirtinti paslaugos ribas, už sprendimą atsakingą asmenį, leistiną prieigą, duomenų tvarkymą, priklausomybes ir priėmimo kriterijus
  • Apibrėžti API, autentiškumo nustatymo, prieigos teisių suteikimo, duomenų, sistemos nuomininkų atskyrimo, darbo procesų, integracijų ir trikčių tvarkymo ribas
  • Užfiksuoti automatinės patikros, konfigūracijos, pasirengimo diegimui, veikimo būklės tikrinimo, žurnalų registravimo ir stebimumo lūkesčius
  • Užfiksuoti neišspręstas priklausomybes, eksploatacinės aplinkos apribojimus, perdavimo medžiagą ir atskirai apibrėžtos apimties tolesnius veiksmus
Iliustracinė perdavimo struktūra

Šis pavyzdys rodo, kaip patvirtintame projekte galima kartu pateikti dokumentuotas ribas, įgyvendinimo įrodymus, eksploatavimo pastabas, priėmimo kriterijus ir perdavimo medžiagą. Juo neteigiama, kad pasiektas kliento rezultatas, operacijų apimtis, veikimo be sutrikimų rodiklis, delsa, lyginamojo testo rezultatas, saugumo rezultatas ar komercinis rezultatas.

Pateikiamo paketo formatas

Saugios serverinės dalies perdavimo dokumentų rinkinys — API sąsajos specifikacija, testavimo santrauka ir eksploatavimo vadovas

  • Patvirtintos paslaugos ribos ir sprendimų priėmimo įrašas
  • API sutartis arba galinių taškų grupė
  • Tapatybės patvirtinimo ir autorizavimo modelis
  • Duomenų, nuolatinio saugojimo ir klientų aplinkų ribos
  • Automatizuotų testų santrauka ir patikros metodas
  • Pastabos apie integraciją ir sutrikimų tvarkymą
  • Konfigūracija ir diegimo struktūra
  • Pastabos apie veikimo būklės patikras, žurnalų registravimą ir stebimumą
  • Priėmimo kriterijai ir neišspręstos priklausomybės
  • Perdavimo ir tolesnių veiksmų rekomendacijos
  • Patvirtinta apimtis
  • Dokumentuota sąsajos sutartis
  • Užfiksuota patikra
  • Parengtos veiklos pastabos
  • Peržiūrėtas perdavimas

Tai tik metodikos iliustracija. Faktinį pateikiamų rezultatų paketą lemia raštu nustatyta apimtis, leidžiama prieiga, patvirtintos priklausomybės, sutarti priėmimo kriterijai ir aplinkos apribojimai.

Svarbu:Tai nėra kliento atvejo analizė ar užbaigtas projektas. Čia nepateikiama jokio kliento, sandorių apimties, veikimo be sutrikimų trukmės, delsos, lyginamojo testo, saugumo rezultato, komercinio rezultato ar garantuoto pristatymo rezultato.

Kas neįtraukta

Įtraukiama

  • Rašytinis apimties patvirtinimas, apimantis paslaugos ribas, prieigą, priklausomybes, už sprendimus atsakingus asmenis ir priėmimo kriterijus
  • Sutartų komponentų serverinės dalies ir API kūrimas, įskaitant duomenų ir integracijų ribas
  • Automatiniai bandymai ir API arba tarnybos dokumentai, atitinkantys patvirtintą taikymo sritį
  • Pasirengimas diegimui, konfigūracijos pavyzdžiai, veikimo būklės patikros, žurnalai ir pradinis veiklos matomumas
  • Dokumentais įforminta pristatymo įrodymų, neišspręstų priklausomybių, veiklos užrašų ir perdavimo medžiagos peržiūra

Neįtraukta

  • Neribotas viso produkto kūrimas, naudotojo sąsajos darbai arba mobiliosios kliento programėlės kūrimas, nebent patvirtinta atskirai
  • Debesijos platformos diegimas, eksploatacinės infrastruktūros kūrimas arba visos platformos eksploatavimas, nebent patvirtinta atskirai
  • Paveldėtų sistemų gelbėjimo, plataus modernizavimo ar migracijos programos už raštu nustatytų paslaugos ribų
  • Prieiga prie eksploatacinės aplinkos, jos keitimas, saugumo testavimas arba kliento duomenų naudojimas be aiškaus rašytinio leidimo
  • Garantuoti delsos, masto, veikimo be sutrikimų, saugumo, atitikties, sertifikavimo ar verslo rezultatai
  • Teisinis, reguliavimo institucijų arba oficialus atitikties patvirtinimas
  • Nuolatinis veikimas 24/7, SOC, MDR, reagavimas į incidentus arba valdomų paslaugų aprėptis
  • Trečiųjų šalių licencijos, debesijos paslaugos, infrastruktūra ir operacijų sąnaudos, kurios patvirtinamos atskirai
  • Terminų pokyčiai dėl kliento nesuteiktos prieigos, nepateiktų duomenų, neišspręstų priklausomybių, negautų patvirtinimų ar trečiųjų šalių nepasiekiamumo

Prieinami priedai

  • Papildoma API, integracija arba darbo eigos riba, kurios apimtis apibrėžiama atskirai
  • Darbas, kuriam suteiktas leidimas, susijęs su pasirengimu eksploatacijai arba našumo matavimu, patvirtinus sutartus tikslus ir prieigą
  • Tolesnė platformos, naudotojo sąsajos, mobiliųjų programų, debesijos ar senųjų sistemų modernizavimo užduotis pagal atskirą raštu apibrėžtą apimtį

Kaip tai veikia

Taikymo srities patvirtinimas

Prieš priimdami darbą patvirtiname serverinės dalies arba API ribas, už sprendimus atsakingus asmenis, prieigą, duomenų tvarkymą, priklausomybes, priėmimo kriterijus ir aiškius produkcinės aplinkos apribojimus.

Ribų ir techninių sąsajų sutarčių projektavimas

Prieš pradedant įgyvendinimą dokumentuojame sutartas paslaugų, API, autentifikavimo, autorizavimo, duomenų, nuomininkų modelio, darbo eigų, integracijų ir veiklos ribas.

Kūrimas ir patikra

Įgyvendiname sutartus komponentus ir dokumentuojame automatinius testus, sąsajų kontraktų patikrą, gedimų tvarkymą bei stebėtą veikimą tik patvirtintoje apimtyje.

Pasirengimas diegimui

Parengiame konfigūracijos pavyzdžius, pakartojamus diegimo veiksmus, veikimo būklės patikras, žurnalų registravimą ir pradinę stebimumo medžiagą, tinkamą sutartai aplinkai.

Priėmimas ir perdavimas

Prieš techninį perdavimą peržiūrime sutartus priėmimo kriterijus, neišspręstas priklausomybes, eksploatacines pastabas, dokumentus ir rekomendacijas dėl tolesnių veiksmų.

Atsiųskite, kokios serverinės dalies ar API funkcijos jums reikia, kokios sistemos susijusios ir kokį sprendimą turite priimti. Patvirtinsime, ar tai tinka ribotos apimties projektui, tada prieš pradedant darbą susitarsime dėl apimties, prieigos, priklausomybių, priėmimo kriterijų, grafiko ir pasiūlymo.

Pasiruošęs pradėti?

Atsiųskite, kokios serverinės dalies ar API funkcijos jums reikia, kokios sistemos susijusios ir kokį sprendimą turite priimti. Patvirtinsime, ar tai tinka ribotos apimties projektui, tada prieš pradedant darbą susitarsime dėl apimties, prieigos, priklausomybių, priėmimo kriterijų, grafiko ir pasiūlymo.

Dažnai užduodami klausimai