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

Updates to README #187

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ You get the full power of Wireshark with minimal impact on your running pods.
### Intro

When working with micro-services, many times it's very helpful to get a capture of the network
activity between your micro-service and it's dependencies.
activity between your micro-service and its dependencies.

ksniff use kubectl to upload a statically compiled tcpdump binary to your pod and redirecting it's
ksniff use kubectl to upload a statically compiled tcpdump binary to your pod and redirecting its
output to your local Wireshark for smooth network debugging experience.

### Demo
Expand All @@ -33,7 +33,7 @@ For manual installation, download the latest release package, unzip it and use t

### Wireshark

If you are using Wireshark with ksniff you must use at least version 3.4.0. Using older versions may result in issues reading captures (see [Known Issues](#known-issues) below).
If you are using Wireshark with ksniff, you must use at least version 3.4.0. Using older versions may result in issues reading captures (see [Known Issues](#known-issues) below).

## Build

Expand Down Expand Up @@ -94,7 +94,7 @@ Example using `tshark`:
kubectl sniff pod-name -f "port 80" -o - | tshark -r -

### Contribution
More than welcome! please don't hesitate to open bugs, questions, pull requests
More than welcome! Please don't hesitate to open bugs, questions, pull requests.

### Future Work
1. Instead of uploading static tcpdump, use the future support of "kubectl debug" feature
Expand Down