kots

Documentation

Index

• func InitOPALinting() error
• type EnterprisePolicy
• type GVKDoc
• type GVKMetadata
• type LintExpression
  • func EnterpriseLintSpecFiles(specFiles SpecFiles, policies []EnterprisePolicy) ([]LintExpression, error)
  • func LintBuilders(ctx context.Context, files SpecFiles) ([]LintExpression, error)
  • func LintSpecFiles(ctx context.Context, specFiles SpecFiles) ([]LintExpression, bool, error)
  • func TroubleshootLintSpec(spec string) ([]LintExpression, error)
• type LintExpressionItemLinePosition
• type LintExpressionItemPosition
• type LintExpressionsByRule
  • func (a LintExpressionsByRule) Len() int
  • func (a LintExpressionsByRule) Less(i, j int) bool
  • func (a LintExpressionsByRule) Swap(i, j int)
• type OPALintExpression
• type RenderTemplateError
  • func (r RenderTemplateError) Error() string
  • func (r RenderTemplateError) Match() string
• type SpecFile
• type SpecFiles
  • func GetEmbeddedTroubleshootSpecs(ctx context.Context, specsFiles SpecFiles) SpecFiles
  • func GetFilesFromChartReader(ctx context.Context, r io.Reader) (SpecFiles, error)
  • func SpecFilesFromTar(reader io.Reader) (SpecFiles, error)
  • func SpecFilesFromTarGz(tarGz SpecFile) (SpecFiles, error)

Functions

func InitOPALinting

func InitOPALinting() error

Types

type EnterprisePolicy

type EnterprisePolicy struct {
	Name   string `json:"name"`
	Policy string `json:"policy"`
}

type GVKDoc

type GVKDoc struct {
	Kind       string      `yaml:"kind" json:"kind" validate:"required"`
	APIVersion string      `yaml:"apiVersion" json:"apiVersion"`
	Metadata   GVKMetadata `yaml:"metadata" json:"metadata"`
}

type GVKMetadata

type GVKMetadata struct {
	Name      string `yaml:"name" json:"name"`
	Namespace string `yaml:"namespace" json:"namespace"`
}

type LintExpression

type LintExpression struct {
	Rule      string                       `json:"rule"`
	Type      string                       `json:"type"`
	Message   string                       `json:"message"`
	Path      string                       `json:"path"`
	Positions []LintExpressionItemPosition `json:"positions"`
}

func EnterpriseLintSpecFiles

func EnterpriseLintSpecFiles(specFiles SpecFiles, policies []EnterprisePolicy) ([]LintExpression, error)

func LintBuilders

func LintBuilders(ctx context.Context, files SpecFiles) ([]LintExpression, error)

func LintSpecFiles

func LintSpecFiles(ctx context.Context, specFiles SpecFiles) ([]LintExpression, bool, error)

func TroubleshootLintSpec

func TroubleshootLintSpec(spec string) ([]LintExpression, error)

type LintExpressionItemLinePosition

type LintExpressionItemLinePosition struct {
	Line int `json:"line"`
}

type LintExpressionItemPosition

type LintExpressionItemPosition struct {
	Start LintExpressionItemLinePosition `json:"start"`
}

type LintExpressionsByRule

type LintExpressionsByRule []LintExpression

func (LintExpressionsByRule) Len

func (a LintExpressionsByRule) Len() int

func (LintExpressionsByRule) Less

func (a LintExpressionsByRule) Less(i, j int) bool

func (LintExpressionsByRule) Swap

func (a LintExpressionsByRule) Swap(i, j int)

type OPALintExpression

type OPALintExpression struct {
	Rule     string `json:"rule"`
	Type     string `json:"type"`
	Message  string `json:"message"`
	Path     string `json:"path"`
	DocIndex int    `json:"docIndex"`
	Field    string `json:"field"`
	Match    string `json:"match"`
}

type RenderTemplateError

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

func (RenderTemplateError) Error

func (r RenderTemplateError) Error() string

func (RenderTemplateError) Match

func (r RenderTemplateError) Match() string

type SpecFile

type SpecFile struct {
	Name            string    `json:"name"`
	Path            string    `json:"path"`
	Content         string    `json:"content"`
	DocIndex        int       `json:"docIndex,omitempty"`
	AllowDuplicates bool      `json:"allowDuplicates"` // kotskinds can be duplicated if they are coming from secrets or configmaps
	Children        SpecFiles `json:"children"`
}

type SpecFiles

type SpecFiles []SpecFile

func GetEmbeddedTroubleshootSpecs

func GetEmbeddedTroubleshootSpecs(ctx context.Context, specsFiles SpecFiles) SpecFiles

func GetFilesFromChartReader

func GetFilesFromChartReader(ctx context.Context, r io.Reader) (SpecFiles, error)

GetFilesFromChartReader will render chart templates and return the resulting files This function will ignore missing required values. This function will also not validate value types.

func SpecFilesFromTar

func SpecFilesFromTar(reader io.Reader) (SpecFiles, error)

func SpecFilesFromTarGz

func SpecFilesFromTarGz(tarGz SpecFile) (SpecFiles, error)