Skip to content

Add Kubernetes deployment guides for Newt and Pangolin #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oschwartz10612 merged 5 commits into from
May 15, 2026
Merged

Add Kubernetes deployment guides for Newt and Pangolin #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f1ae04d
docs(self-host/kubernetes): add Kubernetes deployment guides with Hel…
marcschaeferger May 10, 2026
1140b63
docs(self-host/kubernetes): fix stale links, citations, and version s…
marcschaeferger May 10, 2026
792c5d8
docs(manage/sites): remove Newt Kubernetes installation guide from do…
marcschaeferger May 10, 2026
e3d14a6
chore(self-host/manual/kubernetes): Refactor documentation for Pangol…
marcschaeferger May 14, 2026
a93c491
docs(docs.json): add redirect for Newt Kubernetes installation to Hel…
marcschaeferger May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 43 additions & 2 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
"pages": [
"manage/sites/understanding-sites",
"manage/sites/install-site",
"manage/sites/install-kubernetes",
"manage/sites/configure-site",
"manage/sites/update-site",
"manage/sites/credentials",
Expand Down Expand Up @@ -175,7 +174,44 @@
"group": "Manual Installation",
"pages": [
"self-host/manual/docker-compose",
"self-host/manual/unraid"
"self-host/manual/unraid",
{
"group": "Kubernetes",
"pages": [
"self-host/manual/kubernetes/overview",
"self-host/manual/kubernetes/choose-method",
"self-host/manual/kubernetes/prerequisites",
"self-host/manual/kubernetes/helm",
"self-host/manual/kubernetes/kustomize",
"self-host/manual/kubernetes/helmfile",
{
"group": "GitOps",
"pages": [
"self-host/manual/kubernetes/gitops/overview",
"self-host/manual/kubernetes/gitops/argocd",
"self-host/manual/kubernetes/gitops/flux"
]
},
{
"group": "Site (newt)",
"pages": [
"self-host/manual/kubernetes/newt/helm",
"self-host/manual/kubernetes/newt/kustomize",
"self-host/manual/kubernetes/newt/configuration",
"self-host/manual/kubernetes/newt/troubleshooting"
]
},
{
"group": "Pangolin",
"pages": [
"self-host/manual/kubernetes/pangolin/helm",
"self-host/manual/kubernetes/pangolin/kustomize",
"self-host/manual/kubernetes/pangolin/configuration",
"self-host/manual/kubernetes/pangolin/troubleshooting"
]
}
]
}
]
},
"self-host/dns-and-networking",
Expand Down Expand Up @@ -407,6 +443,11 @@
{
"source": "/manage/resources/private/icmp-access",
"destination": "/manage/resources/private/port-restrictions"
},
{
"source": "/manage/sites/install-kubernetes",
"destination": "/self-host/manual/kubernetes/newt/helm",
"permanent": true
}
],
"seo": {
Expand Down
100 changes: 0 additions & 100 deletions manage/sites/install-kubernetes.mdx
View file
Open in desktop

This file was deleted.

53 changes: 53 additions & 0 deletions self-host/manual/kubernetes/choose-method.mdx
View file
Open in desktop
Comment thread
marcschaeferger marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: "Choose an Installation Path"
description: "Choose the Kubernetes deployment workflow for Pangolin and Sites (Newt)."
---

import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";

<PangolinCloudTocCta />

Use this page to pick the right Kubernetes guide for your deployment workflow.

These guides assume you are already familiar with Kubernetes and the deployment tools listed below.

If you are new to Kubernetes, start with the [official Kubernetes learning resources](https://kubernetes.io/docs/tutorials/kubernetes-basics/) first. Then review the [Prerequisites](/self-host/manual/kubernetes/prerequisites) guide to check your cluster, tools, and setup.

## Installation paths

| Path | Use when | Start here |
| --- | --- | --- |
| Helm | You want the standard chart-based installation path for Pangolin or Sites (Newt). | [Helm Quick-Start](/self-host/manual/kubernetes/helm) |
| Kustomize | You want manifest overlays, for example for environment-specific configuration, patches, or rendered manifests that can be reviewed before applying. | [Kustomize Quick-Start](/self-host/manual/kubernetes/kustomize) |
| Argo CD | You already use Argo CD and want to deploy Pangolin or Sites (Newt) through a Kubernetes-native GitOps workflow. | [Argo CD Guide](/self-host/manual/kubernetes/gitops/argocd) |
| Flux | You already use Flux and want to manage Pangolin or Sites (Newt) through `HelmRelease` or `Kustomization` resources. | [Flux Guide](/self-host/manual/kubernetes/gitops/flux) |
| Helmfile | You want to manage multiple related Helm releases as one stack. | [Helmfile Guide](/self-host/manual/kubernetes/helmfile) |

## Recommended starting point

For most Kubernetes deployments, start with Helm. Use the GitOps guides only if Argo CD or Flux is already part of your deployment workflow.

Kustomize and Helmfile are useful when you need more control over manifests, overlays, or multiple coordinated releases.

## Next steps

<CardGroup cols={2}>
<Card title="Prerequisites" href="/self-host/manual/kubernetes/prerequisites" icon="list-check">
Review the required cluster, ingress, DNS, storage, and secret setup.
</Card>
<Card title="Helm Quick-Start" href="/self-host/manual/kubernetes/helm" icon="box">
Install Pangolin or Sites (Newt) with the standard chart-based workflow.
</Card>
<Card title="Kustomize Quick-Start" href="/self-host/manual/kubernetes/kustomize" icon="layer-group">
Use overlays and patches for manifest-based deployments.
</Card>
<Card title="Argo CD Guide" href="/self-host/manual/kubernetes/gitops/argocd" icon="code-branch">
Deploy Pangolin or Sites (Newt) with Argo CD.
</Card>
<Card title="Flux Guide" href="/self-host/manual/kubernetes/gitops/flux" icon="code-branch">
Deploy Pangolin or Sites (Newt) with Flux.
</Card>
<Card title="Helmfile Guide" href="/self-host/manual/kubernetes/helmfile" icon="boxes-stacked">
Manage multiple Helm releases together.
</Card>
</CardGroup>
Loading