@@ -13,14 +13,18 @@ make generate
13
13
Porch comprises of several software components:
14
14
15
15
* [ api] ( ../api ) : Definition of the KRM API supported by the Porch extension apiserver
16
- * [ apiserver] ( ../apiserver ) : The Porch apiserver implementation, REST handlers, Porch ` main ` function
17
- * [ engine] ( ../engine ) : Core logic of Package Orchestration - operations on package contents
16
+ * [ apiserver] ( ../pkg/ apiserver/ ) : The Porch apiserver implementation, REST handlers, Porch ` main ` function
17
+ * [ engine] ( ../pkg/ engine/ ) : Core logic of Package Orchestration - operations on package contents
18
18
* [ func] ( ../func ) : KRM function evaluator microservice; exposes gRPC API
19
- * [ repository] ( ../repository ) : Integration with Git and OCI package repositories, and package caching
19
+ * [ repository] ( ../pkg/repository/ ) : Repository integration packge
20
+ * [ git] ( ../pkg/git/ ) : Integration with Git repository.
21
+ * [ oci] ( ../pkg/oci/ ) : Integration with OCI repository.
22
+ * [ cache] ( ../pkg/cache/ ) : Package caching.
20
23
* [ controllers] ( ../controllers ) : ` Repository ` CRD. No controller;
21
24
Porch apiserver watches these resources for changes as repositories are (un-)registered.
22
25
* [ remoterootsync] ( ../controllers/remoterootsync ) : CRD and controller for deploying packages
23
- * [ test] ( ../test ) : Test Git Server for Porch e2e testing
26
+ * [ test] ( ../test ) : Test Git Server for Porch e2e testing, and
27
+ [ e2e] ( ../test/e2e/ ) tests.
24
28
25
29
## Running Porch
26
30
@@ -64,13 +68,13 @@ Update the launch arguments to your needs.
64
68
65
69
Some useful code pointers:
66
70
67
- * Porch REST API handlers in [ registry/porch] ( ../apiserver/ pkg/registry/porch ) , for example
68
- [ packagerevision.go] ( ../apiserver/ pkg/registry/porch/packagerevision.go )
69
- * Background task handling cache updates in [ background.go] ( ../apiserver/ pkg/registry/porch/background.go )
70
- * Git repository integration in [ repository/ pkg/git] ( ../repository /pkg/git )
71
- * OCI repository integration in [ repository/ pkg/oci] ( ../repository /pkg/oci )
72
- * CaD Engine in [ engine] ( ../engine/ pkg/engine )
73
- * e2e tests in [ e2e] ( ../apiserver/pkg/ e2e ) . See below more on testing.
71
+ * Porch REST API handlers in [ registry/porch] ( ../pkg/registry/porch/ ) , for example
72
+ [ packagerevision.go] ( ../pkg/registry/porch/packagerevision.go )
73
+ * Background task handling cache updates in [ background.go] ( ../pkg/registry/porch/background.go )
74
+ * Git repository integration in [ pkg/git] ( ../pkg/git )
75
+ * OCI repository integration in [ pkg/oci] ( ../pkg/oci )
76
+ * CaD Engine in [ engine] ( ../pkg/engine )
77
+ * e2e tests in [ e2e] ( ../test/ e2e/ ) . See below more on testing.
74
78
75
79
## Running Tests
76
80
0 commit comments