[Epic] Consolidated CLI for Troubleshoot

[xavpaice]

Goal

The current Troubleshoot project ships command line tools for support-bundle, preflight, analyze and collect. These have a large amount of common functionality with code duplication, plus inconsistent command line switches and syntax.

The proposal is to create a single CLI tool with subcommands for each function, which can be implemented using Krew, to simplify usage and maintenance of the project.

Additionally, the consolidate of sbctl in #882 adds the need for a CLI tool to initiate sbctl, which would end up as a subcommand.

An additional, but no less important, part of this is that the way other projects including KOTS and kURL import Troubleshoot is not using a stable public API, resulting in risk of breaking changes and additional complexity when working within the Troubleshoot code. A consolidated CLI would be a good starting point to arrange for a stable public API which other projects can use long term.

Design Proposal

Private: working backwards doc

• Design proposal for a consolidated Troubleshoot CLI #934

Definition of done

• One CLI entrypoint with subcommands for support-bundle, collect, analyze, redact, preflight and sbctl
• All CLI subcommands call a stable public API which is also available for other projects to import
• Documentation of the consolidated CLI in all necessary documentation pages #1251
• Docs/examples in docs.replicated.com are updated with the new CLI
• Ensure KOTS, Vendor Portal and any other project we discover uses the new API
• Vendor portal provides instructions using the new CLI

Subtasks

• Add version command #89
• Add version command sbctl#26
• [Epic] Consolidation of sbctl and Troubleshoot repos #882
• consolidate preflight and support-bundle into one #883
• Make arguments and flags of cli applications consistent #877
• termui is not actively maintained #789
• Add "standard in" support to support-bundle #1134
• Create "troubleshoot support-bundle" subcommand to succeed the "support-bundle" command #1248
• Create "troubleshoot inspect" subcommand to succeed the "sbctl" command
• Create "troubleshoot preflight" subcommand to succeed the "preflight" command
• Create "troubleshoot redact" subcommand to succeed the "redact" command
• Create "troubleshoot analyze" subcommand to succeed the "analyze" command

Started

• [ ]

Planned

• [ ]