analyzer

Documentation

Index

• Variables
• func CheckOpenShift(foundProviders *providers, apiResources []*metav1.APIResourceList, ...) string
• func ExtractTroubleshootBundle(reader io.Reader, destDir string) error
• func FindBundleRootDir(localBundlePath string) (string, error)
• func ParseNodesForProviders(nodes []corev1.Node) (providers, string)
• type AnalyzeResult
  • func Analyze(analyzer *troubleshootv1beta2.Analyze, getFile getCollectedFileContents, ...) ([]*AnalyzeResult, error)
  • func AnalyzeLocal(localBundlePath string, analyzers []*troubleshootv1beta2.Analyze) ([]*AnalyzeResult, error)
  • func DownloadAndAnalyze(bundleURL string, analyzersSpec string) ([]*AnalyzeResult, error)
• type CephHealth
  • func (a CephHealth) Compare(b CephHealth) int
• type Provider

Variables

var CephStatusDefaultOutcomes = []*troubleshootv1beta2.Outcome{
	{
		Pass: &troubleshootv1beta2.SingleOutcome{
			Message: "Ceph is healthy",
		},
	},
	{
		Warn: &troubleshootv1beta2.SingleOutcome{
			Message: "Ceph status is HEALTH_WARN",
			URI:     "https://rook.io/docs/rook/v1.4/ceph-common-issues.html",
		},
	},
	{
		Fail: &troubleshootv1beta2.SingleOutcome{
			Message: "Ceph status is HEALTH_ERR",
			URI:     "https://rook.io/docs/rook/v1.4/ceph-common-issues.html",
		},
	},
}

Functions

func CheckOpenShift

func CheckOpenShift(foundProviders *providers, apiResources []*metav1.APIResourceList, provider string) string

func ExtractTroubleshootBundle

func ExtractTroubleshootBundle(reader io.Reader, destDir string) error

func FindBundleRootDir

func FindBundleRootDir(localBundlePath string) (string, error)

FindBundleRootDir detects whether the bundle is stored inside a subdirectory or not. returns the subdirectory path if so, otherwise, returns the path unchanged

func ParseNodesForProviders

func ParseNodesForProviders(nodes []corev1.Node) (providers, string)

Types

type AnalyzeResult

type AnalyzeResult struct {
	IsPass bool
	IsFail bool
	IsWarn bool

	Title   string
	Message string
	URI     string
	IconKey string
	IconURI string
}

func Analyze

func Analyze(analyzer *troubleshootv1beta2.Analyze, getFile getCollectedFileContents, findFiles getChildCollectedFileContents) ([]*AnalyzeResult, error)

func AnalyzeLocal

func AnalyzeLocal(localBundlePath string, analyzers []*troubleshootv1beta2.Analyze) ([]*AnalyzeResult, error)

Analyze local will analyze a locally available (already downloaded) bundle

func DownloadAndAnalyze

func DownloadAndAnalyze(bundleURL string, analyzersSpec string) ([]*AnalyzeResult, error)

type CephHealth

type CephHealth string

const (
	CephHealthOK   CephHealth = "HEALTH_OK"
	CephHealthWarn CephHealth = "HEALTH_WARN"
	CephHealthErr  CephHealth = "HEALTH_ERR"
)

func (CephHealth) Compare

func (a CephHealth) Compare(b CephHealth) int

type Provider

type Provider int