config

Documentation

Index

• func IsBoolSet(s *bool) bool
• func IsStrSet(s *string) bool
• func SanitizeFileName(name string) string
• type AllocationLimits
• type Allocations
• type BasicAuth
• type Config
  • func NewConfig(flags *Flags) (*Config, error)
  • func (c *Config) AllowedRegistries() []string
  • func (c *Config) CPUResourceLimits() Allocations
  • func (c *Config) ExcludeContainer(gvr types.GVR, fqn, co string) bool
  • func (c *Config) ExcludeFQN(gvr types.GVR, fqn string, cos []string) bool
  • func (c *Config) MEMResourceLimits() Allocations
  • func (c *Config) Match(s rules.Spec) bool
  • func (c *Config) NodeCPULimit() float64
  • func (c *Config) NodeMEMLimit() float64
  • func (c *Config) PodCPULimit() float64
  • func (c *Config) PodMEMLimit() float64
  • func (c *Config) RestartsLimit() int
  • func (c *Config) Sections() []string
• type Flags
  • func NewFlags() *Flags
  • func (f *Flags) Exhaust() string
  • func (f *Flags) IsPersistent() bool
  • func (f *Flags) OutputFormat() string
  • func (f *Flags) Validate() error
• type Limits
• type Node
• type Pod
• type Popeye
  • func NewPopeye() Popeye
  • func (p Popeye) Match(spec rules.Spec) bool
• type PushGateway
• type Resources
• type S3Info
  • func (s *S3Info) Upload(asset string, rwc io.ReadWriteCloser) error

Functions

func IsBoolSet

func IsBoolSet(s *bool) bool

IsBoolSet checks bool option is set

func IsStrSet

func IsStrSet(s *string) bool

IsStrSet checks string option is set.

func SanitizeFileName

func SanitizeFileName(name string) string

SanitizeFileName ensure file spec is valid.

Types

type AllocationLimits

type AllocationLimits struct {
	CPU Allocations `yaml:"cpu"`
	MEM Allocations `yaml:"memory"`
}

AllocationLimits tracks limit thresholds cpu and memory thresholds.

type Allocations

type Allocations struct {
	UnderPerc int `yaml:"underPercUtilization"`
	OverPerc  int `yanl:"overPercUtilization"`
}

Allocations track under/over allocation limits.

type BasicAuth

type BasicAuth struct {
	User     *string
	Password *string
}

BasicAuth tracks basic authentication.

type Config

type Config struct {
	Popeye    `yaml:"popeye"`
	Flags     *Flags
	LintLevel int
}

Config tracks Popeye configuration options.

func NewConfig

func NewConfig(flags *Flags) (*Config, error)

NewConfig create a new Popeye configuration.

func (*Config) AllowedRegistries

func (c *Config) AllowedRegistries() []string

AllowedRegistries tracks allowed docker registries.

func (*Config) CPUResourceLimits

func (c *Config) CPUResourceLimits() Allocations

CPUResourceLimits returns memory over/under allocation thresholds.

func (*Config) ExcludeContainer

func (c *Config) ExcludeContainer(gvr types.GVR, fqn, co string) bool

func (*Config) ExcludeFQN

func (c *Config) ExcludeFQN(gvr types.GVR, fqn string, cos []string) bool

func (*Config) MEMResourceLimits

func (c *Config) MEMResourceLimits() Allocations

MEMResourceLimits returns memory over/under allocation thresholds.

func (*Config) Match

func (c *Config) Match(s rules.Spec) bool

func (*Config) NodeCPULimit

func (c *Config) NodeCPULimit() float64

NodeCPULimit returns the node cpu threshold if set otherwise the default.

func (*Config) NodeMEMLimit

func (c *Config) NodeMEMLimit() float64

NodeMEMLimit returns the pod mem threshold if set otherwise the default.

func (*Config) PodCPULimit

func (c *Config) PodCPULimit() float64

PodCPULimit returns the pod cpu threshold if set otherwise the default.

func (*Config) PodMEMLimit

func (c *Config) PodMEMLimit() float64

PodMEMLimit returns the pod mem threshold if set otherwise the default.

func (*Config) RestartsLimit

func (c *Config) RestartsLimit() int

RestartsLimit returns pod restarts limit.

func (*Config) Sections

func (c *Config) Sections() []string

Sections tracks a collection of internal.

type Flags

type Flags struct {
	*genericclioptions.ConfigFlags

	PushGateway     *PushGateway
	S3              *S3Info
	LintLevel       *string
	Output          *string
	ClearScreen     *bool
	Save            *bool
	OutputFile      *string
	CheckOverAllocs *bool
	AllNamespaces   *bool
	Spinach         *string
	Sections        *[]string
	InClusterName   *string
	StandAlone      bool
	ActiveNamespace *string
	ForceExitZero   *bool
	MinScore        *int
}

Flags represents Popeye CLI flags.

func NewFlags

func NewFlags() *Flags

NewFlags returns new configuration flags.

func (*Flags) Exhaust

func (f *Flags) Exhaust() string

func (*Flags) IsPersistent

func (f *Flags) IsPersistent() bool

func (*Flags) OutputFormat

func (f *Flags) OutputFormat() string

OutputFormat returns the report output format.

func (*Flags) Validate

func (f *Flags) Validate() error

type Limits

type Limits struct {
	CPU    float64 `yaml:"cpu"`
	Memory float64 `yam:"memory"`
}

Limits tracks cpu and mem limits.

type Node

type Node struct {
	Limits Limits `yaml:"limits"`
}

Node tracks node configurations.

type Pod

type Pod struct {
	Restarts int    `yaml:"restarts"`
	Limits   Limits `yaml:"limits"`
}

Pod tracks pod configurations.

type Popeye

type Popeye struct {
	// AllocationLimits tracks global resource allocations.
	AllocationLimits `yaml:"allocations"`

	// Excludes tracks linter exclusions.
	Exclusions rules.Exclusions `yaml:"excludes"`

	// Resources tracks cpu/mem limits.
	Resources Resources `yaml:"resources"`

	// Codes provides to override codes severity.
	Overrides rules.Overrides `yaml:"overrides"`

	// Registries tracks allowed docker registries.
	Registries []string `yaml:"registries"`
}

Popeye tracks Popeye configuration options.

func NewPopeye

func NewPopeye() Popeye

NewPopeye create a new Popeye configuration.

func (Popeye) Match

func (p Popeye) Match(spec rules.Spec) bool

type PushGateway

type PushGateway struct {
	URL       *string
	BasicAuth BasicAuth
}

PushGateway tracks prometheus gateway representations.

type Resources

type Resources struct {
	Node Node `yaml:"node"`
	Pod  Pod  `yaml:"pod"`
}

type S3Info

type S3Info struct {
	Bucket   *string
	Region   *string
	Endpoint *string
}

func (*S3Info) Upload

func (s *S3Info) Upload(asset string, rwc io.ReadWriteCloser) error