From 15432e61f16a9fed9a831e1f860b08bce7bfa451 Mon Sep 17 00:00:00 2001 From: Oliver Sand Date: Mon, 11 Jan 2021 20:56:55 +0100 Subject: [PATCH] Rework system model diagrams as drawio files --- .../software-model-core-entities.drawio.svg | 3 +++ .../software-model-core-entities.png | Bin 7235 -> 0 bytes .../software-model-entities.drawio.svg | 3 +++ docs/features/software-catalog/system-model.md | 4 +++- 4 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/assets/software-catalog/software-model-core-entities.drawio.svg delete mode 100644 docs/assets/software-catalog/software-model-core-entities.png create mode 100644 docs/assets/software-catalog/software-model-entities.drawio.svg diff --git a/docs/assets/software-catalog/software-model-core-entities.drawio.svg b/docs/assets/software-catalog/software-model-core-entities.drawio.svg new file mode 100644 index 0000000000..032944659c --- /dev/null +++ b/docs/assets/software-catalog/software-model-core-entities.drawio.svg @@ -0,0 +1,3 @@ + + +
attachesTo
attachesTo
Resource
(e.g. SQL Database, S3 bucket, ...)
Resource...
consumesAPI
consumesAPI
API
(e.g. OpenAPI, gRPC API, Avro, Dataset, ...)
API...
providesAPI
providesAPI
Component
(e.g. backend service, data pipeline ...)
Component...
Viewer does not support full SVG 1.1
\ No newline at end of file diff --git a/docs/assets/software-catalog/software-model-core-entities.png b/docs/assets/software-catalog/software-model-core-entities.png deleted file mode 100644 index 60cb283802fe001bf0c1031df0d447edf02ab6d4..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 7235 zcmaJ`2Q*w?x4(KPT7pQ3B;t=ST)hqkk!X=3e$-L4Y@Dqbj!p503HhiKtvP(9Fs*6>j2;f0e}sA z08q*XfC~@vTJEX<0L7rO{(bGUvok60*G%^^8m7z0WNd5T zg5=fm@bJjU$XvU24FZ9LgoM!3)2F7U^7Hc-7Z;0&h#VXoR)=s>BJ5m^t9pDq|9#arf{h^4JokigKB~VpTLQd4d z_itJ{8g{O8h$vT&P)8}no55+1lFOcI-&I%9mDjzm>FjT9V5Mv2d0z|^$!kv4G*o3^ zq!*FAe&Hhb)7&7>2xr$IyR7#K8C7v{FT+sv$rZzBzh|C&mw6J3BWw}ofyoGNZf-d_ zxl2NPa!_eA7b7MXCMqf_ArZlQj{00Y9Ew`9w=J|8H2p2zO|FXzrB%d)WguU5W~$#- zGBq`2V`IB`@uIQq?d0TSTG87a92_<_Hfd>TSFT)PU|^u6q@)!yU}9nl3k#EylA@!d z6LicKbj+)0zP?KiABE!`T^JBYbLkejLxf%WKW(Eo?Ko!}SEs+1YV*l{o)Hby)>eL&8tqkd^OBcWg^6BS)NRUZeXlt* zHEvzMrodSS9i)!}G4o^dqelU2+Sj|8j?=xZBxc7djGIHsT(=S1*iRMD$nWF-qjl~GHOt0zem11F|Pfe z;%xSg_?d+NsqjTQo^6*m;J0CmesyTYJIMXK&4~kbBnMi3a(|iTRf21L*)k>Cm-NBE zyn^`az&vifXR_hWblm!JQbU636W(t9guc_*TyyWw9R}|flmo&y+O>ZKA5;~z&gwRL z+Xg)>36D_m7IM5$&tmJResVOvXLoqsZ}H@3x1^TD5P&p(PTmd34*`nDir)@OGxf2P0FcghzW zA6GVQ0Ao9hCNi+^)sJIe-Z0-`#a{+XriwApq=#AHiqqTz5buLn(eM!CJ z&esbtSnnc7T0*;b3WnKl@AHq)kJ^{z$04m{Z&L>QU}VRTH&tXxDIX&BHD%IIW&)3vH+wHMYb{Fq1_8*qd$5dDr3D zNZX+Y9YqpjlfqzVzUyz#T_x2J+4-!9bQpBcAZG2mezH zxf((wj%hp(1quh>i(}P*FiVaaI^dA1o81&baGf(P(m*S~C(gxEK;dxs<-MzeIdQ50 z>=llmDTLudM$Jz%CmmnDiKv}#Qk<@nIY zlW_TFt$V&w5H9f-|0XL4^v|69!qpw@31DW3MJj9}L%%5_dXaE;=#Be)>Py z2d^7gE&q~h2m)PSJ8f``6=u%gt?8ef4^+I_-p8Dh%uVGf+@No0VLfQ(`%9^6O2i1rgqA*Pc6dAxa zQS8OGP#B5Ei>QCN-iWow$~mSF$(5`BmY< ziq1JDBg%V6%%`mIxRzvxtp_d(lo^V0d?eg35m!lhr|sjqtA7s8^O0WWg?sgxuC!v- zL&_xFtF2f&#>$w(z4PW=_R#|l?-TE*qj=>aw)H(?78MHApW|-1WKwV`ZV;_dikUS9 zUyQFQ47)S5wplXw9_|rwGlW@=6sOubQDOg8RqMCS?G$pv1CX%Ex75F!V&~1%)hMLWf zt%a;s=C)(>pQB`HIvuAvUTAOP>Q#mQkmf9crLT3Pk5%+@qHxNgmGTD{| z6d9(;ZC&Q@@|A>+ZncdZ0KF~w zl4sJP($dWSC4@0s1A0kJ(wi_x`slC!Q~RwFn6SE`=OQdeS&2BVwl?Ot%XG)E!DRJ~ z2{<72M$Cfk>c#qVamUE37qHO3-ijW@`|*qmmEcp02!Y!n55zJCG#N76X~fVp4-(3g zSP_b5y^xBDVn!M`=+3E>o4HrxJFx^|uTuMcy16 z;(%u>dEzO3_WG34ckp}>&4Pe47OM!7byCh+vS-h~U+)VM|?EQMAk~^-m5{ z2WK8Nl9ougp80(Bnm}J1xBg~}n)zV&2M4-{K4H*=6CCiT$i}}HrW$ ztfg~6P81q6yoN7bPqOY3wZp58?=8*3K^XX|$MDi*5~&LFpO9XmW~UnFZ}NLFXGh z@mh|;boXtkQc3-8wFQ=Lzd^nT_T(Zp^0uE*0Gu@$BfeLQV|}ih6pZEB!<_{$0jVag z{($Ec>L=B*-lW{gjGR<0mA&}usx`4?`WeQhtcy69Fpx+~(Iu%hy!*9Z0{Cl3CTDL$ zhZ^!UVT-PzVcHxxEKYBkQptzm3mS>MoWKH?+LmkGB>@w0r zfM=^{%YHU0zY3}aGxs6Uy!w5=4B*wN$yAZQWq^!Kilw9@32=5k-l<=L@;K_*wwsrj zheM@QLA;>A=wTDRUr%ovT2oGRlePi>p6?lO410>|b7P-%I|tYf{3`qT)kK8muexuL zS_{295xg)5-r-)4SJqMLZOn>~gitk_P)xz3LAhc<`QUp`R4W8o*$Ec>rBBr=j`i#k z$d7^BBegU>>@P1_9d`iWq+gf1JK_^lmw&V_W>m?xrq_3E^uV8=C*h}aQNb+zT+5TmIx~nuiu`^~JMbA0mgO3G&O0ib z-L3ifZ7MTm#H&(yE!th-cK5L^2U=e-04LbM_1o)!uQsSo!y)@X_r;{^mF})%iiXZ@cvrE(&_w<1lYnIfxPsr_J1TlQdq}cJ$v(? z6B0Qo3LNi$URDcG_A7Y2@uTDMm?~7Yb5He$(5q3a(CN7$tj!v6G=L-R;3u0a8k5rA z)2JTGimy_yF>&UJVGjv@LmYSA+)@@8y?6t~`v4JtZ+1G1?T$;LO5&J>BE7_AT;n1l z|9jvs=ffXG-N~(E2>-UgAcE-tVWC!Lciwkxzi=9RFgH5CC8(s1JQ{5mh#x&U!LKZ+ zvtk?j{MwKCfYl`T?@or7POccv^;PxhPo4I@olMGpw+VNVR8>^}DJ9TDES33sBb(Q0 z=Up5p5l-)~rVyOzFr{`?#CKRDWb^ll&NmlxU(fwz7oo?J5eyZ{ zJgz0?a@&&kD|`yuki3{ueKlVWB{O(0X>vcnLth;Nn&^>k<8b3^p6ILf&Yg^kP4< zS7vGPR>o+K^WGScEj8Dqt>)DA`OIu^s|zV&mQ!^A%7V{Vxz$hZHK^8{J=xp*7U_64 zm%czWUvw-XUSZ4sh5WGH(Jl*I2>v`jMJE5`7Ns9GYg1RGK;@U@lwwTb3Fjl}e=K|W z7oDQ}T>5DfdZD~gu~M??(RIKx_vHtZTHFHxZZW%9RG{|H7o4fX(i6WkO~Yzm6y%yt z4mCGc74six>!wN?TrJb6A1L$yd2Dn#cKLkoy=kc-)P&KtPNom(yPFP0%fNbqaLP25 zRZg^|o`vTVw3vFVv0}%JUtek`7Q0k4XS(E@Jg9ku!>u@MSrHioh^$L!UU z8!yM8Xl&PqaW~(`A{CVvQWKK9M6r9)RirSBqmvV&og*B{J@X;*g^PH!!wb`53(9MT z?IZfeBNPcak%hD_?6jF}yI_m>hab z!2UJ2y&u)z=T;vG4jjFBBaVH5XMy{4RYoF>Gkx2_^Sm~Jj^;zrt9j|`4aus7HstEsn!H<+*X~CW zQIZe$;ppXB)-eKUqI-tIYE84nqjD&_ZYyK!on8uq8iHk4>{wptqHW&p$(3G==u5Jq zoWQp2lUBw$CwuH1;6VnNE{bw2*JT9ux}_tv_o;$x=bhm5X3O7&Ant-?4i)^y)$g>- zUVNQ*&Ll6_Mh6r*_1SQGUiJ6V@X;4n*ZB36&9zu`JGlMM;Z?p} z)tLqixqpm^%`Et9j4GnRxtkPii9D zM~^3cM9$o`glFW+1)IvOpetW0p|=@I?_-|>#f=@5pqV9Q1b>PkHc|;}e&YU4@h{$| zD8)A5uxE8Xuj2`Kv|#=I6pGaN7SHQ;?;qcr(jtqo>!zo45FF^T6J%+Z;tG9v~Iw`JQ=VNU~4X>}iR z+CPh*L1emQ1Z!z}rwzSru~oV#Ehnf{!+Cu1LG}+^mvCY*eST+gkRN^f?aoWO+AC30tE%+7>@14*1R3-1X zfFmwcsd{h;EBf6g2rN|i?GbhY{hjx7lR^~o=2eZi?DA4c@bdy9vzDZ#78BxphX3Xd zycNk_N)54^A^;Mtb#J^dOAPgvjBmF+xyRD;#D2Aq&#p($epNF6>CCiv2r=j153T9gYRKuF|M6&OlH1H=(55*8jrv0OBMXM?o+E6&H9W>_Ul-c&U*r?^=$tz03XNR< zwDjG3;{-!0y!U5BbPbAlN}9{>7EozC;tx6snoC+Bd~>;Av#X+t4=+zwvSn%5>r^7F zyYE4H!tOF5zKg;l*O4vAEF?BZ*V=`bMZwO77@Ez{jp4x<6p+CIoK;%NK)r zvjsKBx-}iV%d$~DshHkW^?R!1eJ-dux2))CN9Wew{`DpHpV+cA z2%VS>UckO%nm2%292emr4_rS4& z`5>vo-K;xW;q-qnSaxEqYx$-MJ9+PrhBMOKm*< z2k1@VjYph!r-NR(cAn{Mn;(z*#mfTS`Vaa~tJLH*|FKd24EO|P^u0=r&ghSz<^qoX zzasS8yP?EsL~{D+_F(VnV)6^bnP`aeY6rP?@qbdN$(ew-Zf~_?&I-B81sJb!22mLW+NB3n~9YO9d8E{Ra>D{xL+nUiBh3 z*OA&5NM{G6i;|O%3%LQLA<~eWQjnVv+4~TAC0S4jlof+Olpqih+UB$W=HP{Jc83T3 z-wu{m6k22l_CGVY1iHhOv=E*MpL-7-oLm4Ywp>a*vXbLJmD*$rBRJgG1qpx(Z<{)< zlC?blsWo;Fbn&!+xqG>I`?@2%0R<_=zpnkF`` + +
Domain
Domain
partOf
partOf
consumesApi
consumesApi
System
System
attachesTo
attachesTo
partOf
partOf
Resource
(e.g. SQL Database, S3 bucket, ...)
Resource...
consumesAPI
consumesAPI
API
(e.g. OpenAPI, gRPC API, Avro, Dataset, ...)
API...
providesAPI
providesAPI
partOf
partOf
Component
(e.g. backend service, data pipeline ...)
Component...
partOf
partOf
providesApi
providesApi
Viewer does not support full SVG 1.1
\ No newline at end of file diff --git a/docs/features/software-catalog/system-model.md b/docs/features/software-catalog/system-model.md index e9a801fcd2..f0ead20664 100644 --- a/docs/features/software-catalog/system-model.md +++ b/docs/features/software-catalog/system-model.md @@ -23,7 +23,7 @@ We model software in the Backstage catalogue using these three core entities - **Resources** are physical or virtual infrastructure needed to operate a component -![](../../assets/software-catalog/software-model-core-entities.png) +![](../../assets/software-catalog/software-model-core-entities.drawio.svg) ### Component @@ -73,6 +73,8 @@ these entities using the following (optional) concepts: function - **Domains** relate entities and systems to part of the business +![](../../assets/software-catalog/software-model-entities.drawio.svg) + ### System With increasing complexity in software, systems form an important abstraction