Skip to content

Adding Porch definition #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Adding Porch definition #283

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46bc98e
Adding Porch definition
CsatariGergely Nov 6, 2025
d069752
Removing template text
CsatariGergely Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 4 additions & 50 deletions content/en/docs/neo-porch/1_overview/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,53 +7,7 @@ description: Overview of Porch

## What is Porch

Lorem Ipsum

## Introduction to Packages in Porch

A Porch package refers to a KPT package.

As a matter of fact there is no such thing as a "Porch" package but rather Porch utilizes KPT packages which are a structured collection of Kubernetes [YAML](https://en.wikipedia.org/wiki/YAML) resources along with a Kptfile which is managed via Porch's package orchestration mechanisms.

### What is KPT?

KPT is an open-source tool developed by Google to manage Kubernetes [“Configuration as Data”]({{% relref "/docs/porch/config-as-data.md" %}}) to simplify management of [Kubernetes Resource Model](https://github.com/kubernetes/design-proposals-archive/blob/main/architecture/resource-management.md) (KRM)-driven infrastructure at scale using standard YAML and [Git](https://git-scm.com/). KPT originated as a Google ContainerTools project and was later contributed to the CNCF.
Think of kpt as "package management for Kubernetes configurations", similar to how [apt](https://en.wikipedia.org/wiki/APT_(software)) or [yum](https://en.wikipedia.org/wiki/Yum_(software)) works for software packages but in this case, it deals with YAML files that define Kubernetes resources.

### What is a KPT package?

simply a directory/folder with a kpt file and some yaml files?

| Concept | Description |
| ----------------- | ----------------------------------------------------------------------------------------------------- |
| **KPT package** | A directory of Kubernetes YAML files (manifests) with a `Kptfile` that tracks metadata and lifecycle. |
| **Kptfile** | A metadata file that defines pipeline functions, upstream sources (like Git repos), and ownership. |
| **Functions** | Extensible KRM functions (as containers or binaries) that mutate or validate package content. |

### What Does a kpt Package Look Like?

```bash
my-nginx/
├── Kptfile
├── deployment.yaml
└── service.yaml
```

`Kptfile`: Specifies metadata, upstream repo, function pipeline, etc.
`deployment.yaml` & `service.yaml`: Standard Kubernetes resource manifests.

[POINT TO KPT DOCS FOR KPT PKG]

### Example of a KPT file

[KPT FILE],

### Relationship with KRM

[WHAT IS THE RELATIONSHIP WITH KRM]

### Porch pkg untainted by telco

[WE CAN ADD SOME EXAMPLE KPT PKG UNTAINTED BY TELCO].

<https://www.est.tech/news/kptreboot/>
Porch is a specialization and orchestration tool for managing distributed systems. It helps GitOps engineers,
developers, integrators and telecom operators to manage complex systems in a cloud native environment. Porch runs
[kpt](https://kpt.dev/) at a scale for package specialization. It provides collaboration and governance enablers and
integration with GitOps for the packages.
Loading