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.

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

[EN] add eBPF #2050

Merged
merged 42 commits into from
Aug 17, 2023
Merged

[EN] add eBPF #2050

merged 42 commits into from
Aug 17, 2023

Conversation

MaryamTavakkoli
Copy link
Contributor

@MaryamTavakkoli MaryamTavakkoli commented May 16, 2023

Describe your changes

Added a new term - eBPF

Related issue number or link (ex: resolves #issue-number)

Resolves #1448

Checklist before opening this PR (put x in the checkboxes)

  • This PR does not contain plagiarism
    • don’t copy other people’s work unless you are quoting and contributing it to them.
  • I have signed off on all commits
    • signing off (ex: git commit -s) is to affirm that commits comply DCO. If you are working locally, you could add an alias to your gitconfig by running git config --global alias.ci "commit -s".

@netlify
Copy link

netlify bot commented May 16, 2023

Deploy Preview for cncfglossary ready!

Name Link
🔨 Latest commit 491c19c
🔍 Latest deploy log https://app.netlify.com/sites/cncfglossary/deploys/64de3765ecb360000877da5e
😎 Deploy Preview https://deploy-preview-2050--cncfglossary.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the lang/en for English label May 16, 2023
@CathPag
Copy link
Collaborator

CathPag commented May 18, 2023

Thanks, @MaryamTavakkoli. We are still working on pod and stateless apps. Next is runtime and then we'll tackle this PR . Thanks for your patience!

Copy link
Collaborator

@CathPag CathPag left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution and patience, @MaryamTavakkoli!
I reviewed the first section, made some light edits, moved one section up, and have a few questions.

content/en/ebpf.md Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
@nate-double-u nate-double-u self-requested a review May 31, 2023 03:16
@MaryamTavakkoli MaryamTavakkoli force-pushed the patch-1 branch 2 times, most recently from 9e964f0 to e6568bc Compare June 11, 2023 07:08
@MaryamTavakkoli
Copy link
Contributor Author

@CathPag I applied all the suggestions, please have another look :)

@CathPag
Copy link
Collaborator

CathPag commented Jun 11, 2023

Great! Next time, the easiest thing is to simply click on "sign off and commit suggestion." That will automatically resolve the comment. To merge, all comments must be resolved. If you have a different point of few, you can also start a conversation :) One suggestion had a question that we need to address, though.

Screenshot 2023-06-11 at 5 25 52 PM

Copy link
Contributor Author

@MaryamTavakkoli MaryamTavakkoli left a comment

Choose a reason for hiding this comment

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

@CathPag I made some edit suggestions to cover your comment about security risks. Let me know what you think.

content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
@MaryamTavakkoli
Copy link
Contributor Author

@CathPag I see you have pushed the suggestions, thanks! Can you help me understand what is the next step? It shows some checks were not successful (un-signed commits) and some spell-checking. But both seem correct to me (all commits are signed and spells sound fine!), and I don't understand what is wrong.

@CathPag
Copy link
Collaborator

CathPag commented Jun 15, 2023

We need a technical reviewer to have a look as well. Unfortunately, we have a little bit of a backlog right now. But another round of reviews needed.

As to the spellcheck error, eBPF needs to be added to the "wordlist.txt" file. You can find instructions here.

Copy link
Member

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

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

Thanks for this @MaryamTavakkoli!

I've gone through and made some specific technical suggestions in line.

We should also consider mentioning other areas where eBPF is useful, like networking, observability, and security. I don't know if these are key to the definition, but they may provide more context around why eBPF is important.

content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
@nate-double-u nate-double-u changed the title [EN] Add new term (eBPF) [EN] add eBPF Jun 19, 2023
@nate-double-u nate-double-u self-assigned this Jun 27, 2023
@MaryamTavakkoli
Copy link
Contributor Author

Thanks for this @MaryamTavakkoli!

I've gone through and made some specific technical suggestions in line.

We should also consider mentioning other areas where eBPF is useful, like networking, observability, and security. I don't know if these are key to the definition, but they may provide more context around why eBPF is important.

@nate-double-u Thanks for the suggestions. I applied those suggestions now. Is this in good shape now or we should still add more content?

@nate-double-u nate-double-u dismissed their stale review June 27, 2023 20:27

Thanks for making the updates @MaryamTavakkoli! This looks good to me from a technical standpoint.

@MaryamTavakkoli
Copy link
Contributor Author

Also, quick note that we improved our review process, which is now more transparent, @MaryamTavakkoli. You can see our review board here. I just completed runtime, so I started with the eBPF editorial review (the last step). We know the process isn't super fast, but hope that, with the increased transparency, it will help contributors understand where we are in the process.

Thanks for the explanation @CathPag, it makes it easier to understand how the process works :)

Copy link
Collaborator

@CathPag CathPag left a comment

Choose a reason for hiding this comment

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

Done with the 2nd part. I've got many questions, though, sorry, @MaryamTavakkoli! Since I'm non-technical, I serve as the "guinea pig" to ensure these definitions are understandable for that audience as well.

content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
they send a request to the kernel.
For applications that require more flexibility, such as direct hardware
access, the kernel can be extended via what is known as the "Linux
kernel modules" approach. This approach extends the kernel's default functionality
Copy link
Collaborator

Choose a reason for hiding this comment

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

Question: reading through "the problem it addresses" it seems like eBFP is not a "Linux kernel model", but an alternative...or am I getting this wrong? If so, we could probably say below: "However, this approach also introduces security risks making eBFP an attractive alternative."

Copy link
Collaborator

Choose a reason for hiding this comment

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

yes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Applied this as well.

MaryamTavakkoli and others added 6 commits August 16, 2023 14:38
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Copy link
Collaborator

@iamNoah1 iamNoah1 left a comment

Choose a reason for hiding this comment

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

Left some comments. Suggestions seem to be correct.

content/en/ebpf.md Show resolved Hide resolved
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
@iamNoah1
Copy link
Collaborator

please @MaryamTavakkoli also check the spellcheck, there are words missing in the wordlist :) Thanks

Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Copy link
Collaborator

@CathPag CathPag left a comment

Choose a reason for hiding this comment

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

Looks great! I made some minor edits, but this is a solid definition. If these look good to you, @MaryamTavakkoli, we can finalize the edit review and merge 🎉

...and thanks again for your patience while we were onboarding new reviewers and figuring out a new review process!

content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
content/en/ebpf.md Outdated Show resolved Hide resolved
MaryamTavakkoli and others added 7 commits August 17, 2023 16:56
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
@MaryamTavakkoli
Copy link
Contributor Author

Looks great! I made some minor edits, but this is a solid definition. If these look good to you, @MaryamTavakkoli, we can finalize the edit review and merge 🎉

...and thanks again for your patience while we were onboarding new reviewers and figuring out a new review process!

Thanks for the great comments. I applied the suggestions and it seems fine to me to be merged.

Copy link
Collaborator

@iamNoah1 iamNoah1 left a comment

Choose a reason for hiding this comment

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

finalizing

content/en/ebpf.md Outdated Show resolved Hide resolved
wordlist.txt Outdated Show resolved Hide resolved
wordlist.txt Outdated Show resolved Hide resolved
Signed-off-by: Noah Ispas <Noahispas@gmail.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>
Copy link
Collaborator

@iamNoah1 iamNoah1 left a comment

Choose a reason for hiding this comment

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

Thank you so so much @MaryamTavakkoli for your contribution and for your patience while we finalized this new term. Also thanks to all maintainers involved :)

Copy link
Collaborator

@CathPag CathPag left a comment

Choose a reason for hiding this comment

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

LGTM

@CathPag CathPag merged commit 3783ad7 into cncf:main Aug 17, 2023
Fionn88 pushed a commit to Fionn88/glossary that referenced this pull request Sep 15, 2023
* [EN] Add new term (eBPF)

Resolves cncf#1448

Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update ebpf.md

Added semantic line breaks

Signed-off-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Apply suggested editions

Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Nate W. <natew@cncf.io>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Nate W. <natew@cncf.io>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Nate W. <natew@cncf.io>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Nate W. <natew@cncf.io>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Nate W. <natew@cncf.io>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Nate W. <natew@cncf.io>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update wordlist.txt

Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Noah Ispas <Noahispas@gmail.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Noah Ispas <Noahispas@gmail.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Noah Ispas <Noahispas@gmail.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md
Co-authored-by: Noah Ispas <Noahispas@gmail.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update ebpf.md

Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update wordlist.txt

Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>

* Update content/en/ebpf.md

Signed-off-by: Noah Ispas <Noahispas@gmail.com>

* Update wordlist.txt

Signed-off-by: Noah Ispas <Noahispas@gmail.com>

* Update wordlist.txt

Signed-off-by: Noah Ispas <Noahispas@gmail.com>

---------

Signed-off-by: Maryam Tavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: MaryamTavakkoli <maryam_tavakkoli@hotmail.com>
Signed-off-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>
Co-authored-by: Catherine Paganini <74001907+CathPag@users.noreply.github.com>
Co-authored-by: Nate W. <natew@cncf.io>
Co-authored-by: Noah Ispas <Noahispas@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

[New term] eBPF
4 participants