From 341de1b1a5dcdd1780c8d08eac36878216cca36d Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Thu, 10 Nov 2022 16:01:32 +0100 Subject: [PATCH 1/2] docs: moved to docs website Signed-off-by: CrazyMax --- .github/buildkit-container-logs.png | Bin 13021 -> 0 bytes README.md | 30 ++----------- docs/advanced/append-nodes.md | 55 +---------------------- docs/advanced/auth.md | 63 +------------------------- docs/advanced/buildkit-config.md | 66 +--------------------------- docs/advanced/install-default.md | 28 ------------ docs/advanced/standalone.md | 28 +----------- 7 files changed, 8 insertions(+), 262 deletions(-) delete mode 100644 .github/buildkit-container-logs.png delete mode 100644 docs/advanced/install-default.md diff --git a/.github/buildkit-container-logs.png b/.github/buildkit-container-logs.png deleted file mode 100644 index e2cf1ead8b4094c99fa33027607164c53465063d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 13021 zcmZX41z1#D^e0W=C3x z^IBxPsk68xWg91DM?MlKg+?YlJ_>d7)p1J-)hT*#OLCxpq`_su z#+4C<5Gq<^^IC+0SO`He4~l|1it3@*kValyaneV6mQ*(jaUC}YV_zMem{d1)9bQ}( zQo|)Tb#a}d#-|i8MFtihiW(06b-|Gq4o}5`iAbO6{CPB&2&L~I z&-V@pHx^=XuWJpCPF5&tEUx~l5R+T9jeA#6USRYF^yH@`EMwtL2eH$ zZcB=f7P&RLhgRsgrGg--?$BU*Tn93FHIQMWfKPC1&j_huV`5#tE;Ros6sAi7lTp-2 z^pT;*l{vCCNk>BBIFgr=(DIo7F(+m}DNfdVdj9;oiUG6RIgswh3on03Q7I($k-|jUC%|7PAKciid@G$d>9guvrvEp!f z1ZlQwuAO|9+*^;=ZTPLNl_#;aeMnJsXN2WSCOO+g$eEripQ=~&-K?1a&u&_B3n(+b zGJJoWE&6A62vRi7Kv7c0VvlXD?!fCvk+~mSc;?Ovi+B9?nf(;eiVHRo-t+c3!%;Tt zc@B+)%C+&T?la(T6V!;s0dqNZzLe9Yu93+}n=4o;d6Wx7?#4xn8F%f697uwvyU^h; zrv_+9sacX(7o$6ZH)5@e@jDsv`F-2Y0`nY)!1`o>&As=wU!={NsB${l?E_PS!G?a zLRl+ZOaPUuakbr#;}#f(viT~ouu^91(YXXNAg_D@X>H&tsI zZbSsAz3!8h;aZAbE3FgYrp?pixP;hw>`S@AIb6r&@_GB)tSwGNaM0i}xV-7Z5%|)v zVWhS+^p+zTrdhVB|K;_&wz*eFpN^L=zuTCKDeRktT^}@O`IVqtD*9;$lWy$+yr@># zHD0ul-@Z_(vAi7r!`Qa;DzsY%hrf8^;lW(@1Gb04f$1zGqMm(xUiV-op6;B??j`S?;C z&E_&#%m0RU68Q3^I4tqS7_f}>ai*IB>S_D`aIp(-RZ~aiLMX+zsu?2JOor#sz4}8( z_ZOX;pyCnR&o*r+mM8ocvfPLKA55|nz{c-FUuT&DSn$nfGwNh0j)7>`y55>yfTVRr zg}?}w=F|;oxuvQ!jpB=Z0; zmp!qFD~**QAz4Q7o_psOl0vaG9Kx5VY$_#gYTwi$abJ=!UEhb! zeKKabMp@Bwxvu;X$Ey1YSn=jKua%Gya2fm`=RAIWiwr+wM3uuY4Ns3_EWs`f$cTGc zk6k*^hctl(rhDx`tbzXb^bQ8jIlhR@Z#x%8nN+SVM=;|0FNP$sbv2eAw5JzG7S}E2OW5D63&2M1_Dk1;y`VZS9dDS^Ib6M< zb>~L~f=o9$TG_g==%~uodWra>_?*#r`L&9hvtf0{RsByt&P2rP`Q~#6M#n~mYwF#~ z{DhNJq1o>AqoU0U^O2RNhWCgE&Tn>C?k!8d6Q=i4tzhmwZkb20<7HH6^L3{}Ie5@7 z1>Ay1^=W}Ep~TA1CY1uk{d{J@?x|_;)t*;FgL;J*R{HJfhaZ<~w;=TpjdDLetDWwd z?4n~^*vCHHrUv~VJw+;XXRYPreJ_WIo;O_+m<2>(g`fRedMP2wm&h0|4{TD*t8;ai ztS0N@rRl1IA6*c|bf4wqY(L_GV z=%iuPAOoqxO ziYec-_I!B#bea-6sZ4b)A6~ONy{M&X|7|a;NjT;lus!+}+B` zmw8`Xulf-Hl_h0MmQ$Iud#Z#Jk^JWUbn7jF-^K4bJs8jICV7YAdRl8MP+S?cqdw@i zu1sOJl{8s~dJ>R68g3X|`SRCr@D9lP+9<2*d3wr)$z+x1C+(byWY+!K8A6WWa9t)}yL_BL3@cEQ}yuuc!jKuroXCpS&CA zkoei&%%1t62{|#1_Wp{cG|bp6T6q@h<5r4%B3ofp-vSGW*01-rd>4Vxv@fLquf^(S zZ5G+FaEDx24wv@y8+;DcJb=$xOY*E)k!j?AI@~S7v(0!z z_na>~2U>MGE(k&>1t#la)rZ~4WxrLib(cnv%dkU*`5d@MP}8QBRU<0hPAca3<8v}r zVU$mZD>v$X;tp0&D-X{-Pvznhjb$LEWU-Ifg-N>A6*rX*T6tbd=yKucr)q$5WS4^i z8%w+AjUWN(h75K+bjFZ!!K57F*WKz*>}0^IZ{U;F1MtesO>73(JVa>Ed#R@TySB$* zHoWNw#%snOWmtD8BIc_U*~lvhFa!}7nam}RejA4VKr9{LNs#ptNcVd+2&y}ssW8ti z+Qk8JFPNI)bqWGEPW8V79(o1i!X0z+Oh2MD_o|A5Fes$-2&ge_gxB7}B zUQTKX%GdOju7x;UiauVB@yWj@q`NsTIuBjXq#MKVH&w<+97e)Y)R$kx4O|yMLfgMj z#NxxEwqY~W&j+$xpcauH&9$qJ^=M)VhMPt9mN<#d+z*%8H$+!7lyPpt-(LtHB$^zH zma#OyPd5MyLt$+OM}z6I#_DX;5y8?=^FsPOPf9?7aHb!7Hw6Lm`BpXayE!53bp$86 zihje;21I|iqF?gdd-p?{*W+@A>iq_4wjUfh0EU z${~{aF6WJd+;%$GH>k_2pIa@Ok1pTNt1gS+*WvfLm;|2)v|~g_S#9*Pu;~mGpHzu`;@XfI zjkWR*4+%E5(rd8OKB+noXn03=eR0=LY`8gL;O%KOUL_Ri*>zwL5z2|m`bMolqL;LT zCN@%RaaC2JNaeMI9ASJ~#eHR7yY&oxn~{L3j+!UWA=gPz`3o`Nd&w@QaW)k>ou-?F+A$QbdxPVEElk5+Dno0Ko zh49-F5?<;4S_Wgho`ndeXQoK+NG`rKqTl>_Q?*)cQQ<4oK_?+)QsYS(k!jr)G`lF! zLKK)x$&+00!E8mUh3ELzCy_y4wEMH%x1TRX+Aysa6hpP^xbLN`31s2(l?B^+?2vnotHhw zEe`;`${5bgGRAmaG*&;m6-Fl^`!AkMQ@s8=+*-|Ph;>J51A(%QIdj2k;RMj}U_ry& zi;vqkFWYk@BN_t4w$Qn`l^=~Zt70w>%|r6|dUq==ZnaUjH?9!HuI9dxDxi@#J3>a; zwDww`lT*()I$!Ktha{tc1YTgBa=9tn5yA}(kJXty?%_u6IJOkHC2Jtks8mQ4pMxq$ z)<0}?{Ej^0l5t}NLSM0OJkgSiT#-A*t{Az1b4QdwI#w%Id=G1c0H1V03?G8pI7r6M z%LEU;R?I9GSngM$jjF}wFyiN*2*2k9SN0O9gmvJUhTZ!IhVD8~+dSErPvHb9WDIA85U^$l+v)A)Xt*9_x22J8*sdVIp19>LpeH?LXH&>m9S9 z|GfxUb*kWYZjBdDJH=pe$;Y>@*ifCS3@3bCEotf^Zmu&!{&M2TDlcZDiR{Rb3VqG1 zMNmI~&0k*eceuf}9i%nis+++v34^EPXWX}|hCRnq|N5^Kd466=F!3e?!HD2I>2$RT z^lrXR27J`QHjZW1`VpqlQiwjjF&l+mO#R+SXmOvzaxNTB9(5qW$gXP_Af~&5y1r}| z&^V&{RQLmw@ay=|^dW+v+RX(y#TAI5{gvi)LjnRm%_=B*^S&`Xb;XQmHi^2@jWU zXtoZ&4h2&u!^aApMFud?3dJOIy@RWWg*Jbg2W8RIqaF{`0}%gsEg&yy%R?T}RbaTW*!8Hv}&h1<9ki3_ihRTUwzd)kMG? z!d)3P$@C(83-3ujU-NiDK%QDb#x~c5&B_IzQsQEla!<6}*$i)yBqmN>Ne%6kPI>av+3#4BD+@;P)w z;Qcgj!98aUna3o4{J4;e6D0RaX0z!1h-XTe2{h%+-?HhqS4yQ_d~c$Hlpt>cgtRDsd+MPi5SzAU^w*(a-*); zr^Z%w5!-@ppTt%fvCSebDd3dEPT?sBE;Cy}<5QDuj``$({xRZ6e6rZDGHhIbN0A_G zhso^g@-Iznrf<*@WnR?$ZUUf;p}+5ZRf*YU|87sZ3QoeOj|Zim*hHQ_RDuD=QycOZ zFU5Ezp9NeqckXAgfMoh?inf@R;)C40CVpTU2MRJLp9-=BjBu6J#*tW1TX9`<<)ij^ z*`d4wM8Y?>A(j4Q%$^1BJOknpmWM7+Zd_{%6lcSKIXM5~aS`N=8jewU4kq9PXGsSB z&nEn5H?FpQ3s1>1m?vb+js*2*6&qpA$?OHaD(?&9zuBls_;Bs7p2IA$dI_PHxQNw~ z3YsegLhA5_p7vsI7eR!}W53D{3{L@!ailKQjlNEhPtOl&EmyG9>p^=qf*~5Kf>^u# zm}X>9oZ%Zf79SC9Gy#la|HhPH;;EsUq(r@M2YDnCIxz_dVLVMxm)CJ~&b)hBLY_-V zes=l*B3WAMV9=vkO%5lhyLdIwtl+d@*}}WjD_LBCi2-S9WUu-pmburHt~#{F=RB=s zwn7uci1}s5=+}3VMwMix%IO-bqBB@s*zPJ9HK->J1$LV>j@i#a-J+k>Y0(r)8Cd&C zSs<9cHgSuAZDG3zOA|D8HEey|CVcOCEclx1yg`0z_?ABZ@||!tg5{14yoJg|{$Ogi z?1jp`Kr2JG5H#tW_=gv<1M|!F%uDzJr=j+~m-;=TWHj@P#WT)=b+xBOTS8^B)&Q1Ds16 z-2zg$`>Vvw_}RkAMzk69&13lY5YgDix-=yI2`CZG^{@CSvf8iLBS>P6>*C)leNlWS za0&~ZGMBAFoCFM!-oH@&AV-zd%=Ec4{;g2z)5c^4br0t1+}UF>rP4>Wi_pHEadB?+ zuI-1IoBEa5HMf%BnS*+TS5%ElBd>Os>tjQY_-NjH{R^GaaeI$`W>?sLsCw3g= zQj%ay*~5iN%P%Jo{a=8e%};SBI!_`**C)>j^N;1+?rY9jRn$hr4R|pbD%+>+w{G|t zs3xE9{4B?R1y{~>P>6F@w@{Ey^0aSlLyKt}bGwIZE&pH;r6Qnf%RcwM{1JiLK_0f; z>=ORQLL0j6L{@b1yEna34fFYfE^$fVbrD4KWqy)p;+p2`M}HrJHqUddNotY#D`sT9 z7mqOob|)bR1hzFZq?jOcT6RQW{F_w;P2O##nMqMnaeZ~FB;iLXmw%*4mtGX<+J^k? zj`!0nOh_>o;I7^~-#BnN5}`{tzl&7edH>B{K7ivz6$fGB+rjI0G_}H?rp8JE$a8T= z`z^mj(3fBE=pGE)p2~;bJV^Xxp1e&HO+=&n?28_|hdRj0PmaosdRQaO)KNrJs2`=# z=b1WY<|9DBNgL`x2GwwJ32_dgAJ-=Hj+BYWB{I24`KnIGNULPU>Yz#!RF{U2I;~A> zZO8}fu}pPRLPxEkTQVUr@TTk?7g0%dALYYWUc+BN#Eg7?)#jhQ zg?u9P=!aFg<+<_=ZV7IAEqtXXLGq61VNXR#{uc7S0uIs`ikf7fPD8T>;eT~GP*?Hu zaMix%H!Q&6!yBd()3T3v7}L(VEZSFUBTGKVhmp&y}&KUD|Mgk9vfTy*dcpRgQnLF4i~el~@ON&n~4*W9%W(_P4O4!8!aR zpjv#UtTv6j*l?dy|0Bj+oEW&-&qDaw*#)xsu3) z&h~>ODTRWJy;DFz{{1O1Pd5 zE2(muXhMJ`YoE6>?sG4U5ZuU&9;k({9ba2cdhy;BjQi;`Fx7;}P#_jeSj!$g>e%)@DM<%Qg zs4n3}25_vNLdbq$_w(^W4|}&DhZrdi)lu&xf9I8cI3lLbzV0QJuxbAjtzUw69(7THbZz_6fv)%dZ(d^ zEqPEUZ+f+qKG~SnvQvJWc>-~M8L~)7Rskc!JA;o5k=1|W8zdtrM_^UP<6y3v9_MOk znYEAJ$4+Yj-FH<$ZC$52SdB0i2jXJ}6 z+NtVvdpzd%tDZJS+sJ;>7W0ln1G?$ zZF#tpbokb6S4>EEfk1Pd2)L<5S3Iz+NAng=;Zf&mx);`wh6TZ$O1D z9Q#%hkvKM;dDv84T^|IeR~;*Eh%p!H;QSMpi^bGFPhuH!%76J#Xt-c3O6y6kszSh0 zSxKLs5yNYKl>k;ME*@`1qmRV!{fNgX6jEgwNj2?xsEr~G*OFPYd424)+fmcQxD@6e zcK-PW+(Q1Zv*K~@KYT=)*u=7Xeu6lGfKP!hJGp{~$mTwP-Xu!DwlHh)7w7~m^+B;- zs|9vOLF}LQ<^Q^1;*j;o)4u^26Lx7MAm@1oL%d-_af|$K+6;IH8uqRn2SfV$$G9W+FH=*YGG!0PX0?oT;TW)t44=aB>AiT2N+`M`0gD~n$qN+x#zhDf*l^RgR2WvDa8 zcy95pCL(FEIiatwUzpHFLSDxS?Y z&xCcWe1K!Sy#{o5;4+x$M(b|S)pof^xWT(@);rQe;K?0R^H}l$pkv6xI1g`%$mC<^}s_AT%<<%;@ zx=(Zq#d|^9EGV1ROxmc5j5vKzzhfT1&jNolw6w;xC04*tUA4Rf|56~uZBu{vhkiTP5>Z1hKZAES_hl z!s#*+Pat1vVu9rM-{WYG14Tb(x+gq%YI5KY3wY4IxjKhrBQ{uZE_b%s(lpvU z1QNC>n+aKedC-BHHw=dEBOoyk6|5a0>_}pIkj<8vc#JvCqh%XA>QLasfT&R);Fup+ z+ms)-A$BpftApvg7$fdc$$(eGd?~E*0qT7Izrs*~&ZB>XX{q9|3uvvmMd|z@+sT4E zIr|!gCHpkTkuJZFY%rIm>-F0mHyBY)u|RVecS;no7X`<506x`30?#^yM!J7gv25ND zh&-b@XpddkTQ`c6TXLdyS4~EsZ)iC`F_L2yfH;-``g)O3W-P~?307jKF>+S7cYSBvb?r7xE zP%)y4*?-_A1+F*Xe!sFO)xp!VJLAXVGSWx8-YUAn1@VLd>A|zZqOEslb2yc&QruwU z@QjB3Oka#sh**a7%Zpkby{k-OxuBgiR`$cuVIjX2v3tw64W&D>_9DBpSWZ8RhS(s? z&13wJ7|ggIJRv=nBhHh9&){}~=AT`(AALQlOnO^Nlg+Ujn*I*gx%MM+Q zF(6^FOP4rp`t|R!1oT0jfXi^3#d2blfyDh3c;1$fs}uKs_nMu|TJV#`@c>`|IyQ(W z4yd4%g}th$8s>FQZ1Sq6x4>&B zz$nsv*-_Cvc76g0^q}L@+}(VRhZa2z?BtFVR-E#G*gXns@>12;MWxeH{DGgiwN3Dp zv3ZQvs1GU|IiJmu)3>bh7ULv>uN-w&;ZrXj99_QzE=I7p%3@G=U*4KqB;S1>%r_hOp+-GP_EN` z5~9=3K&s!Xa?wmbZut_QxW)VSU8So=0+8d;fTE? zz=#1nEovUVverTJBnlPq#K-~{)CJ3Y+wdX)gGmnaMb=XGbDmYP6oiyK_dZd_N``Cr zl5tse=D2Y4Sj6_oMK?$=>M`1z+h!}b|7ig8SsIPeJq1dhN&5@pVgNj(zN>iTJ*Yv$ z4vX1P%v9%xLDrfTU(X?(Zk>SNp|=nlza)C`l{uk6(iZ`=VG&`p)Ln@lrw?M9p<%KV zW4I00shYJEjvx0%1_lPoG98nA&FTpzZg;N1!G}pey#atv@h{b&=VLL-{ybfWaT8gE z&tHY}VB*DXf3aN5Z614R)K_P*BB_HpUxOW|qIVeAnN@iH+j4@EM?7P;=wsFuP_G-% zFLRxPdmygQhde>}MN+{%Aw?(QZ;EZ8snAyN(^E*zdwtm7LPAQYH0sT56Vm>sU^@TY z_D2g}ldKMk?Ht;!o2pQu!|1%3yo&S0<8cD8%szt*-U5shy@FhGsSrq(VSWrByr!5G zH8K)0cJ5A z{6*Z3OLO(){3hUQ^BBER9}mHMBnQRzTC&>wl z*5XMt-Bh<^{`k)1yB0zZYs?e({tLCDZdK$$WHWdHj-nLh3CC%9y_%!L2d7!|9tqFFL;r|$$#T* z4o_@851dG$dboo23ZS7^uUIi+aa3Z6NGC`q^(R8AY;w*Tgjdxo}^ zPre@6k0|*|@}uti`KfPx#tfF1`&^oT@}|p7D(qPKP{<}2wNyflJ%g?_GXV^bgEuY% zSGMY?1%&U+VKYpIuz9EjGRUQk4?E+_&p-@`Ype65=KjE;$;;N85gI?SJJ!%>Bhi*h zYPPE8u_s1h{Ug@I6*7yle}o#PXe`OC7 z17xb`w+PL6u&6F>Caj)(TowP{)l@N~ zhnst*pQ-<@JeziiI}0ZlXR#VBlR^Otf1WC3QTDCiH;-jQ-J5*oy_*dRqx;;6PzGfO zshP>HFKQv&*69W4a~Loo`bg}52o`=68;+`qhR1K`B2U!wl?MN1?%a*rz(@Sgmc+TH zL^tXPD>fiy=|7dnukQa=p2Nq=vu#J=JO2jjU3gd0b_w!CCb03t^gZO@|EWFwRERq* zgdizjWS5-t7}DNjx?VMpwJQ71hi<*#Sq-kMR^~;vvVHTPOnrShmD!)TKUyc+o%z73 z*2%vW%x=Q9Ej+yH!Qd&Hl{C~xN5G7k6G(Sp&25}{22r$fZp{PEZZE$7mOi`f`8-O~ zXxGFDt1$%2508#Ia;)y9+DLwAJvX4&@hO)3a5{dJ%lC@FArUzmT6$U9Y$;kwcD43L zB~MQvMb=@(bc8$+JJL5JHmXvqdB1rgdvh=ogiI&i$B%cg5cD=+?x9L;Vr6ep;x)=( zZzKU5Gk_D%!gJ}=aJnYxz1^R_551aX^T@#%n8(GGDGMYL8eNk*lE1~Gr$?#ns;g;N zOyW@a1uz@|>=lOP(y1fZ0(Obkn)$F9k0-_Jt(62l%v?Ac^$~8wQc^(=Ita0aKk3~i zPxPLS-Xg46TFMrNM!jCFd)CgS<~!f{K7Rjgk}DF?`eNb*kyIg8HaaHCnnN@`S@G{b z_6T-{Iq+a<2!jHIQjJGCCGX5895XR$gq%ZA89KTO@B`l9Okjrf5#{p{@RS^e8&#XH z1*g4>_7Wm%F|6EvyiI<*{X0Cr?T(`~mM~0MZfA2&YXKaS;Ow`F zUU|H3JQH$nhOM&+{-3UB*M?BxV#@WH<~@@K-Jf^z$Zddf!`oLQq8Ri~m^&HMPauQa zfZ=PV5m799&(^QKv>7K5)*S%y>gO;5rU-Ez1|J7E+c2!e@ny3FC6BxUcpi0oJmqPJ z6cH}RM9)|^T|N%aB0?zv8|1u*$&3=ob1IV zPc$whXyli=Xlp6mNcjmV-v$WyPtuB}5w5*{BO6#n@W{~v&)Zp(-3C-1T zRgvN>3AHR|0hF2=!h~cFq_r1V@6OOvTTcdzF0$#vPtVA1Vz*YG)D(8{7l7OP(FAaV z!fP(I9A2$yj_4&;!EiRm8%j6rm^@DDy@api4Wk562oc1s{_pnHzJA1Cm-)EKz#xrd zLzLgiPh}W1@PeQxe-)j)sL-RGX!Rv*kBFmT2^#XF+cWXtv7wXvwU{JgZV`cPa{dld zmmOiCZ@*r_YiTWGa^Ko~cCz>`00^q--6$$!Uq&FAoHyCis?|sseloOc847*CWenS>Ehav42Uu zim&>)Ww~o}_85=*YC;s8j=m|t)49mokCu)-eW`W3oK!ngSWbR$*HD^R2R@yM%{*P! zGSo6uK&R!a4A4d!bU0a_ik#AUrh)bXVx%A*g)dJUgpy#whC_6beqHolX!WJtUk-Zx zLe~o9V_)_`7;`3FZs@|6NsfqwfcO<{GX6+MVP-n^zLgB^MpXTuIH1+g>kCg5vdd7Z zZ^1?GJ6O>NcabnOFdZ3m0!YYTKBPq(V^7d14wrid%TW`CBdiZbAx zCw(5=da)6nxkpe!+NTU4ThkoRT5;qlF*G6)7E^7U@Lt)?cl^niI|S6@fy#N&jYZmV yWaJ}9os{l!JfV6v#a@k-ox^Ns+3Mpm4%MyZEd+4gjr{q0r@XX^R2AfH!2bayq>;q{ diff --git a/README.md b/README.md index 5dcf392..041b929 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,7 @@ a [BuildKit](https://github.com/moby/buildkit) container. ___ * [Usage](#usage) -* [Advanced usage](#advanced-usage) - * [Authentication support](docs/advanced/auth.md) - * [Append additional nodes to the builder](docs/advanced/append-nodes.md) - * [Install by default](docs/advanced/install-default.md) - * [BuildKit daemon configuration](docs/advanced/buildkit-config.md) - * [Standalone mode](docs/advanced/standalone.md) +* [Configuring your builder](#configuring-your-builder) * [Customizing](#customizing) * [inputs](#inputs) * [outputs](#outputs) @@ -59,13 +54,9 @@ jobs: uses: docker/setup-buildx-action@v2 ``` -## Advanced usage +## Configuring your builder -* [Authentication support](docs/advanced/auth.md) -* [Append additional nodes to the builder](docs/advanced/append-nodes.md) -* [Install by default](docs/advanced/install-default.md) -* [BuildKit daemon configuration](docs/advanced/buildkit-config.md) -* [Standalone mode](docs/advanced/standalone.md) +See https://docs.docker.com/build/ci/github-actions/configure-builder/ ## Customizing @@ -153,20 +144,7 @@ The following [official docker environment variables](https://docs.docker.com/en ### BuildKit container logs -To display BuildKit container logs (when `docker-container` driver is used) you have to [enable step debug logging](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging), -or you can also enable debugging in the [setup-buildx action step](https://github.com/docker/setup-buildx-action): - -```yaml - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - with: - buildkitd-flags: --debug -``` - -Logs will be available at the end of a job: - -![BuildKit container logs](.github/buildkit-container-logs.png) +See https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-container-logs ## Keep up-to-date with GitHub Dependabot diff --git a/docs/advanced/append-nodes.md b/docs/advanced/append-nodes.md index 2753519..175350f 100644 --- a/docs/advanced/append-nodes.md +++ b/docs/advanced/append-nodes.md @@ -1,56 +1,3 @@ # Append additional nodes to the builder -Buildx also supports running builds on multiple machines. This is useful for -building [multi-platform images](https://docs.docker.com/build/building/multi-platform/) -on native nodes for more complicated cases that are not handled by QEMU and -generally have better performance or for distributing the build across multiple -machines. - -You can append nodes to the builder that is going to be created with the -`append` input in the form of a YAML string document to remove limitations -intrinsically linked to GitHub Actions (only string format is handled in the -input fields): - -| Name | Type | Description | -|-------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `name` | String | [Name of the node](https://docs.docker.com/engine/reference/commandline/buildx_create/#node). If empty, it is the name of the builder it belongs to, with an index number suffix. This is useful to set it if you want to modify/remove a node in an underlying step of you workflow. | -| `endpoint` | String | [Docker context or endpoint](https://docs.docker.com/engine/reference/commandline/buildx_create/#description) of the node to add to the builder | -| `driver-opts` | List | List of additional [driver-specific options](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver-opt) | -| `buildkitd-flags` | String | [Flags for buildkitd](https://docs.docker.com/engine/reference/commandline/buildx_create/#buildkitd-flags) daemon | -| `platforms` | String | Fixed [platforms](https://docs.docker.com/engine/reference/commandline/buildx_create/#platform) for the node. If not empty, values take priority over the detected ones. | - -Here is an example using remote nodes with the [`remote` driver](https://docs.docker.com/build/building/drivers/remote/) -and [TLS authentication](auth.md#tls-authentication): - -```yaml -name: ci - -on: - push: - -jobs: - buildx: - runs-on: ubuntu-latest - steps: - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - with: - driver: remote - endpoint: tcp://oneprovider:1234 - append: | - - endpoint: tcp://graviton2:1234 - platforms: linux/arm64 - - endpoint: tcp://linuxone:1234 - platforms: linux/s390x - env: - BUILDER_NODE_0_AUTH_TLS_CACERT: ${{ secrets.ONEPROVIDER_CA }} - BUILDER_NODE_0_AUTH_TLS_CERT: ${{ secrets.ONEPROVIDER_CERT }} - BUILDER_NODE_0_AUTH_TLS_KEY: ${{ secrets.ONEPROVIDER_KEY }} - BUILDER_NODE_1_AUTH_TLS_CACERT: ${{ secrets.GRAVITON2_CA }} - BUILDER_NODE_1_AUTH_TLS_CERT: ${{ secrets.GRAVITON2_CERT }} - BUILDER_NODE_1_AUTH_TLS_KEY: ${{ secrets.GRAVITON2_KEY }} - BUILDER_NODE_2_AUTH_TLS_CACERT: ${{ secrets.LINUXONE_CA }} - BUILDER_NODE_2_AUTH_TLS_CERT: ${{ secrets.LINUXONE_CERT }} - BUILDER_NODE_2_AUTH_TLS_KEY: ${{ secrets.LINUXONE_KEY }} -``` +This page has moved to [Docker Docs website](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder) diff --git a/docs/advanced/auth.md b/docs/advanced/auth.md index 7a1892e..338c89e 100644 --- a/docs/advanced/auth.md +++ b/docs/advanced/auth.md @@ -1,64 +1,3 @@ # Authentication support -## SSH authentication - -To be able to connect to an SSH endpoint using the [`docker-container` driver](https://docs.docker.com/build/building/drivers/docker-container/), -you have to set up the SSH private key and configuration on the GitHub Runner: - -```yaml -name: ci - -on: - push: - -jobs: - buildx: - runs-on: ubuntu-latest - steps: - - - name: Set up SSH - uses: MrSquaare/ssh-setup-action@523473d91581ccbf89565e12b40faba93f2708bd # v1.1.0 - with: - host: graviton2 - private-key: ${{ secrets.SSH_PRIVATE_KEY }} - private-key-name: aws_graviton2 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - with: - endpoint: ssh://me@graviton2 -``` - -## TLS authentication - -You can also [set up a remote BuildKit instance](https://docs.docker.com/build/building/drivers/remote/#remote-buildkit-in-docker-container) -using the remote driver. To ease the integration in your workflow, we put in -place environment variables that will set up authentication using the BuildKit -client certificates for the `tcp://` endpoint where `` is the position of -the node in the list of nodes: - -* `BUILDER_NODE__AUTH_TLS_CACERT` -* `BUILDER_NODE__AUTH_TLS_CERT` -* `BUILDER_NODE__AUTH_TLS_KEY` - -```yaml -name: ci - -on: - push: - -jobs: - buildx: - runs-on: ubuntu-latest - steps: - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - with: - driver: remote - endpoint: tcp://graviton2:1234 - env: - BUILDER_NODE_0_AUTH_TLS_CACERT: ${{ secrets.GRAVITON2_CA }} - BUILDER_NODE_0_AUTH_TLS_CERT: ${{ secrets.GRAVITON2_CERT }} - BUILDER_NODE_0_AUTH_TLS_KEY: ${{ secrets.GRAVITON2_KEY }} -``` +This page has moved to [Docker Docs website](https://docs.docker.com/build/ci/github-actions/configure-builder/#authentication-for-remote-builders) diff --git a/docs/advanced/buildkit-config.md b/docs/advanced/buildkit-config.md index d552795..15c9437 100644 --- a/docs/advanced/buildkit-config.md +++ b/docs/advanced/buildkit-config.md @@ -1,67 +1,3 @@ # BuildKit daemon configuration -You can provide a [BuildKit configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md) -to your builder if you're using the [`docker-container` driver](https://docs.docker.com/build/building/drivers/docker-container/) -(default) with the `config` or `config-inline` inputs: - -## Registry mirror - -You can configure a registry mirror using an inline block directly in your -workflow with the `config-inline` input: - -```yaml -name: ci - -on: - push: - -jobs: - buildx: - runs-on: ubuntu-latest - steps: - - - name: Checkout - uses: actions/checkout@v3 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - with: - config-inline: | - [registry."docker.io"] - mirrors = ["mirror.gcr.io"] -``` - -## Max parallelism - -You can limit the parallelism of the BuildKit solver which is particularly -useful for low-powered machines. - -You can use the `config-inline` input like the previous example, or you can use -a dedicated BuildKit config file from your repo if you want with the -`config` input: - -```toml -# .github/buildkitd.toml -[worker.oci] - max-parallelism = 4 -``` - -```yaml -name: ci - -on: - push: - -jobs: - buildx: - runs-on: ubuntu-latest - steps: - - - name: Checkout - uses: actions/checkout@v3 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - with: - config: .github/buildkitd.toml -``` +This page has moved to [Docker Docs website](https://docs.docker.com/build/ci/github-actions/configure-builder/#daemon-configuration) diff --git a/docs/advanced/install-default.md b/docs/advanced/install-default.md deleted file mode 100644 index ca95d5c..0000000 --- a/docs/advanced/install-default.md +++ /dev/null @@ -1,28 +0,0 @@ -# Install by default - -If you want set up the `docker build` command as an alias to -`docker buildx build`: - -```yaml -name: ci - -on: - push: - -jobs: - buildx: - runs-on: ubuntu-latest - steps: - - - name: Checkout - uses: actions/checkout@v3 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - with: - install: true - - - name: Build - run: | - docker build . # will run buildx -``` diff --git a/docs/advanced/standalone.md b/docs/advanced/standalone.md index 53abf91..e6b3e29 100644 --- a/docs/advanced/standalone.md +++ b/docs/advanced/standalone.md @@ -1,29 +1,3 @@ # Standalone mode -If you don't have the Docker CLI installed on the GitHub Runner, Buildx binary -is invoked directly, instead of calling it as a docker plugin. This can be -useful if you want to use the `kubernetes` driver in your self-hosted runner: - -```yaml -name: ci - -on: - push: - -jobs: - buildx: - runs-on: ubuntu-latest - steps: - - - name: Checkout - uses: actions/checkout@v3 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - with: - driver: kubernetes - - - name: Build - run: | - buildx build . -``` +This page has moved to [Docker Docs website](https://docs.docker.com/build/ci/github-actions/configure-builder/#standalone-mode) From c77919d12ed81266dbf503b2ccf4af829359e9e0 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Thu, 10 Nov 2022 16:02:34 +0100 Subject: [PATCH 2/2] docs: add contributing section Signed-off-by: CrazyMax --- README.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 041b929..0b05f40 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ ___ * [Notes](#notes) * [`nodes` output](#nodes-output) * [BuildKit container logs](#buildkit-container-logs) -* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot) +* [Contributing](#contributing) ## Usage @@ -146,18 +146,7 @@ The following [official docker environment variables](https://docs.docker.com/en See https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-container-logs -## Keep up-to-date with GitHub Dependabot +## Contributing -Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot) -has [native GitHub Actions support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem), -to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file: - -```yaml -version: 2 -updates: - # Maintain dependencies for GitHub Actions - - package-ecosystem: "github-actions" - directory: "/" - schedule: - interval: "daily" -``` +Want to contribute? Awesome! You can find information about contributing to +this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)