From d9b422cc546bb037a989fcf45716b6464c761a08 Mon Sep 17 00:00:00 2001 From: Jeffrey Regan Date: Wed, 23 May 2018 09:56:16 -0700 Subject: [PATCH] Update README with file layout --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++------ docs/overlay.jpg | Bin 46024 -> 46088 bytes 2 files changed, 47 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4355ecb96..ef8c0c673 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ go get github.com/kubernetes-sigs/kustomize ## Usage -#### 1) Make a base +#### 1) Make a customized base A [base] configuration is a [kustomization] file listing a set of k8s [resources] - deployments, services, configmaps, @@ -50,20 +50,60 @@ secrets that serve some common purpose. ![base image][imageBase] -#### 2) Customize it with overlays +File structure: + +> ``` +> ~/yourApp +> └── base +> ├── deployment.yaml +> ├── kustomization.yaml +> └── service.yaml +> ``` + +Your base could be a fork of someone else's +configuration, that your occasionally rebase from to +capture improvements. + +#### 2) Further customize with overlays An [overlay] customizes your base along different dimensions for different purposes or different teams, e.g. for -_development, staging and production_. +_development_ and _production_. ![overlay image][imageOverlay] +File structure: +> ``` +> ~/yourApp +> ├── base +> │   ├── deployment.yaml +> │   ├── kustomization.yaml +> │   └── service.yaml +> └── overlays +> ├── development +> │   ├── cpu_count.yaml +> │   ├── kustomization.yaml +> │   └── replica_count.yaml +> └── production +> ├── cpu_count.yaml +> ├── kustomization.yaml +> └── replica_count.yaml +> ``` + +Your overlays could sit in your own repository. + #### 3) Run kustomize -Run `kustomize` on your overlay. The result -is printed to `stdout` as a set of complete -resources, ready to be [applied] to a cluster. -See the [demos]. +Run `kustomize` on an overlay, e.g. + +``` +kustomize build ~/yourApp/overlays/production +``` + +The result is printed to `stdout` as a set of complete +resources, ready to be [applied] to a cluster. See the +[demos]. + ## About diff --git a/docs/overlay.jpg b/docs/overlay.jpg index ca30f55163d896c8dc6aeb9a0adb8bfc842eecb9..d7ea3b6c8a86e05c9e1d1a2757fd327240b7a4ba 100644 GIT binary patch delta 2766 zcmbu zeIE1~%9mj6F?vG>)nfCh?Hl@nz~eA+n{zLgHS2&@7kNM;B>+$2`!}$708R@>C?X`}-iUq>e-#+t#_F)4?Kee&5U z9*%jQx_NafV@e+?(M6Ptw}};(I9}(u{N?u7p2}rENR?blf`q0ls9#ZSgs{e7M-@rIEo2@c z1%)F@p$5ni6f?EVR>xjYJ(biv?BJl4EAmT~Zxi33#2xXC*5M~G zkey1HS+T%#J5=lJgw|le>l?Q-8zr|+O~^+scj^C#;939R{q<2)(Kf<>yv&Iy3S>T% z{~>rL5QbCjGhjPgDw#LlE(nfYeD`WnzdhVER69GVtW$Xve&gG$m<|S4=<|9U#Ry%x zI;?Z8fjmRR?s(eCF#pDRgUX|7wAuwM#u%k=f!n@}VI8$v@*A5hWxZxH$Iv#J-RtJf zJr-c}hDREBm#bmmmG$6f$ooEWgMNvG%7zM=@avrkT!8wWRw0z3w)RH_Z%}}tXhm{jAQ9?pdFVGKbY6*7K{Vk4Lss@E z)~?uFxU)lZX-Ly5u}82N^LGa8vmoJFihC`Ki3rh(voI0?#OyP$h7;o*^`t*Fd}ciu6h|h+BRTYCQsbj^ zUEOm=Y@d(>YP?BfsCvUHH{6qW{fl({m@DHx`~|F=Tp7P~Q3(QGk?@?qfZfvo?pY}K z9yUGzaowvAKvk1@d;B8(75_7r^L8x^w_bjJ-4kbJ4ZWE7@7w=JFr~JyOi^z6rq0JF z)6!B>lUgK#>Z@CRzAJM@!M)U{ktdxO>S=&f{vQI%&C+zAe0P38B_FGv!drSx4=rEf z=KAUc`3F4xLwOnk0_hV88|7c%3v1$z*wE%!Vmc5PtAyc@F_=A!BiOC3fjs?zN;W2Y zCoHgL+7fYMm{H}4NaFhOk=H9JY5NB5ZNVC}+?D+05P1DEv#GKRNTdBBe5p1qZ|VTV z%BA}k8S~LCi-h>>J!3a_6Holki}2l3Pfc5Dw%C>kn%V5^J^(4uLa=Ah)Wgg^R1jX! z=h}S%Xfkvz3@ncwb#YmE+7K|bb-2uGW_yZFB_Xi7fNr7@5MwGzRFDqRx6ZdN6@E?@ zR$H^rS7QAdgs6^;82EUdk;!c7$rX~$;zy+)b!6=H?HaR>GYp!pB}PlIb|NT@9X#hw z27HFzH#stHR%TtAX)8MrR`u$rm$Wn7J8l$;U>`l;x3Zv@KMd1YIH9)9iTTC3bs z;irMa)@yze4PiUPqM?W3oaRt`M^H(S(1d{jQnEY`{o$o(V>Mw?YAbr(o6lqWXAwcD zsxbKNSD%Q{$RTUg&rR#XDIsO;@$~TAb-vyYUXK1TW`%7xa)lL)kE(q0H&RtirBXG| zgsLR)E_daZO&g|3JMT}_k7^Heta;w0u9B=30|eBwQz6~v4w7aF3pd7@Pan{q*k0-E z9a_lWWeH*0e$&xE(7U}%!}DAM2{d0^vf?qlKVR@HfPj$AjJ3UWtGx(ZVFiSrl?Rq? z8Ur!>If#+r-*r^3AdZs{K)kaC6wg@S-Gq&*?KR&$_yc;$_ucV@lm`bO^)30wz^N)F z;-x(6cesWI#$EL4RmPQc)|D$S^%kLXA+g8h8L`EUPk#m}f8grTR)#g_R zkbP~2oA*)rUae93JxVR*h0LA_qbm#-uu59?qjbyXVj_rJGi{quXasV~OEg(~`U?WB zz0h+cfFPzbwCNsi3lj%BjNBEyl=^~5dqH4=@kyxHT`2Pgl_s)NHRJfi|G%?+GYQjI0 zmUG(a@H|9QxTj0P`xfGqYjmDlQ#Af0^AXE_$^jBX1aD>^i79>T#OKL5v{9cGqw_+? zae(PC7JO87&=jHU*r>hX?D6|s`hPqCNlkDT(>=W}n?37n8R@^Nn$Vx|DXcj|(L(h| zPA*cynPqY@&bU@PhzP3)iU=WS4R=E^x$_FwDYzp6^OpzDh$GEnB{0-@OrNhDr<2BU zpw}84mGr1%jtyD;@O~waJLzx$DpS0N=vMh2tAlwP|Q89;qH-PtDI o%TQL?{c29q%$Jezb12|0w~^qbl0Y~d3&g|E{+FBp-@(Mc0EB!>VgLXD delta 2661 zcmb7^YdF&l1Bd@ZEap^B6(feqDI*Lyl*zG3*hn57Xp=d`ENaXl$@!l|PVI3jk+F=P zJSC?g#2msx$eEZ$CHD5b@3;4Qzq}vr55F(JFZXrbiSvBSIlgM$yc4dUOdKAc&vZW2 zD&1(L<#HViQ8EbQy419JjpDh z$z;hNF4v1hHV;0=ek$IuR9J0pP^tGlqL@t91(Lb)@RRtLp9Z#uK`%D*YJnfpX0AdP zrS^mxjYuE`lwkkJn##Cktb5*E^1SNKj7x_pF|@cJW_tfHY{F%{qR&DcTjKQOYLGOe z92ODi{Ppdxr)%S0o_cgyJ*%GMvxdhok<*o@(ZE>-!=9iuH0uNHkh~{0ZY{2W5+J9w zJy?`2omie-o$hFx(0OkXypTNg`*WW@r*5aeVH~(Y`$1!wy;PYPx0iCZC7QHL3hLwb zLeDtB)?Md|_V{YHKFYN1P;XR~a)O}$gJ2#H;AmpV!z;bJF?)R7{%hXcRebzwBy?it zjS`hVN#hh)Xs!o(QJ`Ri=>bqFem@v(Dhh^sBgw2m^BF}d4;Ti?3s!?U9=FPV#d5uW zasqdbK`*OTqmJ` zlJBJu9~@$%3I5cdq&1Q|D+InL9ve$|XLh3ssv>ZuU=WEn7!3zM=bxHgZ%SyJZ@-#I zwh1SdU3znqKM($0VJWsm(+0@2n2dB1vdF~6Hq~JBZSQ>C(g-=s@vcFxd`kA4UFyF- z$2#;*#vpysU-c7x<7^*EOm7yN@WH0-%tQYIYP9j~kS&{mZ+#WF>--X?B1S!RCEb(E zr<_K{-pXAJZ?|hCSK)%jJ~kI$YzWOT^szvztyr zmY*vxoiv_sdFfwT8(E)zCPZa|meth6pAKa*=Zu~eDF0nI5O%kouBe`UQ2#L>3076k zZ%Yp{JgyG^mIZ!B!9nr+exO4tlq}>}w&;X|%d=MZ#K#Zx<7N4RgN6Unw@ddyS{@Ud zoe4oT$0_Y`Eid8olao7A1!TOsZNqU`omLTJJwk^O31PBXyR? z{7q2m*}=whEeZg@CfGav#!0BxvEYR zJfQzx1+uObjybw`I;zuiY%2gMj2RjJ;byBM&$XeY4a#%mZwv z|J>H@-Hjb3?yLv%fVQW(10TA}V*`=h2R)l)9~DKnDx;0qkhTloq#iVsR*rD*oW_43 z?lSb|sYwIx!M;3m@U5i)Suk$Yq3?Pho^l;Qv5m?sZx1okqd>XbZuf^DTCW9$_{GG1 zd7FaR!y=e*cz{@FdzC2R(Gxg7$Ly0Y!E9`^5MgJy%-Q6A>&5r^SN`-)@YujoJ}>Kt z7{BZYPgTA=3Y<(Bn!MQx1Y^t+p0hEHudA)qD89M+8Bsa>D{Qja0@sHfUNz>qeh}|r zS?B2J5T~Ku&A35Xy&=EZa_7=XS-|a1<5PB1#exUjcsM^yf$r>hvat_Ggxu{4o00cx z1VR{YEbOIoxS+@C6zfzp(*%1K%A77QPf8!NQTpi~T)w!KGTkyjt_yf65*lp!u<-ip z%Nf=qZ#!mHC>FXb0dc$DL4w40hGTv0(2U;hLhkJ1BwGY)SYX=y2Khpi)gV6=jlv&` z93sAHz^P-|ovkI8GUfBC7n+uwoIskEoc8}w=6}L$=_n1Ro6G$V4uGXswK8D`$gXpJ zVVISbRYk|w7=j!EDJQ3yd~1)D5;90TqSN1be>A5SE^|_WCgf& z_MG~>&m{gqEx1r)Py`#*pr(-HLccwvv~Mqe3`>9F)ZlcTp?Jyoa|kTKI)<_$*U@7fg4!yA{X7ERi$;S`m=h=g zvjKxb1i>ChEif-z41`gH$^11Bm(C6R3cdDh)SLO0__SGl-=PwS1jwC zV%#RNrfU;>4Ob@dfS+_qm=Y2kJ1n2nH3(N9BorL#c%g#a$JoyYCtL2!3KZZ=qyV?N znA-s*;~dUEVQh*(x(YJiA`cZY_Dmj}B`pVlfi*I=DfifPID;U1daoSb$kw&!>J zIKyoQG+Z61xw1#EMJ6Ed1l=iWSSJC~0h%wiP1>z9P2o`OC@&v