problem

Documentation

Overview

Package problem helps deliver actionable feedback to a user based on an error message.

Index

• type Problem
  • func FromError(err error, goos string) *Problem
  • func (p *Problem) Display()

Types

type Problem

type Problem struct {
	// ID is an arbitrary unique and stable string describing this issue
	ID string
	// Err is the original error
	Err error
	// Advice is actionable text that the user should follow
	Advice string
	// URL is a reference URL for more information
	URL string
	// Issues are a list of related issues to this problem
	Issues []int
	// Hide the new issue link: it isn't our problem, and we won't be able to suggest additional assistance.
	ShowIssueLink bool
}

Problem represents a known problem in minikube.

func FromError

func FromError(err error, goos string) *Problem

FromError returns a known problem from an error on an OS

func (*Problem) Display

func (p *Problem) Display()

Display problem metadata to the console