pangolin_mirror/docs-v2
1
0
Fork 0
mirror of https://github.com/fosrl/docs-v2.git synced 2026-10-21 20:19:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

Move the k8s docs under the site

Browse Source
This commit is contained in:
Owen
2026-08-25 17:04:09 -04:00
parent 4abafba3dd
commit 8ee0505275
11 changed files with 47 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs.json
+11 -11
View File
@@ -44,7 +44,16 @@
"manage/sites/update-site", "manage/sites/update-site",
"manage/sites/auto-update", "manage/sites/auto-update",
"manage/sites/credentials", "manage/sites/credentials",
"manage/sites/site-provisioning" "manage/sites/site-provisioning",
{
"group": "Kubernetes",
"pages": [
"manage/sites/kubernetes/helm",
"manage/sites/kubernetes/kustomize",
"manage/sites/kubernetes/configuration",
"manage/sites/kubernetes/troubleshooting"
]
}
] ]
}, },
{ {
@@ -271,15 +280,6 @@
"self-host/manual/kubernetes/gitops/flux" "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", "group": "Pangolin",
"pages": [ "pages": [
@@ -529,7 +529,7 @@
}, },
{ {
"source": "/manage/sites/install-kubernetes", "source": "/manage/sites/install-kubernetes",
"destination": "/self-host/manual/kubernetes/newt/helm", "destination": "/manage/sites/kubernetes/helm",
"permanent": true "permanent": true
}, },
{ {
manage/ai/configure-ai-clients/claude-desktop.mdx
+4 -8
View File
@@ -9,8 +9,7 @@ Claude Desktop can route its requests through a third-party inference gateway in
<Frame> <Frame>
<img <img
src=" src="/images/claude_desktop_landing.png"
/images/claude_desktop_landing.png"
alt="Claude Desktop third-party inference settings" alt="Claude Desktop third-party inference settings"
/> />
</Frame> </Frame>
@@ -26,16 +25,14 @@ You'll need the resource's URL (its `<endpoint>`) and its API key (`<key>`). Bot
1. Open Claude Desktop, go to the menu in the top left and select **Help > Troubleshooting**, and turn on **Developer Mode**. 1. Open Claude Desktop, go to the menu in the top left and select **Help > Troubleshooting**, and turn on **Developer Mode**.
<Frame> <Frame>
<img <img
src=" src="/images/claude_desktop_troubleshooting.png"
/images/claude_desktop_troubleshooting.png"
alt="Claude Desktop third-party inference settings" alt="Claude Desktop third-party inference settings"
/> />
</Frame> </Frame>
2. From the menu bar, open **Developer**, then **Configure Third-Party Inference…**. 2. From the menu bar, open **Developer**, then **Configure Third-Party Inference…**.
<Frame> <Frame>
<img <img
src=" src="/images/claude_desktop_developer.png"
/images/claude_desktop_developer.png"
alt="Claude Desktop third-party inference settings" alt="Claude Desktop third-party inference settings"
/> />
</Frame> </Frame>
@@ -46,8 +43,7 @@ You'll need the resource's URL (its `<endpoint>`) and its API key (`<key>`). Bot
- **Gateway API Key:** `<key>` - **Gateway API Key:** `<key>`
<Frame> <Frame>
<img <img
src=" src="/images/claude_desktop_developer_settings.png"
/images/claude_desktop_developer_settings.png"
alt="Claude Desktop third-party inference settings" alt="Claude Desktop third-party inference settings"
/> />
</Frame> </Frame>
self-host/manual/kubernetes/newt/configuration.mdx → manage/sites/kubernetes/configuration.mdx
+8 -6
View File
@@ -1,7 +1,9 @@
--- ---
title: "Configuration" title: "Configuration"
description: "Configuration reference for Newt Kubernetes deployments." description: "Configuration reference for Newt Kubernetes deployments."
---This page covers the main Newt Kubernetes configuration options for Helm and Kustomize workflows. ---
This page covers the main Newt Kubernetes configuration options for Helm and Kustomize workflows.
For exhaustive option coverage, refer to the chart resources: For exhaustive option coverage, refer to the chart resources:
@@ -692,7 +694,7 @@ helm upgrade --install newt fossorial/newt \
--set 'newtInstances[0].auth.existingSecretName=newt-auth' --set 'newtInstances[0].auth.existingSecretName=newt-auth'
``` ```
See [Site (newt) Helm](/self-host/manual/kubernetes/newt/helm) for the installation flow. See [Site (newt) Helm](/manage/sites/kubernetes/helm) for the installation flow.
### Kustomize ### Kustomize
@@ -711,7 +713,7 @@ Then apply an overlay:
kubectl apply -k overlays/site-a kubectl apply -k overlays/site-a
``` ```
See [Newt Kustomize](/self-host/manual/kubernetes/newt/kustomize) for the Kustomize workflow. See [Newt Kustomize](/manage/sites/kubernetes/kustomize) for the Kustomize workflow.
### GitOps ### GitOps
@@ -748,13 +750,13 @@ See [GitOps](/self-host/manual/kubernetes/gitops/overview) for GitOps guidance.
## Next steps ## Next steps
<CardGroup cols={2}> <CardGroup cols={2}>
<Card title="Helm Install" href="/self-host/manual/kubernetes/newt/helm" icon="box"> <Card title="Helm Install" href="/manage/sites/kubernetes/helm" icon="box">
Install Newt with Helm. Install Newt with Helm.
</Card> </Card>
<Card title="Kustomize Install" href="/self-host/manual/kubernetes/newt/kustomize" icon="layer-group"> <Card title="Kustomize Install" href="/manage/sites/kubernetes/kustomize" icon="layer-group">
Install Newt with rendered manifests and Kustomize overlays. Install Newt with rendered manifests and Kustomize overlays.
</Card> </Card>
<Card title="Troubleshooting" href="/self-host/manual/kubernetes/newt/troubleshooting" icon="circle-question"> <Card title="Troubleshooting" href="/manage/sites/kubernetes/troubleshooting" icon="circle-question">
Debug Newt deployment and connection issues. Debug Newt deployment and connection issues.
</Card> </Card>
<Card title="GitOps" href="/self-host/manual/kubernetes/gitops/overview" icon="code-branch"> <Card title="GitOps" href="/self-host/manual/kubernetes/gitops/overview" icon="code-branch">
self-host/manual/kubernetes/newt/helm.mdx → manage/sites/kubernetes/helm.mdx
+3 -3
View File
@@ -395,13 +395,13 @@ OCI changes where Helm pulls the chart from. It does not change the values file
## Next steps ## Next steps
<CardGroup cols={2}> <CardGroup cols={2}>
<Card title="Full Configuration" href="/self-host/manual/kubernetes/newt/configuration" icon="sliders"> <Card title="Full Configuration" href="/manage/sites/kubernetes/configuration" icon="sliders">
Review all Newt chart options. Review all Newt chart options.
</Card> </Card>
<Card title="Troubleshooting" href="/self-host/manual/kubernetes/newt/troubleshooting" icon="circle-question"> <Card title="Troubleshooting" href="/manage/sites/kubernetes/troubleshooting" icon="circle-question">
Debug Newt deployment and connection issues. Debug Newt deployment and connection issues.
</Card> </Card>
<Card title="Kustomize Install" href="/self-host/manual/kubernetes/newt/kustomize" icon="layer-group"> <Card title="Kustomize Install" href="/manage/sites/kubernetes/kustomize" icon="layer-group">
Install Newt with rendered manifests and Kustomize overlays. Install Newt with rendered manifests and Kustomize overlays.
</Card> </Card>
<Card title="Pangolin Helm" href="/self-host/manual/kubernetes/pangolin/helm" icon="server"> <Card title="Pangolin Helm" href="/self-host/manual/kubernetes/pangolin/helm" icon="server">
self-host/manual/kubernetes/newt/kustomize.mdx → manage/sites/kubernetes/kustomize.mdx
+7 -5
View File
@@ -1,7 +1,9 @@
--- ---
title: "Kustomize" title: "Kustomize"
description: "Deploy Newt on Kubernetes using Helm-rendered manifests and Kustomize overlays." description: "Deploy Newt on Kubernetes using Helm-rendered manifests and Kustomize overlays."
---Use Kustomize when you want to manage Newt with rendered manifests, environment-specific overlays, and explicit patches in Git. ---
Use Kustomize when you want to manage Newt with rendered manifests, environment-specific overlays, and explicit patches in Git.
For Newt, the supported Kustomize workflow is: For Newt, the supported Kustomize workflow is:
@@ -20,7 +22,7 @@ Use Kustomize if you:
- use Argo CD or Flux with Kustomize sources - use Argo CD or Flux with Kustomize sources
- want to customize Helm-rendered output without forking the chart - want to customize Helm-rendered output without forking the chart
For a simpler single-site setup, use [Newt Helm](/self-host/manual/kubernetes/newt/helm). For a simpler single-site setup, use [Newt Helm](/manage/sites/kubernetes/helm).
## Supported approach ## Supported approach
@@ -595,13 +597,13 @@ Verify:
## Next steps ## Next steps
<CardGroup cols={2}> <CardGroup cols={2}>
<Card title="Helm Install" href="/self-host/manual/kubernetes/newt/helm" icon="box"> <Card title="Helm Install" href="/manage/sites/kubernetes/helm" icon="box">
Install Newt with Helm. Install Newt with Helm.
</Card> </Card>
<Card title="Configuration" href="/self-host/manual/kubernetes/newt/configuration" icon="sliders"> <Card title="Configuration" href="/manage/sites/kubernetes/configuration" icon="sliders">
Review Newt chart options. Review Newt chart options.
</Card> </Card>
<Card title="Troubleshooting" href="/self-host/manual/kubernetes/newt/troubleshooting" icon="circle-question"> <Card title="Troubleshooting" href="/manage/sites/kubernetes/troubleshooting" icon="circle-question">
Debug Newt deployment and connection issues. Debug Newt deployment and connection issues.
</Card> </Card>
<Card title="GitOps" href="/self-host/manual/kubernetes/gitops/overview" icon="code-branch"> <Card title="GitOps" href="/self-host/manual/kubernetes/gitops/overview" icon="code-branch">
self-host/manual/kubernetes/newt/troubleshooting.mdx → manage/sites/kubernetes/troubleshooting.mdx
+6 -4
View File
@@ -1,7 +1,9 @@
--- ---
title: "Troubleshooting" title: "Troubleshooting"
description: "Diagnose and resolve common Newt Kubernetes deployment issues." description: "Diagnose and resolve common Newt Kubernetes deployment issues."
---Use this guide to troubleshoot Newt Kubernetes deployments installed with Helm, Kustomize, Argo CD, or Flux. ---
Use this guide to troubleshoot Newt Kubernetes deployments installed with Helm, Kustomize, Argo CD, or Flux.
Start with the basic checks, then move to the section that matches the symptom. Start with the basic checks, then move to the section that matches the symptom.
@@ -685,13 +687,13 @@ Before sharing diagnostics, remove:
## Next steps ## Next steps
<CardGroup cols={2}> <CardGroup cols={2}>
<Card title="Configuration" href="/self-host/manual/kubernetes/newt/configuration" icon="sliders"> <Card title="Configuration" href="/manage/sites/kubernetes/configuration" icon="sliders">
Review Newt chart options. Review Newt chart options.
</Card> </Card>
<Card title="Helm Install" href="/self-host/manual/kubernetes/newt/helm" icon="box"> <Card title="Helm Install" href="/manage/sites/kubernetes/helm" icon="box">
Install Newt with Helm. Install Newt with Helm.
</Card> </Card>
<Card title="Kustomize Install" href="/self-host/manual/kubernetes/newt/kustomize" icon="layer-group"> <Card title="Kustomize Install" href="/manage/sites/kubernetes/kustomize" icon="layer-group">
Install Newt with rendered manifests and Kustomize overlays. Install Newt with rendered manifests and Kustomize overlays.
</Card> </Card>
<Card title="GitOps" href="/self-host/manual/kubernetes/gitops/overview" icon="code-branch"> <Card title="GitOps" href="/self-host/manual/kubernetes/gitops/overview" icon="code-branch">
manage/ssh.mdx
+1 -2
View File
@@ -362,8 +362,7 @@ If you need a password generated for your user on the remote system (for example
<Frame> <Frame>
<img <img
src=" src="/images/role_ssh_modal.png"
/images/role_ssh_modal.png"
alt="Claude Desktop third-party inference settings" alt="Claude Desktop third-party inference settings"
/> />
</Frame> </Frame>
self-host/advanced/observability.mdx
+2 -2
View File
@@ -148,7 +148,7 @@ controller:
``` ```
<Note> <Note>
Helm values for Newt are documented on the [Kubernetes Newt configuration page](/self-host/manual/kubernetes/newt/configuration). Controller and Gerbil ServiceMonitor values are documented on the [Kubernetes Pangolin configuration page](/self-host/manual/kubernetes/pangolin/configuration). Helm values for Newt are documented on the [Kubernetes Newt configuration page](/manage/sites/kubernetes/configuration). Controller and Gerbil ServiceMonitor values are documented on the [Kubernetes Pangolin configuration page](/self-host/manual/kubernetes/pangolin/configuration).
</Note> </Note>
</Tab> </Tab>
@@ -520,7 +520,7 @@ increase(pangolin_kube_controller_reconcile_errors_total[10m]) > 5
<Card title="Community Metrics Guide" icon="chart-simple" href="/self-host/community-guides/metrics"> <Card title="Community Metrics Guide" icon="chart-simple" href="/self-host/community-guides/metrics">
Traefik and metrics collection with Prometheus and Grafana. Traefik and metrics collection with Prometheus and Grafana.
</Card> </Card>
<Card title="Newt Kubernetes Monitoring" icon="cubes" href="/self-host/manual/kubernetes/newt/configuration"> <Card title="Newt Kubernetes Monitoring" icon="cubes" href="/manage/sites/kubernetes/configuration">
Verified Newt chart values for metrics, Services, and ServiceMonitor resources. Verified Newt chart values for metrics, Services, and ServiceMonitor resources.
</Card> </Card>
<Card title="Controller Monitoring Values" icon="cubes" href="/self-host/manual/kubernetes/pangolin/configuration"> <Card title="Controller Monitoring Values" icon="cubes" href="/self-host/manual/kubernetes/pangolin/configuration">
self-host/manual/kubernetes/helm.mdx
-11
View File
@@ -55,7 +55,6 @@ It is recommended to create the namespace explicitly before installation. This a
For detailed installation steps, see: For detailed installation steps, see:
* [Pangolin Helm Quick-Start](/self-host/manual/kubernetes/pangolin/helm) — Install Pangolin * [Pangolin Helm Quick-Start](/self-host/manual/kubernetes/pangolin/helm) — Install Pangolin
* [Site (Newt) Helm Quick-Start](/self-host/manual/kubernetes/newt/helm) — Install Site (Newt)
## Install command patterns ## Install command patterns
@@ -162,7 +161,6 @@ Common value sources:
Full configuration options are documented here: Full configuration options are documented here:
* [Pangolin Configuration](/self-host/manual/kubernetes/pangolin/configuration) * [Pangolin Configuration](/self-host/manual/kubernetes/pangolin/configuration)
* [Newt Configuration](/self-host/manual/kubernetes/newt/configuration)
## Artifact Hub and chart discovery ## Artifact Hub and chart discovery
@@ -337,10 +335,7 @@ Uninstalling a Helm release does not always remove persistent volumes, externall
## Troubleshooting ## Troubleshooting
For component-specific troubleshooting, see:
* [Pangolin Troubleshooting](/self-host/manual/kubernetes/pangolin/troubleshooting) * [Pangolin Troubleshooting](/self-host/manual/kubernetes/pangolin/troubleshooting)
* [Newt Troubleshooting](/self-host/manual/kubernetes/newt/troubleshooting)
Useful Helm commands: Useful Helm commands:
@@ -367,15 +362,9 @@ kubectl logs <pod-name> -n pangolin
<Card title="Pangolin Helm Install" href="/self-host/manual/kubernetes/pangolin/helm" icon="server"> <Card title="Pangolin Helm Install" href="/self-host/manual/kubernetes/pangolin/helm" icon="server">
Install Pangolin with the Helm chart. Install Pangolin with the Helm chart.
</Card> </Card>
<Card title="Site (Newt) Helm Install" href="/self-host/manual/kubernetes/newt/helm" icon="globe">
Install Site (Newt) with the Helm chart.
</Card>
<Card title="Pangolin Configuration" href="/self-host/manual/kubernetes/pangolin/configuration" icon="sliders"> <Card title="Pangolin Configuration" href="/self-host/manual/kubernetes/pangolin/configuration" icon="sliders">
Configure Pangolin chart values for your cluster. Configure Pangolin chart values for your cluster.
</Card> </Card>
<Card title="Newt Configuration" href="/self-host/manual/kubernetes/newt/configuration" icon="sliders">
Configure Newt chart values and credentials.
</Card>
<Card title="Argo CD" href="/self-host/manual/kubernetes/gitops/argocd" icon="code-branch"> <Card title="Argo CD" href="/self-host/manual/kubernetes/gitops/argocd" icon="code-branch">
Deploy the charts with Argo CD. Deploy the charts with Argo CD.
</Card> </Card>
self-host/manual/kubernetes/kustomize.mdx
+1 -1
View File
@@ -359,7 +359,7 @@ kubectl get events -n pangolin --sort-by=.lastTimestamp
<Card title="Pangolin Kustomize Install" href="/self-host/manual/kubernetes/pangolin/kustomize" icon="server"> <Card title="Pangolin Kustomize Install" href="/self-host/manual/kubernetes/pangolin/kustomize" icon="server">
Install Pangolin with rendered manifests and Kustomize overlays. Install Pangolin with rendered manifests and Kustomize overlays.
</Card> </Card>
<Card title="Newt Kustomize Install" href="/self-host/manual/kubernetes/newt/kustomize" icon="globe"> <Card title="Newt Kustomize Install" href="/manage/sites/kubernetes/kustomize" icon="globe">
Install Newt with rendered manifests and Kustomize overlays. Install Newt with rendered manifests and Kustomize overlays.
</Card> </Card>
<Card title="Argo CD" href="/self-host/manual/kubernetes/gitops/argocd" icon="code-branch"> <Card title="Argo CD" href="/self-host/manual/kubernetes/gitops/argocd" icon="code-branch">
self-host/manual/kubernetes/overview.mdx
+3 -3
View File
@@ -67,13 +67,13 @@ flowchart LR
<Card title="Pangolin Troubleshooting" href="/self-host/manual/kubernetes/pangolin/troubleshooting" icon="circle-question"> <Card title="Pangolin Troubleshooting" href="/self-host/manual/kubernetes/pangolin/troubleshooting" icon="circle-question">
Diagnose and resolve Pangolin deployment issues. Diagnose and resolve Pangolin deployment issues.
</Card> </Card>
<Card title="Site (Newt) Helm" href="/self-host/manual/kubernetes/newt/helm" icon="server"> <Card title="Site (Newt) Helm" href="/manage/sites/kubernetes/helm" icon="server">
Install a Site connector with the Newt Helm chart. Install a Site connector with the Newt Helm chart.
</Card> </Card>
<Card title="Site (Newt) Configuration" href="/self-host/manual/kubernetes/newt/configuration" icon="sliders"> <Card title="Site (Newt) Configuration" href="/manage/sites/kubernetes/configuration" icon="sliders">
Configure Site connector credentials and runtime settings. Configure Site connector credentials and runtime settings.
</Card> </Card>
<Card title="Site (Newt) Troubleshooting" href="/self-host/manual/kubernetes/newt/troubleshooting" icon="circle-question"> <Card title="Site (Newt) Troubleshooting" href="/manage/sites/kubernetes/troubleshooting" icon="circle-question">
Diagnose and resolve Site connector deployment issues. Diagnose and resolve Site connector deployment issues.
</Card> </Card>
</CardGroup> </CardGroup>