microsoft / retina

eBPF distributed networking observability tool for Kubernetes
https://retina.sh
MIT License
2.72k stars 207 forks source link

[Docs] Missing "kubectl" in command #733

Closed kastl-ars closed 1 month ago

kastl-ars commented 1 month ago

https://github.com/microsoft/retina/blob/735192eb444bcf4413019c4fe68378b43e30299f/docs/04-Captures/cli.md?plain=1#L9

This should read kubectl retina capture....

rbtr commented 1 month ago

The Retina CLI can be invoked directly, it does not need to be kubectl plugin, so this would actually work. It is a bit confusing that all of the subsequent examples in this page invoke it as a plugin though. This should be explained and made consistent.

kastl-ars commented 1 month ago

Yes, it should be unified to make it consistent.

And: When I download the tarball from the release, there is only a kubectl-retina binary in it, without further instructions. Moving that to a directory in my PATH means I can call kubectl retina ..., but not retina directly.

As this is the only command without kubectl, I would propose to stick to the usage with kubectl retina ....