From 2545729b24c711bc29ca66fc7e6cf33cf0d17332 Mon Sep 17 00:00:00 2001 From: Luca Comellini Date: Mon, 20 Mar 2023 11:08:26 -0700 Subject: [PATCH] Move NAP DoS chart to new repo --- .../helm-chart-dos-arbitrator/.helmignore | 2 - .../helm-chart-dos-arbitrator/Chart.yaml | 17 --- .../helm-chart-dos-arbitrator/README.md | 95 ----------------- .../helm-chart-dos-arbitrator/chart-icon.png | Bin 8165 -> 0 bytes .../templates/_helpers.tpl | 18 ---- .../templates/controller-deployment.yaml | 30 ------ .../templates/controller-service.yaml | 15 --- .../helm-chart-dos-arbitrator/values.yaml | 16 --- deployments/helm-chart/README.md | 2 +- .../installation-with-helm-dos-arbitrator.md | 98 ------------------ docs/content/app-protect-dos/installation.md | 19 +++- hack/common-release-prep.sh | 2 - 12 files changed, 17 insertions(+), 297 deletions(-) delete mode 100644 deployments/helm-chart-dos-arbitrator/.helmignore delete mode 100644 deployments/helm-chart-dos-arbitrator/Chart.yaml delete mode 100644 deployments/helm-chart-dos-arbitrator/README.md delete mode 100644 deployments/helm-chart-dos-arbitrator/chart-icon.png delete mode 100644 deployments/helm-chart-dos-arbitrator/templates/_helpers.tpl delete mode 100644 deployments/helm-chart-dos-arbitrator/templates/controller-deployment.yaml delete mode 100644 deployments/helm-chart-dos-arbitrator/templates/controller-service.yaml delete mode 100644 deployments/helm-chart-dos-arbitrator/values.yaml delete mode 100644 docs/content/app-protect-dos/installation-with-helm-dos-arbitrator.md diff --git a/deployments/helm-chart-dos-arbitrator/.helmignore b/deployments/helm-chart-dos-arbitrator/.helmignore deleted file mode 100644 index c1347c2c27..0000000000 --- a/deployments/helm-chart-dos-arbitrator/.helmignore +++ /dev/null @@ -1,2 +0,0 @@ -# Patterns to ignore when building packages. -*.png diff --git a/deployments/helm-chart-dos-arbitrator/Chart.yaml b/deployments/helm-chart-dos-arbitrator/Chart.yaml deleted file mode 100644 index 0aabca8340..0000000000 --- a/deployments/helm-chart-dos-arbitrator/Chart.yaml +++ /dev/null @@ -1,17 +0,0 @@ -name: nginx-appprotect-dos-arbitrator -version: 0.1.0 -appVersion: 1.1.0 -apiVersion: v1 -kubeVersion: ">= 1.22.0-0" -description: NGINX App Protect Dos arbitrator -icon: https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.0.2/deployments/helm-chart-dos-arbitrator/chart-icon.png -home: https://github.com/nginxinc/kubernetes-ingress -sources: - - https://github.com/nginxinc/kubernetes-ingress/tree/v3.0.2/deployments/helm-chart-dos-arbitrator -keywords: - - appprotect-dos - - nginx - - arbitrator -maintainers: - - name: nginxinc - email: kubernetes@nginx.com diff --git a/deployments/helm-chart-dos-arbitrator/README.md b/deployments/helm-chart-dos-arbitrator/README.md deleted file mode 100644 index 82094ea720..0000000000 --- a/deployments/helm-chart-dos-arbitrator/README.md +++ /dev/null @@ -1,95 +0,0 @@ -# NGINX App Protect DoS Arbitrator Helm Chart - -## Introduction - -This chart deploys the NGINX App Protect DoS Arbitrator in your Kubernetes cluster. - -## Prerequisites - - - A [Kubernetes Version Supported by the Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/#supported-kubernetes-versions) - - Helm 3.0+. - - Git. - -## Getting the Chart Sources - -This step is required if you're installing the chart using its sources. Additionally, the step is also required for managing the custom resource definitions (CRDs), which the Ingress Controller requires by default, or for upgrading/deleting the CRDs. - -1. Clone the Ingress Controller repo: - ```console - $ git clone https://github.com/nginxinc/kubernetes-ingress.git --branch v3.0.2 - ``` -2. Change your working directory to /deployments/helm-chart-dos-arbitrator: - ```console - $ cd kubernetes-ingress/deployments/helm-chart-dos-arbitrator - ``` - -## Adding the Helm Repository - -This step is required if you're installing the chart via the helm repository. - -```console -$ helm repo add nginx-stable https://helm.nginx.com/stable -$ helm repo update -``` - -## Installing the Chart - -### Installing via Helm Repository - -To install the chart with the release name my-release-dos (my-release-dos is the name that you choose): - -```console -$ helm install my-release-dos nginx-stable/nginx-appprotect-dos-arbitrator -``` - - -### Installing Using Chart Sources - -To install the chart with the release name my-release-dos (my-release-dos is the name that you choose): - -```console -$ helm install my-release-dos . -``` - -The command deploys the App Protect DoS Arbitrator in your Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation. - -## Upgrading the Chart - -### Upgrading the Release - -To upgrade the release `my-release-dos`: - -#### Upgrade Using Chart Sources: - -```console -$ helm upgrade my-release-dos . -``` - -#### Upgrade via Helm Repository: - -```console -$ helm upgrade my-release-dos nginx-stable/nginx-appprotect-dos-arbitrator -``` - -## Uninstalling the Chart - -### Uninstalling the Release - -To uninstall/delete the release `my-release-dos`: - -```console -$ helm uninstall my-release-dos -``` - -The command removes all the Kubernetes components associated with the release and deletes the release. - -## Configuration - -The following tables lists the configurable parameters of the NGINX App Protect DoS Arbitrator chart and their default values. - -Parameter | Description | Default ---- | --- | --- -`arbitrator.resources` | The resources of the Arbitrator pods. | limits:
cpu: 500m
memory: 128Mi -`arbitrator.image.repository` | The image repository of the Arbitrator image. | docker-registry.nginx.com/nap-dos/app_protect_dos_arb -`arbitrator.image.tag` | The tag of the Arbitrator image. | 1.1.0 -`arbitrator.image.pullPolicy` | The pull policy for the Arbitrator image. | IfNotPresent diff --git a/deployments/helm-chart-dos-arbitrator/chart-icon.png b/deployments/helm-chart-dos-arbitrator/chart-icon.png deleted file mode 100644 index 52961c9a6f9e2e1f281ff3340b8b4a6d941bcbf9..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8165 zcmX9j1yoeu(;y)$T_Vi_0)m8e$I>Z{wDd|NEU+}Xgn%FoON)fGbayw>u^`RT-SO@3 z|DE^Fx%Zu!d++qSGxJSTLlOT4)eAH|s5?F1cXE_EkoiMe`iGt_CJ;SAzQ|E)s^|x1_0)n< zvi`wO&Z#{1NCm@bBMke*x|!M!#p=)WbBxI6v1HKYiR9)1l~$KFwujIsoHvE&l}ioV zqr+!6?`cNQD(;2(+{d1QaB>rn*m4-3$eySmbj#ABaQ)^hJ;lp}tM1&(FGl$GfU_AF zAw+(m6u_d8t$#OcYr7qsz4;X2H_-ZepN;;u)Sz4rNpWJ((rs+6FEXDG76#-jwulyS z&^fTHn5&uwnnA)UW+cfb=cw;!9A>V+EEItGW02V0${XJ`7^OI#yL^;TF;`rF><}j% z!CTOGX5jOOAvj<7D&ZhlSo>rHF4YT*xP!xj=kf`Q8h@ttg`ay3?8nZWpTIJhVb0n= zB!a4IIHaFw!KAPk$zSbgnf}_jLRS(PqPVGKKs(s(We3tSmyXqD06ZLfPIdlc!!jrp zA|%QE=aZTn6)&l%&1j9&n|^pmrM`s$+5tt3{*_gaqpjS6dcV})=pQQ^AJZU;{G68$ zR6V)Ul?UsKVx$3!VcESrPm_rc{}R*TudM{`(jCc3BH4-4YJu%gHdKTmEuCObNbtqk%bY z_^rK*`L&bCB~)up&K4y0b})SHEarsCn$9o_B}Cq8mmXw{_-l-%AVyuKNo!Q3NWLy z;Zh>Fq}m^wT9IRGo~jg}PY{8hLXhoSEsaF#7G6Z{K))kxLEm8&t^5)9`)T1ZRc?`5 zb4cu4sVJqux~~cGne-g__E{;FCsc^ zK+T&S%Cw;KLxS4I|KA{5W2$3nkr2Sb^i-iQJ_{-}ST*1NGS}7JacC-k8t+J8&V$dH z8F*j&WnWEPk8947%=0$8Bri%StFIqdG|jnJeZ&0P$es7@<8Kp&>c<+-J-bew;(1>3 zKI>DVB)D@ge=1-*+Fm(e3-4_WTod=>PSHHCUXJw;S?qnJRBO);F@p!8#EX&C<3;^k zajTTNM~unuDMYD!tLghg%809zKb#6V)a}P^#0y3p;pg)v@t*le+w_-)d=_Tk@<2 z6d3k-OFj3OBC=|Ht>t2>DH=m8v9b=&lu#EURa>R*6fsPWtMx?unJi(lLrHled3C~J zKrO9jnj&;F%j!DhIB`Fk%zCWX5;#8OA=dd)3k-Q~wz3_iL@%qLkbn%`CzAx0AS}u9 z>S&DZSvue2G9>?!&5E1nbBrbgJP^%f+GY^deS>o+)SDjxf##almSfqkjJ2R9H*nchd5CNuH)3pSm^UfW1p53Vho?DyQcpUfWZc ziu8mzT*wsL{HIF+#27C^&A&d7yD(J)JhKZMH!lntE^?h$EJxr^$alq6`F?GL|7OAbt%@Pflepj*<&k&fA(g ze&4`yQ1p=k*9^y@?v)<X-7`7Lcx3tFgf;?>Nk?R}8 zAv#6D+h70K3@-mq6J*vSpemJTY@KR&tj?)}f4IdihhflMtL$9^Hae_0CrX{Em|>VL zShBOY@3gn~Dos>(a?+%#2R!*F&z3}*n3C+FVv3h{@~mHNZ>lh(>zp3ZAnH`LPUBXQ-fjsyX=m>mU%?4>WN#?Y|V?QLgnwG3)rQ zk-UejeS#cojm(@KCrdhDuCzlNgXu2{$3L z=eW9!SG05#0fL0_NbM=IUA#P<(ZTU$gW!_eo0-boJL8=3a$`J3@1Kx%IvZ#o-cYaH zg3i-`em2&22|oCMY@&{wbA0Q7GrqMGB6~8kJ$dWtNTQCs3sP%{gTY-^pR6z|A9YWj z0-S`glAnnP;&Kp}&O=%h_Pv@(j#+z`K%wBZj1vxSB^M?a&wM-)F-z|rC|3C@cs&c?OSvx>-v0~v?4N~}0$Jh9{5xXCXFc%~B3uzI z-$ugS1~SO7y%W|tx3+moATB=4UcdCzcuOtgziFGP+>_Ika@nYU0%j$XRjwV|N^-y9 zM|@UN)=*k2lEfI;na?69T^JXAO`b<~*Csh!_SO7knYGy44)J1;okOk8ULmr+n{CZX z9P?Sev75==by5^EZeVPz^~+SsFQ2F8a`u?h+hx7xYIkA|!oX;S=YNLAryC$*bS)=b zW%PdJ@3baZ{Sg^mF4;dDBPfJqqBEognn%}7@H^nwJ z;<5IUPXGENNOoksoB!BPFTm|X4S5F=3<<gvg5q}bjR1rFr!G9{ss+ZNhuU(3;PB4m&@`plYSqsCfy6&S$fL|x<1G98kcO%W2yJJ9@9O-ABIwfIVkUvM9+Op@L0=RBgnzGo)m$Qhia;+Twsc)Tx2!~!Q%sCU! z03FHGhRI7uoCq3zj$nz;ZX5LOimg_fQB1s*dD^lNaHXnN2263M3Om(SM2ka5~B>DzG-%J4R?f%JHThvEkj)tXjBpoxc2i_WMZB7#Q^1lH8nr70(*QB14f z$~Pv)R>r{>d#=IUL499-8zQERW14Lq$#q})^h$RlvyOa%8OHUlu}iwwi{7ab z-y#S$E>EX^_fE)z#Jw8(HoqU&*h}4J4 zqBfWkEW;`{=gsV9yNih;I%EQR{Kieo>e_#_I$^u%;)oj4K_{S`_a zg!hRT0)M&^j??MoBV_4pAToOP zAi>AB(_!6CuG`W&{GAJLd@2_em8U@CwG5!v0~fKT9yu%Zas z(!C4s>uvv-*Z_SB#l499SR(9!+DdojFm1A`qes+wjeHjhw%M}*>bzjRQ(%(}EMdK|B3Rav)S13(UN!)a=cGfm|=CXDF?UK`2%*bFW24(de z1TI^b0%M|Pb*ApvyZQHbPwyBOxx9q}krhzkd>G*c{=o zajcnumc%su?Vl6TGfrtf*yZojl`Ye0bgbfFot83$DYnjr=op(F911v zy4XdOHI`IOLxiGt=)~Ta2J4jY@q5sYAbO;~vDZ<Unz0ihKsYZ&=}zs`8ams+2|!6W^m;DtX%QYM_48xS-pthdfu=yzQtw) zXD12LvT;Iaw)!+P;@-$twksCS8sHhT4q=Lgjl+Vl?gqW8TIOW+{*_F&+?Un48&3PE=64yRfB}f0Rw3#dXdHVrNGue48(78BpG;A**#kTuV-I0=Y2Ec9g=tL&j{K z76?4m`p!*K#VsdqANlpqe-eJCgma*aEVuSm2Hp+n{P9rXQT-0}V!^E~2iSfSMflt( zxr}~q^L!Kz;$Z<+e_i>z{{}Ho_VSL=J_4>U2$ zYu+b3%&0K56I2&*(36;OH};H1qPL{JC@L0fT||2o#nfO|mcmo3@xpOHh7rF@z|_Q= zg%W5^u64KQ1AlLAejv2^$KIAk_cjXk&7W_6u0!r_5@P8bUKIkdFdn?O%Qx@Zyw3=u zXVoLVDT;{QguMn>q+IXa)_L1QGLeFEOiDOi{Vhilebna7E{*sT(j=WcmY*W2&9jDY zF^tvg7^$Q|uWVI{h6V-$e>~Wn=GhefAPUXNkiTp29K|epHfq+vLZt|Lm9M`)->&YW z=5{Y_feJ63JV|w*h$r=%9UJl8s8F9m7ALs(dsQL%i$nzsKs++l-HjpQestF$1_6}(LFK`ZByxC?ty z*Yg)bdM0WmRf}>oFEfEtRMEPJSAGZXo(?iNDOFH_$k3y0<9Fov3YO4zZ_H6<#) z6dCa$^c{j*7(y~_Iqkvxb!|789JoSo=R6Bb2`6L*?+?0>nN^Dxq~|`#E%1Kp(+sUz z9Vt8e!?g9LRDW&x6$*1z`{x}GgFr^~$q@$dDbZyoR8z+n4pElXsCwB)%g)WncO(-* z)B0tEg-*1a&{{h3m3A%#nqEG&eaZNJr14?-N8gEHs{%tIK7mEw_E7rmUEl)5W84CCCYS#Urg*? zW^dqKGVnsM(hkTbJR;hnT1UtSCREW4vZxN1iS(~I=FOUCzfG3N<7aJdKX<2Ji)8Xu ztFw#&zi0n65<1QS#hu8U&R-Ovyb2jF&#CYrY*Mv4L3*lF4u0dNMu|$MeDxO-d5<+k zl>4+$zWSrPTGXya+ZKhJ^WQKw&&A0^|0Pn8YFEx6sFp%cbL%Jwzrc{*^-^k$8u;9DfFj9tdH`035ysTU!- z%GsC5&iV9{_HTs?*VE3272TnpBMu6_g#_0h$fNKF-YxSXQ{!Zesz&5~<6lw~O7Q{l zcHnuoVyfh=((#g48H3AzW&O^lw>zjZ*NS+P4qv3bj)G8~jjAm#-3I@;b#XE!U&3{X z%k>>Em#3m#Ur~HRU9fcPE(}B2H{C~LEy|v0T6C8Rjz|B8z^{Urs?^IlqQf!dc;HC- zr#r2g1EI6~#n>TD@(6+xjD|ue84uDk<#o}d$8W9rKLx?61Zt5NWZ)ZMl`EO{wJPM^7BHuMgeM-qlAZUUwu)1!5#7< zjF(L+xNqJnGyc2RuG$TXd3Q8i?JsoGofl|fK2L1i=TY@_)12=*ujxbM9;xE)0sHb; zikGdZ_MR9?vz?pFStK&4di2|CSF^IC%%GXJI)7``uEz*dnnI;+7lAted+h7A9Xdb# zAd8H<1>WWT_bXe$@>PzM90>_`Mc&Y^reEDG6K#kaHu7|biOXc#&A-Wg6~*3xn!V+9 z-Y&)qeFfRjENyd=Ld-=6@6x`nL?C?mR;K+o7h2@t?-*HkyXy~#ERyx_mYRK;>Ww-_ zoA^hc@6uwz4$Ho>R95!{)|FazL<``7XTQ#TyIdx2bbg|U>h}%eR5UqNGhGF~zJ0sU zYoJAP{e!(&!n5`3xls(q7OM8f@NulG>~rAjyTQm~V<$&SZk&L)0IacqC$C@Kg8NpV z^4j3vR3AI(^;@WZje=qnq4lkOc~MOp1;4V~JmY(dUR?K^W{k!@-wTX1TtM(;7W=`lqG(ps?gt@R95~ zkGtC)zq49f+uAxpr*7XH1ltiV6K|6061~dNQK4R7u9bEW)(l8M^gRDi?N00BVyylN5`xs1RhgZN zHu($8I5YNKYn~#g4tG%a?D#BzqrKy_T;zjUckkCl!+I;uESfp0&x$;cF?q%FW|zcw z#lE>zH{aXze@8S=oD>$FVn1z=tY}>(I#k#C=S30$^9C2jlHxcMu(AJEj76f~I)(qf z31yTjj<_AQP7JnhWfuz?i<3=+32Xgv;Y(A+!1OR`F)P20fKo3^=U<+Wfu6nG=UnV5 zi(^C8JRnNZl39aAq*wKqK+0AjntanwarEf!N`@#L4s48};q(5M!++815*7 zh!O7-ztnce=Ay=Z$5HEnpUXB&C`9zd?%ka0S}M^qG~CiY9*cSNwg;)*$Nf6jS^H4P z!n0j=kgIwj5tmNH)>h*)oC2R?$$GY<+*Wy9yY-E>uB&XXPBL?lW5R3?NN0p*c)ol`Rr{BWG<#bKK ztrJ#*xgrZbl*?p&p)~~BOV)aK_3p6+n>Kp#+C{1Wzkw){vi+Yz3{cMdLr7&WkMm7Y z@BK!;)Rz=-eo`9=e3hBh2&Jm$ug2>0xO1oiSH4J$p}XI*5M^BZ{=53P62b+l*A+SD zmmIVH{8H$~lhv2LS1M@&-TWiF3IcpL2dWR&KRYQ}IsUgs>xoa9o~<_6FO4)wIHXND z32|LEN}w95e?7EMC+uCNM?m*8Y$<#Vz#mN?$PH5`z=#(vAK|;_kz%XM$A02mua@Dg z5Wm7`lTB*>Hohu*LX(*i=KWDdiw9Tas=?`RyR&!mdvpUaeVy=LO&@fgP`4pT_h0Fx z@~sx9<7x?`Sfg&uwL}HASm%f+^GkZxNYS=6o7GWHJY^p`mrjd+Bn&erbg=9E@?aXj zFqgHQ7(p@9rF|<{A9iimk^ifDd=V8b;d0yGsZy@oA{BYY(T`;J2F)6tq9{ZPJ+)5NB~PNx)ZU+H>0lFL zB;x)`bC!pt*MP@fvAi{NZj9A&3&dHSD|`H9Eb|`A2z6ThGVtSPo@Ds^8-CCSj_oyF z%b)Z~rVne(_DOI(19fIQy+26XU5;wd2UX9DNEdhS->DfOK3I)?Qu_!dst+Qc@>5a~ z*+f})u0EN;uMcj^Gp={Xl{I>xbWsBwOIRl>FpInp|8jIZqUI6s-&$W5@!0*{7_zbt z_O=DbcSE9(W6if?c=OZrp$TSDiZPHbZ9cIOa~v7Zi?A$2J7zC;hErqgN1QRDnZW_D zM)d_+WwDg*^jm>5XnuTE{a+8h4w7YHiNL3iLJ3zfY-R5d5rq`9+yYfP*02iw5t*L% z!J@Ms9BbB7aQI|Na*InNX@Q(R&T4n06RJY3UdQyf&7moBozyI?VT~Z8g`&2yaW&Qy z=`RbI1bs$P%qWE7*7IU4d#jmxmAP~)x5X;8-nAI1uNFrH8kt4Y34KJ%%fb|eJG0)0 zJfetK#(D4IXYlkOosRVE9M}5y&Mz#B(ax#{X}bgheV~}1cBw<%Ky^cw+hLN6MWy(j1cqupbp>_O`453;%(#$J>bTJX_B= zBEhMIDBN~9Iv$GSp(&I+K3tu)pPHijVXsL#d*e(WSi_tDAF+p?JGy}JwyqtMVZcKS zTW};DvGR=pREGApVt^b(r@W zz<_Z+H9&}@^CKY3^r25f;7nX~)Upj}+lfkS=JE-4BQ~Mzm|hom!4z6PU)~DfashI5 zSZqw9```c%A%u!Vzc$}%&9b_$6w(B<8j*cx1>yy1j}1>cpu: 500m
memory: 128Mi -`arbitrator.image.repository` | The image repository of the Arbitrator image. | docker-registry.nginx.com/nap-dos/app_protect_dos_arb -`arbitrator.image.tag` | The tag of the Arbitrator image. | latest -`arbitrator.image.pullPolicy` | The pull policy for the Arbitrator image. | IfNotPresent diff --git a/docs/content/app-protect-dos/installation.md b/docs/content/app-protect-dos/installation.md index e0fb8787f0..3b7cb1e589 100644 --- a/docs/content/app-protect-dos/installation.md +++ b/docs/content/app-protect-dos/installation.md @@ -23,13 +23,26 @@ This document provides an overview of the steps required to use NGINX App Protec $ cd kubernetes-ingress/deployments ``` -## Create the namespace and service account +## Install the App Protect DoS Arbitrator + +### Helm Chart + +The App Protect DoS Arbitrator can be installed using the [NGINX App Protect DoS Helm Chart](https://github.com/nginxinc/nap-dos-arbitrator-helm-chart). +If you have the NGINX Helm Repository already added, you can install the App Protect DoS Arbitrator by running the following command: ```bash - kubectl apply -f common/ns-and-sa.yaml +helm install my-release-dos nginx-stable/nginx-appprotect-dos-arbitrator ``` -## Install the App Protect DoS Arbitrator +### YAML Manifests + +Alternatively, you can install the App Protect DoS Arbitrator using the YAML manifests provided in the Ingress Controller repo. + +- Create the namespace and service account + +```bash + kubectl apply -f common/ns-and-sa.yaml +``` - Deploy the app protect dos arbitrator ```bash diff --git a/hack/common-release-prep.sh b/hack/common-release-prep.sh index 95675c846c..b22bf9fdbd 100755 --- a/hack/common-release-prep.sh +++ b/hack/common-release-prep.sh @@ -22,8 +22,6 @@ FILES_TO_UPDATE_IC_VERSION=( deployments/helm-chart/values-nsm.yaml deployments/helm-chart/values-plus.yaml deployments/helm-chart/values.yaml - deployments/helm-chart-dos-arbitrator/Chart.yaml - deployments/helm-chart-dos-arbitrator/README.md ) FILE_TO_UPDATE_HELM_CHART_VERSION=(deployments/helm-chart/Chart.yaml)