Have PackageVariant set readiness gate on PackageRevisions #156

JamesMcDermott · 2024-12-10T15:51:12Z

Implements #615

incoming ReadinessGates and Conditions are now saved in PackageRevision creation flows
- this includes init and clone operations
  - a new PackageRevision now has the PackagePipelinePassed Condition and
    ReadinessGate by default
  - set to False on creation, but the initial (no-op) render run effectively
    sets it to True by default
  - API-based init operations (Create) will include any Conditions passed in
    in the request
    - and add ReadinessGates based on the Conditions
a successful render run sets the PackagePipelinePassed condition:
- to False before starting
- to True on successful completion
- effectively preventing the PackageRevision from being proposed using porchctl
  rpkg propose while the pipeline is running
  - a future commit will move this validation from porchctl into the API server
    to lock out API-based propose operations as well
PackageVariant controller now sets its own condition and readiness gate on PackageRevisions it manages
- and manages this Condition independently to allow it to lock out propose operations while the controller is performing multiple operations
PackageVariant controller can now handle optimistic concurrency conflicts when making its final (per-reconcile) status update to a PackageVariant
refactors internal conversion of Kptfiles to YAML since readiness condition information is stored in the package Kptfile
- unifies all cases to the same kyaml/yaml-based method (KptFile.ToYamlString() and ToYamlString(*fn.KubeObject))
- this ensures consistency in the Kptfile YAML (indentation, field order etc.)
- and reduces the chances of Git conflicts when setting and updating readiness conditions
adds more info to error message in case of Git conflict when applying a patch
CLI E2E tests now give more information on failure
- pointing out config.yaml file containing command that produced unexpected result and 0-based index of the failed command in that file
CLI E2E tests now fail on first test failure to allow easier identification of the failed test's output
some refactoring/renaming for readbility
fixed typo in Makefile comment

efiacor · 2024-12-10T16:06:14Z

/test presubmit-nephio-go-test

efiacor · 2024-12-10T16:09:24Z

controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller.go

@@ -334,6 +350,13 @@ func (r *PackageVariantReconciler) ensurePackageVariant(ctx context.Context,
 	if err = r.Client.Create(ctx, newPR); err != nil {
 		return nil, err
 	}
+


Looks good. I'd be interested to see how this works in a full test-infra e2e run.
Also, may be somewhat aligned with what @kispaljr was working on?

efiacor · 2024-12-10T18:42:06Z

/test presubmit-nephio-go-test

JamesMcDermott · 2024-12-10T19:19:22Z

/test presubmit-nephio-go-test

JamesMcDermott · 2024-12-10T20:15:08Z

/test presubmit-nephio-go-test

JamesMcDermott · 2024-12-10T20:23:44Z

/test presubmit-nephio-go-test

liamfallon · 2024-12-11T07:33:53Z

/test presubmit-nephio-go-test

JamesMcDermott · 2024-12-11T11:57:42Z

/test presubmit-nephio-go-test

kispaljr

I welcome this PR, and wholeheartedly agree with the general direction. :)
These are my initial comments, but could you give me also a couple more days to understand the logic a bit better?

controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller.go

pkg/kpt/api/kptfile/v1/types.go

controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller.go

- PackageVariant controller now uses a readiness gate to allow a PackageRevision to complete its mutation pipeline before it is allowed to be proposed/approved - refactored conversion of Kptfiles to YAML since readiness condition information is stored in the package Kptfile - unified all cases to the same kyaml/yaml-based method (KptFile.ToYamlString() and ToYamlString(*fn.KubeObject)) - this ensures consistency in the YAML (indentation, field order etc.) - and reduces the chances of Git conflicts when setting and updating readiness conditions - added more info to error message in case of Git conflict when applying a patch nephio-project/nephio#615

- previous solution broke existing functionality to copy comments between Kptfile objects - resulting in failing unit tests - fix for that brought back the Git conflicts caused by indentation, field order etc. - re-refactored conversion of Kptfiles to YAML - KubeObject-related conversion methods (KubeObject/YAML and YAML/KubeObject) now live out in the util package as they aren't Kptfile-specific any more nephio-project/nephio#615

nephio-project/nephio#615

… pipeline-passed condition - review comments to increase applicability of pipeline-passed readiness condition - to enable this: if an incoming PackageRevision update changes only that readiness condition, detect that, skip the pipeline/rendering/etc., and only update the Kptfile with the readiness condition update - other tidy-up/wording comments nephio-project/nephio#615

- also broke ground on testing PackageVariants in end-to-end tests at all nephio-project/nephio#615

nephio-project/nephio#615

- tests now delete package variants whose upstream is a repo created by the test nephio-project/nephio#615

…on flows - this includes both init and clone operations - a new PackageRevision now has the PackagePipelinePassed Condition and ReadinessGate by default - set to False on creation, but the initial (no-op) render run effectively sets it to True by default - API-based init operations (Create) will include any Conditions passed in in the request - and add ReadinessGates based on the Conditions - a successful render run sets the PackagePipelinePassed condition: - to False before starting - to True on successful completion - effectively preventing the PackageRevision from being proposed using porchctl rpkg propose while the pipeline is running - a future commit will move this validation from porchctl into the API server to lock out API-based propose operations as well - PackageVariant controller sets its own condition and readiness gate on PackageRevisions it manages - and manages this Condition independently to allow it to lock out propose operations while the controller is performing multiple operations - PackageVariant controller can handle optimistic concurrency conflicts when making its final (per-reconcile) status update to a PackageVariant - some refactoring/renaming for readbility - fixed typo in Makefile comment nephio-project/nephio#615

nephio-project/nephio#615

…erver - apply readiness-gate lockout to API operations as well as porchctl CLI nephio-project/nephio#615

liamfallon · 2025-02-04T11:59:30Z

pkg/engine/engine.go

@@ -516,6 +535,35 @@ func (cad *cadEngine) UpdatePackageResources(ctx context.Context, repositoryObj
 	return repoPkgRev, renderStatus, nil
 }

+func pushPipelineReadinessGate(ctx context.Context, repo repository.Repository, repoPr repository.PackageRevision) error {


This makes the engine handling of drafts even more complex but there is no oopter way to do this with the current code structure. Let's refactor engine.go in Nephio R5.

liamfallon

/approve

Very comprehensive work @JamesMcDermott

nephio-prow · 2025-02-04T12:26:43Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JamesMcDermott, liamfallon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [liamfallon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

nephio-project/nephio#615

- new document describing operation of readiness gates on PackageRevisions - in general (no existing document for it) - specifically the changes introduced in nephio-project/porch#156 - including default readiness gates managed by Porch server for all PackageRevisions and by package variant controller for PackageRevisions controlled by a PackageVariant - new diagram to illustrate flows nephio-project/nephio#615 nephio-project/porch#156

pkg/engine/engine.go

kispaljr · 2025-02-25T17:26:12Z

I read through the latest code changes. All my previous comments are now resolved.
I focused my review on the pkg/task package, and that seems excellent to me.

all-in-all: it looks good to me, it can be merged from my part

kispaljr

Also, as we already discussed on Slack, it would make porch behavior more consistent if the readinessGates + conditions would be also merged from the PR objects that are created with an edit task (similarly how you implemented it to clone and init), but that is not mandatory. This PR can be merged without that.

pkg/task/clone.go

pkg/task/init.go

efiacor · 2025-02-25T20:44:13Z

Need to run it through a few e2e runs. Hit an issue on the free5gc suite. Will run again and collect data if it's a recurring issue.

Makefile

controllers/main.go

controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller.go

api/porch/v1alpha1/types.go

- Edit operation now includes ReadinessGates and Conditions passed in as part of the edit request - adding them to existing ones from the Kptfile in the PackageRevision being edited - Init, Edit, and Clone operations now merge their lists of Conditions/ReadinessGates (any passed in in the API request are added to the defaults/existing ones) - instead of using slices.Concat which allowed duplicates (with same Condition.Type) to stay - Conditions/ReadinessGates passed in in the API request will OVERRIDE default/existing ones nephio-project/nephio#615

sonarqubecloud · 2025-02-27T15:30:23Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

nephio-prow bot requested review from henderiw and kispaljr December 10, 2024 15:51

JamesMcDermott added the do-not-merge/work-in-progress label Dec 10, 2024

efiacor reviewed Dec 10, 2024

View reviewed changes

kispaljr reviewed Dec 13, 2024

View reviewed changes

controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller.go Outdated Show resolved Hide resolved

pkg/kpt/api/kptfile/v1/types.go Show resolved Hide resolved

kispaljr reviewed Dec 13, 2024

View reviewed changes

controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller.go Outdated Show resolved Hide resolved

kispaljr reviewed Dec 13, 2024

View reviewed changes

controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller.go Outdated Show resolved Hide resolved

kispaljr reviewed Dec 13, 2024

View reviewed changes

controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller.go Show resolved Hide resolved

JamesMcDermott added 3 commits December 17, 2024 10:21

Issue #615 - adjusted test data missed in previous commit

60cb107

nephio-project/nephio#615

JamesMcDermott force-pushed the pv-pipeline-readiness-gates branch from 3cff6bb to 60cb107 Compare December 17, 2024 10:30

JamesMcDermott added 2 commits December 18, 2024 08:56

Merge branch 'nephio-project:main' into pv-pipeline-readiness-gates

d854e74

JamesMcDermott requested a review from kushnaidu January 3, 2025 10:38

JamesMcDermott added 4 commits January 3, 2025 16:07

Issue #615 - added end-to-end test for PackageVariant readiness gate

f06714e

- also broke ground on testing PackageVariants in end-to-end tests at all nephio-project/nephio#615

Issue #615 - added end-to-end test for PackageVariant readiness gate

926483d

- also broke ground on testing PackageVariants in end-to-end tests at all nephio-project/nephio#615

Issue #615 - removed missed line that locked tests' namespace to 'porch'

1e5e34c

nephio-project/nephio#615

Issue #615 - E2E tests - additional repo cleanup for package variants

ff91f1a

- tests now delete package variants whose upstream is a repo created by the test nephio-project/nephio#615

JamesMcDermott mentioned this pull request Jan 16, 2025

Porch: PackageVariant should set a readinessgate nephio-project/nephio#615

Open

JamesMcDermott added 3 commits January 21, 2025 10:04

Merge branch 'nephio-project:main' into pv-pipeline-readiness-gates

8252125

Merge branch 'nephio-project:main' into pv-pipeline-readiness-gates

f6ca35e

Merge branch 'nephio-project:main' into pv-pipeline-readiness-gates

46f7f49

JamesMcDermott added 4 commits January 30, 2025 17:47

Issue #615 - unit test fix

79d97f6

nephio-project/nephio#615

Issue #615 - move readiness validation for propose and approve into s…

316e97b

…erver - apply readiness-gate lockout to API operations as well as porchctl CLI nephio-project/nephio#615

fix word in comment that got caught in variable name refactor

fbdc3f0

nephio-prow bot removed the do-not-merge/work-in-progress label Jan 31, 2025

liamfallon reviewed Feb 4, 2025

View reviewed changes

nephio-prow bot added the approved label Feb 4, 2025

JamesMcDermott added 2 commits February 4, 2025 16:27

Merge branch 'nephio-project:main' into pv-pipeline-readiness-gates

5377b1b

Issue #615 - update copyright comments to 2025

92b6abb

nephio-project/nephio#615

JamesMcDermott mentioned this pull request Feb 10, 2025

Documentation for #615 - PackageRevision readiness gates in Porch nephio-project/docs#204

Open

Merge branch 'nephio-project:main' into pv-pipeline-readiness-gates

efb1702

lapentad reviewed Feb 19, 2025

View reviewed changes

pkg/engine/engine.go Outdated Show resolved Hide resolved

JamesMcDermott added 3 commits February 19, 2025 09:57

Fix variable name reverted in rebase

16917fa

Merge branch 'main' into pv-pipeline-readiness-gates

d42e4f6

Merge branch 'nephio-project:main' into pv-pipeline-readiness-gates

dafc351

Merge branch 'main' into pv-pipeline-readiness-gates

8421cb6

kispaljr reviewed Feb 25, 2025

View reviewed changes

pkg/task/clone.go Outdated Show resolved Hide resolved

pkg/task/init.go Outdated Show resolved Hide resolved

efiacor added the do-not-merge/hold label Feb 25, 2025

efiacor reviewed Feb 26, 2025

View reviewed changes

Makefile Outdated Show resolved Hide resolved

controllers/main.go Outdated Show resolved Hide resolved

controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller.go Outdated Show resolved Hide resolved

api/porch/v1alpha1/types.go Outdated Show resolved Hide resolved

JamesMcDermott added 3 commits February 27, 2025 15:17

Merge branch 'nephio-project:main' into pv-pipeline-readiness-gates

93d2ff9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Have PackageVariant set readiness gate on PackageRevisions #156

Have PackageVariant set readiness gate on PackageRevisions #156

JamesMcDermott commented Dec 10, 2024 •

edited

Loading

efiacor commented Dec 10, 2024

efiacor Dec 10, 2024

efiacor commented Dec 10, 2024

JamesMcDermott commented Dec 10, 2024

JamesMcDermott commented Dec 10, 2024

JamesMcDermott commented Dec 10, 2024

liamfallon commented Dec 11, 2024

JamesMcDermott commented Dec 11, 2024

kispaljr left a comment

liamfallon Feb 4, 2025

liamfallon left a comment

nephio-prow bot commented Feb 4, 2025

kispaljr commented Feb 25, 2025

kispaljr left a comment

efiacor commented Feb 25, 2025

sonarqubecloud bot commented Feb 27, 2025

Have PackageVariant set readiness gate on PackageRevisions #156

Are you sure you want to change the base?

Have PackageVariant set readiness gate on PackageRevisions #156

Conversation

JamesMcDermott commented Dec 10, 2024 • edited Loading

efiacor commented Dec 10, 2024

efiacor Dec 10, 2024

Choose a reason for hiding this comment

efiacor commented Dec 10, 2024

JamesMcDermott commented Dec 10, 2024

JamesMcDermott commented Dec 10, 2024

JamesMcDermott commented Dec 10, 2024

liamfallon commented Dec 11, 2024

JamesMcDermott commented Dec 11, 2024

kispaljr left a comment

Choose a reason for hiding this comment

liamfallon Feb 4, 2025

Choose a reason for hiding this comment

liamfallon left a comment

Choose a reason for hiding this comment

nephio-prow bot commented Feb 4, 2025

kispaljr commented Feb 25, 2025

kispaljr left a comment

Choose a reason for hiding this comment

efiacor commented Feb 25, 2025

sonarqubecloud bot commented Feb 27, 2025

Quality Gate passed

JamesMcDermott commented Dec 10, 2024 •

edited

Loading