Skip to content

Commit 3c26cae

Browse files
CsatariGergelylovesprungtimop62
authored
Adding Porch definition (#283)
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Co-authored-by: Dominika Schweier <dominika.schweier@nokia.com> Co-authored-by: Timo Perala <timo.perala@nokia.com>
1 parent 104c534 commit 3c26cae

File tree

1 file changed

+4
-50
lines changed
  • content/en/docs/neo-porch/1_overview

1 file changed

+4
-50
lines changed

content/en/docs/neo-porch/1_overview/_index.md

Lines changed: 4 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,7 @@ description: Overview of Porch
77

88
## What is Porch
99

10-
Lorem Ipsum
11-
12-
## Introduction to Packages in Porch
13-
14-
A Porch package refers to a KPT package.
15-
16-
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.
17-
18-
### What is KPT?
19-
20-
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.
21-
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.
22-
23-
### What is a KPT package?
24-
25-
simply a directory/folder with a kpt file and some yaml files?
26-
27-
| Concept | Description |
28-
| ----------------- | ----------------------------------------------------------------------------------------------------- |
29-
| **KPT package** | A directory of Kubernetes YAML files (manifests) with a `Kptfile` that tracks metadata and lifecycle. |
30-
| **Kptfile** | A metadata file that defines pipeline functions, upstream sources (like Git repos), and ownership. |
31-
| **Functions** | Extensible KRM functions (as containers or binaries) that mutate or validate package content. |
32-
33-
### What Does a kpt Package Look Like?
34-
35-
```bash
36-
my-nginx/
37-
├── Kptfile
38-
├── deployment.yaml
39-
└── service.yaml
40-
```
41-
42-
`Kptfile`: Specifies metadata, upstream repo, function pipeline, etc.
43-
`deployment.yaml` & `service.yaml`: Standard Kubernetes resource manifests.
44-
45-
[POINT TO KPT DOCS FOR KPT PKG]
46-
47-
### Example of a KPT file
48-
49-
[KPT FILE],
50-
51-
### Relationship with KRM
52-
53-
[WHAT IS THE RELATIONSHIP WITH KRM]
54-
55-
### Porch pkg untainted by telco
56-
57-
[WE CAN ADD SOME EXAMPLE KPT PKG UNTAINTED BY TELCO].
58-
59-
<https://www.est.tech/news/kptreboot/>
10+
Porch is a specialization and orchestration tool for managing distributed systems. It helps GitOps engineers,
11+
developers, integrators and telecom operators to manage complex systems in a cloud native environment. Porch runs
12+
[kpt](https://kpt.dev/) at a scale for package specialization. It provides collaboration and governance enablers and
13+
integration with GitOps for the packages.

0 commit comments

Comments
 (0)