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: Add instructions to remote debug the Driver pods #11499

Merged
merged 1 commit into from
Jan 9, 2025

Conversation

mprahl
Copy link
Contributor

@mprahl mprahl commented Jan 6, 2025

Description of your changes:

This makes the driver command configurable so that Delve can be used to execute the driver binary and adds Make targets to build the Driver image for debugging.

Checklist:

@mprahl
Copy link
Contributor Author

mprahl commented Jan 6, 2025

/cc @HumairAK

@google-oss-prow google-oss-prow bot requested a review from HumairAK January 6, 2025 18:43
Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

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

/lgtm

.gitignore Show resolved Hide resolved
backend/README.md Outdated Show resolved Hide resolved
backend/README.md Outdated Show resolved Hide resolved
backend/README.md Outdated Show resolved Hide resolved
backend/README.md Show resolved Hide resolved
the Delve port in the pod to your localhost (replace `<driver pod name>` with the actual name).

```bash
kubectl -n <driver pod name> 2345:2345
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
kubectl -n <driver pod name> 2345:2345
kubectl -n kubeflow port-forward pod/<driver pod name> 2345:2345

backend/README.md Outdated Show resolved Hide resolved
backend/README.md Show resolved Hide resolved
@HumairAK
Copy link
Collaborator

HumairAK commented Jan 9, 2025

awesome work @mprahl just some small comments above, some are nits, so feel free to update at your discretion

for posterity, I tested this in Goland and it worked just fine, I had to use the following command:

Goland version: 2024.2.1

Driver command:
dlv --listen=:2345 --headless=true --api-version=2 --accept-multiclient exec /bin/driver --

API Server env vars
image

Rest of the config can be adapted from "Run the API Server With Debug Configuration" section.

For running remote session, use the "Go Remote" configuration

image

image

And it worked like a charm:

image

@mprahl
Copy link
Contributor Author

mprahl commented Jan 9, 2025

@HumairAK thanks for the review! Your comments clearly illustrate why my profession isn't writing technical documentation with all those typos lol.

@mprahl mprahl requested review from hbelmiro and HumairAK January 9, 2025 14:28
This makes the driver command configurable so that Delve can be used to
execute the driver binary and adds Make targets to build the Driver
image for debugging.

Signed-off-by: mprahl <[email protected]>
@HumairAK
Copy link
Collaborator

HumairAK commented Jan 9, 2025

Not at all, I thought it was very well written! Thanks for this!

/lgtm
/approve

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: HumairAK

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:

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

@google-oss-prow google-oss-prow bot merged commit a40be7b into kubeflow:master Jan 9, 2025
32 checks passed
@hbelmiro
Copy link
Contributor

all those typos

self note: always review PRs in an IDE to identify typos 😓

I thought it was very well written!

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants