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

Fixup watcher docs, and watchlist doc examples #1284

Merged
merged 2 commits into from
Aug 24, 2023
Merged

Conversation

clux
Copy link
Member

@clux clux commented Aug 22, 2023

Lots of missing references in doc builds because we don't have warnings as errors on doc builds. Maybe we should.

Removed the namespace_reflector example because it's a slowly changing thing to watch, and instead added a way to opt-in to WATCHLIST=1 in pod_ and node_ watchers.

Was trying to allow this on event_watcher also but apparently events on k3s do not support sendInitialEvents on 1.27 yet so left it out there. While in the area though, i updated event_watcher to use the new Event type (rather than the legacy core one) to make the example better.

EDIT: follow-up on param serializer might also be needed but doing that separaetly #1281 (comment) - am ultimately not changing the logic anywhere here, just applying clippy suggestions

Lots of missing references in doc builds because many of these are warnings.

Removed the `namespace_reflector` because it's a slowly changing thing to watch, and instead added a way to opt-in to `WATCHLIST=1` in pod and node watchers.

Was trying to do this on event_watcher also but apparently events on k3s does not support sendInitialEvents on 1.27 yet so left it out there.
While in the area i also updated event_watcher to use the new `Event` type to make the example better.

Signed-off-by: clux <[email protected]>
@clux clux added docs unclear documentation changelog-exclude changelog excluded prs labels Aug 22, 2023
@clux clux added this to the 0.86.0 milestone Aug 22, 2023
@clux clux marked this pull request as ready for review August 22, 2023 09:44
@codecov
Copy link

codecov bot commented Aug 22, 2023

Codecov Report

Merging #1284 (1e7fd51) into main (f44ce00) will not change coverage.
The diff coverage is n/a.

❗ Current head 1e7fd51 differs from pull request most recent head 5aa37a5. Consider uploading reports for the commit 5aa37a5 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1284   +/-   ##
=======================================
  Coverage   72.27%   72.27%           
=======================================
  Files          75       75           
  Lines        6259     6259           
=======================================
  Hits         4524     4524           
  Misses       1735     1735           
Files Changed Coverage Δ
kube-core/src/params.rs 84.03% <ø> (ø)
kube-runtime/src/controller/mod.rs 34.21% <ø> (ø)
kube-runtime/src/watcher.rs 38.13% <ø> (ø)

@clux clux requested review from nightkr and Dav1dde August 22, 2023 09:44
Signed-off-by: clux <[email protected]>
@clux
Copy link
Member Author

clux commented Aug 24, 2023

Sending this through. It's just docs + examples rest is non-functionally changing clippy stuff.

@clux clux merged commit 9685bc1 into main Aug 24, 2023
16 checks passed
@clux clux deleted the fixup-docs-event-watcher branch August 24, 2023 05:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-exclude changelog excluded prs docs unclear documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant