Notes from working through the tutorial #441
Draft
+56
−39
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dafydd-t
commented
Oct 21, 2024
Comment on lines
+104
to
+106
| > [!NOTE] | ||
| > If you do not see the changes in the plugin UI, try clearing your browser cache. | ||
|
|
There was a problem hiding this comment.
I spent 20 minutes banging my head against this 😅
dafydd-t
commented
Oct 21, 2024
| @@ -7,18 +7,36 @@ By default, the operator is run as a separate container alongside your grafana d | |||
| The operator is a logical pattern which runs one or more controllers. The typical use-case for a controller is the `operator.InformerController`, which holds: | |||
| * One or more informers, which subscribe to events for a particular resource kind and namespace | |||
| * One or more watchers, which consume events for particular kinds | |||
| In our case, the boilerplate code uses the `simple.Operator` operator type, which handles dealing with tying together informers and watchers (or reconcilers) in an `InformerController` for us in `cmd/operator/main.go`: | |||
|
|
|||
| In our case, the boilerplate code uses the opinionated `simple.App` App type, which handles dealing with tying together informers and watchers (or reconcilers) as Managed Kinds for us in `pkg/app/app.go`: | |||
There was a problem hiding this comment.
This bit has not been updated since the refactor away from directly using simple.App. It could do with a redraft by someone more familiar IMO
dafydd-t
commented
Oct 21, 2024
| return nil, fmt.Errorf("unable to create IssueWatcher: %w", err) | ||
| } | ||
|
|
||
| prometheus.MustRegister(issueWatcher.PrometheusCollectors()...) |
There was a problem hiding this comment.
This is a bodge that worked for me, i suspect there's a better way to register this collector, but I couldn't see anything useful in simple.App
dafydd-t
commented
Oct 21, 2024
| ```go | ||
| issueWatcher, err := watchers.NewIssueWatcher() | ||
| ``` | ||
| to this: | ||
| ```go | ||
| issueWatcher, err := watchers.NewIssueWatcher(runner.ClientGenerator()) | ||
| issueWatcher, err := watchers.NewIssueWatcher(k8s.NewClientRegistry(cfg.KubeConfig, k8s.ClientConfig{})) |
There was a problem hiding this comment.
Another bodge from me to highlight a change required. This worked, but I imagine its not the way it "should" work after the refactor.
dafydd-t
commented
Oct 21, 2024
| @@ -52,7 +52,7 @@ type KindValidator interface { | |||
| ``` | |||
| Basically, it consumes an admission request and produces a validation error if validation fails, or returns nil on success. | |||
| The `simple` package has a ready-to-go implementation for this: `simple.Validator`, which calls `ValidateFunc` when `Validate` is called. | |||
| That's what we're using here, but you can always define your own type to implement `KindValidator`, too. | |||
| We use the `simple.Validator` struct here to validate, but you can use any type that implements `simple.KindValidator`. | |||
There was a problem hiding this comment.
I couldn't get these changes to apply for me, even after a teardown & clean. But its near the end of the day, I can try again tomorrow!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've worked through the tutorial with very little context on the project, these are some amendments and comments i have as feedback