subctl should be refactored to a library, and make subctl the CLI of that library

[mangelajo]

What would you like to be added:

Splitting subctl in two parts, an interface part, and a library part, the library would contain all the logic
that subctl uses, and a defined Interface that external projects can consume

Why is this needed:

In this way, other projects can use the subctl logic to deploy clusters and brokers in an automated
way without calling the subctl logic from the command line.

Work items:

• Rename apis -> api
  • Depends on Rename /apis to /api #1651
  • Depends on Adjust with subm-operator api rename stolostron/submariner-addon#220
• Move all cobra related stuff to cmd/subctl, Logic called by subctl inside pkg/cmd/subctl for below commands
  • deploy-broker Depends on refactor deploy-broker and version commands #1663
  • join Depends on Move join to its own pkg #1726
  • benchmark Depends on Refactor benchmark cmd #1772
  • verify Depends on Move verify to cmd/subctl #1795
  • version Depends on refactor deploy-broker and version commands #1663
  • diagnose
    • Depends on Refactor pkg/subctl/cmd/diagnose functionality to pkg/diagnose #1994
    • Depends on Add new subctl diagnose command #2015
  • show
    • Changes made in Print out brokers information on subctl show all
    • Depends on Refactor pkg/subctl/cmd/show #2006
  • gather
    • Depends on Use reporter interface & clientproducer for gather #1801
    • Depends on Refactor pkg/subctl/cmd/gather -> internal/gather #2007
    • Depends on Add new subctl gather command #2043
  • cloud
    • Depends on Use reporter.Interface in cmd/cloud #1770
    • Depends on Refactor pkg/subctl/cmd/cloud -> pkg/cloud just for AWS #2013
    • Depends on Refactor pkg/subctl/cmd/cloud/* for GCP #2041
    • Depends on Refactor pkg/subctl/cmd/cloud -> pkg/cloud for generic #2049
    • Depends on Refactor pkg/subctl/cmd/ -> pkg/cloud for RHOS #2048
    • Move all cobra stuff to cmd/subctl/* Depends on New subctl cmds #2061
  • export
    • Depends on Copy export to its own package #1817
  • unexport
    • Depends on Move unexport to new subctl implementation #1983
  • uninstall
    • Depends on Move uninstall command to new subctl implementation #1980
• pkg/internal -> /internal Depends on Add a status reporter to be used in the subctl lib #1705
• Add a generic status handler to all commands Depends on Add a status reporter to be used in the subctl lib #1705
• Handle broker data storage in a more generic way rather than a file Depends on Refactor deploy.Broker to use the client.Producer #1717
• Move packages out of pkg/subctl
  • Depends on Replace utils.ExitOnError->exit.OnErrorWithMessage #1800
  • Depends on Move pkg/subctl/resource to internal/ #1799
  • Depends on Refactor pkg/subctl/operator/common #1761
• Other optimisations
  • Depends on cli.Status should output queued messages in order #1786
  • Depends on Deprecate colour codes, stop sending them to Submariner #1775
  • Depends on Remove unused GlobalCIDRConfigMap field from BrokerOptions #1773
  • Depends on Move pkg/utils/crds to pkg/crd #1743
  • Depends on Move brokercr package under pkg #1740
  • Depends on Refactor pkg/subctl/cmd/execute.go #1804
  • Depends on Make ForCluster return cluster config and name #1806
  • Depends on: Rename clients from submariner and operator repo #1735

Just few examples. Follow
https://github.com/golang-standards/project-layout
https://medium.com/golang-learn/go-project-layout-e5213cdcfaa2
https://vsoch.github.io/2019/go/

[mangelajo]

@mkolesnik ping ^

[mkolesnik]

/cc @skeeey @zhiweiyin318 @qiujian16 would this be useful for your ACM plugin?

[mangelajo]

This would also be beneficial for testing because we could test subctl better by having good interfaces that we can mock.

[github-actions]

This PR/issue depends on:

• Rename /apis to /api #1651
• Adjust with subm-operator api rename stolostron/submariner-addon#220
• refactor deploy-broker and version commands #1663
• Move join to its own pkg #1726
• Refactor benchmark cmd #1772
• Move verify to cmd/subctl #1795
• Refactor pkg/subctl/cmd/diagnose functionality to pkg/diagnose #1994
• Add new subctl diagnose command #2015
• Refactor pkg/subctl/cmd/show #2006
• Use reporter interface & clientproducer for gather #1801
• Refactor pkg/subctl/cmd/gather -> internal/gather #2007
• Add new subctl gather command #2043
• Use reporter.Interface in cmd/cloud #1770
• Refactor pkg/subctl/cmd/cloud -> pkg/cloud just for AWS #2013
• Refactor pkg/subctl/cmd/cloud/* for GCP #2041
• Refactor pkg/subctl/cmd/cloud -> pkg/cloud for generic #2049
• Refactor pkg/subctl/cmd/ -> pkg/cloud for RHOS #2048
• New subctl cmds #2061
• Copy export to its own package #1817
• Move unexport to new subctl implementation #1983
• Move uninstall command to new subctl implementation #1980
• Add a status reporter to be used in the subctl lib #1705
• Refactor deploy.Broker to use the client.Producer #1717
• Replace utils.ExitOnError->exit.OnErrorWithMessage #1800
• Move pkg/subctl/resource to internal/ #1799
• Refactor pkg/subctl/operator/common #1761
• cli.Status should output queued messages in order #1786
• Deprecate colour codes, stop sending them to Submariner #1775
• Remove unused GlobalCIDRConfigMap field from BrokerOptions #1773
• Move pkg/utils/crds to pkg/crd #1743
• Move brokercr package under pkg #1740
• Refactor pkg/subctl/cmd/execute.go #1804
• Make ForCluster return cluster config and name #1806
  By Dependent Issues (🤖). Happy coding!