Installation on Porch Documentation

Compatibility & Requirements

Mon, 01 Jan 0001 00:00:00 +0000

Documentation Note

This documentation covers features from the latest development branch (1.6.4-pre.2 + api 1.0.3). For production deployments, use the stable versions listed below.

Porch Server & API Module Compatibility

The Porch API module (github.com/kptdev/porch/api) is versioned independently from the Porch server. Use this matrix to ensure version compatibility when integrating with or using Porch:

Stable (Production Ready)

Porch Server	Recommended API Module	Release Date	Status
v1.6.0	v1.0.0	2026-06-29	Stable
v1.6.1	v1.0.0	2026-07-10	Stable
v1.6.2	v1.0.1	2026-07-25	Stable
v1.6.3	1.0.1 (recommended)	2026-07-30	Latest Stable

In Development (Main Branch)

Porch Server	Recommended API Module	Expected Release	Status
v1.6.4-pre.2	1.0.3	TBD	Pre-release

These versions are from the main development branch and are documented here. For production use, stick with the stable versions above.

Installing Porchctl CLI

Mon, 01 Jan 0001 00:00:00 +0000

Download the latest porchctl binary

curl -LO "https://github.com/kptdev/porch/releases/download/v1.6.3/porchctl_1.6.3_linux_amd64.tar.gz"

curl -LO "https://github.com/kptdev/porch/releases/download/v1.6.3/porchctl_1.6.3_linux_arm64.tar.gz"

curl -LO "https://github.com/kptdev/porch/releases/download/v1.6.3/porchctl_1.6.3_darwin_amd64.tar.gz"

curl -LO "https://github.com/kptdev/porch/releases/download/v1.6.3/porchctl_1.6.3_darwin_arm64.tar.gz"

Note:

To download a specific version of porch and its porchctl binary you can do so by replacing the version number and machine type its for in the curl link above.

Installing Porch

Mon, 01 Jan 0001 00:00:00 +0000

Deploying Porch on a cluster

Create a new directory for the kpt package and navigate into it:

mkdir porch-1.6.3 && cd porch-1.6.3

Download the latest Porch kpt package blueprint:

curl -LO "https://github.com/kptdev/porch/releases/download/v1.6.3/porch-kpt-package.tar.gz"

Extract the Porch kpt package contents:

tar -xzf porch-kpt-package.tar.gz

Initialize and apply the Porch kpt package:

kpt live init && kpt live apply

Verify Installation

Check that Porch components are running:

kubectl get all -n porch-system

A healthy Porch installation should show:

Uninstalling Porch

Mon, 01 Jan 0001 00:00:00 +0000

Uninstalling Porch Server

Navigate to the directory where you installed Porch:

cd porch-1.6.3

Remove Porch components using kpt:

kpt live destroy

This will delete all Porch resources from your cluster, including:

Porch server deployment
Function runner deployment
Porch controllers deployment
Services, ConfigMaps, and Secrets
Custom Resource Definitions (CRDs)

Warning

Destroying Porch will not delete your Git repositories or the packages stored in them. However, PackageRevision and Repository resources in your cluster will be removed.