pkg

Documentation

Index

• Variables
• func NopWriter(i io.ReadWriter) io.ReadWriteCloser
• type Popeye
  • func NewPopeye(flags *config.Flags, log *zerolog.Logger) (*Popeye, error)
  • func (p *Popeye) Do(req *http.Request) (*http.Response, error)
  • func (p *Popeye) Init() error
  • func (p *Popeye) Sanitize() (int, int, error)
  • func (p *Popeye) SetFactory(f types.Factory)
  • func (p *Popeye) SetOutputTarget(s io.ReadWriteCloser)

Variables

var (
	// LogFile the path to our logs.
	LogFile = filepath.Join(os.TempDir(), "popeye.log")
	// DumpDir indicates a directory location for sanitizer reports.
	DumpDir = dumpDir()
	// ErrUnknownS3BucketProtocol defines the error if we can't parse the S3 URI
	ErrUnknownS3BucketProtocol = errors.New("invalid S3 URI: hostname not valid")
)

Functions

func NopWriter

func NopWriter(i io.ReadWriter) io.ReadWriteCloser

NopWriter fake writer.

Types

type Popeye

type Popeye struct {
	// contains filtered or unexported fields
}

Popeye represents a kubernetes linter/sanitizer.

func NewPopeye

func NewPopeye(flags *config.Flags, log *zerolog.Logger) (*Popeye, error)

NewPopeye returns a new instance.

func (*Popeye) Do

func (p *Popeye) Do(req *http.Request) (*http.Response, error)

Do implements the HTTPDoer interface to replace the standard http client push request and write to the outputTarget

func (*Popeye) Init

func (p *Popeye) Init() error

Init configures popeye prior to sanitization.

func (*Popeye) Sanitize

func (p *Popeye) Sanitize() (int, int, error)

Sanitize scans a cluster for potential issues.

func (*Popeye) SetFactory

func (p *Popeye) SetFactory(f types.Factory)

SetFactory sets the resource factory.

func (*Popeye) SetOutputTarget

func (p *Popeye) SetOutputTarget(s io.ReadWriteCloser)

SetOutputTarget sets up a new output stream writer.