feat(support-bundle): add runHostCollectorsInPod in spec (#1608)

cmd/troubleshoot/cli/run.go

@@ -9,6 +9,7 @@ import (
 	"os"
 	"os/signal"
 	"path/filepath"
+	"reflect"
 	"sync"
 	"time"
 
@@ -183,6 +184,7 @@ func runTroubleshoot(v *viper.Viper, args []string) error {
 		OutputPath:                v.GetString("output"),
 		Redact:                    v.GetBool("redact"),
 		FromCLI:                   true,
+		RunHostCollectorsInPod:    mainBundle.Metadata.RunHostCollectorsInPod,
 	}
 
 	nonInteractiveOutput := analysisOutput{}
@@ -197,7 +199,7 @@ func runTroubleshoot(v *viper.Viper, args []string) error {
 
 	if len(response.AnalyzerResults) > 0 {
 		if interactive {
-			if err := showInteractiveResults(mainBundle.Name, response.AnalyzerResults, response.ArchivePath); err != nil {
+			if err := showInteractiveResults(mainBundle.Metadata.Name, response.AnalyzerResults, response.ArchivePath); err != nil {
 				interactive = false
 			}
 		} else {
@@ -206,7 +208,7 @@ func runTroubleshoot(v *viper.Viper, args []string) error {
 	}
 
 	if !response.FileUploaded {
-		if appName := mainBundle.Labels["applicationName"]; appName != "" {
+		if appName := mainBundle.Metadata.Labels["applicationName"]; appName != "" {
 			f := `A support bundle for %s has been created in this directory
 named %s. Please upload it on the Troubleshoot page of
 the %s Admin Console to begin analysis.`
@@ -335,14 +337,25 @@ func loadSpecs(ctx context.Context, args []string, client kubernetes.Interface)
 			APIVersion: "troubleshoot.sh/v1beta2",
 			Kind:       "SupportBundle",
 		},
-		ObjectMeta: metav1.ObjectMeta{
-			Name: "merged-support-bundle-spec",
+		Metadata: troubleshootv1beta2.SupportBundleMetadata{
+			ObjectMeta: metav1.ObjectMeta{
+				Name: "merged-support-bundle-spec",
+			},
+			RunHostCollectorsInPod: false,
 		},
 	}
+
+	var enableRunHostCollectorsInPod bool
+
 	for _, sb := range kinds.SupportBundlesV1Beta2 {
 		sb := sb
 		mainBundle = supportbundle.ConcatSpec(mainBundle, &sb)
+		//check if sb has metadata and if it has RunHostCollectorsInPod set to true
+		if !reflect.DeepEqual(sb.Metadata.ObjectMeta, metav1.ObjectMeta{}) && sb.Metadata.RunHostCollectorsInPod {
+			enableRunHostCollectorsInPod = sb.Metadata.RunHostCollectorsInPod
+		}
 	}
+	mainBundle.Metadata.RunHostCollectorsInPod = enableRunHostCollectorsInPod
 
 	for _, c := range kinds.CollectorsV1Beta2 {
 		mainBundle.Spec.Collectors = util.Append(mainBundle.Spec.Collectors, c.Spec.Collectors)

config/crds/troubleshoot.sh_hostpreflights.yaml

@@ -1860,6 +1860,13 @@ spec:
                       - backgroundWriteIOPSJobs
                       - enableBackgroundIOPS
                       type: object
+                    hostOS:
+                      properties:
+                        collectorName:
+                          type: string
+                        exclude:
+                          type: BoolString
+                      type: object
                     hostServices:
                       properties:
                         collectorName:

config/crds/troubleshoot.sh_preflights.yaml

@@ -18703,6 +18703,13 @@ spec:
                       - backgroundWriteIOPSJobs
                       - enableBackgroundIOPS
                       type: object
+                    hostOS:
+                      properties:
+                        collectorName:
+                          type: string
+                        exclude:
+                          type: BoolString
+                      type: object
                     hostServices:
                       properties:
                         collectorName:

config/crds/troubleshoot.sh_remotecollectors.yaml

@@ -193,6 +193,13 @@ spec:
                       - backgroundWriteIOPSJobs
                       - enableBackgroundIOPS
                       type: object
+                    hostOS:
+                      properties:
+                        collectorName:
+                          type: string
+                        exclude:
+                          type: BoolString
+                      type: object
                     hostServices:
                       properties:
                         collectorName:

pkg/apis/troubleshoot/v1beta2/remote_collector_shared.go

@@ -16,6 +16,9 @@ type RemoteCollectorMeta struct {
 type RemoteCPU struct {
 	RemoteCollectorMeta `json:",inline" yaml:",inline"`
 }
+type RemoteHostOS struct {
+	RemoteCollectorMeta `json:",inline" yaml:",inline"`
+}
 
 type RemoteMemory struct {
 	RemoteCollectorMeta `json:",inline" yaml:",inline"`
@@ -170,6 +173,7 @@ type RemoteCollect struct {
 	FilesystemPerformance *RemoteFilesystemPerformance `json:"filesystemPerformance,omitempty" yaml:"filesystemPerformance,omitempty"`
 	Certificate           *RemoteCertificate           `json:"certificate,omitempty" yaml:"certificate,omitempty"`
 	HostServices          *RemoteServices              `json:"hostServices,omitempty" yaml:"hostServices,omitempty"`
+	HostOS                *RemoteHostOS                `json:"hostOS,omitempty" yaml:"hostOS,omitempty"`
 }
 
 func (c *RemoteCollect) AccessReviewSpecs(overrideNS string) []authorizationv1.SelfSubjectAccessReviewSpec {

pkg/apis/troubleshoot/v1beta2/supportbundle_types.go

@@ -20,6 +20,11 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+type SupportBundleMetadata struct {
+	metav1.ObjectMeta      `json:",inline" yaml:",inline"`
+	RunHostCollectorsInPod bool `json:"runHostCollectorsInPod,omitempty" yaml:"runHostCollectorsInPod,omitempty"`
+}
+
 // SupportBundleSpec defines the desired state of SupportBundle
 type SupportBundleSpec struct {
 	AfterCollection []*AfterCollection `json:"afterCollection,omitempty" yaml:"afterCollection,omitempty"`
@@ -43,8 +48,8 @@ type SupportBundleStatus struct {
 // SupportBundle is the Schema for the SupportBundles API
 // +k8s:openapi-gen=true
 type SupportBundle struct {
-	metav1.TypeMeta   `json:",inline" yaml:",inline"`
-	metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`
+	metav1.TypeMeta `json:",inline" yaml:",inline"`
+	Metadata        SupportBundleMetadata `json:"metadata,omitempty" yaml:"metadata,omitempty"`
 
 	Spec   SupportBundleSpec   `json:"spec,omitempty" yaml:"spec,omitempty"`
 	Status SupportBundleStatus `json:"status,omitempty"`

pkg/collect/cluster_resources_test.go

@@ -481,9 +481,11 @@ func TestCollectClusterResources_CustomResource(t *testing.T) {
 
 	// Create a CR
 	sbObject := troubleshootv1beta2.SupportBundle{
-		ObjectMeta: metav1.ObjectMeta{
-			Name:      "supportbundle",
-			Namespace: "default",
+		Metadata: troubleshootv1beta2.SupportBundleMetadata{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "supportbundle",
+				Namespace: "default",
+			},
 		},
 		TypeMeta: metav1.TypeMeta{
 			Kind:       "SupportBundle",

pkg/collect/collect.go

@@ -15,8 +15,9 @@ import (
 var (
 	// ErrCollectorNotFound is returned when an undefined host collector is
 	// specified by the user.
-	ErrHostCollectorNotFound        = errors.New("unrecognized host collector")
-	ErrInsufficientPermissionsToRun = errors.New("insufficient permissions to run all collectors")
+	ErrHostCollectorNotFound         = errors.New("unrecognized host collector")
+	ErrInsufficientPermissionsToRun  = errors.New("insufficient permissions to run all collectors")
+	ErrRemoteCollectorNotImplemented = errors.New("unimplemented remote collector")
 )
 
 type CollectorRunOpts struct {
@@ -28,7 +29,8 @@ type CollectorRunOpts struct {
 	PullPolicy                string
 	LabelSelector             string
 	Timeout                   time.Duration
-	ProgressChan              chan interface{}
+	ProgressChan              chan<- interface{}
+	NamePrefix                string
 }
 
 type CollectProgress struct {
@@ -48,7 +50,7 @@ type RemoteCollectResult struct {
 	AllCollectedData map[string][]byte
 	Collectors       RemoteCollectors
 	Spec             *troubleshootv1beta2.RemoteCollector
-	isRBACAllowed    bool
+	IsRBACAllowed    bool
 }
 
 // CollectHost runs the collection phase for a local collector.
@@ -107,6 +109,7 @@ func CollectRemote(c *troubleshootv1beta2.RemoteCollector, additionalRedactors *
 			LabelSelector: opts.LabelSelector,
 			Namespace:     opts.Namespace,
 			Timeout:       opts.Timeout,
+			NamePrefix:    opts.NamePrefix,
 		}
 		collectors = append(collectors, &collector)
 	}
@@ -129,7 +132,7 @@ func CollectRemote(c *troubleshootv1beta2.RemoteCollector, additionalRedactors *
 	}
 
 	if foundForbidden && !opts.CollectWithoutPermissions {
-		collectResult.isRBACAllowed = false
+		collectResult.IsRBACAllowed = false
 		return collectResult, ErrInsufficientPermissionsToRun
 	}
 

pkg/collect/host_block_device.go

@@ -108,3 +108,7 @@ func parseLsblkOutput(output []byte) ([]BlockDeviceInfo, error) {
 
 	return devices, nil
 }
+
+func (c *CollectHostBlockDevices) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_certificate.go

@@ -77,3 +77,7 @@ func isEncryptedKey(filename string) (bool, error) {
 	}
 	return bytes.Contains(data, []byte("ENCRYPTED")), nil
 }
+
+func (c *CollectHostCertificate) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_certificates_collection.go

@@ -104,3 +104,7 @@ func HostCertsParser(certPath string) HostCertificatesCollection {
 		Message:          CertValid,
 	}
 }
+
+func (c *CollectHostCertificatesCollection) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_cgroup.go

@@ -97,3 +97,7 @@ func parseV1ControllerNames(r io.Reader) ([]string, error) {
 
 	return names, nil
 }
+
+func (c *CollectHostCGroups) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_collector.go

@@ -8,6 +8,7 @@ type HostCollector interface {
 	Title() string
 	IsExcluded() (bool, error)
 	Collect(progressChan chan<- interface{}) (map[string][]byte, error)
+	RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) // RemoteCollect is used to priviledge pods to collect data from different nodes
 }
 
 func GetHostCollector(collector *troubleshootv1beta2.HostCollect, bundlePath string) (HostCollector, bool) {

pkg/collect/host_copy.go

@@ -137,3 +137,7 @@ func (c *CollectHostCopy) copyDir(src, dst string, result CollectorResult) error
 
 	return nil
 }
+
+func (c *CollectHostCopy) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_cpu.go

@@ -54,3 +54,7 @@ func (c *CollectHostCPU) Collect(progressChan chan<- interface{}) (map[string][]
 
 	return output, nil
 }
+
+func (c *CollectHostCPU) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_disk_usage.go

@@ -86,3 +86,7 @@ func traverseFiletreeDirExists(filename string) (string, error) {
 	}
 	return "", errors.New("max recursion exceeded")
 }
+
+func (c *CollectHostDiskUsage) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_dns.go

@@ -203,3 +203,7 @@ func queryDNS(name, query, server string) DNSEntry {
 	}
 	return entry
 }
+
+func (c *CollectHostDNS) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_filesystem_performance.go

@@ -460,3 +460,7 @@ func collectFioResults(ctx context.Context, hostCollector *troubleshootv1beta2.F
 
 	return &result, nil
 }
+
+func (c *CollectHostFilesystemPerformance) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_http.go

@@ -65,3 +65,7 @@ func (c *CollectHostHTTP) Collect(progressChan chan<- interface{}) (map[string][
 
 	return httpOutput, nil
 }
+
+func (c *CollectHostHTTP) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}

pkg/collect/host_httploadbalancer.go

@@ -181,3 +181,7 @@ func attemptPOST(address string, request []byte, response []byte) NetworkStatus
 
 	return NetworkStatusConnected
 }
+
+func (c *CollectHostHTTPLoadBalancer) RemoteCollect(progressChan chan<- interface{}) (map[string][]byte, error) {
+	return nil, ErrRemoteCollectorNotImplemented
+}