From 8a2971bef6641439a31a6ee7cba209d65e98ca5a Mon Sep 17 00:00:00 2001 From: afeiszli Date: Tue, 19 Oct 2021 12:00:37 -0400 Subject: [PATCH] updating docs for helm repo --- docs/_build/doctrees/environment.pickle | Bin 90316 -> 90316 bytes .../doctrees/server-installation.doctree | Bin 119550 -> 119824 bytes .../html/_sources/server-installation.rst.txt | 13 +++++++++---- docs/_build/html/searchindex.js | 2 +- docs/_build/html/server-installation.html | 12 ++++++++---- docs/server-installation.rst | 13 +++++++++---- kube/helm/README.md | 14 ++++++++++---- 7 files changed, 37 insertions(+), 17 deletions(-) diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 4df0dba5f681a4489923166ea48981e550f1786d..784ab6640c0dbd757ff6be1f7113eea958b050c5 100644 GIT binary patch delta 1525 zcmZuwYfKzf6z1%9yOc+H4DYAxE^Wc?E`_&a$K_ z5=EO5w{hd$I%>qGi9Z!+*LI?&CB#SCN~^|bjL}%1u_5^QW3-m&Im1Gt>7Vbr=ljk% z_ntd*7Z)sx3zoUrs!XdWM^ru-Wb;*J6FI!%8xmE)r$!Ya8RsH`GAby}bPBJEAvqbh z@PnbKnv7e6qEC<`m}e1Xzc7}JXOBch-w`MFQ_#-~2&yW|fz?>>V}&my`=dVea#ST0 z9SjPQp->3Jd|^x#6q)r^=VnJEd;oiz`LM`-ttzovBhhd;q@*URO&c0UO&J+`yS_O5 z_BZZAt2D75?Re?16kCrv4)(B_x^Wh^ZDO3Qrz#=Mq4!*JTfA5t#_kcfPZ4-kaLR(p zW^5hIZs)d_r7hHk`6D>B9P$gUupCIni_%t@rXiVqZ>ujVT`NGr=@(R93`W>K`{{Bz zByE>YQM3{YHZg{P3Ikk$THpkK;_IO)Av@B;C7*>IHDlMB>N|6wzf zVLf}YlhgAH;52D-g`g4dD}rNyW8!IP%n@z25DJ+4gH1Y~wiPHWWS1|L=#^!-sS)b4 zZhe`-JMr+zmcgapO7$@8l@HM;F#7$WW2M_`(`;Q$;n< zTVVV+y%q^aI0QG%hU!TgDpE{)y$_~yDRs)wrZDl*$6y)TXx;tLi8R@dpDCuj)ek4_ z^g~O3)MR8FPfC9w84p#uwJNL_f+l)Efy>%g9=Hn@wG|K8HPH*3HJ2B-yzAHiUxe|9 z6Y*m9yRBpc_PU};UZ{s_TEYvp@S!&6g-ZBHTl7NL#82rGI%FcAFAqEYA|FurVP~^T z3I~!{{^NgAGS?p|TFYsR-cKT)D~$Pqq9Cg~j7NPJ$+aLW11{_YyP`v=QtfXdx&g*h-LJM_5TvOi-g$4#3%e0Z0(^(f|Me delta 1492 zcmZuxZERCz6yE759b@06W25Y=?bwI5o!yr*0*(+-m`=k-GToY$_S)S`ce}Q?W0|$hmVOWF#8L zxHOjJg9qISDG-<3Vwe|46}dRfNfIxHvso^r$ZP*q#cph@eYhYH4-WAX7nG8599P1P zN?cqFMBKp$&xuk(k!btnzS&3-YZHYTXs~iHfJS!-O<5p&KmZe z!(Ly)5919ayka!OB|IZySdnc;Dj4Si66Y2s1 zs$A>YA=i3nWn->#)`qH`^|*ZOlq=6d+oLVqayi)huI7xTK9&b#?6XY{_T~{Un{)4j zaf;N|a;Rp5o<2zFp}Pi}*=q0aHkvM6%tfGc3tx~*WvnfYbLu4iKfW&vgCi0ZNsz4;EKt#{Sx#jWXAlV}{!QcQUKad;^17rS+QNfFUpD!q0}h zY=&M#Hd??~&#Hd1YUlGnHk|%^c*&5ztOeeXVj&n)v|o$BV$!#y6_vuYQ7~HuhYi`c z4h{ldhWA5}E+dBW+tZaA9;cns+SvxpUI8zl)=pHy8RETmxJF!G1+M|5)C<+Hi1&xf z^jpxb)<75Lwfs7GhxnWW4iRs0!AWGcG}xjQY=Y+~H_-r7FvGWl)g3P-2TD1#1Aw+t5!K!sW1_R_D-vzs< z-_0IKQ;b87WoxQ6$CEHbxtE`UDdMI*@Vu#*KB?WM`uDWkEZ`CL!R=fV8noUm`0?I;o8c#EZEFo)O&LK2K{G)M!8U>|1P>8(5V#3!1a^Xw Q2Eu9r7eSqBAB5BY0M<6?mH+?% diff --git a/docs/_build/doctrees/server-installation.doctree b/docs/_build/doctrees/server-installation.doctree index 5ebe8e9d359362eaedc525b6988243311808585c..bd664ccd4c847460c7e343ce0028e4e10fdca2b0 100644 GIT binary patch delta 4415 zcmb7IdsLNG7VmdJ?)@?yu9pkQO9&Oz;vrh8DEY_<9PZM@)G70Ge<#AcKruk=c&pmtp z_HX~r{`Pk+cWNzf?yxM|k2oPNHJgJ3GDlz}Egpp#@=wz!Os5ld=)H8ZE3a@~baCE- zqUfC5-01mvCG&FT<`qY~N=gvyegL^yUG<@`O|diR9H)EyQFb*jK8T8Ky__LU1 zle8bSPSr6P^z9QU6B#yg6(fSyOvC`;Vvj+{FfUHTLddu+voPGUni-6+d6>brCovtB znn74P#u{&Ev`R073SS26>D_c>8#UVLEpJI17_h=dN9y1Rn-S|LW#U#Sn7^S**vvvM|agf&5XKBVvh4l-UiCC$OKkTl+r534&%9>XB-qvcMc znmHJb2^3R+*tRwuOUvDer7iKW1{`9D(fmc67}>|ubSI2{m5YYnJ}7hOu{;zY&j%%^ z6Ut#m$yO+G9vz*FM4I*j>=uO{-iP%tUwr|`Vg0Qx;5A*qk@f=OX|D@|LaMv1qMEL{ zkc4-9^1sz7|1rkdpsVocDvrp4L+ZPQtEXE97>q+caE+bdjx*fvec(QJBh6QoRH@ezOBh- z5ngF)veO(soxg}f7VUYddnJ@tj9tydb&KJYQ{mELj5Jp1A}YK^l=~LZOu4_tpNx&# ziL@#KXE|fJCcO1Ur27)yLpNSTGWPlqe!mmp77pK`3D@3}u<|OmtEau^5|kOun#36| ziF55FR{G}un(|-9Xk78h|JP3W|H6?Mb^Z(Y%&)w3ezTmlHH;wD8q#VAD6zO{JJaC_fj5xn#chgOactsYvN#9$JB6Xx0r|UV#{+Ko^iNedX&Oxs;HW zOoAv4qQ^Z223f z%?(oB^}=d7r7XwMoA#{6+c-cOZ(x`4kl`t6`kdUMIa0|D9nQ zsn=ROAxFW~wHRRiQhQwNB;+^j)vAR&AEc)2^|g4o_jl~7Z&(p2Lnx*UVU)fOJ*{dZ z-2Fob2KB2!4_x!XXj+H&j6jDv^WF}c;>KXhx18#JhiB`JfjCdC9%Oc{A>AlLvL@B-LYm1nqk!Gz1^CL%EOe24#02(tJAdyYk_-q zM4L&wK@c%r!+U8L86HH*b(mxf)euQu2%CnN1a3i$=@M zkFZe~eY96#h`tphae}+Ss{XKJ$mm*s0+k$t2Ukq%ajX)UX;yuL6Mg|H62+ZF&;JoO zmL8C^$$ctNn*ID~ADc(y-O`=HrkqU~n^1XOaXZ*V$=9DdoJ|>{&MNv)Rd} zn$3DPLpWbNn_tLh$(_z-HJjHRanc^)kB8XQ%c|W6*xY7wlT9qgMQ=DMXMGAePNG^- zUa9Ch6;-FA=~NV*ik?$Zb1GU+Maik?tW;E-ipEMsVWrCMRGFPBt5aokmb#+l&sKMm z%93&j^4 zEmUs1P;2;;5{f%T3pHK~C6_DOb*gbh%C!=TrJo7P(y+u&}7Kc#ixZ z!H`P-!h-pERg*sFnb08j`O!an?wPaq zx4-k9efK%HY>)q=_x#t@B9gJjCOwKF<<}U>^Aa#i{4^zCCQliS$>xWFUAnmXx*zbJ z;TRs+N+Y=ZTp_M#S7^#A{pM)A>8F`3(#d4u78^$TuYrhY4fNc*W#gB|qEU0GdAl+H zx-sAUR~x@K4im77hbJS9&rHPg+A!rCW8qcdhz%SUDs62wn#n#)lf&)1DdJfA)hNi4y_3$hWyk4(hV>=p8lLV|9Zglvd859;I0DMdtR zh{Z#ME=5&wY3U&wZWypmrEJHn2b4EiE`R(EN%;76DHl5Zq{lIKv|ZYF+NJf(#B|2$4N?7OV>r8_ zM6K87&PE~4DN*;f6C&0QB}82Rn3%=6Y3cK_mMmDbu>Y`Ev$ArAEso0`nxC4P(NQIy z`8zZ{tGLekzY%V*+wIm;)3%n=+5;ute+}{eqzKC@sGEydP^QXqL@FXQi&d6*Ppc}+ z02+GB@`%1Y6{$=MQ(mD~^&%W4!~iQVDL`LO*na}Jdp=@Db!vbuoy$wejlhB1L`A!dfx}?lf`)6SBeH6k%4H| z=!0;{KsZSV=bs=bDb^OETc2FPCf7B@-SsK4L8`+^;sI7_WqNETK7@8xN%XZL(P<@- z>~-U^P^mpq^FJ8#XN`GkEhCm<6ppB(DqV_rbFfVoRS=(6fEasELCZ@2cU!Y`>&eo=t8?=qkKsKBH2fQmLEU zQb+RctC8xP{~FIDBX33C(Aj3u8rcH7=kcKs zo?k4=GmG&1d4`_xXJTJ_lwbxH@bnVA!PeS&(;(Qz@TpRSQjk1v|4x}-w#!btq7={J z20vViJ=o2E`v$7b2Ni++ia?DofzR}*WhjC9Bjt3QoMQOS!7!WtNw76MY%7w`$kVst zX{}LtH5(e{RMe{?&JLr4{9_7Nr4_4ZeNny z_tFg)`Pb!03GBf6wm#)ebn`=RKCJ?KF@P_tMwrmc%m-9rviLir5}d^aNwHY(ARbVP z5b>+j`nOz`UG3OYZGE?`II|`>u7takgfNND4t8G=8%7WCnS3*N?HQd)dRk#Ulr}Elv z@cEW-N`lmV>Rn9gsKWuy_{|`NhL{Ni^ltMFuPc;7a`9VA;Unh5rXRpg7{yW5H=GTdfe1})!JJoQ`*5O(0kcvIvP&KxXhTa>+yGPiC)JwR<<2ugLt1 zjGf{v!sHffOHwn_bMlv_XVV?lJ&;FUMul8Kk!0_b%$<_8Q!;i+wob{^DOoxtL#Jd{ zB$+uSt0Kv$NRn|%B2G!dDG4}pUHvI#xZvRmaMij-x$kP?@tAuFAJc$4Yo%_Vkc?6{ z`fgRa(f6d%jlSlTZgiPfy3zGZ=|&eBr5hc9O1E|NBz2==R=SN;x`|

Highly Available Installation (Kubernetes)

-

Netmaker comes with a Helm chart to deploy with High Availability on Kubernetes.

+

Netmaker comes with a Helm chart to deploy with High Availability on Kubernetes:

+
helm repo add netmaker https://gravitl.github.io/netmaker-helm/
+helm repo update
+
+

Requirements

To run HA Netmaker on Kubernetes, your cluster must have the following: @@ -1325,7 +1329,7 @@ This install has some notable exceptions:

Example Installations:

An annotated install command:

-
helm install ./netmaker --generate-name \ # generate a random id for the deploy
+
helm install netmaker/netmaker --generate-name \ # generate a random id for the deploy
 --set baseDomain=nm.example.com \ # the base wildcard domain to use for the netmaker api/dashboard/grpc ingress
 --set replicas=3 \ # number of server replicas to deploy (3 by default)
 --set ingress.enabled=true \ # deploy ingress automatically (requires nginx or traefik and cert-manager + letsencrypt)
@@ -1337,14 +1341,14 @@ This install has some notable exceptions:
 

 

 
The below command will install netmaker with two server replicas, a coredns server, and ingress with routes of api.nm.example.com, grpc.nm.example.com, and dashboard.nm.example.com. CoreDNS will be reachable at 10.245.75.75, and will use NFS to share a volume with Netmaker (to configure dns entries).

-
helm install ./netmaker --generate-name --set baseDomain=nm.example.com \
+
helm install netmaker/netmaker --generate-name --set baseDomain=nm.example.com \
 --set replicas=2 --set ingress.enabled=true --set dns.enabled=true \
 --set dns.clusterIP=10.245.75.75 --set dns.RWX.storageClassName=nfs \
 --set ingress.className=nginx
 

 

 
The below command will install netmaker with three server replicas (the default), no coredns, and ingress with routes of api.netmaker.example.com, grpc.netmaker.example.com, and dashboard.netmaker.example.com. There will be one UI replica instead of two, and one database instance instead of two. Traefik will look for a ClusterIssuer named “le-prod-2” to get valid certificates for the ingress.

-
helm3 --kubeconfig /root/k3s.yaml install ./netmaker --generate-name \
+
helm3 install netmaker/netmaker --generate-name \
 --set baseDomain=netmaker.example.com --set postgresql-ha.postgresql.replicaCount=1 \
 --set ui.replicas=1 --set ingress.enabled=true \
 --set ingress.tls.issuerName=le-prod-2 --set ingress.className=traefik
diff --git a/docs/server-installation.rst b/docs/server-installation.rst
index ae3bbde8..1894cd77 100644
--- a/docs/server-installation.rst
+++ b/docs/server-installation.rst
@@ -374,7 +374,12 @@ The following file configures Netmaker as a subdomain. This config is an adaptio
 Highly Available Installation (Kubernetes)
 ==================================================
 
-Netmaker comes with a Helm chart to deploy with High Availability on Kubernetes.
+Netmaker comes with a Helm chart to deploy with High Availability on Kubernetes:
+
+.. code-block::
+
+    helm repo add netmaker https://gravitl.github.io/netmaker-helm/
+    helm repo update
 
 Requirements
 ---------------
@@ -402,7 +407,7 @@ An annotated install command:
 
 .. code-block::
 
-    helm install ./netmaker --generate-name \ # generate a random id for the deploy 
+    helm install netmaker/netmaker --generate-name \ # generate a random id for the deploy 
     --set baseDomain=nm.example.com \ # the base wildcard domain to use for the netmaker api/dashboard/grpc ingress 
     --set replicas=3 \ # number of server replicas to deploy (3 by default) 
     --set ingress.enabled=true \ # deploy ingress automatically (requires nginx or traefik and cert-manager + letsencrypt) 
@@ -417,7 +422,7 @@ The below command will install netmaker with two server replicas, a coredns serv
 
 .. code-block::
 
-    helm install ./netmaker --generate-name --set baseDomain=nm.example.com \
+    helm install netmaker/netmaker --generate-name --set baseDomain=nm.example.com \
     --set replicas=2 --set ingress.enabled=true --set dns.enabled=true \
     --set dns.clusterIP=10.245.75.75 --set dns.RWX.storageClassName=nfs \
     --set ingress.className=nginx
@@ -426,7 +431,7 @@ The below command will install netmaker with three server replicas (the default)
 
 .. code-block::
 
-    helm3 --kubeconfig /root/k3s.yaml install ./netmaker --generate-name \
+    helm3 install netmaker/netmaker --generate-name \
     --set baseDomain=netmaker.example.com --set postgresql-ha.postgresql.replicaCount=1 \
     --set ui.replicas=1 --set ingress.enabled=true \
     --set ingress.tls.issuerName=le-prod-2 --set ingress.className=traefik
diff --git a/kube/helm/README.md b/kube/helm/README.md
index 8aca5774..17168af4 100644
--- a/kube/helm/README.md
+++ b/kube/helm/README.md
@@ -2,7 +2,12 @@
 
 ![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.9.0](https://img.shields.io/badge/AppVersion-0.9.0-informational?style=flat-square)
 
-A Helm chart to run Netmaker with High Availability on Kubernetes
+A Helm chart to run Netmaker with High Availability on Kubernetes:
+
+```
+helm repo add netmaker https://gravitl.github.io/netmaker-helm/
+helm repo update
+```
 
 ## Requirements
 
@@ -23,7 +28,7 @@ Furthermore, the chart will by default install and use a postgresql cluster as i
 ### Example Install
 
 ```
-helm install ./netmaker --generate-name \ # generate a random id for the deploy 
+helm install netmaker/netmaker --generate-name \ # generate a random id for the deploy 
 --set baseDomain=nm.example.com \ # the base wildcard domain to use for the netmaker api/dashboard/grpc ingress 
 --set replicas=3 \ # number of server replicas to deploy (3 by default) 
 --set ingress.enabled=true \ # deploy ingress automatically (requires nginx or traefik and cert-manager + letsencrypt) 
@@ -45,11 +50,12 @@ This install has some notable exceptions:
 Below, we discuss the considerations for Ingress, Kernel WireGuard, and DNS.
 
 #### Ingress	
-To run HA Netmaker, you must have ingress installed and enabled on your cluster with valid TLS certificates (not self-signed). If you are running Nginx as your Ingress Controller and LetsEncrypt for TLS certificate management, you can run the helm install with the following settings:
+To run HA Netmaker, you must have ingress installed and enabled on your cluster with valid TLS certificates (not self-signed). If you are running Nginx or Traefik as your Ingress Controller and LetsEncrypt for TLS certificate management, you can run the helm install with the following settings:
 `--set ingress.enabled=true`
+`--set ingress.className=`
 `--set ingress.annotations.cert-manager.io/cluster-issuer=`
 
-If you are not using Nginx and LetsEncrypt, we recommend leaving ingress.enabled=false (default), and then manually creating the ingress objects post-install. You will need three ingress objects with TLS:
+If you are not using Nginx or Traefik and LetsEncrypt, we recommend leaving ingress.enabled=false (default), and then manually creating the ingress objects post-install. You will need three ingress objects with TLS:
 `dashboard.`
 `api.`
 `grpc.`