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.

Sign up for GitHub

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

fix readme style #1

Merged
merged 1 commit into from
May 26, 2018
Merged

fix readme style #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,15 @@ We provide shell script that automates the build of katran for Ubuntu 18.04.
To build and install katran library and thrift/grpc examples - you need to run
build_katran.sh script. It should take care of all the required dependencies.
If you need to build it for other linux distributions, yon need to make sure that

1. it runs on recent linux kernel (4.13+)
2. you have installed:
1. [folly](https://github.com/facebook/folly)
2. recent version of clang compiler (6.0+)
3. glog/gtest/gflags/elf libraries
4. [wangle](https://github.com/facebook/wangle)
5. recent version of [linux kernel src](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git)
6. if you want to build examples [fbthrift](https://github.com/facebook/fbthrift) and [grpc](https://github.com/grpc/grpc) must be installed as well
- [folly](https://github.com/facebook/folly)
- recent version of clang compiler (6.0+)
- glog/gtest/gflags/elf libraries
- [wangle](https://github.com/facebook/wangle)
- recent version of [linux kernel src](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git)
- if you want to build examples [fbthrift](https://github.com/facebook/fbthrift) and [grpc](https://github.com/grpc/grpc) must be installed as well

# motivation behind layer 4 load balancing
Layer 4 load balancer (lb) enables to easily scale out Layer7 load balancers (the
Expand Down
10 changes: 5 additions & 5 deletions USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,16 +182,16 @@ lb.addVip(vip);
The same function can be called w/ optional "flag" parameter.
‘flag’ can be used to specify some special conditions of this VIP. Currently the supported options are:

0 - default value. Default vip uses connection table and use
- 0 - default value. Default vip uses connection table and use
src port and src addresses of the packet for hashing
1 - HASH_NO_SRC_PORT, this flag removes src port from hashing calculation. This
- 1 - HASH_NO_SRC_PORT, this flag removes src port from hashing calculation. This
allows packets from same source address, but different ports to end up on the
same destination server (some applications requires this: e.g. nfs or gfs)
2 - LRU_BYPASS - disable connection table lookup/update for this VIP
4 - QUIC_VIP - this is a VIP for QUIC protocol. Load balancing is going to be
- 2 - LRU_BYPASS - disable connection table lookup/update for this VIP
- 4 - QUIC_VIP - this is a VIP for QUIC protocol. Load balancing is going to be
done based on connection-id field. This is not fully stable/actively being developed codepath
(as IETF QUIC is still in developing stage and standard has not been finalized yet)
8 - HASH_DPORT_ONLY - use only destination port for hashing. In this case
- 8 - HASH_DPORT_ONLY - use only destination port for hashing. In this case
only destination port is going to be used for hashing, so different clients
(different src address/src port) with the same destination port would end
up on the same real server (usually VOIP based protocols needs this)
Expand Down