You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/porch/package-orchestration.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description:
6
6
---
7
7
8
8
Customers who want to take advantage of the benefits of [Configuration as Data](config-as-data.md)
9
-
can do so today using a[kpt](https://kpt.dev) CLI and the kpt function ecosystem, including its
9
+
can do so today using the[kpt](https://kpt.dev) CLI and the kpt function ecosystem, including its
10
10
[functions catalog](https://catalog.kpt.dev/). Package authoring is possible using a variety of
11
11
editors with [YAML](https://yaml.org/) support. That said, a UI experience of
12
12
what-you-see-is-what-you-get (WYSIWYG) package authoring which supports a broader package lifecycle,
@@ -22,10 +22,10 @@ experience for supporting the configuration lifecycle.
22
22
This section briefly describes core concepts of package orchestration:
23
23
24
24
***Package***: A package is a collection of related configuration files containing configurations
25
-
of [KRM][krm]**resources**. Specifically, configuration packages are [kpt packages](https://kpt.dev/).
25
+
of [KRM][krm]**resources**. Specifically, configuration packages are [kpt packages](https://kpt.dev/book/02-concepts/01-packages).
26
26
Packages are sequentially ***versioned***. Multiple versions of the same package may exist in a
27
-
repository. ([more details](#package-versioning)) A package may have a link (URL) to an
28
-
***upstream package*** (a specific version) from which it was cloned. ([more details](#package-relationships)) Packages go through three lifecycle stages: ***Draft***, ***Proposed***, and ***Published***:
27
+
([repository](#package-versioning)). A package may have a link (URL) to an
28
+
***upstream package*** (a specific version) ([from which it was cloned](#package-relationships)) . Packages go through three lifecycle stages: ***Draft***, ***Proposed***, and ***Published***:
29
29
30
30
****Draft***: The package is being created or edited. The contents of the package can be
31
31
modified; however, the package is not ready to be used (or deployed).
@@ -34,15 +34,15 @@ repository. ([more details](#package-versioning)) A package may have a link (URL
34
34
used. Published packages can be deployed or cloned.
35
35
36
36
***Repository***: The repository stores packages. [git][] and [OCI][oci] are two examples of a
37
-
repository. ([more details](#repositories)) A repository can be designated as a
37
+
([repository](#repositories)). A repository can be designated as a
38
38
***deployment repository***. *Published* packages in a deployment repository are considered to be
39
-
deployment-ready. ([more details](#deployment))
39
+
([deployment-ready](#deployment)).
40
40
***Functions***: Functions (specifically, [KRM functions][krm functions]) can be applied to
41
-
packages to mutate or validate resources the resources within them. Functions can be applied to a
41
+
packages to mutate or validate the resources within them. Functions can be applied to a
42
42
package to create specific package mutations while editing a package draft. Functions can be added
43
43
to a package's Kptfile [pipeline][].
44
44
45
-
## Core components of the Configuration as Data implementation
45
+
## Core components of the Configuration as Data (CAD) implementation
46
46
47
47
The core implementation of Configuration as Data, or *CaD Core*, is a set of components and APIs
48
48
which collectively enable the following:
@@ -59,7 +59,7 @@ the approved package.
59
59
60
60
* The deployment of the packages from the deployment repositories, and the observability of their
61
61
deployment status.
62
-
* A permission model that allows role-based access control.
62
+
* A permission model that allows role-based access control (RBAC).
63
63
64
64
### High-level architecture
65
65
@@ -135,7 +135,7 @@ then the upstream link can be used to update the downstream package.
135
135
136
136
The deployment mechanism is responsible for deploying the configuration packages from a repository
137
137
and affecting the live state. Because the configuration is stored in standard repositories (Git,
138
-
and in the future OCI), the deployment component is pluggable. By default, [configsync][] is the
138
+
and in the future OCI), the deployment component is pluggable. By default, [configsync][https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/overview] is the
139
139
deployment mechanism used by CaD Core implementation. However, other deployment mechanisms can be
140
140
also used.
141
141
@@ -342,7 +342,7 @@ The **Porch server** itself comprises several key components, including the foll
342
342
The *package cache* enables both local caching, as well as the abstract manipulation of packages
343
343
and their contents, irrespective of the underlying storage mechanism, such as Git, or OCI.
344
344
* The *repository adapters* for Git and OCI
345
-
The *repository adapters* implement the specific logic of interacting with those types of package
345
+
The *repository adapters*for Git and OCI implement the specific logic of interacting with those types of package
346
346
repositories.
347
347
* The *function runtime*
348
348
The *function runtime* implements support for evaluating the [kpt functions][functions] and the
0 commit comments