New command in Tetragon CLI: tetra explain

[christian-2]

Is there an existing issue for this?

• I have searched the existing issues

Is your feature request related to a problem?

Currently the best exact description of Tetragon's CRD TraingPolicy resides in the source code. This is suboptimal; the proposed command tetra explain would provide easier access to the same descriptions.

See also related thread in Slack here.

Describe the feature you would like

When working with tracing policies, and exact understanding of the fields in Tetragon's CRD TracingPolicy and their semantics is mandatory. The Kubernetes client kubectl offers a command kubectl explain to get hold or CRD descriptions. For cases where Tetragon serves independently of Kubernetes it would be helpful if its client tetra could support such a command as well: e.g. tetra explain tracingpolicy.spec.call.syscall.

Describe your proposed solution

tetra explain should render the description from comments that already reside in the source code. An implementation could perhaps build on top of (call out to code "inside") Kubernetes' kubectl explain. Yet tetra explain must not introduce a strong dependency on Kubernetes: the command should work in deployments both with and without it.

Code of Conduct

• I agree to follow this project's Code of Conduct