Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pangolin.net/llms.txt

Use this file to discover all available pages before exploring further.

Try free on Pangolin Cloud

Fastest way to get started with Pangolin using the hosted control plane. No credit card required.
Use GitOps when Pangolin and Sites (Newt) should be reconciled from Git instead of being installed manually from a local shell. Can be used together with Blueprints — see Blueprint config reference for details. These guides assume you already use, or plan to use, a GitOps controller such as Argo CD or Flux. General GitOps concepts such as reconciliation, desired state, and Git-driven workflows are outside the scope of this documentation. Refer to your GitOps controller’s documentation for those concepts.

​
Supported GitOps paths

Argo CD Guide

Deploy Pangolin or Sites (Newt) with Argo CD Applications.

Flux Guide

Deploy Pangolin or Sites (Newt) with Flux HelmRelease or Kustomization resources.

​
What GitOps manages

A GitOps workflow can reconcile the same deployment inputs used by the other Kubernetes guides:
InputUsed for
Helm chart valuesConfigure Pangolin, controller mode, database mode, ingress, Sites, and related components.
Kustomize overlaysPatch or compose rendered manifests for environment-specific deployments.
Kubernetes SecretsProvide credentials, TLS material, database connection details, or Site connector credentials.
Custom resourcesManage Argo CD Applications, Flux HelmReleases, Flux Kustomizations, or related controller resources.
Keep the Pangolin and Site configuration close to the cluster or environment that owns it. 
infrastructure/
├── clusters/
│   ├── production/
│   │   ├── pangolin/
│   │   └── sites/
│   ├── staging/
│   │   ├── pangolin/
│   │   └── sites/
│   └── dev/
│       ├── pangolin/
│       └── sites/
└── shared/
    ├── pangolin/
    └── sites/
Use environment-specific directories for values, patches, and secrets that differ between clusters. Use shared directories only for reusable configuration that should stay the same across environments.

​
Next steps

Argo CD Guide

Create Argo CD Applications for Pangolin and Sites (Newt).

Flux Guide

Create Flux sources, HelmReleases, or Kustomizations for Pangolin and Sites (Newt).

Choose an Installation Path

Compare the supported Kubernetes deployment paths.

Prerequisites

Review cluster, networking, storage, RBAC, and resource requirements.