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

Developing an extension outside the eBPF repo has unclear steps #3021

Open
mtfriesen opened this issue Nov 3, 2023 · 0 comments · May be fixed by #3514
Open

Developing an extension outside the eBPF repo has unclear steps #3021

mtfriesen opened this issue Nov 3, 2023 · 0 comments · May be fixed by #3514
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation P2 triaged Discussed in a triage meeting
Milestone

Comments

@mtfriesen
Copy link
Collaborator

Describe the bug

The documentation in epfExtensions.md does not describe how the following fields should be defined when creating a new hook point:

  1. bpf_attach_type
  2. bpf_link_type
  3. bpf_prog_type

It is not clear whether these should be defined in the eBPF repo or only in the codebase of the new extension. It is also not clear how the bpf_link_type enum should be used.

At a higher level, the sample code referenced in the documentation should ideally provide an example that would work outside of the eBPF repo. Finally, ideally the steps to build the sample code would rely only on the nuget package produced by the build, and the sample would be built and tested in automation, providing confidence that the sample is a good reference point for third party developers.

OS information

N/A.

Steps taken to reproduce bug

  1. Read the docs
  2. Read the sample extension
  3. Have several open questions, and separately, observe the sample could not even be compiled outside of the repo (see ebpf_store_helper.h includes non-exported (internal) eBPF header #3020)

Expected behavior

The docs should provide clear guidance for various scenarios, and the sample code should be able to be copied into a standalone codebase and work with minimal changes.

Actual outcome

The docs and sample code led to confusion and some mild frustration.

Additional details

No response

@mtfriesen mtfriesen added the bug Something isn't working label Nov 3, 2023
@dthaler dthaler added the documentation Improvements or additions to documentation label Nov 6, 2023
@Alan-Jowett Alan-Jowett assigned dv-msft and saxena-anurag and unassigned dv-msft Nov 6, 2023
@Alan-Jowett Alan-Jowett added the triaged Discussed in a triage meeting label Nov 6, 2023
@Alan-Jowett Alan-Jowett modified the milestones: 2310, 2311 Nov 6, 2023
@shankarseal shankarseal modified the milestones: 2311, 2312 Dec 5, 2023
@saxena-anurag saxena-anurag modified the milestones: 2312, 2401 Dec 11, 2023
@shankarseal shankarseal modified the milestones: 2401, 2402 Jan 10, 2024
@saxena-anurag saxena-anurag modified the milestones: 2401, 2402 Jan 29, 2024
@shankarseal shankarseal modified the milestones: 2402, 2403 Feb 28, 2024
@shankarseal shankarseal modified the milestones: 2403, 2404 Mar 6, 2024
@shankarseal shankarseal modified the milestones: 2404, 2405 Apr 29, 2024
@shankarseal shankarseal assigned gtrevi and unassigned saxena-anurag May 1, 2024
@gtrevi gtrevi linked a pull request May 2, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in 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

Successfully merging a pull request may close this issue.

7 participants