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

Add documentation about debugging with Docker #82

Merged
merged 4 commits into from
Jan 12, 2024
Merged

Add documentation about debugging with Docker #82

merged 4 commits into from
Jan 12, 2024

Conversation

gaby
Copy link
Contributor

@gaby gaby commented Mar 29, 2021

  • Add Docker debug instructions to README.md

Tools were mentioned in #77

Add common utils to docker image.
@tooryx
Copy link
Member

tooryx commented Jan 10, 2024

Hi @gaby,

Thank you for your contribution! Although, I would prefer to keep the default container image as lightweight as possible. Maybe we could add some instructions in the README instead to help people debug these situations.

Let me know your thoughts, otherwise I will close this PR after some time.

~tooryx

@tooryx tooryx self-assigned this Jan 10, 2024
@gaby
Copy link
Contributor Author

gaby commented Jan 10, 2024

@tooryx The problem is without some of those tools in the image you will need to build your own tsunami container for debugging.

I could probably remove vi and iproute

@tooryx
Copy link
Member

tooryx commented Jan 10, 2024

Could you not just inject yourself inside the container?

$ docker run -d --rm  --network="host" --name=tsunami -v "$(pwd)/logs":/usr/tsunami/logs frakman1/tsunami:latest --ip-v4-target=172.17.0.2
xxxxxxxx (the container id)
$ docker exec -it tsunami bash
# apt update && apt install -y vi {...}

@gaby
Copy link
Contributor Author

gaby commented Jan 10, 2024

@tooryx Yes that will work as long as you have internet access.

Adding a note to the readme should be enough. I will change the PR later today after work

@tooryx
Copy link
Member

tooryx commented Jan 10, 2024

Thank you!

@tooryx tooryx added the documentation Improvements or additions to documentation label Jan 10, 2024
@gaby gaby changed the title Add common tools for debugging in Docker Image Add documentation about debugging with Docker Jan 11, 2024
@gaby
Copy link
Contributor Author

gaby commented Jan 11, 2024

@tooryx Done, I tried to keep simple and concise

Copy link
Member

@tooryx tooryx left a comment

Choose a reason for hiding this comment

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

Thank you @gaby! I added a small note

README.md Outdated Show resolved Hide resolved
@gaby
Copy link
Contributor Author

gaby commented Jan 11, 2024

@tooryx Done

@copybara-service copybara-service bot merged commit 3d0c45c into google:master Jan 12, 2024
5 checks passed
@gaby gaby deleted the docker-utils branch January 12, 2024 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants