@@ -14,9 +14,9 @@ of WYSIWYG package authoring which supports broader package lifecycle, including
14
14
package authoring with * guardrails* , approval workflow, package deployment, and
15
15
more, is not yet available.
16
16
17
- * Package Orchestration* service is the component that completes the set of core
18
- Configuration as Data components - * CaD Core * - and enables building the
19
- delightful UI experience supporting the configuration lifecycle.
17
+ * Package Orchestration* service is part of the implementation of the
18
+ Configuration as Data approach, and enables building the delightful UI
19
+ experience supporting the configuration lifecycle.
20
20
21
21
## Core Concepts
22
22
@@ -52,7 +52,7 @@ repository to be applied to all packages on changes.
52
52
([ more details] ( #functions ) )
53
53
54
54
A repository can be designated as *** deployment repository*** . * Published*
55
- packages in a deployment repository is considered deployment-ready.
55
+ packages in a deployment repository are considered deployment-ready.
56
56
([ more details] ( #deployment ) )
57
57
58
58
<!-- Reference links -->
@@ -68,7 +68,7 @@ packages in a deployment repository is considered deployment-ready.
68
68
[ representation ] : https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#differing-representations
69
69
[ crds ] : https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
70
70
71
- ## CaD Core Components
71
+ ## Core Components of Configuration as Data Implementation
72
72
73
73
The Core implementation of Configuration as Data, * CaD Core* , is a set of
74
74
components and APIs which collectively enable:
@@ -95,8 +95,9 @@ At the high level, the Core CaD functionality comprises:
95
95
* package discovery, authoring and lifecycle management
96
96
* [ kpt] [ ] - a Git-native, schema-aware, extensible client-side tool for
97
97
managing KRM packages
98
- * [ Config Sync] [ ] - configuration distribution and deployment mechanism with
99
- observability of the status of deployed resources
98
+ * a GitOps-based deployment mechanism (for example [ Config Sync] [ ] ), which
99
+ distributes and deploys configuration, and provides observability of the
100
+ status of deployed resources
100
101
* a task-specific UI supporting repository management, package discovery,
101
102
authoring, and lifecycle
102
103
@@ -108,10 +109,11 @@ Concepts briefly introduced above are elaborated in more detail in this section.
108
109
109
110
### Repositories
110
111
111
- [ Config Sync ] [ ] and [ kpt ] [ ] currently integrate with [ git] [ ] repositories, and
112
+ [ kpt ] [ ] and [ Config Sync ] [ ] currently integrate with [ git] [ ] repositories, and
112
113
there is an existing design to add [ OCI support] ( ./02-oci-support.md ) to kpt.
113
- Initially, the CaD Core system will prioritize integration with [ git] [ ] , and
114
- support for additional repository types may be added in the future as required.
114
+ Initially, the Package Orchestration service will prioritize integration with
115
+ [ git] [ ] , and support for additional repository types may be added in the future
116
+ as required.
115
117
116
118
Requirements applicable to all repositories include: ability to store packages,
117
119
their versions, and sufficient metadata associated with package to capture:
@@ -159,7 +161,12 @@ the downstream package.
159
161
160
162
### Deployment
161
163
162
- [ Config Sync] [ ] is the deployment mechanism used by CaD Core implementation.
164
+ The deployment mechanism is responsible for deploying configuration packages
165
+ from a repository and affecting the live state. Because the configuration
166
+ is stored in standard repositories (Git, and in the future OCI), the deployment
167
+ component is pluggable. By default, [ Config Sync] [ ] is the deployment mechanism
168
+ used by CaD Core implementation but others can be used as well.
169
+
163
170
Here we highlight some key attributes of the deployment mechanism and its
164
171
integration within the CaD Core:
165
172
@@ -345,7 +352,7 @@ of the basic roles. For example, only permitted roles can:
345
352
### Porch Architecture
346
353
347
354
The Package Orchestration service, ** Porch** is designed to be hosted in a
348
- [ Kubernetes] ( https://kubernetes.io/ ) cluster, just like [ Config Sync ] [ ] .
355
+ [ Kubernetes] ( https://kubernetes.io/ ) cluster.
349
356
350
357
The overall architecture is shown below, and includes also existing components
351
358
(k8s apiserver and Config Sync).
0 commit comments