github-personal/netmaker-helm
1
0
Fork 0
mirror of https://github.com/outbackdingo/netmaker-helm.git synced 2026-01-27 10:19:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Add Helm Repo Reference

Browse Source 
## 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
This commit is contained in:
Yonatan Koren
2022-08-14 16:43:46 +03:00
committed by GitHub
parent 490aa879af
commit 1be41955d1
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -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)