From 46bc98e4efa95ffac4e3e12de6008ddd69fe51e5 Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Thu, 6 Nov 2025 16:03:13 +0200 Subject: [PATCH 1/2] Adding Porch definition Signed-off-by: Gergely Csatari Co-authored-by: Dominika Schweier Co-authored-by:Michael Greaves Co-authored-by: Timo Perala --- .../en/docs/neo-porch/1_overview/_index.md | 47 +++++++------------ 1 file changed, 16 insertions(+), 31 deletions(-) diff --git a/content/en/docs/neo-porch/1_overview/_index.md b/content/en/docs/neo-porch/1_overview/_index.md index 0f455c21..ca19c439 100644 --- a/content/en/docs/neo-porch/1_overview/_index.md +++ b/content/en/docs/neo-porch/1_overview/_index.md @@ -7,46 +7,31 @@ description: Overview of Porch ## What is Porch -Lorem Ipsum +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. ## Introduction to Packages in Porch -A Porch package refers to a KPT package. +A Porch package refers to a [kpt package](https://kpt.dev/book/02-concepts/#packages). -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. +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? +### 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. +[Kpt is an open source tool](https://kpt.dev/book/02-concepts/#what-is-kpt) started 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/). -### What is a KPT package? +### What is a kpt package? -simply a directory/folder with a kpt file and some yaml files? +A kpt package is a bundle of configuration data. More about the concept in the +[kpt documentation](https://kpt.dev/book/02-concepts/#what-is-kpt). -| 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 From d0697528474a4403bb967d4ab525c6be06185ca5 Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Thu, 20 Nov 2025 11:41:28 +0200 Subject: [PATCH 2/2] Removing template text Signed-off-by: Gergely Csatari --- .../en/docs/neo-porch/1_overview/_index.md | 31 ------------------- 1 file changed, 31 deletions(-) diff --git a/content/en/docs/neo-porch/1_overview/_index.md b/content/en/docs/neo-porch/1_overview/_index.md index ca19c439..81cde4a6 100644 --- a/content/en/docs/neo-porch/1_overview/_index.md +++ b/content/en/docs/neo-porch/1_overview/_index.md @@ -11,34 +11,3 @@ Porch is a specialization and orchestration tool for managing distributed system 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. - -## Introduction to Packages in Porch - -A Porch package refers to a [kpt package](https://kpt.dev/book/02-concepts/#packages). - -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](https://kpt.dev/book/02-concepts/#what-is-kpt) started 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/). - -### What is a kpt package? - -A kpt package is a bundle of configuration data. More about the concept in the -[kpt documentation](https://kpt.dev/book/02-concepts/#what-is-kpt). - - -### Relationship with KRM - -[WHAT IS THE RELATIONSHIP WITH KRM] - -### Porch pkg untainted by telco - -[WE CAN ADD SOME EXAMPLE KPT PKG UNTAINTED BY TELCO]. - -