Skip to content
This repository has been archived by the owner on Mar 20, 2024. It is now read-only.

Updated README for libxdp #84

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

phansGithub
Copy link
Contributor

Note: New libxdp installation commands are unaligned, will fix.

Makefile Outdated
@echo
sudo apt update && \
sudo apt install -y wget build-essential golang && \
sudo wget http://security.ubuntu.com/ubuntu/pool/main/libb/libbpf/libbpf1_1.1.0-1_amd64.deb && \
Copy link
Contributor

@patrickog11 patrickog11 Nov 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation here needs fixing

README.md Outdated
@@ -97,6 +97,9 @@ The following prerequisites are required to build and deploy the plugins from so
- **llvm**
- Compiling the bpf progs for Kind.
- Install on Ubuntu: `apt install llvm`
- **libxdp**
- Same as Libbpf, to load and uload the XDP program onto the network device.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*unload (spellcheck)

Might be worth adding just a brief about what we're doing - installing libbpf, the wget packages and libxdp.

Also, I think we should be doing a libbpf check on the host first as we're including it as the first step of the libxdp installation:

If not present = first install libbpf
else = install libxdp

If we're to break the installation process to 2 sections (libbpf and libxdp) both steps will be required for the ci-public.yml.

@garyloug, we might discuss this further.

@phansGithub phansGithub force-pushed the xdp-update branch 7 times, most recently from d2cb853 to d851338 Compare November 21, 2023 14:37
Makefile Outdated
install-xdp:
@echo "****** Install libxdp ******"
@echo
sudo apt update && \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if someone is running on Fedora, apt instructions won't work.

I don't know about adding this to the Makefile, we don't typically install any other dependencies for the project, we list them in the readme and the expectation is that the user ensures the dependencies are installed.

README.md Outdated
@@ -97,6 +97,10 @@ The following prerequisites are required to build and deploy the plugins from so
- **llvm**
- Compiling the bpf progs for Kind.
- Install on Ubuntu: `apt install llvm`
- **libxdp**
- Same as Libbpf, to load and unload the XDP program onto the network device.
- Installation: `make install-xdp`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Installation: `make install-xdp`
- Install on Ubuntu: `make install-xdp`

Makefile Outdated
install-xdp:
@echo "****** Install libxdp ******"
@echo
sudo apt update && \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively add a check to verify one is running on ubuntu before proceeding.

Signed-off-by: phansGithub <[email protected]>
@phansGithub phansGithub changed the title Updated README and Makefile for libxdp Updated README for libxdp Nov 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants