From 1be41955d1499e46fd15f42e66ed8c0decededfa Mon Sep 17 00:00:00 2001 From: Yonatan Koren Date: Sun, 14 Aug 2022 16:43:46 +0300 Subject: [PATCH] Documentation: Add Helm Repo Reference ## What * Add a simple helm repo reference (GitHub pages) to the Example Install section ## Why * Make it easier for new users to find the Helm repo ## Notes N/A --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bc7fd85..d5ac738 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,8 @@ 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 repo add netmaker https://gravitl.github.io/netmaker-helm/ +helm install netmaker/netmaker --generate-name \ # generate a random id for the deploy --set wireguard.kernel=true \ # set wireguard to kernel mode (false by default) --set baseDomain=nm.example.com \ # the base wildcard domain to use for the netmaker api/dashboard/mq ingress --set replicas=3 \ # number of server replicas to deploy (3 by default) @@ -42,7 +43,7 @@ helm install ./netmaker --generate-name \ # generate a random id for the deploy ### Recommended Settings: A minimal HA install of Netmaker can be run with the following command: -`helm install netmaker --generate-name --set baseDomain=nm.example.com --set RWXStorageClassName=nfs` +`helm install netmaker/netmaker --generate-name --set baseDomain=nm.example.com --set RWXStorageClassName=nfs` ` This install has some notable exceptions: - Ingress **must** be manually configured post-install (need to create valid Ingress with TLS)