mirror of
https://github.com/gravitl/netmaker.git
synced 2025-09-06 05:04:27 +08:00
updating docs for helm repo
This commit is contained in:
afeiszli
parent
af3ff04f1b
commit
8a2971bef6
7 changed files with 37 additions and 17 deletions
BIN
docs/_build/doctrees/environment.pickle
vendored
BIN
docs/_build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/_build/doctrees/server-installation.doctree
vendored
BIN
docs/_build/doctrees/server-installation.doctree
vendored
Binary file not shown.
|
|
@ -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
|
||||
|
|
|
|||
2
docs/_build/html/searchindex.js
vendored
2
docs/_build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
12
docs/_build/html/server-installation.html
vendored
12
docs/_build/html/server-installation.html
vendored
|
|
@ -1303,7 +1303,11 @@ kubectl apply -f netclient-template.yaml
|
|||
|
||||
|
||||
<span id="hainstall"></span><h2 id="highly-available-installation-kubernetes">Highly Available Installation (Kubernetes)<a class="headerlink" href="#highly-available-installation-kubernetes" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Netmaker comes with a Helm chart to deploy with High Availability on Kubernetes.</p>
|
||||
<p>Netmaker comes with a Helm chart to deploy with High Availability on Kubernetes:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">helm</span> <span class="n">repo</span> <span class="n">add</span> <span class="n">netmaker</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">gravitl</span><span class="o">.</span><span class="n">github</span><span class="o">.</span><span class="n">io</span><span class="o">/</span><span class="n">netmaker</span><span class="o">-</span><span class="n">helm</span><span class="o">/</span>
|
||||
<span class="n">helm</span> <span class="n">repo</span> <span class="n">update</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
||||
<h3 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h3>
|
||||
<p>To run HA Netmaker on Kubernetes, your cluster must have the following:
|
||||
|
|
@ -1325,7 +1329,7 @@ This install has some notable exceptions:
|
|||
|
||||
<h3 id="example-installations">Example Installations:<a class="headerlink" href="#example-installations" title="Permalink to this headline">¶</a></h3>
|
||||
<p>An annotated install command:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">helm</span> <span class="n">install</span> <span class="o">./</span><span class="n">netmaker</span> <span class="o">--</span><span class="n">generate</span><span class="o">-</span><span class="n">name</span> \ <span class="c1"># generate a random id for the deploy</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">helm</span> <span class="n">install</span> <span class="n">netmaker</span><span class="o">/</span><span class="n">netmaker</span> <span class="o">--</span><span class="n">generate</span><span class="o">-</span><span class="n">name</span> \ <span class="c1"># generate a random id for the deploy</span>
|
||||
<span class="o">--</span><span class="nb">set</span> <span class="n">baseDomain</span><span class="o">=</span><span class="n">nm</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> \ <span class="c1"># the base wildcard domain to use for the netmaker api/dashboard/grpc ingress</span>
|
||||
<span class="o">--</span><span class="nb">set</span> <span class="n">replicas</span><span class="o">=</span><span class="mi">3</span> \ <span class="c1"># number of server replicas to deploy (3 by default)</span>
|
||||
<span class="o">--</span><span class="nb">set</span> <span class="n">ingress</span><span class="o">.</span><span class="n">enabled</span><span class="o">=</span><span class="n">true</span> \ <span class="c1"># deploy ingress automatically (requires nginx or traefik and cert-manager + letsencrypt)</span>
|
||||
|
|
@ -1337,14 +1341,14 @@ This install has some notable exceptions:
|
|||
</pre></div>
|
||||
</div>
|
||||
<p>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).</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">helm</span> <span class="n">install</span> <span class="o">./</span><span class="n">netmaker</span> <span class="o">--</span><span class="n">generate</span><span class="o">-</span><span class="n">name</span> <span class="o">--</span><span class="nb">set</span> <span class="n">baseDomain</span><span class="o">=</span><span class="n">nm</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> \
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">helm</span> <span class="n">install</span> <span class="n">netmaker</span><span class="o">/</span><span class="n">netmaker</span> <span class="o">--</span><span class="n">generate</span><span class="o">-</span><span class="n">name</span> <span class="o">--</span><span class="nb">set</span> <span class="n">baseDomain</span><span class="o">=</span><span class="n">nm</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> \
|
||||
<span class="o">--</span><span class="nb">set</span> <span class="n">replicas</span><span class="o">=</span><span class="mi">2</span> <span class="o">--</span><span class="nb">set</span> <span class="n">ingress</span><span class="o">.</span><span class="n">enabled</span><span class="o">=</span><span class="n">true</span> <span class="o">--</span><span class="nb">set</span> <span class="n">dns</span><span class="o">.</span><span class="n">enabled</span><span class="o">=</span><span class="n">true</span> \
|
||||
<span class="o">--</span><span class="nb">set</span> <span class="n">dns</span><span class="o">.</span><span class="n">clusterIP</span><span class="o">=</span><span class="mf">10.245</span><span class="o">.</span><span class="mf">75.75</span> <span class="o">--</span><span class="nb">set</span> <span class="n">dns</span><span class="o">.</span><span class="n">RWX</span><span class="o">.</span><span class="n">storageClassName</span><span class="o">=</span><span class="n">nfs</span> \
|
||||
<span class="o">--</span><span class="nb">set</span> <span class="n">ingress</span><span class="o">.</span><span class="n">className</span><span class="o">=</span><span class="n">nginx</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The below command will install netmaker with three server replicas (the default), <strong>no coredns</strong>, 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.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">helm3</span> <span class="o">--</span><span class="n">kubeconfig</span> <span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">k3s</span><span class="o">.</span><span class="n">yaml</span> <span class="n">install</span> <span class="o">./</span><span class="n">netmaker</span> <span class="o">--</span><span class="n">generate</span><span class="o">-</span><span class="n">name</span> \
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">helm3</span> <span class="n">install</span> <span class="n">netmaker</span><span class="o">/</span><span class="n">netmaker</span> <span class="o">--</span><span class="n">generate</span><span class="o">-</span><span class="n">name</span> \
|
||||
<span class="o">--</span><span class="nb">set</span> <span class="n">baseDomain</span><span class="o">=</span><span class="n">netmaker</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> <span class="o">--</span><span class="nb">set</span> <span class="n">postgresql</span><span class="o">-</span><span class="n">ha</span><span class="o">.</span><span class="n">postgresql</span><span class="o">.</span><span class="n">replicaCount</span><span class="o">=</span><span class="mi">1</span> \
|
||||
<span class="o">--</span><span class="nb">set</span> <span class="n">ui</span><span class="o">.</span><span class="n">replicas</span><span class="o">=</span><span class="mi">1</span> <span class="o">--</span><span class="nb">set</span> <span class="n">ingress</span><span class="o">.</span><span class="n">enabled</span><span class="o">=</span><span class="n">true</span> \
|
||||
<span class="o">--</span><span class="nb">set</span> <span class="n">ingress</span><span class="o">.</span><span class="n">tls</span><span class="o">.</span><span class="n">issuerName</span><span class="o">=</span><span class="n">le</span><span class="o">-</span><span class="n">prod</span><span class="o">-</span><span class="mi">2</span> <span class="o">--</span><span class="nb">set</span> <span class="n">ingress</span><span class="o">.</span><span class="n">className</span><span class="o">=</span><span class="n">traefik</span>
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -2,7 +2,12 @@
|
|||
|
||||
  
|
||||
|
||||
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=<nginx|traefik>`
|
||||
`--set ingress.annotations.cert-manager.io/cluster-issuer=<your LE issuer name>`
|
||||
|
||||
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.<baseDomain>`
|
||||
`api.<baseDomain>`
|
||||
`grpc.<baseDomain>`
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue