mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-07-17 03:19:56 +00:00
docs(self-host/kubernetes): fix stale links, citations, and version support wording
Signed-off-by: Marc Schäfer <git@marcschaeferger.de>
This commit is contained in:
@@ -33,7 +33,7 @@ Use Helmfile if you want to:
|
||||
## Helmfile prerequisites
|
||||
|
||||
- Helm 3.10+
|
||||
- `helmfile` CLI installed: [Helmfile GitHub](https://github.com/roboll/helmfile)
|
||||
- `helmfile` CLI installed: [Helmfile GitHub](https://github.com/helmfile/helmfile)
|
||||
- Basic knowledge of Helm values and YAML
|
||||
|
||||
Install helmfile:
|
||||
@@ -43,7 +43,7 @@ Install helmfile:
|
||||
brew install helmfile
|
||||
|
||||
# or download from releases
|
||||
wget https://github.com/roboll/helmfile/releases/download/v<version>/helmfile_<os>_<arch>
|
||||
wget https://github.com/helmfile/helmfile/releases/download/v<version>/helmfile_<os>_<arch>
|
||||
chmod +x helmfile
|
||||
sudo mv helmfile /usr/local/bin/
|
||||
```
|
||||
|
||||
@@ -10,7 +10,7 @@ import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||
|
||||
Newt is the site connector used to expose private resources through Pangolin. It runs close to the resources you want to publish and connects back to Pangolin.
|
||||
|
||||
Newt is a user-space WireGuard tunnel client and TCP/UDP proxy. It does not require users to manage WireGuard tunnels or NAT rules manually. :contentReference[oaicite:1]{index=1}
|
||||
Newt is a user-space WireGuard tunnel client and TCP/UDP proxy. It does not require users to manage WireGuard tunnels or NAT rules manually.
|
||||
|
||||
## Version matrix
|
||||
|
||||
@@ -21,7 +21,7 @@ Newt is a user-space WireGuard tunnel client and TCP/UDP proxy. It does not requ
|
||||
| Kubernetes version | `>=1.30.14-0` |
|
||||
| Default image tag | `1.12.3` |
|
||||
|
||||
Newt chart `1.4.0` includes Newt `1.12.3` and supports Kubernetes `>=1.30.14-0`. :contentReference[oaicite:2]{index=2}
|
||||
Newt chart `1.4.0` includes Newt `1.12.3` and supports Kubernetes `>=1.30.14-0`.
|
||||
|
||||
## What the chart supports
|
||||
|
||||
@@ -38,7 +38,7 @@ Newt chart `1.4.0` includes support for:
|
||||
- optional native WireGuard mode
|
||||
- multi-instance deployments with per-instance overrides
|
||||
|
||||
The chart README lists these features for version `1.4.0`. :contentReference[oaicite:3]{index=3}
|
||||
The chart README lists these features for version `1.4.0`.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -52,7 +52,7 @@ Before installing Newt, you need:
|
||||
- Newt credentials from Pangolin: `NEWT_ID` and `NEWT_SECRET`
|
||||
- or a provisioning key for Newt 1.11+ provisioning
|
||||
|
||||
The chart quickstart lists Kubernetes `>=1.30.14`, Helm 3.x, configured `kubectl`, and Newt credentials from Pangolin as prerequisites. :contentReference[oaicite:4]{index=4}
|
||||
The chart quickstart lists Kubernetes `>=1.30.14`, Helm 3.x, configured `kubectl`, and Newt credentials from Pangolin as prerequisites.
|
||||
|
||||
See [Prerequisites](/self-host/manual/kubernetes/prerequisites) for cluster, namespace, storage, networking, and security planning.
|
||||
|
||||
@@ -66,7 +66,7 @@ Newt chart `1.4.0` supports three credential patterns:
|
||||
| Provisioning key | Newt 1.11+ provisioning | Requires writable config persistence |
|
||||
| Inline values | Local testing only | Credentials may be stored in Helm release history |
|
||||
|
||||
For production, use `auth.existingSecretName` or a GitOps-safe secret workflow. The chart values explicitly warn that inline credentials can be stored in Helm release history and recommend existing Secrets for production. :contentReference[oaicite:5]{index=5}
|
||||
For production, use `auth.existingSecretName` or a GitOps-safe secret workflow. The chart values explicitly warn that inline credentials can be stored in Helm release history and recommend existing Secrets for production.
|
||||
|
||||
## Quick install with existing Secret
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ This section covers the main Kubernetes workflows:
|
||||
| Gerbil | WireGuard interface management service used as part of the Pangolin tunnel stack. |
|
||||
| Newt | Site connector used to expose private resources through Pangolin. Newt runs as a user-space WireGuard tunnel client and TCP/UDP proxy. |
|
||||
| Traefik | Reverse proxy and router for ingress traffic. |
|
||||
| PostgreSQL / SQlite | Database options for Pangolin deployments, depending on the selected installation workflow and chart configuration. |
|
||||
| PostgreSQL / SQLite | Database options for Pangolin deployments, depending on the selected installation workflow and chart configuration. |
|
||||
| Controller | Kubernetes controller for integration with Traefik cluster resources, replacing single Traefik instances with Traefik ingress controllers. |
|
||||
|
||||
<Info>
|
||||
|
||||
@@ -37,7 +37,7 @@ Depending on the selected values, the chart can deploy:
|
||||
| Gerbil tag | `1.3.1` |
|
||||
| Traefik tag | `v3.6.15` |
|
||||
|
||||
The current chart metadata defines chart version `0.1.0-alpha.0`, app version `1.18.2`, Kubernetes `>=1.30.14-0`, and the component image metadata listed above. :contentReference[oaicite:0]{index=0}
|
||||
The current chart metadata defines chart version `0.1.0-alpha.0`, app version `1.18.2`, Kubernetes `>=1.30.14-0`, and the component image metadata listed above.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ Use a Kubernetes version that is both:
|
||||
- supported by your Kubernetes provider or distribution
|
||||
- compatible with the chart requirement
|
||||
|
||||
Kubernetes 1.30 satisfies the chart minimum, but it is no longer a supported upstream Kubernetes release. For production, use a currently supported Kubernetes minor release whenever possible.
|
||||
Kubernetes 1.30 satisfies the chart minimum, but it is no longer a supported upstream Kubernetes release. See the [Kubernetes version skew policy](https://kubernetes.io/releases/version-skew-policy/) for current support details. For production, use a currently supported Kubernetes minor release whenever possible.
|
||||
|
||||
Check your cluster version:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user