preflight

package
v0.107.5 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2024 License: Apache-2.0 Imports: 44 Imported by: 17

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddFlags added in v0.44.0 

func AddFlags(flags *flag.FlagSet)

func ConcatHostPreflightSpec added in v0.50.0 

func ConcatHostPreflightSpec(target *troubleshootv1beta2.HostPreflight, source *troubleshootv1beta2.HostPreflight) *troubleshootv1beta2.HostPreflight

func ConcatPreflightSpec added in v0.50.0 

func ConcatPreflightSpec(target *troubleshootv1beta2.Preflight, source *troubleshootv1beta2.Preflight) *troubleshootv1beta2.Preflight

func HasStrictAnalyzer added in v0.31.1 

func HasStrictAnalyzer(analyzer *troubleshootv1beta2.Analyze) (bool, error)

HasStrictAnalyzers - checks and returns true if a preflight's analyzer has strict:true, else false

func HasStrictAnalyzers added in v0.31.1 

func HasStrictAnalyzers(preflight *troubleshootv1beta2.Preflight) (bool, error)

HasStrictAnalyzers - checks and returns true if a preflight's analyzer has strict:true, else false

func HasStrictAnalyzersFailed added in v0.31.1 

func HasStrictAnalyzersFailed(preflightResult *UploadPreflightResults) bool

HasStrictAnalyzersFailed - checks if preflight analyzer's result is strict:true and isFail:true, then returns true else false

func RunPreflights added in v0.44.0 

func RunPreflights(interactive bool, output string, format string, args []string) error

Types

type ClusterCollectResult added in v0.10.0 

type ClusterCollectResult struct {
	AllCollectedData map[string][]byte
	Collectors       []collect.Collector
	RemoteCollectors collect.RemoteCollectors

	Spec    *troubleshootv1beta2.Preflight
	Context context.Context
	// contains filtered or unexported fields
}

func (ClusterCollectResult) Analyze added in v0.10.0 

func (c ClusterCollectResult) Analyze() []*analyze.AnalyzeResult

Analyze runs the analyze phase of preflight checks

func (ClusterCollectResult) IsRBACAllowed added in v0.10.0 

func (cr ClusterCollectResult) IsRBACAllowed() bool

type CollectOpts added in v0.9.27 

type CollectOpts struct {
	Namespace              string
	IgnorePermissionErrors bool
	KubernetesRestConfig   *rest.Config
	Image                  string
	PullPolicy             string
	LabelSelector          string
	Timeout                time.Duration
	ProgressChan           chan interface{}

	// Optional path to the bundle directory to store the collected data
	BundlePath string
}

type CollectProgress added in v0.10.11 

type CollectProgress struct {
	CurrentName    string
	CurrentStatus  string
	CompletedCount int
	TotalCount     int
	Collectors     map[string]CollectorStatus
}

func (*CollectProgress) String added in v0.13.4 

func (cp *CollectProgress) String() string

type CollectResult added in v0.9.27 

type CollectResult interface {
	Analyze() []*analyze.AnalyzeResult
	IsRBACAllowed() bool
}

func Collect added in v0.9.27 

func Collect(opts CollectOpts, p *troubleshootv1beta2.Preflight) (CollectResult, error)

Collect runs the collection phase of preflight checks

func CollectHost added in v0.10.0 

func CollectHost(opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)

CollectHost runs the collection phase of host preflight checks

func CollectHostWithContext added in v0.57.0 

func CollectHostWithContext(
	ctx context.Context, opts CollectOpts, p *troubleshootv1beta2.HostPreflight,
) (CollectResult, error)

func CollectRemote added in v0.15.0 

func CollectRemote(opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)

Collect runs the collection phase of preflight checks

func CollectRemoteWithContext added in v0.57.0 

func CollectRemoteWithContext(ctx context.Context, opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)

func CollectWithContext added in v0.57.0 

func CollectWithContext(ctx context.Context, opts CollectOpts, p *troubleshootv1beta2.Preflight) (CollectResult, error)

type CollectorStatus added in v0.28.2 

type CollectorStatus struct {
	Status string
}

type HostCollectResult added in v0.10.0 

type HostCollectResult struct {
	AllCollectedData map[string][]byte
	Collectors       []collect.HostCollector
	Spec             *troubleshootv1beta2.HostPreflight
	Context          context.Context
}

func (HostCollectResult) Analyze added in v0.10.0 

func (c HostCollectResult) Analyze() []*analyze.AnalyzeResult

Analyze runs the analyze phase of host preflight checks

func (HostCollectResult) IsRBACAllowed added in v0.10.0 

func (cr HostCollectResult) IsRBACAllowed() bool

type PreflightFlags added in v0.44.0 

type PreflightFlags struct {
	Interactive               *bool
	Format                    *string
	CollectorImage            *string
	CollectorPullPolicy       *string
	CollectWithoutPermissions *bool
	Selector                  *string
	SinceTime                 *string
	Since                     *string
	Output                    *string
	Debug                     *bool
}

func NewPreflightFlags added in v0.44.0 

func NewPreflightFlags() *PreflightFlags

type RemoteCollectResult added in v0.15.0 

type RemoteCollectResult struct {
	AllCollectedData map[string][]byte
	Collectors       collect.RemoteCollectors
	Spec             *troubleshootv1beta2.HostPreflight
	Context          context.Context
}

func (RemoteCollectResult) Analyze added in v0.15.0 

func (c RemoteCollectResult) Analyze() []*analyze.AnalyzeResult

Analyze runs the analyze phase of host preflight checks.

Runs the analysis for each node and aggregates the results.

func (RemoteCollectResult) IsRBACAllowed added in v0.15.0 

func (cr RemoteCollectResult) IsRBACAllowed() bool

type TextOutput added in v0.70.3 

type TextOutput struct {
	Pass []TextResultOutput `json:"pass,omitempty" yaml:"pass,omitempty"`
	Warn []TextResultOutput `json:"warn,omitempty" yaml:"warn,omitempty"`
	Fail []TextResultOutput `json:"fail,omitempty" yaml:"fail,omitempty"`
}

func ShowTextResultsStructured added in v0.70.3 

func ShowTextResultsStructured(preflightName string, analyzeResults []*analyzerunner.AnalyzeResult) *TextOutput

Used by both JSON and YAML outputs

type TextResultOutput added in v0.70.3 

type TextResultOutput struct {
	Title   string `json:"title" yaml:"title"`
	Message string `json:"message" yaml:"message"`
	URI     string `json:"uri,omitempty" yaml:"uri,omitempty"`
	Strict  bool   `json:"strict,omitempty" yaml:"strict,omitempty"`
}

type UploadPreflightError added in v0.9.27 

type UploadPreflightError struct {
	Error string `json:"error"`
}

type UploadPreflightResult added in v0.9.27 

type UploadPreflightResult struct {
	Strict bool `json:"strict,omitempty"`
	IsFail bool `json:"isFail,omitempty"`
	IsWarn bool `json:"isWarn,omitempty"`
	IsPass bool `json:"isPass,omitempty"`

	Title   string `json:"title"`
	Message string `json:"message"`
	URI     string `json:"uri,omitempty"`
}

type UploadPreflightResults added in v0.9.27 

type UploadPreflightResults struct {
	Results []*UploadPreflightResult `json:"results,omitempty"`
	Errors  []*UploadPreflightError  `json:"errors,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.