Skip to content

Commit ddf5f55

Browse files
mpgreaveslapentad
authored andcommitted
Proofreading of Configuration as code. (nephio-project#233)
Signed-off-by: Michael Greaves <michael.greaves@nokia.com>
1 parent 64b4a4a commit ddf5f55

1 file changed

Lines changed: 15 additions & 21 deletions

File tree

content/en/docs/porch/config-as-data.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
title: "Configuration as Data (CaD)"
3+
title: "Configuration as Data (CaD)"
34
type: docs
45
weight: 1
5-
description:
6+
description:
67
---
78

89
This document provides the background context for Package Orchestration, which is further
@@ -86,7 +87,7 @@ the following:
8687
format.
8788
* A function `ResourceList → ResultList` (*kpt* function) as the foundational, composable unit of
8889
package manipulation code.
89-
90+
9091
{{% alert title="Note" color="primary" %}}
9192

9293
Other forms of code can also manipulate packages, such as UIs and custom algorithms not
@@ -97,25 +98,18 @@ the following:
9798

9899
**KRM CaD** provides the following basic functionalities:
99100

100-
* Loading a serialized package from a repository (as a ResourceList). Examples of a repository may
101-
be one or more of the following:
102-
* Local HDD
103-
* Git repository
104-
* OCI
105-
* Cloud storage
106-
* Saving a serialized package (as a ResourceList) to a package repository.
107-
* Evaluating a function on a serialized package (ResourceList).
108-
* [Rendering](https://kpt.dev/book/04-using-functions/#declarative-function-execution) a package
109-
(evaluating the functions declared within the package itself).
110-
* Creating a new (empty) package.
111-
* Forking (or cloning) an existing package from one package repository (called upstream) to another
112-
(called downstream).
113-
* Deleting a package from a repository.
114-
* Associating a version with the package and guaranteeing the immutability of packages with an
115-
assigned version.
116-
* Incorporating changes from the new version of an upstream package into a new version of a
117-
downstream package (three-way merge).
118-
* Reverting to a prior version of a package.
101+
* load a serialized package from a repository (as ResourceList) (examples of repository may be one or more of: local
102+
HDD, Git repository, OCI, Cloud Storage, etc.)
103+
* save a serialized package (as ResourceList) to a package repository
104+
* evaluate a function on a serialized package (ResourceList)
105+
* [render](https://kpt.dev/book/04-using-functions/01-declarative-function-execution) a package (evaluate functions
106+
declared within the package itself)
107+
* create a new (empty) package
108+
* fork (or clone) an existing package from one package repository (called upstream) to another (called downstream)
109+
* delete a package from a repository
110+
* associate a version with the package; guarantee immutability of packages with an assigned version
111+
* incorporate changes from the new version of an upstream package into a new version of a downstream package (3 way merge)
112+
* revert to a prior version of a package
119113

120114
## Configuration values
121115

0 commit comments

Comments
 (0)