From 319a7b389c896ad7b41305b2961a5358798ecd02 Mon Sep 17 00:00:00 2001 From: Eric Date: Wed, 20 Oct 2021 16:30:08 -0400 Subject: [PATCH] Update Consul ECS documentation with health sync changes This also switches the task startup image to an svg so it isn't pixelated anymore --- website/content/docs/ecs/architecture.mdx | 23 +++++++++++++++++++--- website/public/img/ecs-task-startup.png | Bin 10694 -> 0 bytes website/public/img/ecs-task-startup.svg | 4 ++++ 3 files changed, 24 insertions(+), 3 deletions(-) delete mode 100644 website/public/img/ecs-task-startup.png create mode 100644 website/public/img/ecs-task-startup.svg diff --git a/website/content/docs/ecs/architecture.mdx b/website/content/docs/ecs/architecture.mdx index e3d9dcb345..b6e262832e 100644 --- a/website/content/docs/ecs/architecture.mdx +++ b/website/content/docs/ecs/architecture.mdx @@ -31,12 +31,17 @@ at startup and sets up initial configuration for Consul and Envoy. This diagram shows the timeline of a task starting up and all its containers: -![Task Startup Timeline](/img/ecs-task-startup.png) +Task Startup Timeline - **T0:** ECS starts the task. The `consul-client` and `mesh-init` containers start: - `consul-client` uses the `retry-join` option to join the Consul cluster - - `mesh-init` registers the service for this task and its sidecar proxy into Consul. It runs `consul connect envoy -bootstrap` to generate Envoy’s bootstrap JSON file and write it to a shared volume. After registration and bootstrapping, `mesh-init` exits. -- **T1:** The `sidecar-proxy` container starts. It runs Envoy by executing `envoy -c `. + - `mesh-init` registers the service for the current task and its sidecar proxy with + Consul. It runs `consul connect envoy -bootstrap` to generate Envoy’s + bootstrap JSON file and write it to a shared volume. `mesh-init` exits after completing these operations. + +- **T1:** The following containers start: + - The `sidecar-proxy` container starts and runs Envoy by executing `envoy -c `. + - If applicable, the `health-sync` container syncs health checks from ECS to Consul (see [ECS Health Check Syncing](#ecs-health-check-syncing)). - **T2:** The `sidecar-proxy` container is marked as healthy by ECS. It uses a health check that detects if its public listener port is open. At this time, your application containers are started since all Consul machinery is ready to service requests. The only running containers are `consul-client`, `sidecar-proxy`, and your application container(s). ### Task Shutdown @@ -77,3 +82,15 @@ token does not yet exist. The ACL controller stores all ACL tokens in AWS Secrets Manager, and tasks are configured to pull these tokens from AWS Secrets Manager when they start. + +### ECS Health Check Syncing + +If the following conditions apply, ECS health checks automatically sync with Consul health checks for all application containers: + +* marked as `essential` +* have ECS `healthChecks` +* are not configured with native Consul health checks + +The `mesh-init` container creates a TTL health check for +every container that fits these criteria and the `health-sync` container ensures +that the ECS and Consul health checks remain in sync. diff --git a/website/public/img/ecs-task-startup.png b/website/public/img/ecs-task-startup.png deleted file mode 100644 index 6b9e587b2c607d313e7b4c7849e1d7f226c42f6c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 10694 zcmd72c|6qJ8~;Bl5s8YrMYJ!p$(DVq6xm`-(U9!R3>iiYL$=ah$W9c>F!m9{SWEVG z7{*Y_K0{dsGnU_(`*T0;JNqmu!8Ny{?I!LUc1F3f!f?lCFkYS6juI~L`yqeL8Sv}Q<2-%{B#3f|z6k<3K;Y#} z?BVJElP^_qSrphsObk^9zLt=N;jbwz)=LH!F=`(ODpCmueWg86qR)(>EdGgv#>&qS zOj+^m>P@oue%>xoqV|yjF!3^u^RY@OhsILWSgZUDiH-LiOY&)^_Z6Bx58-2{A z&Ydm)sg0`U-uv-EK@u4U%M?Xjem+ejQc*p**6uF7_@vRLXqc6APmbkS`KF*eAvD)l zNDiFX^JKq@!pPnE4&8*|PmeR5*S|m4perp7pq?wy^J<%?ax0NAy|I=A$Hv#EUHL?$ z?96j4M#{B|z;utdd^|&>pBJO3ul%fyVutbW%}B)MLvyWY%%?gOTCpoEzVy9$PW=89 zb9^LqVO!8GADTBaC18jYz;Gc+RA3erNur8#7*CpW}dZs?yhCI(t z9usd=z-BM zhv{oa3-fSd?Jndjd$!kjd$rp3uaesTJoKdg7QQ{FVn_M69J>~Kd$Vyb9&XxSxVdK9 z8Z3Ub!9&)eZ4e&8f7VtSUgnj5Uspx8IZ35=`+nta;nNn~*om5O0kMJUm%5bICQ{9G zUBqsN%xXc`yQ`62l9j8>1kAo5p}!X(E)34VvA!IBPI13(y43O3?8EiZv6MhG(SaX4 z6kVFW)ml71w?68m=|C4GGzjFD2UQsc32qZd(7NC_ovx=;6w%x~}QOxJJe{$NUTfM_aQqHqg6vJPA&WBJW84U-0R zc;4C8KV$mw?>Uv%rm_5EH+yBSO~c18T-Wx5@tYvuiS(EO9Y~Pdqdfit!s}iXwZAfq zQjpe>VD`VXDBOqa)>f8BpDGTXQ}dfYcUbqCT;SSrCiPRcMR8;K`WidKwHH4cBB*{2 zAc^dm`}ROG9%PDyHg$G09c+1e?kRA1w*PgmN_F{1j> zpls#(8m94X^zm^&PKI-~CZcl?))jum0oVgJK7-}H8P=6pbh(rfrO?r6I93eZ3l6Wf zQQ)zzdzCA*`g8Qcw*FE!qh#p%v&W>@KGOrGXm$BqH4IaZ6W+rWk4L{1_gWR^`mV1o zQhWO=Fg~47NMPxD3Rl7InlnONd~OEua`{@g+ttAtS6&`s&Wtoh>u>YPC9$#^V$P;; zGL_q^OKYMMB9OZzs3xy90OT`+U&EgmLm~BjjwuLp{H?fgTzjITyA{R&eiqE&m{GFo z=tzvU;k@tUhfI1Y-{S_-(l9?2Uv(Os6p=D9c^5mjq<6Q;=*RER3Ii+0(;n~AFr(!q zSc%p)$H}(bbWF0RKHhWMWlY<)y|kfKZSfYW%Rn*i@mbOZd-d+Xm8D;VHjq7&J+BFJ z`$0a7->uupT-OcZ5kw1efiUJi^hW2w4uxB4;JiDGwI&e^aM^stB{XzGfcl*}UNNLA zI7u+XB}I2=js=;?W>Vb|mO^OMNTYp!v8$s3a=@w9i_K&pFbN6>H;oFzZ#7{p_A&6+ zH;SPjO}};v5)OE+?Y1dFPzi)w?GJ+qD~pxu#WSTh3murg4mLh>qb;LRriS?kefo=> z2?hsQFLfpIS6PcQ?$nDmuwJ}r=ChkcPA?H%-oj6$p;=Mmx}uw3kiPEKT-CVZ&0wu} z7T7lpAT^KdMBmqO1F3lQU8Lc85h*hd!8jg?dsPE>>-RG`X|q&m_RHZe|HSu_7c8FU zSeD=eBtmJAM5Ht3yL4wQszC)J1mH!i7P=mJ7NlTV4O?%7*=EF*6mt zMNScMuX@R=6;A|M%X4E!s_R4>m~HQ2-mR+l z>KHpi;j8e#EdLV~p3(>Oc!^a9GtOm7id&FrdslCpT+lZHF@%^1*AhN z2Yx(g6q(oYtqm6-Yy$ZjybMclPPb_m~T9)!?Kd4b_+J z*hAMiMKDl$g0>lQai`7R3w2&|QJc(jtttj|wz1w@2Tb~34?3uuI zm6iqCgTcrX^o$Zue3?zyaMjQ@q6Lj_O?2tY;xGNgv7puql*6G55{Sg8?*bX?>dNGQ%+!OK}XFNjoN?p?MpNiJ;T z*&*%}5{taSZ;lZWcPA}7P}e}6>?dT0!vjv^gYChaS^!e*4k((*Y3)^TOjC1PC}VnOs^FN zk#-tq1FM9L%TE($)GY(!%4g0(4q(74?Rd|~#q&+s zET_e-3mPDeFm#t2j&j`;Af`br!_;#An(`|%F&N9bb%?Ub00-??(qiy^1f-c9V8Hl} z0Rb~2Dpg?|Sdqb;>6R}J(asa}00a}hUGz@i!FIiTbCUP&c$Sl5_>a}l!hPt4rjSvy z-uBwlGzi2_BNTq%P|>UR2Nv6P1mj+xw(NJ`jMCq8QL-2p`Uc=ohGhwoY1#YgWZnmL z1qwzXZqn_6pk#7q#y$&fGlW*gs(bOPsZPBDW_86_GKP-d=_klH?w52M>fM!Lz+4v8 zSb5>+xwXh83xfNVb?bXh$zZ{Z+MB6yKfnDQYajja?q2#C9=ZEPy#%7I#`zV3-$=BV z)C=ramP)*bpp!QX-feg`-fF;I%~kg|ZA!=q zitfq2tclD&KKl8on4?Sg`)?aJ`WyfsRKwAj4GZOQr6pO7>Oa?_h(x_+Q1WZTpA2Ey zEoxC8lu)A-RPE1&Uh4$?vlZQl-_|imXR^oAT^@)ybV8xqL}&Uj-Dlz%a3Xp-^%@P! zW-tc;-yG>5#Ig}{)jX0%78>J6nqm@O9@Z`UeUm({tkUv`*i}Ekvb*O%PA`3Mo}6o~ zfdOHLVW0vwzpj}9L;slH0O|~h1{5ZBfq9JSjIYFA=vrs00}ul1C` zwYW}4aPmgu9Ft{=U3&?u`xM-qKqh$Ad7PJMk%|~1RWN)$iNIp_THULr4_2t8yZd!o z_8|t#OGQ=h<;BU^hLxqAI))Hw*nT(5miLMxtvsq zfpbrQ6cx{Z=3`ZI?_1sHb;ZJeb5yH3+YR+u)RCfW0f(&$zdIjk)q+e`^`$@6ejthc z_yI^)fim6w-cbS10hu_bS$nojx2Nhb%EwCwA8(ok0k%6pb`I3R{$K2isB|S2poi#h z?HXQLC+S(%-#YdaU*AcY! zc|M}w^9J0PeqSx=FU2loy`oaZ_p3?gw}#p0Yix+`4RoJ(ur4RlY0)MWa$~W+^k-WgYYsY6$o+`lu>G7Le|S^lnfRb4ywV|pk}4=-#fs@wtClPt&+2xXKjHr5ejh#ZfEf}>kZEnRN>w}$;}2UzFYlPz;R$?H|cl+}G`n}}1fBA!*TJeojA zL3Z4K@ia;6h(`-OPi-+8k}~T&Pg+sY-|Jj*Q8$=UZ0x2y2hS~7_*4(DaCV= zc5}RZ6aKPew0UWo!aFOP-p)^7uLYDt=gZ4RKG_k$&H_%7<&l>*G z`#cgJ8;btHaT>A2_h&WFAGOYJVbY#sS#2njLcu`m#R31S^!IuLfoQq`koji{ywxC~ zwE+8){>LK%^R5ecm4AHU@f80~j=8h(5#InG^Z%p#^Y1-VWNGwUi2g%J|IFaPmQ~h* z>}H-FUK=0r9!MA0N|3aHjj+^DK)CwNkN;85+cONrx`5~K$2>XK$|-o+hI$P~=UB-X z>)vREG|RTBepkqp@t!p6`e1t8`~?K^WfL$Ob^@H2@yTFCQ);+ zJJU#V4xs;r;(cfsmrH8wlt>DtIRWP@`fsD=_j&VlfXV|x(sf|;8iH0vb{itmI8v7A zx8PC;>Qjl50Nfq;en`|l;3b^LFzI&_x|V0GNJs@9yJ{t%;l>?J!&y5uwhZz04$Z{3?ZTF=7|N z8VJ?3vMb8Kc}Bo0i}pH$GQ?0~6#`6jSe&LsU|AQIfGwl|+^VAV{eF`BN;tqh0Icu~ z;PNn6Y6Ue0tQLWRa5ZuLvzR+&F=Of&hS}$cz^t#WGGZ4N+cefy)1S{zlA98-tclUZ zp+Fx&`z!0JfNr4w3x{D<9u8%c4nLA^4&AnUKu7Zja4P~S92&pBiM#pIUbx*>K?%3Z zpx#RO|I`xej+b+OH9pouH%wOT`_T|tzx67&Y?5V#pEq?hoHm6gwr;HfVvjn76CX}Q zwdSY#0qYAqiLz;uWsZgX9B`WY9%$#((Dz#V+pwSfB~xRipS#d-JS8@_a;<;xLZ*jr zvrPRF^P3|6-Z^QP9>;^li@W@EU!1OFfZQ*OiPEpZ{B(>mlVaOq>0V(^T4h>_VZHa~ zJmOCFpS>EX;)6sDM;wn=_MVL8_}u<0zv|IpmRfLBJ07lL$x4kzE_8W2wk0Fl)`5L! z0Lma;9(bD$R4?0<;9me#kg%-c>*<>M`~&jLC_-S)SZ(T+WKK2<%1QgK3mUn zzfx&772|4-c?lN+3ld z`hdC*Oa_L(<-GYT0A}|T>90v1HQSggNh&_aScrj-9UQ8QfcCK#rl^alOuOnw1=??c zw*kD)w(EVNC+L%j`L^{LMT)>Y5l2&OBK98>Mw4d-F*61epdr!Lht3%|X8HvRA+aWL zyAd3-lnb8wf&8_wRkA9?AqvY^nN+5-6uI4H;l0V*SFKA^d&7PxHxZ}H znp)$;m|Q8&mtd8`*1jXrqo4L#%XMWMl~np~?gI^o3%tqqhPSb6wX5}xZWfU?m*bc% zjRtTqed)wWoF`9=%eBZ_{3J9)B<6_(%L!Us%wmH8`*BMq=hyf81ddw24$0X%RsIIM znBY#z4+zei8hn8o3Rvv3p#0Fy+aFnj^y9(;OPOi0U)d|KEhI1DR`5Zov+eSob3pI+ zq4u1)727G%Yy=FW>;0FcuLE8y{4Tuuvqx|qs6}Np*-Yz0!pQ+6?4_fvD9yY}=*txD z9lHYj*H}}zRC3SP(NkfH1>~3apc}$%`HXn5de9`=FbvmG>Zz zr2p4jGSTX<%_>a|l|IQK`nw0S(+fg?j8LcLO<@Oy()IUpJi92}ytH@|N|LPOvx?W+ z_$@ZDblwKD%3E1xAEF3BlhNL-ptrRf(VwHWQ0)Rsvhm!eqghCV||1Cu0X?%jS# zQhqX(QCfu2_Iz_KL!m-48Zv&^KkT~CQC<0JWsUbGEhp&HkMX#88<w?eK10A!ODX(wHnAQEC07veYHWTjPXl*NTs_XBT$rV7GC4ESAo7$J+|ir9~e?jAvjB^oTCJy4*@zN2x>SSzC)a`a=* zZ_bm>fKHR;W3lcA2Vryw?Z`lxZA%!^gCF@hlA{Tk0;J%Z=|}w5fQ@&AwWUZUOi#aP zn4}^9rNOK48*zp-^*diIJ(zfl3JAqp7&DySJXaDa_c~t4927A32btyiR>V~LoY@d= zRYltD{R@h|qVJRp!$Bz2EL!ixb}5RByzKH}-)PMfny&0Kh(0pW$K6sdl{|33%=NKc zj+Z)co6+ge)LS5`Rc=>7s56?icykL8H}5ghATAh>k1W@4zH9?i%=mChd!e>k_cI{S zlDUjhJ~XO5nP|af9waadQ!#cL<9$lb;qG~Q*H7&!J8+$C-I$-<`AmpqU(HFB|8pX$ zwBC4lb4>s5&s18&rO3&^C&p!Q<(w#!&eDH1&c(O*d5*qf$_G_#`(1nkW%s3h7j7sPI_sa=-&-vFMdV`f25sqCDM~^JOAN$Yur@EKSMgR7%+WFcQ-=k66hnea5{{? z!`q*OgR1#=D{QIsvaGP9u=?$1ri{?VCXX_`}Zh0QUf5fzhx5R)d71&cORQ`e-A*1Ki?v01|k^ zLj568j0+tM3Y|I*ZJ41@Fu>@p9yiv18V{oF0SuK`a24Q>p%c;l&Q^h;jNhHkGOrKI zfK&dbWg_OpLGQ5^v8h0y=FHdpiLT6q52l%AEe^n}bO5h7fF4r>0p!A1P7wp*Jb`QT z)>u%Lk0-r!0rvz5L%^g&Ks*9K3z3d9|)1yOZ7b&s%ko&y4u-`Ti; zCHEBA>$6|Zn&|GgeW3%_?4f9$gsFuy3)fabzyXTQ1&OFCWGN<{Gxr28_FgJg{ z2$b76tO=}1KNh%&2DhwjU^X{aHP%;9Vs@Zs8h2qDkXJ5U9(1SNLBm0iN^l`dnU)~o zRJ_Q|Z8dlazcx-IhT+FZR6@mrw6Aj4APl~sGM0$ih3mH9I%84v{-k*}1sk~A96&=0 zc$9y4f6F?2BBqy~Pu{co}6Z zGX-1b3;N3~;~j6ix~GbryFN30LC_#*ZnJN-Lbft*SqsV7@|1J;(u82JbOz6he!6brNR{Ujjbxq5|&EB`;BOuo~ z{++GG&K{`(bGHy%i*z!(cZin9p6@a`Zr#uNSu4npiN5i$W_o!nWoDign02-L*J|p| zY1D!LS_rBcdG~R7lKGLK=gjXVczBxT2U>3NoE7bBtw z;7(Fs0_K&Z#ZwV(1l%%xyOgXkf&qw`p_}D01I!D?-cTAaeZT}j45g@Lu&hmDq4&^; zzJgCo(-%XM{alBnRrKoqs|sIb!VGhI%A^1ba7a1;XdYAKx!tSA8sH?mC8d?G%r-F- zzlImvDZ>ylUeo{Cs#t_=iZ?(G-S*1|R*+%^I`Cf^H$~Bg2+7JN#=KOjISI|?i zNtyai)eht9%OSq1Jns$UFLQKH&K4e~BHd--CiUUbUY$w#U`9={-{eW^o=`ZW{LSjU z%~|W@X~B{KPyMvhAGLBoj}RSwLpZbvT&t>YtnYvb2?8VEwyZ-saBbxnP*EAcI9D)} z%9DZ|dqBGyd8|)Oo?L=v^pA3`9My}Xo(P0hBe$P-qnxvB!ueU`;9d6eHn8=I`0QL;Menm?D2JkZlO0wb%&WIUfIPj^V z1~}z)#uiO83@(1~O$y-|ag@qFmWQjN4X&yis&W z+&?1h`F|!~-RIQpL@6Alx1{P*(r+KQ5M|>7`ftcc*l+KBgm%6G?y*o4!%2Qino}qc z1t3ZO+s2!p85%;&KKl1t{_&6gZ@7v$wGL^{;?aGlGv*Fv1-W|3@FHIOcJTiL + + +
consul-client
consul-client
mesh-init
mesh-init
health-sync
health-sync
sidecar-proxy
sidecar-proxy
user-app
user-app
T0
T0
T1
T1
T2
T2Viewer does not support full SVG 1.1 \ No newline at end of file