Skip to content

Commit 643d94a

Browse files
committed
cosemetic edits to the README
1 parent 4f7a749 commit 643d94a

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,19 @@ Cool thing about namespaces is that you can switch between them. You can enter a
2727

2828
* **Network's Network Namespace:** If you want to troubleshoot a Docker network, you can enter the network's namespace using `nsenter`. This is explained in the `nsenter` section below.
2929

30-
**Kubernetes:** If you want to spin up a throw away container for debugging.
30+
**Kubernetes**
31+
32+
If you want to spin up a throw away container for debugging.
3133

3234
`$ kubectl run --generator=run-pod/v1 tmp-shell --rm -i --tty --image nicolaka/netshoot -- /bin/bash`
3335

3436
And if you want to spin up a container on the host's network namespace.
3537

3638
`$ kubectl run tmp-shell --generator=run-pod/v1 --rm -i --tty --overrides='{"spec": {"hostNetwork": true}}' --image nicolaka/netshoot -- /bin/bash`
3739

38-
**Network Problems:** Many network issues could result in application performance degradation. Some of those issues could be related to the underlying networking infrastructure(underlay). Others could be related to misconfiguration at the host or Docker level. Let's take a look at common networking issues:
40+
**Network Problems**
41+
42+
Many network issues could result in application performance degradation. Some of those issues could be related to the underlying networking infrastructure(underlay). Others could be related to misconfiguration at the host or Docker level. Let's take a look at common networking issues:
3943

4044
* latency
4145
* routing
@@ -95,7 +99,7 @@ To troubleshoot these issues, `netshoot` includes a set of powerful tools as rec
9599
util-linux
96100
vim
97101

98-
##**Docker EE 2.0 + Kubernetes Use Cases:**
102+
## **Docker EE 2.0 + Kubernetes Use Cases:**
99103
Here's a list of use-cases that can help you understand when and how to use this container to solve networking issues in your Docker cluster. Please feel free to add your own use-case where you used `netshoot` to investigate, trouble-shoot, or just learn more about your environment!!!
100104

101105

@@ -629,14 +633,15 @@ br0 8000.0215b8e7deb3 no vxlan1
629633
```
630634

631635
## CTOP
632-
ctop is a free open source, simple and cross-platform top-like command-line tool for monitoring container metrics in real-time. It allows you to get an overview of metrics concerning CPU, memory, network, I/O for multiple containers and also supports inspection of a specific container.
633636

634-
# To get data into ctop, you'll need to bind docker.sock into the netshoot container.
635-
```
637+
ctop is a free open source, simple and cross-platform top-like command-line tool for monitoring container metrics in real-time. It allows you to get an overview of metrics concerning CPU, memory, network, I/O for multiple containers and also supports inspection of a specific container.
636638

637-
/ # docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock nicolaka/netshoot ctop
639+
To get data into ctop, you'll need to bind docker.sock into the netshoot container.
638640

639641
```
642+
/ # docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock nicolaka/netshoot ctop
643+
```
644+
640645
![ctop.png](img/ctop.png)
641646

642647
It will display running and existed containers with useful metrics to help troubleshoot resource issues; hit "q" to exit.

0 commit comments

Comments
 (0)