Predloga zapisa arhitekturne odločitve (ADR)

To je predloga ADR za EdgeX Foundry.

Navedite predlagatelje ADR.

Oblika:

Dnevnik sprememb

Navedite spremembe dokumenta, vključno s stanjem, datumom in URL-jem zahteve za združitev (PR).

Stanje je eno od: pending (v obravnavi), approved (odobreno), amended (spremenjeno), deprecated (zastarelo).

Datum je niz ISO 8601 (YYYY-MM-DD).

PR je zahteva za združitev (pull request), ki je predložila spremembo, vključno z informacijami, kot so razlike (diff), sodelavci in pregledovalci.

Oblika:

Navedite vse ustrezne dokumente primerov uporabe / zahtev.

ADR zahteva vsaj en ustrezen, odobren primer uporabe.

Oblika:

Dodajte pojasnila, če ADR ne obravnava vseh zahtev primera uporabe.

Opišite:

v čem je zasnova arhitekturno pomembna – kar upravičuje ADR (v primerjavi s preprosto prijavo težave in PR za odpravo problema)
pristop k zasnovi na visoki ravni (podrobnosti so opisane v predlagani zasnovi spodaj)

Podrobnosti zasnove (po možnosti brez podrobnosti izvedbe).

Povzetek:

storitve/moduli, na katere bo vplivano (spremenjeni)
nove storitve/moduli, ki jih je treba dodati
vpliv na model in DTO (spremembe/dodatki/odstranitve)
vpliv na API (spremembe/dodatki/odstranitve)
vpliv na splošno konfiguracijo (ustanovitev novih razdelkov, spremembe/dodatki/odstranitve)
vpliv na DevOps

Dokumentirajte alternative, pomisleke, pomožna ali sorodna vprašanja in vprašanja, ki so se pojavila v razpravi o ADR.

Navedite, ali in kako so bili rešeni ali omiljeni.

Dokumentirajte vse dogovorjene pomembne podrobnosti izvedbe, opozorila, prihodnje premisleke ter preostala ali odložena vprašanja zasnove.

Dokumentirajte vse dele zahtev, ki jih predlagana zasnova ne izpolnjuje.

Navedite vse ustrezne ADR – na primer odločitev o zasnovi podkomponente funkcije, zasnovo, ki je zaradi te zasnove postala zastarela, itd.

Oblika:

Navedite dodatne vire.

Oblika: