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.34.2
Required tools:
- kubectl - configured with access to your cluster (v1.34.2)
- kpt - for deploying the Porch package (v1.0.0-beta.59)
- git - for repository operations (v2.51.2)
- Docker - if using kind or minikube with Docker driver (v28.1.1)
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):
- Go programming language (v1.25.3)

The versions above are the latest tested versions and are NOT the only compatible versions. Porch may work with other versions.

Once installed, see Tutorials and How-Tos to learn how to use Porch.

Install guide for the Porchctl CLI.

Install guide for the Porch system on a Kubernetes cluster.

Guide for removing Porch from your Kubernetes cluster.