Add debug binary to the docker image #3686

alexkursell · 2019-01-21T22:13:32Z

What this PR does / why we need it:
This PR adds a command-line tool to the image, /dbg, that can inspect various parts of the nginx configuration, including the dynamic parts used by lua. This should make it easier to debug problems to do with the generated configuration.

Right now, it can query the /configuration/backends and /configuration/general endpoints and display the result. In the case of the backend endpoint, it can also filter the output by backend name. It also includes a subcommand that essentially performs cat /etc/nginx/nginx.conf just to save on typing.

In the future, I'd also like to add the ability to inspect the dynamically loaded SSL keys that are also managed by lua, as well as anything else that makes debugging easier.

Which issue this PR fixes : Addresses #3679

cc: @ElvinEfendi

k8s-ci-robot · 2019-01-21T22:13:44Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please email the CNCF helpdesk: [email protected]

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

alexkursell · 2019-01-22T14:29:34Z

I've signed the CLA.

diazjf

Thanks for working on this. it would be very useful.

Still needs:

unit tests
documentation on usage

diazjf · 2019-01-30T04:03:16Z

cmd/dbg/main.go

+
+func backends() {
+	//Get the backend information from the nginx instance
+	body, requestErr := makeRequest("http://127.0.0.1:18080/configuration/backends")


Instead of http://127.0.0.1:18080/configuration/backends being hardcoded here, it can be a global variable.

Also 18080 should be obtained be user configurable.

diazjf · 2019-01-30T04:03:36Z

cmd/dbg/main.go

+}
+
+func backendsList() {
+	body, requestErr := makeRequest("http://127.0.0.1:18080/configuration/backends")


Instead of http://127.0.0.1:18080/configuration/backends being hardcoded here, it can be a global variable.

Also 18080 should be obtained be user configurable.

diazjf · 2019-01-30T04:03:45Z

cmd/dbg/main.go

+}
+
+func backendsGet(name string) {
+	body, requestErr := makeRequest("http://127.0.0.1:18080/configuration/backends")


Instead of http://127.0.0.1:18080/configuration/backends being hardcoded here, it can be a global variable.

Also 18080 should be obtained be user configurable.

diazjf · 2019-01-30T04:03:57Z

cmd/dbg/main.go

+
+func general() {
+	//Get the other (general) information from the nginx instance
+	body, requestErr := makeRequest("http://127.0.0.1:18080/configuration/general")


Instead of http://127.0.0.1:18080/configuration/general being hardcoded here, it can be a global variable.

Also 18080 should be obtained be user configurable.

diazjf · 2019-01-30T04:08:48Z

cmd/dbg/main.go

+		fmt.Println(err)
+		return nil, err
+	}
+	defer resp.Body.Close()


You should begin with the defer. Defer is always be triggered when a function ends.

diazjf · 2019-01-30T04:08:54Z

cmd/dbg/main.go

+		fmt.Println(err)
+		return
+	}
+	defer confFile.Close()


You should begin with the defer. Defer is always be triggered when a function ends.

aledbf · 2019-01-30T18:02:41Z

@alexkursell just in case, I am removing the server listening on port 18080 in #3684

ElvinEfendi · 2019-01-30T20:21:39Z

@alexkursell let's use a proper cli library instead: https://github.com/spf13/cobra seems to be the one in k8s realm.

I am removing the server listening on port 18080 in #3684

As long as we have got the right abstraction here, the change should not be an issue. So this is not a blocker.

ElvinEfendi · 2019-02-01T16:10:59Z

test/e2e/framework/framework.go

@@ -214,6 +214,19 @@ func (f *Framework) NginxLogs() (string, error) {
 	return nginxLogs(f.KubeClientSet, f.IngressController.Namespace)
 }

+// PodCommand executes any command inside the nginx pod
+func (f *Framework) PodCommand(cmd string) (string, error) {


there's already a function to do this: ExecIngressPod

aledbf · 2019-02-06T23:30:52Z

@alexkursell there is something wrong with this PR. If you need to add new dependencies, you need to run something like

rm -rf images/grpc-fortune-teller/
make dep-ensure

to avoid adding the grpc-fortune-teller dependencies.
Then, before committing the changes, restore images/grpc-fortune-teller/.

Also, usually we squash the commit, using one for the code changes and another for the changes in the vendor directory

aledbf · 2019-02-07T15:08:51Z

cmd/dbg/main.go

+	fmt.Print(string(contents))
+}
+
+func makeConfigRequest(path string) ([]byte, error) {


Why not use https://github.com/kubernetes/ingress-nginx/blob/master/internal/nginx/main.go#L51 just to avoid duplications

cmd/dbg/main.go

aledbf · 2019-02-07T17:45:54Z

/approve

aledbf · 2019-02-07T17:46:38Z

deferring lgtm to @ElvinEfendi

ElvinEfendi · 2019-02-07T18:02:22Z

cmd/dbg/main.go

+	"os"
+)
+
+var (


these are const, not var

ElvinEfendi · 2019-02-11T15:24:24Z

/lgtm
/approve

k8s-ci-robot · 2019-02-11T15:24:47Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, alexkursell, ElvinEfendi

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ElvinEfendi,aledbf]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ElvinEfendi · 2019-02-11T15:26:41Z

closes #3679

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 21, 2019

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jan 21, 2019

k8s-ci-robot requested review from aledbf and ElvinEfendi January 21, 2019 22:13

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 22, 2019

diazjf suggested changes Jan 30, 2019

View reviewed changes

aledbf added the do-not-merge/blocked-paths Indicates that a PR should not merge because it touches files in blocked paths. label Jan 30, 2019

alexkursell force-pushed the dbg-tool branch from 59e1198 to 2a6bda6 Compare January 30, 2019 19:04

ElvinEfendi reviewed Feb 1, 2019

View reviewed changes

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 1, 2019

alexkursell force-pushed the dbg-tool branch 2 times, most recently from 5661b43 to f1daec2 Compare February 6, 2019 22:05

alexkursell force-pushed the dbg-tool branch from f1daec2 to 6db9298 Compare February 7, 2019 14:57

alexkursell force-pushed the dbg-tool branch from 6016c74 to 68c3b97 Compare February 7, 2019 15:06

aledbf reviewed Feb 7, 2019

View reviewed changes

cmd/dbg/main.go Show resolved Hide resolved

aledbf removed the do-not-merge/blocked-paths Indicates that a PR should not merge because it touches files in blocked paths. label Feb 7, 2019

aledbf assigned ElvinEfendi Feb 7, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 7, 2019

ElvinEfendi reviewed Feb 7, 2019

View reviewed changes

alexkursell force-pushed the dbg-tool branch from b01b4c6 to 4559946 Compare February 7, 2019 21:00

Alex Kursell added 2 commits February 8, 2019 11:25

Add debug tool to image

9534f8b

make dep-ensure

190b60f

alexkursell force-pushed the dbg-tool branch from 38fdc40 to 190b60f Compare February 8, 2019 16:32

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 11, 2019

k8s-ci-robot merged commit 9ba6799 into kubernetes:master Feb 11, 2019

ElvinEfendi deleted the dbg-tool branch February 11, 2019 15:27

alexkursell mentioned this pull request Feb 11, 2019

Feature request: kubectl plugin #3755

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add debug binary to the docker image #3686

Add debug binary to the docker image #3686

alexkursell commented Jan 21, 2019

k8s-ci-robot commented Jan 21, 2019

alexkursell commented Jan 22, 2019

diazjf left a comment

diazjf Jan 30, 2019

diazjf Jan 30, 2019

diazjf Jan 30, 2019

diazjf Jan 30, 2019

diazjf Jan 30, 2019

diazjf Jan 30, 2019

aledbf commented Jan 30, 2019 •

edited

Loading

ElvinEfendi commented Jan 30, 2019

ElvinEfendi Feb 1, 2019

aledbf commented Feb 6, 2019 •

edited

Loading

aledbf Feb 7, 2019

alexkursell Feb 7, 2019

aledbf commented Feb 7, 2019

aledbf commented Feb 7, 2019

ElvinEfendi Feb 7, 2019

alexkursell Feb 7, 2019

ElvinEfendi commented Feb 11, 2019

k8s-ci-robot commented Feb 11, 2019

ElvinEfendi commented Feb 11, 2019

+              	"os"
+              )
+              var (

Add debug binary to the docker image #3686

Add debug binary to the docker image #3686

Conversation

alexkursell commented Jan 21, 2019

k8s-ci-robot commented Jan 21, 2019

alexkursell commented Jan 22, 2019

diazjf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aledbf commented Jan 30, 2019 • edited Loading

ElvinEfendi commented Jan 30, 2019

Choose a reason for hiding this comment

aledbf commented Feb 6, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aledbf commented Feb 7, 2019

aledbf commented Feb 7, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ElvinEfendi commented Feb 11, 2019

k8s-ci-robot commented Feb 11, 2019

ElvinEfendi commented Feb 11, 2019

aledbf commented Jan 30, 2019 •

edited

Loading

aledbf commented Feb 6, 2019 •

edited

Loading