platform

Documentation

Index

• Variables
• func Names() (names []string)
• func Register(provider Provider)
• type Config
  • func Get(name string) (config Config, ok bool)
  • func MustGet(name string) Config
  • func NewConfig(provider Provider) Config
  • func (c Config) DelConfig(f *resource.Fetcher) error
  • func (c Config) Fetch(f *resource.Fetcher, state *state.State) (types.Config, report.Report, error)
  • func (c Config) Init(f *resource.Fetcher) error
  • func (c Config) Name() string
  • func (c Config) NewFetcher(l *log.Logger) (resource.Fetcher, error)
  • func (c Config) Status(stageName string, f resource.Fetcher, statusErr error) error
• type Name
  • func (s *Name) Set(val string) error
  • func (s Name) String() string
• type Provider

Variables

var (
	ErrCannotDelete = errors.New("cannot delete config on this platform")
	ErrNoProvider   = errors.New("config provider was not online")
)

Functions

func Names

func Names() (names []string)

func Register

func Register(provider Provider)

Types

type Config

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

Config defines the capabilities of a particular platform, for use by the rest of Ignition.

func Get

func Get(name string) (config Config, ok bool)

func MustGet

func MustGet(name string) Config

func NewConfig

func NewConfig(provider Provider) Config

Helper function for wrapping a Provider, for use by specialized providers that don't want to add themselves to the registry.

func (Config) DelConfig

func (c Config) DelConfig(f *resource.Fetcher) error

func (Config) Fetch

func (c Config) Fetch(f *resource.Fetcher, state *state.State) (types.Config, report.Report, error)

func (Config) Init

func (c Config) Init(f *resource.Fetcher) error

Init performs additional fetcher configuration post-config fetch. This ensures that networking is already available if a platform needs to reach out to the metadata service to fetch additional options / data.

func (Config) Name

func (c Config) Name() string

func (Config) NewFetcher

func (c Config) NewFetcher(l *log.Logger) (resource.Fetcher, error)

func (Config) Status

func (c Config) Status(stageName string, f resource.Fetcher, statusErr error) error

Status takes a Fetcher and the error from Run (from engine)

type Name

type Name string

Name is used to identify an platform. It must be in the set of registered platforms.

func (*Name) Set

func (s *Name) Set(val string) error

func (Name) String

func (s Name) String() string

type Provider

type Provider struct {
	Name       string
	NewFetcher func(logger *log.Logger) (resource.Fetcher, error)
	Fetch      func(f *resource.Fetcher) (types.Config, report.Report, error)
	Init       func(f *resource.Fetcher) error
	Status     func(stageName string, f resource.Fetcher, e error) error
	DelConfig  func(f *resource.Fetcher) error

	// Fetch, and also save output files to be written during files stage.
	// Avoid, unless you're certain you need it.
	FetchWithFiles func(f *resource.Fetcher) ([]types.File, types.Config, report.Report, error)
}

Provider is the struct that platform implementations use to define their capabilities for use by this package.