Skip to content

Commit c68a5bf

Browse files
authored
Docs - Minor Fixes in Porch Engine (kptdev#446)
* clarify task list contains single task and fix lifecycle validation Signed-off-by: aravind.est <aravindhan.a@est.tech> * Fix review comments Signed-off-by: aravind.est <aravindhan.a@est.tech> --------- Signed-off-by: aravind.est <aravindhan.a@est.tech>
1 parent 1c7d17f commit c68a5bf

3 files changed

Lines changed: 19 additions & 41 deletions

File tree

docs/content/en/docs/5_architecture_and_components/engine/functionality/lifecycle-management.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -134,17 +134,17 @@ CreatePackageRevision
134134
135135
No
136136
137-
Draft/Proposed? ──Yes──> Allow
137+
Draft? ──Yes──> Allow
138138
139139
No
140140
141-
Published/DeletionProposed? ──Yes──> Reject
141+
Proposed/Published/DeletionProposed? ──Yes──> Reject
142142
```
143143

144144
**Process:**
145145
1. **Empty lifecycle**: Defaults to Draft
146-
2. **Draft or Proposed**: Allowed for creation
147-
3. **Published or DeletionProposed**: Rejected with error
146+
2. **Draft**: Allowed for creation
147+
3. **Proposed or Published or DeletionProposed**: Rejected with error
148148
4. **Invalid value**: Rejected with error
149149

150150
**Update validation:**
@@ -313,7 +313,7 @@ CreatePackageRevision
313313
314314
No
315315
316-
Draft/Proposed? ──Yes──> Continue
316+
Draft? ──Yes──> Continue
317317
318318
No
319319
@@ -337,11 +337,11 @@ UpdatePackageRevision
337337
338338
Check Current Lifecycle
339339
340-
Draft/Proposed? ──Yes──> Full Update Path
340+
Draft? ──Yes──> Full Update Path
341341
342342
No
343343
344-
Published/DeletionProposed? ──Yes──> Metadata Only Path
344+
Proposed/Published/DeletionProposed? ──Yes──> Metadata Only Path
345345
346346
No
347347
@@ -457,10 +457,7 @@ The lifecycle system maintains an audit trail of package revision evolution:
457457
- Used for tracking approval timing
458458

459459
**Tasks:**
460-
- Append-only list of operations performed
461-
- Each task represents a modification
462-
- First task indicates creation method (init, clone, edit, upgrade)
463-
- Subsequent tasks show evolution history
460+
- Typically contains a single task indicating creation method (init, clone, edit, upgrade)
464461
- Stored in PackageRevision spec
465462

466463
**Resource Version:**

docs/content/en/docs/5_architecture_and_components/engine/functionality/task-coordination.md

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -431,24 +431,12 @@ ApplyTask/DoPRMutations/DoPRResourceMutations
431431

432432
The Engine uses specific patterns for task coordination:
433433

434-
### Sequential Task Execution
434+
### Task Execution
435435

436436
```
437-
Task List: [init, clone, render]
437+
Task List: [init/clone/edit/upgrade]
438438
439-
Execute init
440-
441-
Success? ──No──> Return Error
442-
443-
Yes
444-
445-
Execute clone
446-
447-
Success? ──No──> Return Error
448-
449-
Yes
450-
451-
Execute render
439+
Execute [init/clone/edit/upgrade]
452440
453441
Success? ──No──> Return Error
454442
@@ -458,7 +446,7 @@ Task List: [init, clone, render]
458446
```
459447

460448
**Sequential execution:**
461-
- Tasks executed in order
449+
- Typically one task (init, clone, edit, or upgrade)
462450
- Each task must succeed before next
463451
- First error stops execution
464452
- No parallel task execution
@@ -468,26 +456,19 @@ Task List: [init, clone, render]
468456
- Simplifies error handling
469457
- Maintains consistent state
470458

471-
### Append-Only Task List
459+
### Task List Pattern
472460

473461
```
474462
Create: [init]
475463
476-
Update: [init, clone]
464+
Update: [clone/edit/upgrade]
477465
478-
Update: [init, clone, render]
466+
Update: [render]
479467
```
480468

481-
**Append-only pattern:**
482-
- Tasks never removed from list
483-
- New tasks appended to end
484-
- Task history preserved
485-
- Audit trail of operations
486-
487-
**Benefits:**
488-
- Clear operation history
489-
- Reproducible package state
490-
- Debugging and troubleshooting
469+
**Task list pattern:**
470+
- Single persistent task indicating [init/clone/edit/upgrade] method
471+
- Task history shows package origin
491472

492473
### Draft Isolation
493474

docs/content/en/docs/5_architecture_and_components/porch-apiserver/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |
1010

1111
The **Porch API Server** is a Kubernetes extension API server that exposes Porch's aggregated API resources (PackageRevision, PackageRevisionResources, Package) and CRDs (Repository, PackageRev) through the Kubernetes API. It acts as the entry point for client interactions with Porch, translating Kubernetes API requests into operations on the underlying Engine and Cache.
1212

13-
> The PackageVaraint and PackageVariantSet CRDs are not controlled by the Porch API server. They are controlled by the [Porch Controllers]({{% relref "/docs/5_architecture_and_components/controllers/_index.md" %}})
13+
> The PackageVariant and PackageVariantSet CRDs are not controlled by the Porch API server. They are controlled by the [Porch Controllers]({{% relref "/docs/5_architecture_and_components/controllers/_index.md" %}})
1414
1515
The Porch API Server is responsible for:
1616

0 commit comments

Comments
 (0)