Installation
A set of guides for installing Porch prerequisites, the porchctl CLI, and deploying Porch components on a Kubernetes cluster.
Prerequisites
Before installing Porch, ensure you have:
A Kubernetes cluster - Any of the following:
- Local cluster:
kind (recommended for testing, requires Docker),
minikube (requires Docker or other driver), or similar
- Cloud cluster: GKE, EKS, AKS, or any managed Kubernetes service
- Bare-metal cluster with standard Kubernetes installation
- Minimum version: Kubernetes v1.37.0
Required tools:
- kubectl - configured with access to your cluster (v1.37.0)
- kpt - for deploying the Porch package (v1.0.2-pre.1)
- git - for repository operations (v2.54.0)
- Docker - if using kind or minikube with Docker driver (v28.0.4)
Network access:
- Internet connectivity to pull container images from GitHub Container Registry
- Or pre-pulled images available in your cluster’s container registry
Optional tools (only needed for building Porch from source or development):
Version Compatibility
The versions listed above are the latest tested versions. Before proceeding, review the
Compatibility & Requirements page to:
- Verify your Kubernetes cluster version matches minimum requirements
- Check compatibility between Porch server and API module versions
- Confirm Go version support if building from source
Next Steps
Once you have the prerequisites, see
Tutorials and How-Tos to learn how to use Porch.
Version compatibility matrices for Porch server, API module, and dependencies.
Install guide for the Porchctl CLI.
Install guide for the Porch system on a Kubernetes cluster.
Guide for removing Porch from your Kubernetes cluster.