preflight

Documentation

Index

• 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)
• type HostCollectResult
  • func (c HostCollectResult) Analyze() []*analyze.AnalyzeResult
  • func (cr HostCollectResult) IsRBACAllowed() bool
• type UploadPreflightError
• type UploadPreflightResult
• type UploadPreflightResults

Types

type ClusterCollectResult

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

	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
	ProgressChan           chan interface{}
}

type CollectProgress

type CollectProgress struct {
	CurrentName    string
	CurrentStatus  string
	CompletedCount int
	TotalCount     int
}

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

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 analysze phase of host preflight checks

func (HostCollectResult) IsRBACAllowed

func (cr HostCollectResult) IsRBACAllowed() bool

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"`
}