cli

package
v0.123.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 23, 2025 License: Apache-2.0 Imports: 58 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Analyze added in v0.9.1

func Analyze() *cobra.Command

func ApplyAutoDiscovery added in v0.123.0

func ApplyAutoDiscovery(ctx context.Context, client kubernetes.Interface, restConfig *rest.Config,
	mainBundle *troubleshootv1beta2.SupportBundle, config AutoDiscoveryConfig, namespace string) error

ApplyAutoDiscovery applies auto-discovery to the support bundle spec

func ApplyDiscoveryPatterns added in v0.123.0

func ApplyDiscoveryPatterns(items []string, patterns PatternConfig) ([]string, error)

ApplyDiscoveryPatterns applies include/exclude patterns to a list

func CreateDefaultDiscoveryConfigFile added in v0.123.0

func CreateDefaultDiscoveryConfigFile(configPath string) error

CreateDefaultDiscoveryConfigFile creates a default discovery config file

func CreateImageCollectionOptions added in v0.123.0

func CreateImageCollectionOptions(config AutoDiscoveryConfig) images.CollectionOptions

CreateImageCollectionOptions creates image collection options from CLI config

func Diff added in v0.123.0

func Diff() *cobra.Command

func GetAutoDiscoveryMode added in v0.123.0

func GetAutoDiscoveryMode(args []string, autoEnabled bool) string

GetAutoDiscoveryMode returns the auto-discovery mode based on arguments

func GetDiscoveryConfigPath added in v0.123.0

func GetDiscoveryConfigPath() string

GetDiscoveryConfigPath returns the default path for discovery configuration

func GetDiscoveryProfiles added in v0.123.0

func GetDiscoveryProfiles() map[string]DiscoveryProfile

GetDiscoveryProfiles returns available discovery profiles

func InitAndExecute

func InitAndExecute()

func LintCmd added in v0.123.9

func LintCmd() *cobra.Command

func PrintAutoDiscoveryInfo added in v0.123.0

func PrintAutoDiscoveryInfo(config AutoDiscoveryConfig, mode string)

PrintAutoDiscoveryInfo prints information about auto-discovery configuration

func Redact added in v0.53.0

func Redact() *cobra.Command

func RootCmd

func RootCmd() *cobra.Command

func SaveDiscoveryConfig added in v0.123.0

func SaveDiscoveryConfig(config *DiscoveryConfig, configPath string) error

SaveDiscoveryConfig saves discovery configuration to a file

func Schedule added in v0.123.0

func Schedule() *cobra.Command

Schedule returns the schedule command for managing scheduled support bundle jobs

func ShouldUseAutoDiscovery added in v0.123.0

func ShouldUseAutoDiscovery(v *viper.Viper, args []string) bool

ShouldUseAutoDiscovery determines if auto-discovery should be used

func UploadCmd added in v0.123.0

func UploadCmd() *cobra.Command

func ValidateAutoDiscoveryFlags added in v0.123.0

func ValidateAutoDiscoveryFlags(v *viper.Viper) error

ValidateAutoDiscoveryFlags validates auto-discovery flag combinations

func ValidateTokenizationFlags added in v0.123.0

func ValidateTokenizationFlags(v *viper.Viper) error

ValidateTokenizationFlags validates tokenization flag combinations

func VerifyTokenizationSetup added in v0.123.0

func VerifyTokenizationSetup(v *viper.Viper) error

VerifyTokenizationSetup verifies tokenization configuration without collecting data

Types

type AutoDiscoveryConfig added in v0.123.0

type AutoDiscoveryConfig struct {
	Enabled                 bool
	IncludeImages           bool
	RBACCheck               bool
	Profile                 string
	ExcludeNamespaces       []string
	IncludeNamespaces       []string
	IncludeSystemNamespaces bool
	Timeout                 time.Duration
}

AutoDiscoveryConfig contains configuration for auto-discovery

func GetAutoDiscoveryConfig added in v0.123.0

func GetAutoDiscoveryConfig(v *viper.Viper) AutoDiscoveryConfig

GetAutoDiscoveryConfig extracts auto-discovery configuration from viper

type BundleMetadata added in v0.123.0

type BundleMetadata struct {
	Path      string `json:"path"`
	Size      int64  `json:"size"`
	CreatedAt string `json:"createdAt,omitempty"`
	NumFiles  int    `json:"numFiles"`
}

BundleMetadata contains metadata about a support bundle

type Change added in v0.123.0

type Change struct {
	Type        string                 `json:"type"`     // added, removed, modified
	Category    string                 `json:"category"` // resource, log, config, etc.
	Path        string                 `json:"path"`     // file path or resource path
	Impact      string                 `json:"impact"`   // high, medium, low, none
	Details     map[string]interface{} `json:"details"`  // change-specific details
	Remediation *RemediationStep       `json:"remediation,omitempty"`
}

Change represents a single difference between bundles

type DiffMetadata added in v0.123.0

type DiffMetadata struct {
	OldBundle   BundleMetadata `json:"oldBundle"`
	NewBundle   BundleMetadata `json:"newBundle"`
	GeneratedAt string         `json:"generatedAt"`
	Version     string         `json:"version"`
}

DiffMetadata contains metadata about the diff operation

type DiffResult added in v0.123.0

type DiffResult struct {
	Summary      DiffSummary  `json:"summary"`
	Changes      []Change     `json:"changes"`
	Metadata     DiffMetadata `json:"metadata"`
	Significance string       `json:"significance"`
}

DiffResult represents the result of comparing two support bundles

type DiffSummary added in v0.123.0

type DiffSummary struct {
	TotalChanges      int `json:"totalChanges"`
	FilesAdded        int `json:"filesAdded"`
	FilesRemoved      int `json:"filesRemoved"`
	FilesModified     int `json:"filesModified"`
	HighImpactChanges int `json:"highImpactChanges"`
}

DiffSummary provides high-level statistics about the diff

type DiscoveryConfig added in v0.123.0

type DiscoveryConfig struct {
	Version  string                      `json:"version" yaml:"version"`
	Profiles map[string]DiscoveryProfile `json:"profiles" yaml:"profiles"`
	Patterns DiscoveryPatterns           `json:"patterns" yaml:"patterns"`
}

DiscoveryConfig represents the configuration for auto-discovery

func LoadDiscoveryConfig added in v0.123.0

func LoadDiscoveryConfig(configPath string) (*DiscoveryConfig, error)

LoadDiscoveryConfig loads discovery configuration from file or returns defaults

type DiscoveryPatterns added in v0.123.0

type DiscoveryPatterns struct {
	NamespacePatterns    PatternConfig `json:"namespacePatterns" yaml:"namespacePatterns"`
	ResourceTypePatterns PatternConfig `json:"resourceTypePatterns" yaml:"resourceTypePatterns"`
	RegistryPatterns     PatternConfig `json:"registryPatterns" yaml:"registryPatterns"`
}

DiscoveryPatterns defines inclusion/exclusion patterns for discovery

type DiscoveryProfile added in v0.123.0

type DiscoveryProfile struct {
	Name          string
	Description   string
	IncludeImages bool
	RBACCheck     bool
	MaxDepth      int
	Timeout       time.Duration
}

DiscoveryProfile defines different levels of auto-discovery

type PatternConfig added in v0.123.0

type PatternConfig struct {
	Include []string `json:"include" yaml:"include"`
	Exclude []string `json:"exclude" yaml:"exclude"`
}

PatternConfig defines include/exclude patterns

type RemediationStep added in v0.123.0

type RemediationStep struct {
	Title       string `json:"title"`
	Description string `json:"description"`
	Command     string `json:"command,omitempty"`
	URL         string `json:"url,omitempty"`
}

RemediationStep represents a suggested remediation action

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL