Add ephemeral debugging guide #1202
Merged
+211
−5
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
github-actions
bot
added
chore
sjberman
reviewed
Oct 26, 2023
sjberman
reviewed
Oct 26, 2023
kate-osborn
force-pushed
the
chore/add-debug-guide
branch
from
962191a
to
0a03010
Compare
|
Closing until I figure out why it's not working for everyone |
|
Does anyone on the team use VSCode? If so, and you get this working, would love to see what your |
|
Nevermind, user error. |
ADubhlaoich
approved these changes
Dec 22, 2023
@ADubhlaoich no thanks! This is a developer doc and doesn't need to be on the public site. |
pleshakov
reviewed
Jan 2, 2024
kate-osborn
force-pushed
the
chore/add-debug-guide
branch
from
9efa473
to
515a1ec
Compare
pleshakov
approved these changes
Jan 4, 2024
bjee19
approved these changes
Jan 4, 2024
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.
Proposed changes
Problem: No documentation on how to debug NGF in Kubernetes
Solution: Add a developer guide with step-by-step instructions on how to inject an ephemeral dlv debug container into NGF while it's running in a cluster. Includes makefile targets to make the process easier and a dockerfile for the dlv debug image.
Testing: Ran through the steps in the guide to make sure it works.
Closes #1201
Checklist
Before creating a PR, run through this checklist and mark each as complete.