Spike - Document command sematics
There is a need to have a structure to the commands we will be using that aligns with other open source tools and makes sense for a user.
Acceptance Criteria
- Document what format the cli tool will look like when invoking the tool.
bbctl<verb><objects>
- Document how we will be structuring and incorporating flags into the command.
- Namespace (
-n <namespace-here>
) - kubeconfig (
--kubeconfig </path/to/config>
) - Help (
<item you need help with> -h
)
- Namespace (
- Document how we plan to incorporate env vars into the cli tool
- We will plan to use the default env var for kubeconfig so users don't have to specify the path.
Questions to ask
- Considering the various tools that are being wrapped what format should we use
<command><verb><object> ?
Or, something else?- helm
- kubectl
- flux
- istioctl
- crictl
- etc...
Edited by Talha Siddique