config

Documentation

Index

• func StringToLevelHookFunc() mapstructure.DecodeHookFuncType
• type ContainerExcludeRules
• type ContainerRuleExclude
• type ContainerRuleExcludeList
  • func (l ContainerRuleExcludeList) Get() []pkg.ContainerRuleExclude
• type ContainerSettings
• type ConversionsRuleSettings
• type HooksIngressRuleSetting
• type HooksSettings
• type ImageExcludeRules
• type ImageSettings
• type KindRuleExclude
• type KindRuleExcludeList
  • func (l KindRuleExcludeList) Get() []pkg.KindRuleExclude
• type LicenseExcludeRule
• type LintersSettings
  • func (cfg *LintersSettings) MergeGlobal(lcfg *global.Linters)
• type Loader
  • func NewLoader(cfg any, dirs ...string) *Loader
  • func (l *Loader) Load() error
• type LoaderOptions
• type ModuleConfig
• type ModuleDefinitionFileRuleSettings
• type ModuleExcludeRules
• type ModuleOSSRuleSettings
• type ModuleSettings
• type NoCyrillicExcludeRules
• type NoCyrillicSettings
• type OpenAPIExcludeRules
• type OpenAPISettings
• type PatchesRuleSettings
• type PrefixRuleExcludeList
  • func (l PrefixRuleExcludeList) Get() []pkg.PrefixRuleExclude
• type RBACExcludeRules
• type RbacSettings
• type RootConfig
  • func NewDefaultRootConfig(dirs []string) (*RootConfig, error)
• type ServicePortExclude
• type ServicePortExcludeList
  • func (l ServicePortExcludeList) Get() []pkg.ServicePortExclude
• type StringRuleExcludeList
  • func (l StringRuleExcludeList) Get() []pkg.StringRuleExclude
• type TemplatesExcludeRules
• type TemplatesSettings

Functions

func StringToLevelHookFunc

func StringToLevelHookFunc() mapstructure.DecodeHookFuncType

Types

type ContainerExcludeRules

type ContainerExcludeRules struct {
	ControllerSecurityContext KindRuleExcludeList `mapstructure:"controller-security-context"`
	DNSPolicy                 KindRuleExcludeList `mapstructure:"dns-policy"`

	HostNetworkPorts       ContainerRuleExcludeList `mapstructure:"host-network-ports"`
	Ports                  ContainerRuleExcludeList `mapstructure:"ports"`
	ReadOnlyRootFilesystem ContainerRuleExcludeList `mapstructure:"read-only-root-filesystem"`
	ImageDigest            ContainerRuleExcludeList `mapstructure:"image-digest"`
	Resources              ContainerRuleExcludeList `mapstructure:"resources"`
	SecurityContext        ContainerRuleExcludeList `mapstructure:"security-context"`
	Liveness               ContainerRuleExcludeList `mapstructure:"liveness-probe"`
	Readiness              ContainerRuleExcludeList `mapstructure:"readiness-probe"`

	Description StringRuleExcludeList `mapstructure:"description"`
}

type ContainerRuleExclude

type ContainerRuleExclude struct {
	Kind      string `mapstructure:"kind"`
	Name      string `mapstructure:"name"`
	Container string `mapstructure:"container"`
}

type ContainerRuleExcludeList

type ContainerRuleExcludeList []ContainerRuleExclude

func (ContainerRuleExcludeList) Get

func (l ContainerRuleExcludeList) Get() []pkg.ContainerRuleExclude

type ContainerSettings

type ContainerSettings struct {
	ExcludeRules ContainerExcludeRules `mapstructure:"exclude-rules"`

	Impact *pkg.Level `mapstructure:"impact"`
}

type ConversionsRuleSettings

type ConversionsRuleSettings struct {
	// disable conversions rule completely
	Disable bool `mapstructure:"disable"`
}

type HooksIngressRuleSetting

type HooksIngressRuleSetting struct {
	// disable ingress rule completely
	Disable bool `mapstructure:"disable"`
}

type HooksSettings

type HooksSettings struct {
	Ingress HooksIngressRuleSetting `mapstructure:"ingress"`

	Impact *pkg.Level `mapstructure:"impact"`
}

type ImageExcludeRules

type ImageExcludeRules struct {
	SkipImageFilePathPrefix      PrefixRuleExcludeList `mapstructure:"skip-image-file-path-prefix"`
	SkipDistrolessFilePathPrefix PrefixRuleExcludeList `mapstructure:"skip-distroless-file-path-prefix"`
}

type ImageSettings

type ImageSettings struct {
	ExcludeRules ImageExcludeRules `mapstructure:"exclude-rules"`

	Patches PatchesRuleSettings `mapstructure:"patches"`

	Impact *pkg.Level `mapstructure:"impact"`
}

type KindRuleExclude

type KindRuleExclude struct {
	Kind string `mapstructure:"kind"`
	Name string `mapstructure:"name"`
}

type KindRuleExcludeList

type KindRuleExcludeList []KindRuleExclude

func (KindRuleExcludeList) Get

func (l KindRuleExcludeList) Get() []pkg.KindRuleExclude

type LicenseExcludeRule

type LicenseExcludeRule struct {
	Files       StringRuleExcludeList `mapstructure:"files"`
	Directories PrefixRuleExcludeList `mapstructure:"directories"`
}

type LintersSettings

type LintersSettings struct {
	Container  ContainerSettings  `mapstructure:"container"`
	Hooks      HooksSettings      `mapstructure:"hooks"`
	Images     ImageSettings      `mapstructure:"images"`
	Module     ModuleSettings     `mapstructure:"module"`
	NoCyrillic NoCyrillicSettings `mapstructure:"no-cyrillic"`
	OpenAPI    OpenAPISettings    `mapstructure:"openapi"`
	Rbac       RbacSettings       `mapstructure:"rbac"`
	Templates  TemplatesSettings  `mapstructure:"templates"`
}

func (*LintersSettings) MergeGlobal

func (cfg *LintersSettings) MergeGlobal(lcfg *global.Linters)

type Loader

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

func NewLoader

func NewLoader(cfg any, dirs ...string) *Loader

func (*Loader) Load

func (l *Loader) Load() error

type LoaderOptions

type LoaderOptions struct {
	Config string
}

type ModuleConfig

type ModuleConfig struct {
	LintersSettings LintersSettings `mapstructure:"linters-settings"`
}

type ModuleDefinitionFileRuleSettings

type ModuleDefinitionFileRuleSettings struct {
	// disable definition-file rule completely
	Disable bool `mapstructure:"disable"`
}

type ModuleExcludeRules

type ModuleExcludeRules struct {
	License LicenseExcludeRule `mapstructure:"license"`
}

type ModuleOSSRuleSettings

type ModuleOSSRuleSettings struct {
	// disable oss rule completely
	Disable bool `mapstructure:"disable"`
}

type ModuleSettings

type ModuleSettings struct {
	ExcludeRules ModuleExcludeRules `mapstructure:"exclude-rules"`

	OSS            ModuleOSSRuleSettings            `mapstructure:"oss"`
	DefinitionFile ModuleDefinitionFileRuleSettings `mapstructure:"definition-file"`
	Conversions    ConversionsRuleSettings          `mapstructure:"conversions"`

	Impact *pkg.Level `mapstructure:"impact"`
}

type NoCyrillicExcludeRules

type NoCyrillicExcludeRules struct {
	Files       StringRuleExcludeList `mapstructure:"files"`
	Directories PrefixRuleExcludeList `mapstructure:"directories"`
}

type NoCyrillicSettings

type NoCyrillicSettings struct {
	NoCyrillicExcludeRules NoCyrillicExcludeRules `mapstructure:"exclude-rules"`

	Impact *pkg.Level `mapstructure:"impact"`
}

type OpenAPIExcludeRules

type OpenAPIExcludeRules struct {
	KeyBannedNames         []string              `mapstructure:"key-banned-names"`
	EnumFileExcludes       []string              `mapstructure:"enum"`
	HAAbsoluteKeysExcludes StringRuleExcludeList `mapstructure:"ha-absolute-keys"`
}

type OpenAPISettings

type OpenAPISettings struct {
	OpenAPIExcludeRules OpenAPIExcludeRules `mapstructure:"exclude-rules"`

	Impact *pkg.Level `mapstructure:"impact"`
}

type PatchesRuleSettings

type PatchesRuleSettings struct {
	// disable conversions rule completely
	Disable bool `mapstructure:"disable"`
}

type PrefixRuleExcludeList

type PrefixRuleExcludeList []string

func (PrefixRuleExcludeList) Get

func (l PrefixRuleExcludeList) Get() []pkg.PrefixRuleExclude

type RBACExcludeRules

type RBACExcludeRules struct {
	Placement KindRuleExcludeList `mapstructure:"placement"`
	Wildcards KindRuleExcludeList `mapstructure:"wildcards"`
}

type RbacSettings

type RbacSettings struct {
	ExcludeRules RBACExcludeRules `mapstructure:"exclude-rules"`

	Impact *pkg.Level `mapstructure:"impact"`
}

type RootConfig

type RootConfig struct {
	GlobalSettings global.Global `mapstructure:"global"`
}

RootConfig encapsulates the config data specified in the YAML config file.

func NewDefaultRootConfig

func NewDefaultRootConfig(dirs []string) (*RootConfig, error)

type ServicePortExclude

type ServicePortExclude struct {
	Name string `mapstructure:"name"`
	Port string `mapstructure:"port"`
}

type ServicePortExcludeList

type ServicePortExcludeList []ServicePortExclude

func (ServicePortExcludeList) Get

func (l ServicePortExcludeList) Get() []pkg.ServicePortExclude

type StringRuleExcludeList

type StringRuleExcludeList []string

func (StringRuleExcludeList) Get

func (l StringRuleExcludeList) Get() []pkg.StringRuleExclude

type TemplatesExcludeRules

type TemplatesExcludeRules struct {
	VPAAbsent     KindRuleExcludeList    `mapstructure:"vpa"`
	PDBAbsent     KindRuleExcludeList    `mapstructure:"pdb"`
	ServicePort   ServicePortExcludeList `mapstructure:"service-port"`
	KubeRBACProxy StringRuleExcludeList  `mapstructure:"kube-rbac-proxy"`
}

type TemplatesSettings

type TemplatesSettings struct {
	ExcludeRules TemplatesExcludeRules `mapstructure:"exclude-rules"`

	Impact *pkg.Level `mapstructure:"impact"`
}