[WIP] Add secret monitor for Routes by thejasn · Pull Request #1518 · openshift/library-go

thejasn · 2023-05-02T12:07:57Z

Related: CFE-866
Implements: openshift/enhancements#1307

openshift-ci · 2023-05-02T12:08:02Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

p0lyn0mial · 2023-05-16T12:31:58Z

Hi @thejasn, I would like to get some context before I start reviewing this PR (or reading the KEP).
Could you please explain to me why we need this functionality in the library-go ?

openshift-ci · 2023-07-11T08:47:37Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: thejasn
Once this PR has been reviewed and has the lgtm label, please assign knobunc for approval. For more information see the Kubernetes Code Review Process.

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

Details

Needs approval from an approver in each of these files:

pkg/route/OWNERS

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

Fixes one-to-many mapping of secret to multiple routes

thejasn · 2023-07-11T10:41:18Z

/cc @deads2k

deads2k · 2023-07-13T00:54:41Z

pkg/route/monitor/monitor.go

+}
+
+type Object struct {
+	RefCount int


This seems more suitable as a property tracked by the caller.

Yeah I would agree, will rework this bit.

deads2k · 2023-07-13T00:54:56Z

pkg/route/monitor/monitor.go

+type objectKey struct {
+	namespace string
+	name      string
+	uid       types.UID


top-to-bottom, I'm surprised to see UID.

deads2k · 2023-07-13T01:01:31Z

pkg/route/secret/secret_monitor.go

+
+// Monitor manages Kubernetes secrets. This includes retrieving
+// secrets or registering/unregistering them via Routes.
+type Monitor interface {


I think we need something like

type SecretEventHandlerRegistration interface{ ResourceEventHandlerRegistration UID() string } type SecretMonitor interface{ AddEventHandler(namespace, name string, handler ResourceEventHandler) (SecretEventHandlerRegistration, error) RemoveEventHandler(SecretEventHandlerRegistration) error }

This will allow an eventHandler for every route (overlapping secrets). It's not perfectly efficient, but it is easy. And handler passed in could wire back to a route to be queued in a different controller. Need a link to your calling code to see how to wire that back in.

We might also need a way to get a list of all known eventHandlers to diff against the current state (re-list after an outage), but if the caller correctly handles deletes we may not need it. It is a potential spot for a leak.

See the 1.27 SharedInformer interface for where I got inspiration and how can you wire it up through a sharedinformer versus a regular informer.

So I understand your suggestion as, we need an abstraction between the secret watching logic and And the caller (the component that interfaces with Routes) in form of (do correct me if I understood it incorrectly)

type SecretMonitor interface{ AddEventHandler(namespace, name string, handler ResourceEventHandler) (SecretEventHandlerRegistration, error) RemoveEventHandler(SecretEventHandlerRegistration) error }

See the 1.27 SharedInformer interface for where I got inspiration and how can you wire it up through a sharedinformer versus a regular informer.

Are you also suggesting I replace the use of the regular informer in the implementation with a sharedinformer?

Add SecretEventHandlerRegistration and SecretMonitor interface as an abstraction for secret watchers and consume the SecretMonitor via a Manager that interfaces with routes

deads2k · 2023-07-13T22:58:45Z

opened #1554 to adjust the secretmonitor. see if it makes sense.

Replace informer with sharedinformer

openshift-bot · 2023-11-01T01:00:41Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot · 2023-12-01T08:31:05Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

openshift-bot · 2024-01-01T00:00:32Z

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-ci · 2024-01-01T00:02:06Z

@openshift-bot: Closed this PR.

Details

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 2, 2023

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 4, 2023

thejasn force-pushed the feature/secret-manager branch from 1b5e110 to 75490f9 Compare June 6, 2023 05:59

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 6, 2023

thejasn changed the title ~~[WIP] Add secret manager for Routes~~ [WIP] Add secret monitor for Routes Jun 6, 2023

thejasn added 5 commits July 11, 2023 14:10

Add secret_manager for routes

80c9835

Update go.mod and vendor

fd4d7e0

Add internal monitor object

b03bfbd

Delete obsolete watch based managers

9c00d2e

Add secret monitor

0ac5b31

thejasn force-pushed the feature/secret-manager branch from 75490f9 to 24c65a5 Compare July 11, 2023 08:42

Update deps and vendor

88b71e4

thejasn force-pushed the feature/secret-manager branch from 24c65a5 to 88b71e4 Compare July 11, 2023 08:47

Fix secret monitor ref count issue

ca26833

Fixes one-to-many mapping of secret to multiple routes

openshift-ci bot requested a review from deads2k July 11, 2023 10:41

deads2k reviewed Jul 13, 2023

View reviewed changes

Refactor to use a secret watcher abstraction

750c085

Add SecretEventHandlerRegistration and SecretMonitor interface as an abstraction for secret watchers and consume the SecretMonitor via a Manager that interfaces with routes

thejasn added 2 commits July 14, 2023 12:18

Refactor based on review suggestions

7eb91ad

Replace informer with sharedinformer

Cleanup

12d5446

thejasn mentioned this pull request Aug 2, 2023

add secret monitor #1554

Closed

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 1, 2023

chiragkyal mentioned this pull request Nov 22, 2023

CFE-866: Add secret manager for routes to consume secret_monitor #1626

Merged

openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Dec 1, 2023

openshift-ci bot closed this Jan 1, 2024

Comments

Conversation

thejasn commented May 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci bot commented May 2, 2023

Uh oh!

p0lyn0mial commented May 16, 2023

Uh oh!

openshift-ci bot commented Jul 11, 2023

Uh oh!

thejasn commented Jul 11, 2023

Uh oh!

deads2k Jul 13, 2023

Choose a reason for hiding this comment

Uh oh!

thejasn Jul 13, 2023

Choose a reason for hiding this comment

Uh oh!

deads2k Jul 13, 2023

Choose a reason for hiding this comment

Uh oh!

deads2k Jul 13, 2023

Choose a reason for hiding this comment

Uh oh!

deads2k Jul 13, 2023

Choose a reason for hiding this comment

Uh oh!

thejasn Jul 13, 2023

Choose a reason for hiding this comment

Uh oh!

deads2k commented Jul 13, 2023

Uh oh!

openshift-bot commented Nov 1, 2023

Uh oh!

openshift-bot commented Dec 1, 2023

Uh oh!

openshift-bot commented Jan 1, 2024

Uh oh!

openshift-ci bot commented Jan 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

thejasn commented May 2, 2023 •

edited

Loading