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

chore: watch_failure template for reporting watch failures #1682

Merged
merged 5 commits into from
Jan 17, 2025

Conversation

cmwylie19
Copy link
Contributor

@cmwylie19 cmwylie19 commented Jan 17, 2025

Description

Adds a watch failure template with strict criteria for reporting in order to get enough info to debug. This template is referenced in the UDS Core docs for debugging in this PR defenseunicorns/uds-core#1205

Related Issue

Fixes #

Relates to #

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19 cmwylie19 requested a review from a team as a code owner January 17, 2025 00:30
Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.52%. Comparing base (b21ae45) to head (9aad38c).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1682   +/-   ##
=======================================
  Coverage   79.52%   79.52%           
=======================================
  Files          48       48           
  Lines        2090     2090           
  Branches      461      430   -31     
=======================================
  Hits         1662     1662           
- Misses        398      426   +28     
+ Partials       30        2   -28     

see 8 files with indirect coverage changes

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
Copy link
Contributor

@btlghrants btlghrants left a comment

Choose a reason for hiding this comment

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

Yep. Was able to run all the commands & they seem to do what we need. LGTM.

@cmwylie19 cmwylie19 added this pull request to the merge queue Jan 17, 2025
Merged via the queue into main with commit d4786e0 Jan 17, 2025
48 checks passed
@cmwylie19 cmwylie19 deleted the watch_failure_template branch January 17, 2025 22:07
mjnagel added a commit to defenseunicorns/uds-core that referenced this pull request Jan 21, 2025
## Description

After chatting with @mjnagel and him confirming this is a descent idea I
decided to take a shot at this PR that adds debugging section to the UDS
Core docs, with a link to information about watch behavior.

Background: Sometimes users immediately roll the pods when
troubleshooting around watch, this causes us to lose the info about
whether an event was missed. Being it is almost impossible to catch
those events those times are really key.

Please let me know any changes you would like to see.

Original PR and comments from
[pepr-docs](defenseunicorns/uds-docs#125)


This relates to a `watch_failure.md` [issue
template](defenseunicorns/pepr#1682) that is
going into Pepr.

## Related Issue

Fixes #
<!-- or -->
Relates to #

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Steps to Validate
- If this PR introduces new functionality to UDS Core or addresses a
bug, please document the steps to test the changes.

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor
Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md)
followed

---------

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com>
tamirazrab pushed a commit to tamirazrab/pepr that referenced this pull request Feb 10, 2025
…icorns#1682)

## Description

Adds a watch failure template with strict criteria for reporting in
order to get enough info to debug. This template is referenced in the
UDS Core docs for debugging in this PR
defenseunicorns/uds-core#1205


## Related Issue

Fixes #
<!-- or -->
Relates to #

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging
- [x] Unit,
[Journey](https://github.com/defenseunicorns/pepr/tree/main/journey),
[E2E Tests](https://github.com/defenseunicorns/pepr-excellent-examples),
[docs](https://github.com/defenseunicorns/pepr/tree/main/docs),
[adr](https://github.com/defenseunicorns/pepr/tree/main/adr) added or
updated as needed
- [x] [Contributor Guide
Steps](https://docs.pepr.dev/main/contribute/#submitting-a-pull-request)
followed

---------

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants