Skip to content

Commit 42c8117

Browse files
authored
Updated docs to remove mention of mutators/validators against Repository from Porch Orchestration page (#205)
The corresponding change in Repository API spec is covered in following Porch PR nephio-project/porch#179
1 parent 52d6bc6 commit 42c8117

File tree

2 files changed

+8
-16
lines changed

2 files changed

+8
-16
lines changed

content/en/docs/porch/contributors-guide/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Porch comprises of several software components:
2727
operations on package contents
2828
* [func](https://github.com/nephio-project/porch/tree/main/func): KRM function evaluator microservice; exposes gRPC API
2929
* [repository](https://github.com/nephio-project/porch/blob/main/pkg/repository): Repository integration package
30-
* [git](https://github.com/nephio-project/porch/tree/main/pkg/git): Integration with Git repository.
31-
* [oci](https://github.com/nephio-project/porch/tree/main/pkg/oci): Integration with OCI repository.
30+
* [git](https://github.com/nephio-project/porch/tree/main/pkg/externalrepo/git): Integration with Git repository.
31+
* [oci](https://github.com/nephio-project/porch/tree/main/pkg/externalrepo/oci): Integration with OCI repository.
3232
* [cache](https://github.com/nephio-project/porch/tree/main/pkg/cache): Package caching.
3333
* [controllers](https://github.com/nephio-project/porch/tree/main/controllers): `Repository` CRD. No controller;
3434
Porch apiserver watches these resources for changes as repositories are (un-)registered.
@@ -81,8 +81,8 @@ Some useful code pointers:
8181
* Porch REST API handlers in [registry/porch](https://github.com/nephio-project/porch/tree/main/pkg/registry/porch),
8282
for example [packagerevision.go](https://github.com/nephio-project/porch/tree/main/pkg/registry/porch/packagerevision.go)
8383
* Background task handling cache updates in [background.go](https://github.com/nephio-project/porch/tree/main/pkg/registry/porch/background.go)
84-
* Git repository integration in [pkg/git](https://github.com/nephio-project/porch/tree/main/pkg/git)
85-
* OCI repository integration in [pkg/oci](https://github.com/nephio-project/porch/tree/main/pkg/oci)
84+
* Git repository integration in [pkg/git](https://github.com/nephio-project/porch/tree/main/pkg/externalrepo/git)
85+
* OCI repository integration in [pkg/oci](https://github.com/nephio-project/porch/tree/main/pkg/externalrepo/oci)
8686
* CaD Engine in [engine](https://github.com/nephio-project/porch/tree/main/pkg/engine)
8787
* e2e tests in [e2e](https://github.com/nephio-project/porch/tree/main/test/e2e). See below more on testing.
8888

@@ -113,4 +113,4 @@ then run test suite against the Porch instance.
113113

114114
[VS Code](https://code.visualstudio.com/) works really well for editing and debugging.
115115
Just open VSCode from the root folder of the Porch repository and it will work fine. The folder contains the needed
116-
configuration to Launch different functions of Porch.
116+
configuration to Launch different functions of Porch.

content/en/docs/porch/package-orchestration.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,6 @@ associated with package to capture:
9898
At repository registration, customers must be able to specify details needed to store packages in appropriate locations
9999
in the repository. For example, registration of a Git repository must accept a branch and a directory.
100100

101-
Repositories may have associated guardrails - mutation and validation functions that ensure and enforce requirements of
102-
all packages in the repository, including gating promotion of a package to a *published* lifecycle stage.
103-
104101
{{% alert title="Note" color="primary" %}}
105102

106103
A user role with sufficient permissions can register a package or function repository, including repositories
@@ -170,9 +167,6 @@ The repository management functionality of Package Orchestration service enables
170167
packages will be cloned.
171168
* annotate repository with metadata such as whether repository contains deployment ready packages or not; metadata can
172169
be application or customer specific
173-
* define and enforce package invariants (guardrails) at the repository level, by registering mutator and/or validator
174-
functions with the repository; those registered functions will be applied to packages in the repository to enforce
175-
invariants
176170

177171
### Package Discovery
178172

@@ -217,10 +211,8 @@ The package authoring and lifecycle functionality of the package Orchestration s
217211

218212
* Rebase a package onto another upstream base package or onto a newer version of the same package (to
219213
aid with conflict resolution during the process of publishing a draft package)
220-
* Get feedback during package authoring, and assistance in recovery from:
221214

222-
* merge conflicts, invalid package changes, guardrail violations
223-
* compliance of the drafted package with repository-wide invariants and guardrails
215+
* Get feedback during package authoring, and assistance in recovery from merge conflicts, invalid package changes, guardrail violations
224216

225217
* Propose for a _draft_ package be _published_.
226218
* Apply an arbitrary decision criteria, and by a manual or automated action, approve (or reject) proposal of a _draft_
@@ -229,7 +221,7 @@ The package authoring and lifecycle functionality of the package Orchestration s
229221

230222
* Assisted/automated update (upgrade, rollback) of groups of packages matching specific criteria (i.e. base package
231223
has new version or specific base package version has a vulnerability and should be rolled back)
232-
* Proposed change validation (pre-validating change that adds a validator function to a base package or a repository)
224+
* Proposed change validation (pre-validating change that adds a validator function to a base package)
233225

234226
* Delete an existing package.
235227

@@ -402,4 +394,4 @@ Kubernetes apiserver are:
402394
[apiserver]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/
403395
[representation]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#differing-representations
404396
[crds]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
405-
[oci]: https://github.com/opencontainers/image-spec/blob/main/spec.md
397+
[oci]: https://github.com/opencontainers/image-spec/blob/main/spec.md

0 commit comments

Comments
 (0)