preflight

Documentation

Index

• func AddFlags(flags *flag.FlagSet)
• func HasStrictAnalyzer(analyzer *troubleshootv1beta2.Analyze) (bool, error)
• func HasStrictAnalyzers(preflight *troubleshootv1beta2.Preflight) (bool, error)
• func HasStrictAnalyzersFailed(preflightResult *UploadPreflightResults) bool
• func RunPreflights(interactive bool, output, format, arg string) error
• type ClusterCollectResult
  • func (c ClusterCollectResult) Analyze() []*analyze.AnalyzeResult
  • func (cr ClusterCollectResult) IsRBACAllowed() bool
• type CollectOpts
• type CollectProgress
  • func (cp *CollectProgress) String() string
• type CollectResult
  • func Collect(opts CollectOpts, p *troubleshootv1beta2.Preflight) (CollectResult, error)
  • func CollectHost(opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)
  • func CollectRemote(opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)
• type CollectorStatus
• type HostCollectResult
  • func (c HostCollectResult) Analyze() []*analyze.AnalyzeResult
  • func (cr HostCollectResult) IsRBACAllowed() bool
• type PreflightFlags
  • func NewPreflightFlags() *PreflightFlags
• type RemoteCollectResult
  • func (c RemoteCollectResult) Analyze() []*analyze.AnalyzeResult
  • func (cr RemoteCollectResult) IsRBACAllowed() bool
• type UploadPreflightError
• type UploadPreflightResult
• type UploadPreflightResults

Functions

func AddFlags

func AddFlags(flags *flag.FlagSet)

func HasStrictAnalyzer

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

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

func HasStrictAnalyzers

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

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

func HasStrictAnalyzersFailed

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

func RunPreflights(interactive bool, output, format, arg string) error

Types

type ClusterCollectResult

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

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

func (ClusterCollectResult) Analyze

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

Analyze runs the analyze phase of preflight checks

func (ClusterCollectResult) IsRBACAllowed

func (cr ClusterCollectResult) IsRBACAllowed() bool

type CollectOpts

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

type CollectProgress

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

func (*CollectProgress) String

func (cp *CollectProgress) String() string

type CollectResult

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

func Collect

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

Collect runs the collection phase of preflight checks

func CollectHost

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

CollectHost runs the collection phase of host preflight checks

func CollectRemote

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

Collect runs the collection phase of preflight checks

type CollectorStatus

type CollectorStatus struct {
	Status string
}

type HostCollectResult

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

func (HostCollectResult) Analyze

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

Analyze runs the analyze phase of host preflight checks

func (HostCollectResult) IsRBACAllowed

func (cr HostCollectResult) IsRBACAllowed() bool

type PreflightFlags

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

func NewPreflightFlags() *PreflightFlags

type RemoteCollectResult

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

func (RemoteCollectResult) Analyze

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

func (cr RemoteCollectResult) IsRBACAllowed() bool

type UploadPreflightError

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

type UploadPreflightResult

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

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