Versioon 1.0.0-alpha.1uusim
Peatükk 2.28
Laienduse avaldamine
Kuidas pistikprogramm või pakett liigub edukast ehitusest üksustesse, mis seda käitavad, ja kuidas see sealt taas eemaldatakse. Versioonid, väljalaske ülevaatus, kanalid ja paigaldused, allkirjastamine, muudatuste kinnitused, tarne identiteedikirje, migratsioonid, tagasipööramine ja versiooni kasutusest kõrvaldamine.
Selle lehe tõlkis AI ingliskeelsest originaalist. Kui miski jääb ebaselgeks, võtke aluseks ingliskeelne leht. Lugege seda lehte inglise keeles

Cold chain 0.4.0 oli meie esimene väljalase, mis küsis rohkem kui sellele eelnenu. See lisas e-kirjade saatmise ja ühe välise aadressi külmikkonteinerite hoiatuste jaoks. Ehitus oli roheline, testid läbisid kõigis kolmes sünteetilises harus ja ometi seisis see kaks päeva arendusruumis, kuni kaks inimest lugesid läbi, mida see soovis, ja kolmas kinnitas aadressi. Just nii on Nexuses väljalaskmine mõeldud tunduma: kood on lihtne osa, tõendid ja kinnitused ongi väljalase.
See peatükk käsitleb kõike, mis jääb rohelise ehituse ja kõigis üksustes töötava versiooni vahele, ning tagasipöördumise võimalusi. Edendamise teed ennast, arendusruumist testkeskkonda, sealt pilootüksusesse ja kõigisse üksustesse, tutvustatakse peatükis 2.24, Kohandatud vertikaali ehitamine algusest lõpuni, ja ma ei korda selle väravaid siin. Kõike raamib üks reegel. Juurutamine toimub ainult paigalduse väljalaskekanalite kaudu. Kiireloomulise paranduse jaoks pole kõrvalust ja keegi ei muuda töötavat kujutist käsitsi.
Versioonid
Paketi väljalaskes liigub kolm versiooninumbrit ja tasub neid peas lahus hoida.
| Mis | Kus see asub | Näide | Reegel |
|---|---|---|---|
| Pistikprogramm | version failis nexus.manifest.json |
0.4.0 |
Semantiline versioon; eelväljalaske järelliide, näiteks -rc.1, on lubatud |
| Pakett | version failis pack.json |
0.4.0 |
Liigub koos paketi läätsede, sõnade ja klastritega |
| Teadmusmudel | Mudeli enda versioon | 1.3 kuni 1.4 |
Liigub ainult graafi muudatustaotluse kaudu |
Arendusehitusel on järelliide 0.4.0-dev, kuni see jõuab testkeskkonda. Hoidke pistikprogrammi ja paketi versioonid võrdsena, kui need tarnitakse koos; see säästab igas väljalaske ülevaatuses vaidlusest selle üle, millisele numbrile tõendid kuuluvad.
Kaks muud versiooni on fikseeritud, mitte valitud. Paketi malli versioon (Cold chaini puhul domain-pack@1.6.0) määratakse paketi loomisel ja muutub ainult ülevaadatud muudatusena. SDK (tarkvaraarenduskomplekt) paigaldatakse täpse versioonina, mitte vahemikuna, nii et sama ehitus annab järgmisel kuul sama tulemuse:
npm install --save-exact @adverant-nexus/plugin-sdk@2.50.0Skills Engine'i oskustel on samuti versioonid ja need käituvad teisiti. Iga avaldatud versioon on fikseeritud ning live, canary ja shadow on versioonide sildid. Tagasi lülitamine liigutab silti ja juba käimasolevad käivitused lõpetatakse versiooniga, millega need alustasid.
Enne ülevaatuse küsimist: manifest
Leht Manifest ja õigused võrdleb seda, mida see väljalase deklareerib, eelmise väljalaskega: selle ulatusi, salvestusi, väljaminevaid aadresse ja liivakastiprofiili. Lugege see läbi enne, kui palute kellelgi üle vaadata, sest see näitab täpselt, mida ülevaatajatel palutakse aktsepteerida.
Väljalase, mis küsib rohkem, kui selle manifest varem deklareeris, peetakse kinni seal, kus see on, koodiga MANIFEST_SCOPE_WIDENED, kuni kaks ülevaatajat aktsepteerivad laiendatud manifesti. Väline aadress vajab lisaks kliendi poolel väliste aadresside omaniku kinnitust; see kinnitus antakse kindlaks ajaks ja meie oma kehtis 12 kuud. Teil on kaks võimalust edasi liikuda: eemaldada read või taotleda ülevaatust. Lehel on mõlemad nupud.
Iga sellel lehel olev rida jõustatakse käitusajal, mitte ainult ei vaadata üle. Iga tööriistakutset kontrollitakse deklareeritud ulatuste suhtes, väline aadress on blokeeritud, kui see pole loetletud, ja liivakastiprofiil ei luba muud võrku. Pistikprogramm, mis püüab jõuda millenigi, mida see ei deklareerinud, keelatakse ja ainus lahendus on uus väljalase, mis selle deklareerib.
Väljalaske ülevaatus
Leht Väljalaske ülevaatus koondab ühe väljalaske tõendid ühte tabelisse ülevaatajale, kes ei ole autor.
| Tõendid | Mida see näitas versiooni 0.4.0 puhul |
|---|---|
| Testid | 66 testist 66, kolmes sünteetilises harus |
| Kvaliteedikontrollid | Dokumentatsioon ja kood on kooskõlas |
| Poliitika | Iga lääts ainult kitsendab; isikuandmete väljad on vaikimisi välja lülitatud |
| Allkirjad | Kujutis ja pakett on konveieri poolt allkirjastatud |
| Ulatuste erinevus | Lisab e-kirjade saatmise ja ühe välise aadressi koos selle kinnitusega |
| Ühilduvus | Platvormi versioon ja baaspaketi versioon, mille vastu seda testiti |
| Mudeli muudatus | Graafi muudatustaotluse proovikäivitus: 1284 linki ümber nimetatud, midagi pole eemaldatud |
Tabeli all on muudatuse kommentaarid ja päritolu: milline konveier selle ehitas, millisest muudatusest, kujutise räsi ja mall. Ülevaatajad kinnitavad oma pääsuvõtmega. Kinnitavad kaks ülevaatajat, kes ei ole autor, ja seejärel viib konveier väljalaske testkeskkonda. Autorit ei loeta kunagi ülevaatajaks ja selline katse keelatakse koodiga NEEDS_SECOND_PERSON. Ülevaatustaotlus aegub 3 päeva pärast.
Vastake ülevaatajate küsimustele kommentaarides, mitte vestlusaknas. Meie ülevaatuse ajal küsis meie vastavusametnik, miks nõude summa oli liigitatud ärialaseks, ja teine ülevaataja küsis mudeli muudatuse tagasivõtmise plaani. Mõlemad vastused on nüüd osa väljalaske kirjest, kust järgmine ülevaataja otsima hakkab.
Muudatuspoliitika kinnitused
Väljalaske ülevaatus hõlmab väljalaset tervikuna. Manifesti plokk changePolicy läheb kaugemale: see määrab, millised teie pistikprogrammi juurutatavate osade muudatuste klassid vajavad kinnitust ja kui mitmelt inimeselt.
"changePolicy": {
"enabled": true,
"classes": ["website", "bff", "migration"],
"approvals": { "website": 1, "bff": 1, "migration": 2 }
}Kolm klassi on website (veebirakendus), bff (taustasüsteem esisüsteemi jaoks) ja migration (andmebaasi migratsioon). Igal classes all nimetatud klassil peab olema oma arv approvals all, vahemikus 1 kuni 10. Välja jäetud klass on reguleerimata ja skeem sunnib teid kirjutama selle välja valikuna, mitte jõudma selleni väljajätmise teel. Me nõuame migratsioonidele kahte kinnitust, sest migratsioon on ainus muudatus, mida on raske tagasi võtta.
Kinnitusi loetakse eri inimeste kaupa ja ettepaneku tegija ei ole kunagi nende hulgas. Seda toetavaid reegleid tasub teada, sest igaühel neist on oma keeldumine:
- Muudatuse ettepaneku teinud isiku kinnitus keelatakse koodiga
TRUST_APPROVAL_SELF_APPROVAL. - Isik, kes ei tohi seda klassi muudatusi üldse teha, keelatakse koodiga
CHANGE_CLASS_NOT_PERMITTED. - Kui mõni muudatuse sissekanne on allkirjastatud organisatsiooni agendi identiteediga, on kvoorum tavapärane miinimum pluss üks ja agendi enda häält ei arvestata.
- Iga kinnitus salvestab erinevuse ja peaharu seisu, mida see nägi. Kui muudatus pärast viimast kinnitust liigub, keelatakse selle ühendamine koodiga
HASH_MISMATCHja kinnitused tuleb uue sisu jaoks uuesti koguda.
See kolmas reegel on oluline, kui ehitate AI (tehisintellekti) kodeerimistööriistaga, nagu kirjeldab peatükk 2.26, Ehitamine AI kodeerimistööriistadega. Agendi kirjutatud töö vajab ühte inimkinnitust rohkem kui inimese kirjutatud töö. Arvestage sellega.
Allkirjastamine ja verifitseerimine
Iga kujutise ja paketi allkirjastab selle ehitanud konveier ning allkirjastatud kujutis on üks testkeskkonda pääsemise väravatest. Arendusruum käitab algusest peale ainult allkirjastatud kujutisi. Enterprise'is määrab administraator iga nimeruumi kas allkirjastamata kujutisi salvestama või neid keelama ning viib nimeruumid keelamisele ükshaaval, nii et tootmiskeskkond käitab lõpuks ainult kujutisi, mille konveier on ehitanud ja allkirjastanud. Allkirjastamine on osa ehitusest, mitte midagi, mida lisatakse enne väljalaset.
Kõike läbiv reegel on, et ebaõnnestunud allkiri on keeldumine, mitte kunagi hoiatus. Kontroll, mis saab SIG_INVALID, peatub. See ei lange tagasi allkirjastamata versioonile ega jätka märkusega logis, sest hoiatus ehituslogis on läbilaskmine kõigile, kes seda ei lugenud.
Sama reegel kehtib kõigele, mida andmekandjal üle annate. Õhkvahega kliendile mõeldud suletud kimp kontrollitakse teie avaliku võtme vastu enne, kui midagi lahti pakitakse, ja peatükk 2.25, Ehitamine iga väljaande jaoks, näitab käsku.
Tarne identiteet
Pistikprogramm tarnitakse mitme asja kaudu, millest igaühel on nimi: selle hoidlad, allkirjastamisvõti, juurutusnimeruum, registri eesliide, andmebaasi skeem, domeenide kogum ja muudatuspoliitika. Igaüks neist on koht, kus kaks pistikprogrammi võivad kokku põrgata või üks pistikprogramm võib triivida. Tarneidentiteet on üks allkirjastatud kirje pistikprogrammi kohta, mis hoiab neid kõiki, nii et iga kontroll väljalaske teel loeb sama vastust ja keeldub mittevastavuse korral.
Oma osa annate ainult manifesti kaudu: schema, db, domains, changePolicy ja hoidla URL. Platvorm täiendab kirjet ülejäänuga ja allkirjastab selle. Te ei nimeta kunagi ise oma nimeruumi, registri eesliidet ega allkirjastamisvõtit. Need määratakse teile ja manifest, mis püüaks neid deklareerida, esitaks väite, mida kontrollid peaksid seejärel umbusaldama.
Allkirjastatud kirjes on üksteist välja: pistikprogrammi lühinimi, omanikorganisatsioon, seda ehitav organisatsioon, selle hoidlad, allkirjastamisvõtme nimi, juurutusnimeruum, registri eesliide, andmebaasi skeem, domeenid, muudatuspoliitika ja lühike loend vanematest kujutisenimedest, mida see kasutas enne registri eesliite olemasolu. See viimane loend saab ainult kahaneda. Kuna see on allkirjastatud, saab uus allkiri kirje eemaldada ja miski ei saa vaikselt kirjet lisada. Allkiri on Ed25519 nende üheteistkümne välja standardse kanoonilise JSON-vormi üle, nii et kirje, milles on "Tomás" või "Sinéad", kontrollitakse kõikjal ühtemoodi.
Kui väljalase ei vasta oma kirjele, kehtib esimene keeldumine:
| Kood | Millal | HTTP |
|---|---|---|
DELIVERY_IDENTITY_MISSING |
Pistikprogrammi jaoks pole kirjet | 403 |
DELIVERY_PATH_REFUSED |
Kujutise saatmine väljapoole registri eesliidet, mis pole vanemate nimede allkirjastatud loendis | 403 |
NAMESPACE_MISMATCH |
Juurutus, mis sihib teist nimeruumi | 403 |
IMAGE_NAME_COLLISION |
Kujutisenimi, mida teine pistikprogramm juba nõuab | 409 |
CHANGE_CLASS_NOT_PERMITTED |
Muudatuse klass, mida poliitika ei reguleeri | 403 |
IMAGE_NAME_COLLISION on see, mis inimesi üllatab. Valige teine nimi ja ärge kunagi kasutage nime uuesti: jagatud kujutisenimi tähendab, et ühe pistikprogrammi edendamine võib liigutada teise pistikprogrammi podisid.
Migratsioonid, kinnitatud ja piiritletud
Migratsioon tarnitakse teie pistikprogrammi kujutise sees ja käivitatakse enne uue versiooni käivitumist SDK ainsa migratsioonikäivitaja nexus-migrate kaudu. Te ei kirjuta oma rakendajat. Enne kui mõni väljalase saab liikuda, rakendab sama käivitaja teie migratsioone ükshaaval failide kaupa ühekordse andmebaasi vastu, nii et ebaõnnestuv migratsioon ebaõnnestub seal. Malli varjuehitus kutsub käivitajat välja üks kord faili kohta, järjekorras, ja salvestab iga faili nii, nagu teeb seda tootmiskeskkond.
Käivitaja reeglid on need, mida väravad kontrollivad, koodina kirja pandud:
- See ühendub teie skeemi migraatori rollina ja käivitab iga faili skeemi omanikuna. Iga muu sisselogimine, eelkõige superkasutaja, keelatakse. Fail, mis püüab ise rolli vahetada, keelatakse enne, kui midagi käivitub.
- Rentnikufaili numbriga 0 ei muudeta kunagi pärast selle rakendamist. Rentnikuseadistuse muudatus saab oma revisioonifaili
000_tenancy_r<N>.sql, millenexus-tenancy render --revision <N>teie eest kirjutab. - Tavaliselt haldab käivitaja iga faili tehingut ja keelab selle sees
BEGINvõiCOMMIT. Fail, mis haldab oma tehinguid ise, deklareerib, et see käivitub lausehaaval, ja siis peab igal selle avatudBEGIN-l olema vaste. - See peab registrit, üks rida faili kohta, faili SHA-256 ja selle käivitamise viisiga. Rakendatud faili ei muudeta kunagi kohapeal; muudatus on uus nummerdatud fail.
npx -p @adverant-nexus/plugin-sdk@2.50.0 nexus-tenancy render --manifest nexus.manifest.json --revision 2 --out migrations/000_tenancy_r2.sqlPiiritletud tähendab, et igal uuel tabelil on organization_id, owner_user_id ja business_unit_id ning lisaks markerveerg is_demo, välja arvatud juhul, kui gates/demo-exempt.json vabastab tabeli põhjendusega, primaarvõtmega, mis algab organisatsiooniga, ja võõrvõtmetega, mis seda kannavad, ning sellele on jõustatud reataseme turvalisus. Värav migrations-are-scoped kontrollib neid reegleid igas failis ja migrations-commit-what-they-open loeb, et iga fail kinnitab selle, mida see avab. Teine värav on olemas seetõttu, et kord lõpetas vaikselt tagasi võetud migratsioon koodiga 0 ja tabelit, mille see oleks pidanud looma, ei olnud kunagi olemas.
Igasse väljalaskesse kuulub veel üks fail. scripts/ci/required-env väljastab keskkonnamuutujad, mida teie teenus käivitumiseks vajab, JSON-massiivina, mis on võetud teie konfiguratsioonilaadijast. Väljalaske tee käivitab selle ja keelab väljalaske, mille juurutus ei sea neist igaüht, nii et puuduv muutuja tabatakse enne väljalaset, mitte podi poolt, mis ei käivitu.
node scripts/ci/required-envOskuste avaldamine
Kaks oskuste liiki jõuavad inimesteni eri teid pidi, seega laske need välja erinevalt.
Manifesti oskus, tüübitud rida teie pistikprogrammi väljal skills[], tarnitakse koos pistikprogrammiga ja liigub läbi sama edendamise nagu ülejäänud osa. Kasutuselevõtt sünkroonib iga väljalaske korral kogu oskuste kogumi registrisse. Jätke oskus kogumist välja ja see keelatakse ning Enterprise'is ei võta sünkroonimine ühe vigase oskusega ühtegi neist vastu, nii et edasi töötab eelmine versioon, mitte pool uuest.
Skills Engine'i oskus avaldatakse teegist. Enterprise'i paketis ootab kirjutustööriista lisav oskus, kuni kaks nimeliselt määratud isikut selle oma pääsuvõtmetega kinnitavad, ning ettepaneku tegija ei saa olla üks neist. Kinnitatud versioon töötab seejärel varirežiimis, siis kanaarirežiimis ühes üksuses nimeliselt määratud väravate taga ja seejärel kõigile ning peatab end ise, kui mõni värav ei ole täidetud. Kui teie plugin ja Skills Engine'i oskus sõltuvad teineteisest, avaldage esmalt oskus ja laske sellel jõuda kõigini, enne kui seda kutsuv plugina väljalase pilootfaasist väljub.
Kanalid ja paigaldused
Kui väljalase on pilootfaasi läbinud ja jõudnud kõigi üksusteni, pakutakse seda kanalis ning iga üksus valib oma kanali. Selle administraator nõustub iga üleminekuga. Lehel Kanalid ja paigaldused on näha, millised üksused millist versiooni kasutavad, kusjuures veamäärad on esitatud ainult arvudena: näete, kuidas teie laiendus käitub, kuid mitte kunagi seda, mida keegi sellega tegi.
Meie carrier-sync plugin töötab korraga kolmes versioonis ja see on tavapärane. Enamik üksusi kasutab praegust väljalaset, üks üksus jääb vanemale versioonile kanalis, mida hoitakse kuni kindlaksmääratud kuupäevani, ning väljalaskekandidaat on kanalis, mida keegi pole veel valinud. Ärge sellega võidelge – üksusel, mis vajab auditi jaoks stabiilsust, on selleks õigus.
Teie laienduse logid ja mõõdikud
Teie paketi logide ja mõõdikute leht on piiratud teie enda töökoormustega nendes üksustes, kus teil on lubatud vaadata. Saate filtreerida üksuse ja keskkonna järgi ning näete arve, ajastusi ja olekuid.
Isikuandmete väljad asendatakse enne rea kirjutamist ning kliendi sisu, näiteks nõuete teksti, e-kirju või dokumentide sisu, ei kirjutata kunagi logidesse. Logisid säilitatakse 14 päeva. Organisatsiooni määrab lüüs, mitte kunagi teie päring, seega lükatakse teist organisatsiooni nimetav päring tagasi koodiga TENANT_BOUNDARY. Dokis olev assistent saab teiega samu logisid lugeda ja ainult neid: kui küsisin temalt, miks kõrvalekallete kirjed ühel hommikul hilinesid, jälgis ta 18 minutit korduskatseid tagasi ühe kai toiteliini dubleeritud näitudeni.
Tagasipööramine
Tagasipööramist on kahte liiki ja mõlemad on läbivaadatavad muudatused, mitte lülitid.
Keskkonna tagasipööramisel kasutatakse eelmist versiooni. Iga keskkond säilitab seda 30 päeva. Tagasipööramine valmistatakse ette väljalaske muudatusena, see kuvab eelvaatena, mida see teeb, ning vajab teist isikut; pärast kinnitamist pöörab konveier muudatuse umbes minutiga tagasi. Iga tagasipööramise kestus mõõdetakse, samuti iga õppuse oma, seega harjutage seda enne, kui seda vajate. Ühe üksuse tagasipööramiseks kasutatakse lehte Kanalid ja paigaldused. Tagasipööramise modaalaknas on kirjas, mis muutub (see üksus kasutab taas vanemat versiooni ja selle veamäära jälgitakse ühe tunni jooksul), mis jääb samaks (teised üksused ning üksuse seaded ja kirjed), põhjus ning kes on teine isik: selle üksuse administraator.
Seaded ja kirjed säilivad tagasipööramisel, seega kavandage iga väljalase eeldusel, et sellele eelnev versioon võib uuesti töötada andmetel, mille uuem versioon kirjutas. See on praktiline põhjus hoida migratsioonid täiendavatena väljalaskes, mida võib olla vaja tagasi pöörata, ja põhjus, miks palume igaühe kinnitamiseks kahte isikut. Mudeli muudatusega on sama lugu: läbivaataja võib ja peaks enne graafi muudatustaotluse kinnitamist küsima selle tagasipööramise plaani.
Oskuste tagasipööramine on leebem. Live-sildi teisaldamine varasemale versioonile on üks samm ning juba käimasolevad käivitused lõpetatakse versioonil, millega need alustasid.
Versiooni kasutusest kõrvaldamine
Kord tehtud väljalaset ei muudeta kunagi. Versioon, mida ei tohiks enam kasutada, võetakse tagasi ja parandus avaldatakse uue versiooninumbrina. SDK enda väljalaskekanalid järgivad sama tava: vigane SDK versioon tõmmatakse tagasi, mitte ei asendata seda sama numbri all erineva sisuga. Järgige seda, sest versiooninumber, mis võib tähendada kahte erinevat järku, muudab iga selle kohta käiva tõendi väärtusetuks.
Plugina või paketi tagasivõtmine peatab uued paigaldused. Üksused jäävad kasutatavale versioonile, kuni nad üle lähevad, seega on tagasivõtmine signaal ja tähtaeg, mitte väljalülitusnupp. Teatage üksuste administraatoritele, millisele versioonile ja millise tähtajaks üle minna.
Oskuse kasutuselt kõrvaldamine järgib sama põhimõtet ühe lisasammuga. Skills Engine viib kõik ülejäänud kutsujad pärast asendaja juhtumite käivitamist asendajale üle, peatab uued käivitused ning säilitab versioonid, juhtumid ja suletud käivituskirjed, et oskuse saaks tagasi tuua, kui asendaja osutub valeks.
Väljalaske kontrollnimekiri
Selle loendi loeme läbi enne iga Cold chaini väljalaset. See on lühike, sest platvorm kontrollib suurema osa sellest meie eest.
- Versioonid ühtivad: manifest,
pack.jsonja teadmusmudel, kui see muutus. - Iga värav on kohalikult roheline, puhtast olekust alates, ning iga uus test näidati esmalt ebaõnnestuvat.
- Leht Manifest ja õigused ei näita laienemist või on laienemine see, mida me silmas pidasime, ning läbivaatajad teavad, miks.
- Iga migratsioon on uus nummerdatud fail, piiritletud ja rakendatud tõrgeteta ühekordse andmebaasi vastu.
scripts/ci/required-envloetleb kõik muutujad, mida teenus vajab, ja juurutus määrab igaühe neist.- Tagasipööramise plaan on muudatuses kirjas, sealhulgas iga mudeli muudatuse puhul.
- Sel nädalal on saadaval kaks läbivaatajat, kes ei ole autor.
Viimane punkt tundub tühine. Just see on viivitanud rohkem meie väljalaseid kui kõik väravad kokku.



