Implements #2789 - Debug Container #3019
Conversation
leowmjw
force-pushed
the
debug-container
branch
from
430394d to
070c5fc
Compare
Codecov Report
@@ Coverage Diff @@
## main #3019 +/- ##
==========================================
- Coverage 74.52% 74.47% -0.05%
==========================================
Files 92 92
Lines 5963 5960 -3
==========================================
- Hits 4444 4439 -5
- Misses 1422 1423 +1
- Partials 97 98 +1
|
|
Thanks for the PR @leowmjw! Can you help describe a bit about what this PR does and why we need it? Are you looking for ways to debug your cluster networking? I'm just wondering if this is the right place for that sort of tool. |
Signed-off-by: Michael Leow <leow@sinarproject.org>
leowmjw
force-pushed
the
debug-container
branch
from
541e61f to
a095679
Compare
|
@stevesloka This addresses #2789 which was asking for a debug tools with contour. Done as part of Hacktoberfest. If this is not required, feel free to close. |
|
Is Debian stable the best choice for debug tooling? Would something faster-moving make more sense (personally I'm most familiar with Fedora)? |
|
@jpeach I think the debugging tools do not need to be bleeding edge; I choose the slimmest debian that I am familiar with. I can definitely change the base image to Fedora if that is the preferred; which base image do you suggest? |
|
+1 to a smaller image I prefer Debian over Fedora, but we'll all never agree. =) |
Is it worth using the same base as envoy? FWIW, I can live with whatever you choose :) |
There was a problem hiding this comment.
Thanks for this PR @leowmjw! I like the overall approach, and don't mind debian as the distro. I don't really think it matters too much, as long as there is a distro.
We're got some docs restructuring queued up, but for now if you could write up a small guide and put it in /site/_guides, I think that will at least ensure that we have some instructions captured, ready to move around when we do that.
|
Envoy uses I think I'm fine with landing this unless folks think they can enable the alpha features in ephemeral containers which ultimately I think would be the best solution (https://kubernetes.io/docs/tasks/debug-application-cluster/debug-running-pod/#ephemeral-container). In any case as long as the deploy scripts can be updated to build this, I don't think it's a big deal to ship as long as the docs clearly state this is only for debugging. =) |
|
|
||
| COPY cmd cmd | ||
| COPY internal internal | ||
| COPY apis apis |
There was a problem hiding this comment.
need to add the pkg dir as well now - see recent commit 6668c59#diff-dd2c0eb6ea5cfc6c4bd4eac30934e2d5746747af48fef6da689e85b752f39557
| @@ -0,0 +1,42 @@ | |||
| FROM golang:1.15.2 AS build | |||
There was a problem hiding this comment.
Since we now have multi-arch support for our container image, it'd be nice to support that here as well - see recent commit baa89ee#diff-dd2c0eb6ea5cfc6c4bd4eac30934e2d5746747af48fef6da689e85b752f39557
| @@ -97,6 +97,16 @@ container: ## Build the Contour container image | |||
| $(shell pwd) \ | |||
| --tag $(IMAGE):$(VERSION) | |||
|
|
|||
| debug-container: ## Build the Contour debug container image | |||
There was a problem hiding this comment.
I assume we'd want to actually push these images to Docker Hub? If so, need to add make target and GitHub Actions code for that.
I think ubuntu is a better choice - consistent with Envoy, updated more frequently than Debian stable, wider user base |
|
@leowmjw are you still interested in working on this? |
|
Marking this PR stale since there has been no activity for 14 days. It will be closed if there is no activity for another 90 days. |
github-actions
bot
added
the
lifecycle/stale
|
Closing this out as stale, feel free to reopen or open a new PR if you want to pick this up again! |
Fixes #2789
First cut implementation; any suggestions to make it better?
Where do you recommend I should put the docs for this? It appears in the "make help" output already.
Any other common tools are needed when debugging contour?
Any other common scenarios usually encountered that I should add to the examples?