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

Add description in CRD definition to explain returnCopy and maxData fields #958

Closed
mtardy opened this issue Apr 28, 2023 · 0 comments · Fixed by #965
Closed

Add description in CRD definition to explain returnCopy and maxData fields #958

mtardy opened this issue Apr 28, 2023 · 0 comments · Fixed by #965
Assignees
Labels
area/documentation Improvements or additions to documentation

Comments

@mtardy
Copy link
Member

mtardy commented Apr 28, 2023

We can also enrich the TracingPolicy reference on the same occasion.

For maxData we can use what was written in TracingPolicy reference:

description: Read maximum possible data (currently 327360). This field is only used for char_buff data. When this value is false (default), the bpf program will fetch at most 4096 bytes. In later kernels (>=5.4) tetragon supports fetching up to 327360 bytes if this flag is turned on.

It feels like it could be a good idea to generate TracingPolicy docs straight from the CRD definition as well. Rewriting the description for all the args types and all the fields description seems redundant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant