Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update: remove ondelete not used for cleanup steps #1621

Merged
merged 2 commits into from
Feb 13, 2025

Conversation

zdtsw
Copy link
Member

@zdtsw zdtsw commented Feb 6, 2025

  • we do not unpatch auth in smcp since we do not support unmanaged case

Description

How Has This Been Tested?

Screenshot or short clip

Merge criteria

  • You have read the contributors guide.
  • Commit messages are meaningful - have a clear and concise summary and detailed explanation of what was changed and why.
  • Pull Request contains a description of the solution, a link to the JIRA issue, and to any dependent or related Pull Request.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work

@zdtsw zdtsw requested review from bartoszmajsak and removed request for carlkyrillos and asanzgom February 6, 2025 11:40
@zdtsw
Copy link
Member Author

zdtsw commented Feb 6, 2025

/test all

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 20.14%. Comparing base (28c36c2) to head (2d12306).
Report is 17 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1621      +/-   ##
==========================================
- Coverage   20.28%   20.14%   -0.14%     
==========================================
  Files         163      162       -1     
  Lines       11137    11089      -48     
==========================================
- Hits         2259     2234      -25     
+ Misses       8638     8621      -17     
+ Partials      240      234       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

zdtsw added 2 commits February 7, 2025 11:22
- we do not unpatch auth in smcp since we do not support unmanaged case

Signed-off-by: Wen Zhou <[email protected]>
Signed-off-by: Wen Zhou <[email protected]>
@zdtsw
Copy link
Member Author

zdtsw commented Feb 7, 2025

/test opendatahub-operator-e2e

@zdtsw zdtsw requested a review from bartoszmajsak February 7, 2025 16:12
@zdtsw zdtsw mentioned this pull request Feb 7, 2025
5 tasks
Copy link
Contributor

@bartoszmajsak bartoszmajsak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With no hard feelings...

approved

@openshift-ci openshift-ci bot added the lgtm label Feb 12, 2025
Copy link

openshift-ci bot commented Feb 12, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: bartoszmajsak
Once this PR has been reviewed and has the lgtm label, please ask for approval from zdtsw. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

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

@zdtsw zdtsw merged commit 4ed6f56 into opendatahub-io:main Feb 13, 2025
9 of 10 checks passed
zdtsw added a commit to zdtsw-forking/opendatahub-operator that referenced this pull request Feb 14, 2025
* update: remove ondelete not used for cleanup steps

- we do not unpatch auth in smcp since we do not support unmanaged case
---------

Signed-off-by: Wen Zhou <[email protected]>
openshift-merge-bot bot pushed a commit that referenced this pull request Feb 14, 2025
…1666)

* Improve gc service/action (#1656)

* Improve gc service/action

* Remove useless lock

* Fix typos

* Improve error handling

* update: remove ondelete not used for cleanup steps (#1621)

* update: remove ondelete not used for cleanup steps

- we do not unpatch auth in smcp since we do not support unmanaged case
---------

Signed-off-by: Wen Zhou <[email protected]>

* actions: refactor to move template and manifest rendering to a helper (#1563)

* actions: abstract caching functionality into cacher

The caching code for all caching Actions is pretty much the same

1) hash the key
2) if the hash is the same as the stored one, return stored resource
3) otherwise render the resource
4) store the key and the resource
5) return the resource

Abstract this logic into Cacher[T] generic type, where T is the type
of the resource, which is supposed to be included as a composition
in on the higher levels.

The core engine is implemented as Render method which accepts actual
renderer (function) and return boolean value in addition to the
resources indicating if it performed rendering. It supposed to be
used in resource rendering actions for accounting.

The renderer should return (error, T).

Put renderer as the last argument to make more convenient to call
with a closure.

Copy CachingKeyFn type. In future it can be extented to accept
context for possible debug logging.

Define contract, CachingKeyFn should not return empty hash. (!!!)

The code originally is taken pretty much from the existing kustomize
rendering Action. But taking into account the contract, refactor the
code to avoid comparation of the result (and nil assignments) since
with generics to work with both nilable (maps, arrays, etc) and
non-nilable (ints, strings) types it requires some extra handling of
Zero values.

Zero values are still required for return values in error case, so
implement Zero[T] generic function.

With the assumption make "empty key" a error condition, it removes
need of extra comparation.

Move actual rendering and cache update into separate function, it
makes main Render function more clear without extra indentation.

Possible usage supposed to be

```
type Action struct {
	cacher.Cacher[resources.UnstructuredList]
	// action data
}

type ActionOpts func(*Action)
func WithCache() ActionOpts {
	return func(a *Action) {
		a.Cacher.SetKeyFn(types.Hash) // or own
	}
}

func (s *Action) run(ctx context.Context, rr *types.ReconciliationRequest) error {
	//...
	res, acted, err := a.Cacher.Render(ctx, rr, s.render)
	if acted { /* may be do something */ }
	// use resources
}

func (s *Action) render(ctx context.Context, rr *types.ReconciliationRequest) (resources.UnstructuredList, error) {
	result := make(resources.UnstructuredList)
	// make some resources
	return result, nil
}

func NewAction(opts ...ActionOpts) actions.Fn {
	for _, opt := range opts {
		opt(&action)
	}

	return action.run
}
```

with reconciler creation

```
func (s *componentHandler) NewComponentReconciler(ctx context.Context, mgr ctrl.Manager) error {
	_, err := reconciler.ReconcilerFor(
		mgr,
		&componentApi.Type{},
	).
		// ...
		WithAction(foobar.NewAction(
			foobar.WithCache(),
		))
}
```

Pay attention to signature of render() and call to Cacher.Render()
from run().

Signed-off-by: Yauheni Kaliuta <[email protected]>

* actions: abstract resource caching into resourcecacher

Make an abstract wrapper on the raw cacher.Cacher[T] to work on
actions whose Renderer produces
resources (resources.UnstructuredList) to be recorded into
ReconciliationRequest.Manifests and later deployed (deleted) to the
cluster.

Performs common tasks:
- invalidate caching if devflags enabled;
- account resources if they were generated (and skip cached ones);
- add resources to the ReconciliationRequest.

Created constructor which accepts mandatory name. Since it is used
in prometheus, it's recommended to make it lower case.

At this moment this is the only part which interested in the origin
of resources (cached or not) and it's supposed to be used in actions
whose final goal is to add resources to the request (which is done
by this helper), so change signature of its Render()
method (comparing to cacher.Cacher) to return only error.

The code is basically copied from manifest/template rendering
actions run() method.

Usage (changed run() comparing to cacher.Cacher):

```
type Action struct {
	resourcecacher.ResourceCacher
	// action data
}

type ActionOpts func(*Action)
func WithCache() ActionOpts {
	return func(a *Action) {
		a.ResourceCacher.SetKeyFn(types.Hash) // or own
	}
}

func (s *Action) run(ctx context.Context, rr *types.ReconciliationRequest) error {
	//...
	return a.ResourceCacher.Render(ctx, rr, s.render)
}

func (s *Action) render(ctx context.Context, rr *types.ReconciliationRequest) (resources.UnstructuredList, error) {
	result := make(resources.UnstructuredList)
	// make some resources
	return result, nil
}

func NewAction(opts ...ActionOpts) actions.Fn {
        action := Action{
                ResourceCacher: resourcecacher.NewResourceCacher("mycoolaction"),
        }
	for _, opt := range opts {
		opt(&action)
	}

	return action.run
}
```

Signed-off-by: Yauheni Kaliuta <[email protected]>

* actions: use resourcecacher for manifests rendering

All the run() functionality now implemented by the ResourceCacher,
so just call its Render() in run().

Amend WithCache() as required by ResourceCacher to set its
CachingKeyFn and remove CachingKeyFn initialization from NewAction.

Change render() signature to return resources.UnstructuredList

RendererEngine is used as a field initializer now, so no need to
export, rename to rendererEngine.

Signed-off-by: Yauheni Kaliuta <[email protected]>

* actions: use resourcecacher for template rendering

The same changes as to manifests rendering.
Just keep `data` field initialization in NewAction, used in
render().

Signed-off-by: Yauheni Kaliuta <[email protected]>

---------

Signed-off-by: Yauheni Kaliuta <[email protected]>

* chore: move Release strcuts from pkg/cluster to apis/common (#1580)

Structs that are part of the public APIs should be in the apis packages
for consistency and to avoid cyclic import issues

(cherry picked from commit 1760dee)

* feat(test): support for Succeed and MatchError in testf framework (#1628)

(cherry picked from commit a774767)

* chore(kserve): wrap error returned by FromUnstructured (#1646)

(cherry picked from commit 9402f6a)

---------

Signed-off-by: Wen Zhou <[email protected]>
Signed-off-by: Yauheni Kaliuta <[email protected]>
Co-authored-by: Luca Burgazzoli <[email protected]>
Co-authored-by: Yauheni Kaliuta <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants