Installation on Porch Documentation

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.5.11/porchctl_1.5.11_linux_amd64.tar.gz"

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

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

curl -LO "https://github.com/kptdev/porch/releases/download/v1.5.11/porchctl_1.5.11_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.5.11 && cd porch-1.5.11

Download the latest Porch kpt package blueprint:

curl -LO "https://github.com/kptdev/porch/releases/download/v1.5.11/porch_blueprint.tar.gz"

Extract the Porch kpt package contents:

tar -xzf porch_blueprint.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:

NAME READY STATUS RESTARTS AGE
pod/function-runner-567ddc76d-7k8sj 1/1 Running 0 4m3s
pod/function-runner-567ddc76d-x75lv 1/1 Running 0 4m3s
pod/porch-controllers-d8dfccb4-8lc6j 1/1 Running 0 4m3s
pod/porch-server-7dc5d7cd4f-smhf5 1/1 Running 0 4m3s

NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/api ClusterIP 10.96.108.221 <none> 443/TCP,8443/TCP 4m3s
service/function-runner ClusterIP 10.96.237.108 <none> 9445/TCP 4m3s

NAME READY UP-TO-DATE AVAILABLE AGE
deployment.apps/function-runner 2/2 2 2 4m3s
deployment.apps/porch-controllers 1/1 1 1 4m3s
deployment.apps/porch-server 1/1 1 1 4m3s

NAME DESIRED CURRENT READY AGE
replicaset.apps/function-runner-567ddc76d 2 2 2 4m3s
replicaset.apps/porch-controllers-d8dfccb4 1 1 1 4m3s
replicaset.apps/porch-server-7dc5d7cd4f 1 1 1 4m3s

Verify the Porch API is accessible:

Uninstalling Porch

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

Uninstalling Porch Server

Navigate to the directory where you installed Porch:

cd porch-1.5.11

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.