Welcome to the Porch documentation. Porch is a Kubernetes extension apiserver that manages the lifecycle of KRM configuration packages in Git and OCI repositories.

Getting Started#

New to Porch? Start here:

• [Overview]({{% relref "/docs/1_overview/_index.md" %}}) - What Porch is and why it exists
• [Install Porch]({{% relref "/docs/3_getting_started/installing-porch.md" %}}) - Get Porch running in your cluster
• [Core Concepts]({{% relref "/docs/2_concepts/_index.md" %}}) - Understand packages, repositories, and lifecycle
• [Tutorials]({{% relref "/docs/4_tutorials_and_how-tos/_index.md" %}}) - Step-by-step guides for common tasks

Documentation Sections#

Learn#

• [Overview]({{% relref "/docs/1_overview/_index.md" %}}) - Introduction to Porch
• [Concepts]({{% relref "/docs/2_concepts/_index.md" %}}) - Core terminology and models
• [Architecture & Components]({{% relref "/docs/5_architecture_and_components/_index.md" %}}) - How Porch works internally

Use#

• [Getting Started]({{% relref "/docs/3_getting_started/_index.md" %}}) - Installation and setup
• [Tutorials & How-tos]({{% relref "/docs/4_tutorials_and_how-tos/_index.md" %}}) - Practical guides
• [Configuration & Deployment]({{% relref "/docs/6_configuration_and_deployments/_index.md" %}}) - Deployment options and configuration
• [CLI & API Reference]({{% relref "/docs/7_cli_api/_index.md" %}}) - Command-line and API documentation

Operate#

• [Troubleshooting & FAQ]({{% relref "/docs/9_troubleshooting_and_faq/_index.md" %}}) - Common problems and solutions

Contribute#

• [Contributing]({{% relref "/docs/12_contributing/_index.md" %}}) - How to contribute to Porch
• [Glossary]({{% relref "/docs/11_glossary/_index.md" %}}) - Term definitions
• GitHub Repository - Source code and issues

Additional Resources#

• Nephio Project - Porch is part of the Nephio project
• kpt Documentation - Porch uses kpt for package operations
• Release Notes - What's new in each version