Porch Server on Porch Documentation

Git Authentication

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

Authentication Methods

The Porch Server handles interaction with Git repositories through Repository Custom Resources (CRs) that act as a link between the Porch Server and the Git repositories.

Porch Server supports three authentication methods for Git repositories:

Basic Authentication - Username and password or Personal Access Token (post-deployment)
Bearer Token Authentication - Token-based authentication (post-deployment)
HTTPS/TLS Configuration - Custom TLS certificates for self-hosted Git (requires pre-deployment configuration)

1. Basic Authentication

Uses username and password or Personal Access Token (PAT). The secret must:

Cert Manager Webhooks

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

Porch includes validating webhooks that require TLS certificates. By default, Porch generates self-signed certificates, but you can configure it to use cert-manager for automatic certificate management.

Porch Webhooks

Porch uses two validating webhooks:

PackageRevision Deletion Webhook - Validates PackageRevision deletion requests
Repository Validation Webhook - Validates Repository creation and updates

Using the Catalog Package

The porch catalog provides a ready-to-use package for Porch with cert-manager integration:

# Register the catalog repository (if not already done)
porchctl repo register \
 --namespace default \
 https://github.com/kptdev/catalog.git \
 --name=catalog

# Clone the cert-manager webhook package
porchctl rpkg clone \
 catalog.porch.optional.porch-cert-manager-webhook.main \
 porch-cert-manager \
 --repository=deployment-repo \
 --namespace=default

This package includes:

Jaeger Tracing

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

Jaeger tracing provides distributed tracing capabilities for the Porch Server, allowing you to monitor and debug package operations. This is particularly useful for development and troubleshooting.

Note

Jaeger tracing is currently only supported for the Porch Server component. Function Runner and Porch Controllers do not support tracing.

Overview

Porch Server supports OpenTelemetry tracing that can be exported to Jaeger for visualization. When enabled, Porch Server will generate traces for:

Package operations (create, update, delete)
Git repository interactions
Function execution requests
API requests and responses

Deployment Setup

Deploy Jaeger to Kubernetes

Porch includes a ready-to-use Jaeger deployment: