Configurations on Porch Documentation

Repository Sync

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

Documentation Location

This documentation is currently located in the system configuration section but should be moved to a more logical location as it’s about configuring individual Repository resources, not system-wide settings. This may be relocated in future documentation updates.

Sync Configuration Fields

The spec.sync field in a Repository CR controls synchronization behavior with the external repository. Repositories without sync configuration use the system default for periodic synchronization (10 minutes, overridden by RepoSyncFrequency parameter in porch-server deployment).

Cache

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

Porch supports two caching mechanisms to store package metadata and improve performance.

Cache Types

CR Cache (Default)

By default, Porch uses Custom Resource (CR) cache, which stores cache data as Kubernetes Custom Resources.

Advantages:

No additional infrastructure required
Automatic backup with cluster backups
Simple setup and maintenance

Use when:

Getting started with Porch
Small to medium deployments
Simplicity is preferred

Database Cache

Database cache uses PostgreSQL to store cache data, providing better performance for large deployments.

OpenTelemetry Configuration

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

Overview

Porch supports OpenTelemetry observability through the autoexport package, which provides automatic configuration of metrics and traces exporters via environment variables. This enables seamless integration with various observability backends including OTLP collectors, Prometheus, and Jaeger.

All Porch components (porch-server, porch-controllers, function-runner, and wrapper-server) support OpenTelemetry configuration through standardized environment variables as defined by the OpenTelemetry specification.

Note

Current Implementation Status: Porch currently implements metrics and traces export. Logs export is not supported.

Traces Configuration

OTLP Trace Export

Export traces to an OpenTelemetry Protocol (OTLP) collector using either HTTP or gRPC protocols.