From 7693d31bceecc4ef2f7f1a77f6e41b18349ea10a Mon Sep 17 00:00:00 2001 From: Rodrigo Fernando Silva Date: Mon, 11 Apr 2022 09:42:01 -0300 Subject: [PATCH 1/3] add documentation stack --- about.md | 0 pictures/studio.png | Bin 0 -> 5728 bytes stack.yaml | 12 +++++++++++- useCase.md | 0 4 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 about.md create mode 100644 pictures/studio.png create mode 100644 useCase.md diff --git a/about.md b/about.md new file mode 100644 index 0000000..e69de29 diff --git a/pictures/studio.png b/pictures/studio.png new file mode 100644 index 0000000000000000000000000000000000000000..16dc6f899c0c2d2b1dee3e0a6d8f48ebd0be4bb5 GIT binary patch literal 5728 zcmV-m7N6;fP)h<^000WwX+uL$Nkc;* zP;zf(X>4Tx07!|Imj_gnSr*6N_oat~l0XEcgx--(04bq|B1i{O2}wvoi6J4Vhz%JW z!LcAB0ycC+M8VM!kg*^ZEDVCZPmn=DT?Y#`RQ3xjVP^L1?%8|J%ln<1`|i8<<$d4z z2LN&?TP)6o)d9#6Zm_NxM z6`Vf7XwpPXTucDMbO7)qHe136fMkpK>G>Q!l82<|!9m0oiV!YD*oPxva}hp?ux(Dx zA_Wg2Y>C8+0U#r%0~qOl%E|vr{&Z!2Hk+^H$-X8GA1IWHv)N1k&!hR@mXj@;+QS?f zB!MI}MzJ4qes{ALg)3Qp?G%##MiPO)TBjB>9GNdR+-*^-HUi3rPOS@BB0fX7niFA&5fPI104Va^mwvtq-i zV*-?Zi7ZB0KTj0mKfQ0TviBV6pZXQDlxy<@aiPlI+0*s&M9k@&(j;YVTwY+%bWFT5 zUYzHz+)JDtt&HbohbaBh{8;7MJmhjtuZ>ooVJ15)dWwM%L;^P8(AB00fIQxkJVhe` zi^NMMLcSo6&P1Lz9-SrP*xS;b9Gsj0P&~Vn*WoQ~;+ceKSEhZr9RPTgB2NCak8J|L ziKhTi-%tBY-XK?L69A`rIWkH9qz|q5z#zY#8uC`q0S3sM!4lX3C*TIWfFB3~VIT^` zfn=}%sZ{`SfCMZCgm*`XMy08|tz1(ku4pjMztQI)7VR1>Nl)rGo&lA~UtKB2K_ zDw>YALwlh^(eY>wIv2eHy&heSK7ejPpGV(7_oGM9-!Np19>xaaiD6-qFnr8nObMnE zvmbLDa{+S;Gl+SQ#bRk#3#>af6q}6A#4f|G$L_#3V>_^Y*a7S)4u{jh+2Fi!Q8+d( z4_AWQjyr@qgS(C!#C^o8;0^Ik_+WerUW6~gSK<%iPvfuSpW(*{>I5@_Cn1W!B`hUu zBP4~cJ8R8)*rJXGeY2vt_8RH+Z2M|4M&YAjU0{j z8V5BlYYb6v6mv=tg-a=>?4_Ke3{X*26KVjJLtR7NN4-ED)Wm99XtFdjHOn*)YxZc4 zXi>CWv=X$IXw_()(vs6qG;UHal>Ko{X=!^BY>z~tqX+SgZGsrZkFgR^6Y)CcqF%%kB7@jeFPS>I{>Dlxu z`g!_@k)Bbgk<4h1QIFA>v4wHGaglMe@gozW3Bx4Aq{5`rWW?0aG}5%tw9)jw8NrNU zCNSG()@Am=+`>H3e64w_`H+RS1Hrd_^Wqg}r}%|61u$iCJ7)hyFlDYG`u z>YDYur!^_Sq z%j=-m&}@s@yxIF^4|p4Uv%U9t%YEoRX+FDsY&HL#=-pH#^8|<*N|l)9if=e@X*bn zcUbx?4y%DR66PMZJnVcpDLgj3I{Zn5b%Z3MJra%#i`)|VaE{p=(VW&O5XFkx67?wB zB04wvm$}%v(Q|9&K8&LC&4)eTu<-BJZ-WlZ?Lws-k7XGln zS5PTQUA)<(~MCTV7ELyUtPi!MD5zBKu zbGPP>NWvxirI2*Kv@K5)5lP)LOWAj_{(PVOn*5K86BZv^qOnA@q*|8nN?Ju9FU=_@){nyf5dIk+lh)q&N-)mf{5EpjL-FM78oaZP)% ze(|c}f$u`TYb;SMk(At7>$P^*_vr71-}kI@UblVSw^DBDl`@C2%Cax(IqR?d;P^w; z591p$HuP+C+qiQRc9Uq+?ajWM50q<^7nBcdiQLjsL9ZySc(--o*2|SHmAkePx5>82 zt0Jn}wwrF>wEau9p!!yge@%0(UhTTt4?DO!uJ82Q*|bZ4SJ|%5yM?>&?g`n`QfFRQ zxfi=PfA7jB%{#XS1Jck5iAAwm>aQTSi(1t@5_yw!RZ# zCpz1`+K>NY|4aQzqmwnKv`%e2O*~zEdi+emnb8h$$IG+)vjd$AJ0F}&I(PH@-19vb z!Y^F97<}=;8-9eYN`9{w@65!||N)aWPxMo{$14WWX620KBP3v~e<`9S~hk zoHwbhCk&eWKQKYyKk=mgo-j86>iqzSUj;w}qEU7t!wg{(GAkreoF9Olot5KXCe3hm zn#@H)lqKfl`1o6W0C4R9e3gukkL?&A|GEz;_8tHoxs#e+VOT`V@1`iI+n}%z{LLoy z{-1jM`wSEnxPZUU{{*ki7-1c4-#-8V061k>NoGw=04e|g00;m9hiL!=000010000Q z0000000N)_00aO40096109>F000aO40096109*h7002V3>m>jH3jIk$K~#7F)to(y z9JdvKZ)RtA@5gW?Kt98;aKZ(Fr2v-zIU$e>9RjGZQUy{Q6=|X(Rf?o>k;+AyG)j}g zZsjg;05`S^Bf$v>ROnpTfaL&zAVESBMS&7qx3{-{laI?gE_cY`aQ^mo7Ym8QAs@+a zA0HndXD(R(>w8Nl^l5zEQ7sQ&URCLQi8v1TyTK@))Cz;q+HxEOlboEXFlYHWD_#Q; zM!3jO>LIeoP--Irlt`c070!(~4B~b(ZblW#oQSHE2(8pLeXx9Cw?7$1g{hi})CfgD zh_w}=Dk$|6sToRDAe5Y$5DEH&sJMfm`Z}Gc$w;AhmHQ*p9T!&+2@iU8*%Y(AQaLju zLO&M)%4~@&0+g8(nR_TFL1ez6oDh+Cxs}7CjiYF^(p)OB`{YOP{df?GJN@1#U-drz zibQy3t#M(!eSM3BZxhFBjb0uiqgIr|4G#u`aDT|Iyml@gL`Ki{_ka6o{A^ziiObQQ z2gCbMSKq$k$wjWdCJ}P-tve7*L5TRB+C{(DIO9>(p z0m{N`a^Mg{7<*`X898fIj-N+6-B-z_`gt_nis+&dLrcsWH4Hs5eDplJu&(FmX_E+d zgKn?U?WtmZni7lyeBmU(SG~SeL_`fNEfIL^-Tj~lnDuhW+}HT%2;IcWI@CmrBaN1p zpJVlrT=d?fFO6>wG-<_?h?-O`G;3t__O-2v99wGCZia___gaw$3T=$_MdxB`w_IKc zBCYFN&7Dnm^KmO0wlYTTJ$+PD#ynDYk_pWQC2yr&mm{*Ar6y_3Ci3$`L4f2EH4?I> zE`uO$HK%eiFXn>?-ONy=)PcZdwVismz>T>fQUc2HuDODg2Kn9y*m#EyAKBUpJw&} zK+*PD%Wf@>gZ@xdZ#MK(PS4esddoL2wJv8^*39mi1&TnymF~QIS8c{jp=mkI%bON7 z)1^$>q!LFTfX_`=;8DJod-T`H#SbQS~oUM`4py1 zJ}4!L$Ub3f;9_>sp9s|l_nsX7=?l+6%3>&KrfVll=2(&m=akVAHGsI&JGix**vr;U zgw_u~_`=5mQqmU+oj&}e_^eSxWCCdf&GbxqoN1((dTa0exPXqRhG<2l9f>GlBcOeV zIW9FUn^)_JT0<mZF0%YWWkqYZ9p zgzMn(iNx+m{~Y%5%3{M?W%bod>1oEceB%dt4g=t_wX@m1z1K_8FF>fk$LL{3UnLP% zz3%&;=?&#g)2L4s+w_qR)pYH&*@y#@Afne>zOkL=xlv592wrhTn-vkyP@~>~MB23O zi30M{2E{1ITrl#EGBTT4xp^tAuF7ZFY3#y{)7TNFVR<4nhf=FX9f^?m0$)6CMWA!ov3sQ0@o;Tua7!l8g zF_39iLrK6v2#n(xel&QgGWb_$gwhuPv8g#C!cj(6ELzF2CXm*;wzcY^v$Fb;^Trya zEUr+Tc5>JM%`g7w=ot|}My`fr_6(caxphY^My74ntI&|r8q!wl81MHFe!rWkr-((= z*jE(GqUXmK3MWq(f45MYk1o8*q~K>~e{2>Wd?_TbY^yPwWqfiVMSn(*o@W*=Km?h- z@f7UBK^7GH+TVN37rDZAZk!f?F089*LKq=)7?}m?CXxe6^WxdVjZ>b^4{}j#z7i0V z3k#>y$sBoFff*2?>Bid6f5LwRdye8g_?H-6o867R|C;bS`{S@sTCZ*S&>8GK!5)(s z&z+X7RCeBMh|rH5P}tqVWpMXV0WNaHD4JNRf+hFSj1|w!h~$Gp>F`@C%{R~W_ns`3 zSR*mmNI*`|bcVh)HvUAgU#q|V5#~&*J)Inf`+~txP7dq8IW$GeMqk=j&*OKDulSMmS4gU|ojy7C=I8Feck5h69Oy{zh*3Gwh_Z(wDiGIK+b&0rcN8hWg}53>i3 z9Ju(*Bg|0ecYpC&eT9yAJe&d)N3Y~9-zC{9hY1l3@%VK4-1*0fehcs3|Q(SO*b0Okl)3_T`Z- zPWTihUnr;p1L%*VD*PxAH z`KsNZF*K3ExtAiM3UqIO1}t@%mSA;czngZ~-0am(M0Q0Uhii`j=#L?Jg;9q09-E_* z7QxInbDCP*#JsEL)Io%w)BHt6qv>31(?{bcdpt~uys>c?Ap$zi0R(m6aLhAgGx@aw<+@|2}Ok9jExUdU|{1iRu+Qt_Q0Cz?r&i=v7_U$0O6CB^xhQ61&rRFZJ2h z;LJ-(j$O%>Aisnpf)eROR8>$~BJjpM^0Fz8kQ&Ou;*!P%1$KL1a$QG=S>#M}NlqV21tL-7XG|EO^)5tS{OUtCzR~vU%6u@B@y#tiizY(Od@_7iF|D3G zsb)+0wU_U+xeX&(INwtTt7n_P$Fl_ItKmo}%KQz;-8h9!Fdp9;#|g zI)~X(#jFX&$@5GcmHF(X+c&l$Xq7X`3<6(Gk#&}@Z|ph6?tD9;Aca& zI{QSuM0opc_CqS!V% z2sz$yaT0-8@`-CfamFA1_!&`Q?SRf~p9q#CEC7)lZx3b>p>^YlYqLl7=kQ12^aDDx zL4q%7P%0-v>vJ)E^n)mq2sz@U(Fo=KDq8JWa>+i z)^ZY|iIcV|(+4heDAT^=#nu+5ZEEz|QEK SfHji<0000 Date: Wed, 13 Apr 2022 09:47:10 -0300 Subject: [PATCH 2/3] add documentation stack --- README.md | 2 ++ stack.yaml | 6 +++--- useCase.md | 17 +++++++++++++++++ 3 files changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b621b24..8a438fd 100644 --- a/README.md +++ b/README.md @@ -1 +1,3 @@ # zup-kotlin-stack + +Stack para criação e configuração de infraestrutura AWS EKS e criação de aplicações na liguagem Kotlin e framework Spring com opção de inclusão de capacidades extras como observability, banco de dados relacional, messageria SQS e Argo Rollouts para configuração de deploy canário diff --git a/stack.yaml b/stack.yaml index 13bb9ee..6777f1c 100644 --- a/stack.yaml +++ b/stack.yaml @@ -1,6 +1,6 @@ -description: Stack que oferece a capacidade de construir aplicativos com Kotlin e Spring, além de fornecer a configuração mínima para implantar o aplicativo no AWS EKS via CDK -name: zup-kotlin-stack -displayName: Kotlin/Spring Stack +description: Stack para criação e configuração de infraestrutura AWS EKS e criação de aplicações na liguagem Kotlin e framework Spring com opção de inclusão de capacidades extras como observability, banco de dados relacional, messageria SQS e Argo Rollouts para configuração de deploy canário +name: zup-kotlin +displayName: Kotlin + Spring Stack picture: "pictures/studio.jpeg" category: Backend compatibility: diff --git a/useCase.md b/useCase.md index e69de29..305b9db 100644 --- a/useCase.md +++ b/useCase.md @@ -0,0 +1,17 @@ +### Capacidades da stack + +#### Base dados relacional + +O **relational-database-app-kt-plugin** funciona com base no Spring Boot e Spring Data JPA. +Ele adiciona as dependências das bibliotecas necessárias, o driver JDBC referente ao banco de dados escolhido e, caso opte por uma ferramenta de migração, sua dependência também será adicionada. +A configuração básica para utilização do banco de dados relacional é adicionada nos respectivos arquivos do projeto, assim como o código CDK para provisionamento do RDS na AWS. + +#### Metrics + +O **metrics-app-kt-plugin** é um plugin que tem como objetivo padronizar as métricas geradas pelas aplicações. Ao adicionar o plugin na aplicação é possível escolher se as métricas serão enviadas para o [AWS CloudWatch](https://aws.amazon.com/pt/cloudwatch/) ou para o [Prometheus](https://prometheus.io/docs/introduction/overview/). + +#### Tracing + +O **tracing-app-kt-plugin** visa padronizar o *tracing* gerado pela aplicação utilizando OpenTelemetry para exportação dos dados. +É possível escolher se o *tracing* gerado será enviado para **Jaeger** ou **AWS X-Ray**. + From ecb2ef36d1fc4d358a562302fb3c0527253fa876 Mon Sep 17 00:00:00 2001 From: Rodrigo Fernando Silva Date: Wed, 13 Apr 2022 09:51:14 -0300 Subject: [PATCH 3/3] add documentation stack --- useCase.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/useCase.md b/useCase.md index 305b9db..252ba44 100644 --- a/useCase.md +++ b/useCase.md @@ -1,5 +1,14 @@ ### Capacidades da stack +#### Infraestrutura EKS + + +#### Aplicação linguagem Kotlin e framework SpringBoot + + +#### Infraestrutura Argo Rollouts + + #### Base dados relacional O **relational-database-app-kt-plugin** funciona com base no Spring Boot e Spring Data JPA. @@ -15,3 +24,7 @@ O **metrics-app-kt-plugin** é um plugin que tem como objetivo padronizar as mé O **tracing-app-kt-plugin** visa padronizar o *tracing* gerado pela aplicação utilizando OpenTelemetry para exportação dos dados. É possível escolher se o *tracing* gerado será enviado para **Jaeger** ou **AWS X-Ray**. +#### Messageria + + +#### Deploy Canário \ No newline at end of file