Skip to content

Commit

Permalink
docs: update mirror feature to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oilbeater committed Jun 18, 2019
1 parent 4b6290b commit 96ec620
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Kube-OVN integrates the OVN-based Network Virtualization with Kubernetes. It off
- **Distributed Gateways**: Every Node can act as a Gateway to provide external network connectivity.
- **Namespaced Gateways**: Every Namespace can have a dedicated Gateway for Egress traffic.
- **Direct External Connectivity**:Pod IP can be exposed to external network directly.
- **Traffic Mirror**: Duplicated container network traffic for monitoring and diagnosing.

## Planned Future Work
- Hardware Offloading and DPDK Support
Expand All @@ -38,6 +39,7 @@ Kube-OVN is easy to install with all necessary components/dependencies included.
- [Static IP](docs/static-ip.md)
- [Dynamic QoS](docs/qos.md)
- [Gateway and Direct connect](docs/gateway.md)
- [Traffic Mirror](docs/mirror.md)

## Contact
Mail: mengxin#alauda.io
Expand Down
2 changes: 1 addition & 1 deletion docs/mirror.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Kube-OVN support traffic mirroring that duplicates pod nic send/receive network

Traffic mirror is disabled by default, you should add cmd args in cni-server when installing kube-ovn to enabled it.
- `--enable-mirror=true`: enable traffic mirror
- `--mirror-iface=mirror0`: kube-ovn will create an ovs internal port on every node to mirror pod traffic on that node. If not set will use mirror0 as the default port name
- `--mirror-iface=mirror0`: kube-ovn will create an ovs internal port on every node to mirror pods traffic on that node. If not set will use mirror0 as the default port name

Then you can use tcpdump or other tools to diagnose traffic from interface mirror0:

Expand Down

0 comments on commit 96ec620

Please sign in to comment.