config

Documentation

Index

• Variables
• func IsCouldNotParseConfigFile(e error) bool
• func IsCouldNotReadConfigFile(e error) bool
• type CRDItem
• type Deprecation
• type DeprecationReplacedBy
• type FromFile
  • func Read(path string) (*FromFile, error)
• type SourceRepository

Variables

var CouldNotParseConfigFileError = &microerror.Error{
	Kind: "CouldNotParseConfigFileError",
	Desc: "The configuration file could not be parsed.",
}

var CouldNotReadConfigFileError = &microerror.Error{
	Kind: "CouldNotReadConfigFileError",
	Desc: "The configuration file could not be read.",
}

Functions

func IsCouldNotParseConfigFile

func IsCouldNotParseConfigFile(e error) bool

IsCouldNotParseConfigFile asserts CouldNotParseConfigFileError

func IsCouldNotReadConfigFile

func IsCouldNotReadConfigFile(e error) bool

IsCouldNotReadConfigFile asserts CouldNotReadConfigFileError

Types

type CRDItem

type CRDItem struct {
	Owners      []string     `yaml:"owner,omitempty"`
	Topics      []string     `yaml:"topics,omitempty"`
	Providers   []string     `yaml:"provider,omitempty"`
	Hidden      bool         `yaml:"hidden,omitempty"`
	Deprecation *Deprecation `yaml:"deprecation,omitempty"`
}

type Deprecation

type Deprecation struct {
	Info       string                 `yaml:"info,omitempty"`
	ReplacedBy *DeprecationReplacedBy `yaml:"replaced_by,omitempty"`
}

type DeprecationReplacedBy

type DeprecationReplacedBy struct {
	FullName  string `yaml:"full_name"`
	ShortName string `yaml:"short_name"`
}

type FromFile

type FromFile struct {
	SourceRepositories []SourceRepository `yaml:"source_repositories"`
	TemplatePath       string             `yaml:"template_path"`
	OutputPath         string             `yaml:"output_path"`
}

FromFile represent a config file content.

func Read

func Read(path string) (*FromFile, error)

Read reads a config file and returns a struct.

type SourceRepository

type SourceRepository struct {
	URL             string             `yaml:"url"`
	Organization    string             `yaml:"organization"`
	ShortName       string             `yaml:"short_name"`
	Metadata        map[string]CRDItem `yaml:"metadata"`
	CommitReference string             `yaml:"commit_reference"`
	AnnotationsPath []string           `yaml:"annotations_paths"`
	CRDPaths        []string           `yaml:"crd_paths"`
	CRPaths         []string           `yaml:"cr_paths"`
}

SourceRepository has details about a source repository to find CRDs in.