Working with Porch Repositories on Porch Documentation

Registering Repositories

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

Registering a repository connects Porch to your Git storage backend, allowing it to discover and manage packages. You can register repositories with various authentication methods and configuration options.

Register a Git Repository

porchctl repo register https://github.com/example/porch-test.git \
 --namespace default \
 --name=porch-test \
 --description="Blueprint packages" \
 --branch=main

This command registers the Git repository with Porch, creates a Repository resource in Kubernetes and begins synchronizing packages from the repository.

Repositories Basic Usage

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

Basic Operations

These operations cover the fundamental commands for viewing and managing registered repositories.

List Registered Repositories

View all repositories registered with Porch:

porchctl repo get --namespace default

This command queries Porch for all registered repositories in the specified namespace, displays the repository type, content type, sync schedule, and status and shows the repository address.

Note

porchctl repo list is an alias for porchctl repo get and can be used interchangeably:

Synchronizing Repositories

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

Repository Synchronization

Porch periodically synchronizes with registered repositories to discover new packages and updates. You can also trigger manual synchronization when you need immediate updates.

Note

Sync Schedule Format: Cron expressions follow the format minute hour day month weekday. For example, */10 * * * * means “every 10 minutes”.

Trigger Manual Sync

Force an immediate synchronization of a repository:

porchctl repo sync porch-test --namespace default

This command schedules a one-time sync (minimum 1-minute delay), updates packages from the repository. This sync is independent of the periodic sync schedule.

Unregistering Repositories

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

Unregistering Repositories

When you no longer need Porch to manage packages from a repository, you can unregister it. This removes Porch’s connection to the repository without affecting the underlying Git storage.

Unregister a Repository

Remove a repository from Porch:

porchctl repo unregister porch-test --namespace default

This command removes the Repository resource from Kubernetes, it stops synchronizing packages from the repository, removes Porch’s cached metadata for the repository but does not delete the underlying Git repository or its contents.