Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update architecture diagram to remove or de-emphasize interpreter #3928

Open
dthaler opened this issue Oct 13, 2024 · 0 comments
Open

Update architecture diagram to remove or de-emphasize interpreter #3928

dthaler opened this issue Oct 13, 2024 · 0 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation P2 triaged Discussed in a triage meeting
Milestone

Comments

@dthaler
Copy link
Collaborator

dthaler commented Oct 13, 2024

Describe the bug

Currently the main diagram at https://github.com/microsoft/ebpf-for-windows shows the interpreter prominently.
This apparently leads some to believe it's a key part of the Windows implementation, and a news article this week even stated:
"Like the Linux eBPF, Windows eBPF will offer a sandbox to execute small programs within the kernel itself, using an enclaved in-kernel interpreter to execute eBPF bytecode, once the code is verified."

In my LinkedIn post, I corrected this and pointed to Alan's blog article Towards debuggability and secure deployments of eBPF programs on Windows but the fact remains that the diagram is misleading and should be updated now. Importantly the native mode isn't even depicted or mentioned on the main page and should be.

OS information

No response

Steps taken to reproduce bug

Read the main page of the project

Expected behavior

Should mention native mode, should not call prominent attention to the interpreter

Actual outcome

Native mode is not mentioned and the interpreter shows as most prominent

Additional details

No response

@dthaler dthaler added bug Something isn't working documentation Improvements or additions to documentation labels Oct 13, 2024
@shankarseal shankarseal self-assigned this Oct 14, 2024
@shankarseal shankarseal added this to the 2410 milestone Oct 14, 2024
@shankarseal shankarseal added triaged Discussed in a triage meeting P2 labels Oct 14, 2024
@Alan-Jowett Alan-Jowett modified the milestones: 2410, 2411 Oct 30, 2024
@shankarseal shankarseal modified the milestones: 2411, 2501 Nov 2, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation P2 triaged Discussed in a triage meeting
Projects
None yet
Development

No branches or pull requests

3 participants