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 (default 1 hour, configurable via --repositories.full-sync-frequency flag - see Repository Controller Configuration.

Cache Configuration

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

Porch supports two caching mechanisms for storing package metadata. Choose based on your deployment scale and infrastructure.

Cache Types

CR Cache (Default)

Uses Custom Resources for metadata tracking while package content is served through Porch’s aggregated API server. Suitable for development and smaller deployments.

Characteristics:

No external database required
Metadata stored in Kubernetes etcd via Custom Resources
Package content served through aggregated API server
Automatic backup with cluster backups
Simple operational model

Best For:

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.