preflight

Documentation

Index

• type CollectOpts
• type CollectResult
  • func Collect(opts CollectOpts, p *troubleshootv1beta1.Preflight) (CollectResult, error)
  • func (c CollectResult) Analyze() []*analyze.AnalyzeResult
• type UploadPreflightError
• type UploadPreflightResult
• type UploadPreflightResults

Types

type CollectOpts

type CollectOpts struct {
	Namespace              string
	IgnorePermissionErrors bool
	KubernetesRestConfig   *rest.Config
	ProgressChan           chan interface{}
}

type CollectResult

type CollectResult struct {
	AllCollectedData map[string][]byte
	Collectors       collect.Collectors
	IsRBACAllowed    bool
	Spec             *troubleshootv1beta1.Preflight
}

func Collect

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

Collect runs the collection phase of preflight checks

func (CollectResult) Analyze

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

Analyze runs the analyze phase of preflight checks

type UploadPreflightError

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

type UploadPreflightResult

type UploadPreflightResult struct {
	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"`
}