Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PacketCrunch committed Aug 3, 2022
1 parent ebdd756 commit 4a86d03
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

loxilb is a cloud-native networking/security stack built from grounds up using eBPF at its core. loxilb aims to provide the following :

- Service type external load-balancer for kubernetes (hence the name loxilb)
* L4/NAT stateful loadbalancer
- Service type external load-balancer for kubernetes (hence the name loxilb)
- L4/NAT stateful loadbalancer
* High-availability support
* K8s CCM compliance
- Optimized SRv6 implementation in eBPF
Expand All @@ -21,28 +21,41 @@ loxilb is a cloud-native networking/security stack built from grounds up using e

## How to build/run

Step1 - Install package dependencies
1. Install package dependencies

# sudo apt install clang llvm libelf-dev gcc-multilib libpcap-dev
# sudo apt install linux-tools-$(uname -r)
# sudo apt install elfutils dwarves
```
sudo apt install clang llvm libelf-dev gcc-multilib libpcap-dev
sudo apt install linux-tools-$(uname -r)
sudo apt install elfutils dwarves
```

Step2 - Build libbpf locally
*loxilb also requires a special version of iproute2 for its operation. The repository can be found [here](https://github.com/loxilb-io/iproute2). Detailed build instructions can be found [here](https://github.com/loxilb-io/iproute2/blob/main/README.loxilb).*

2. Build libbpf locally

```
# cd libbpf/src/
# mkdir build
# DESTDIR=build make install
```

3. Make loxilb

Step2 - Make
```
make
```

# make
4. Run loxilb

Step3 - Run
```
sudo go run .
```

# sudo go run .
or

or
```
sudo ./loxilb
```

# sudo ./loxilb

We encourage loxilb users to follow various guides in loxilb docs [repository](https://github.com/loxilb-io/loxilbdocs)

0 comments on commit 4a86d03

Please sign in to comment.