source

Documentation

Index

• Variables
• func GetAllConfigurableSources() map[string]ConfigurableSource
• func GetAllFeatureSources() map[string]FeatureSource
• func GetAllLabelSources() map[string]LabelSource
• func Register(s Source)
• type Config
• type ConfigurableSource
  • func GetConfigurableSource(name string) ConfigurableSource
• type FeatureLabelValue
• type FeatureLabels
• type FeatureSource
  • func GetFeatureSource(name string) FeatureSource
• type HostDir
  • func (d HostDir) Path(elem ...string) string
• type LabelSource
  • func GetLabelSource(name string) LabelSource
• type MockLabelSource
  • func (_m *MockLabelSource) GetLabels() (FeatureLabels, error)
  • func (_m *MockLabelSource) Name() string
  • func (_m *MockLabelSource) Priority() int
• type Source
• type SupplementalSource

Variables

var (

	// BootPath is where the /boot directory of the system to be inspected is located
	BootDir = HostDir(pathPrefix + "boot")
	// EtcPath is where the /etc directory of the system to be inspected is located
	EtcDir = HostDir(pathPrefix + "etc")
	// SysfsPath is where the /sys directory of the system to be inspected is located
	SysfsDir = HostDir(pathPrefix + "sys")
	// UsrPath is where the /usr directory of the system to be inspected is located
	UsrDir = HostDir(pathPrefix + "usr")
	// VarPath is where the /var directory of the system to be inspected is located
	VarDir = HostDir(pathPrefix + "var")
)

Functions

func GetAllConfigurableSources

func GetAllConfigurableSources() map[string]ConfigurableSource

GetAllConfigurableSources returns all registered configurable sources

func GetAllFeatureSources

func GetAllFeatureSources() map[string]FeatureSource

GetAllFeatureSources returns all registered label sources

func GetAllLabelSources

func GetAllLabelSources() map[string]LabelSource

GetAllLabelSources returns all registered label sources

func Register

func Register(s Source)

RegisterSource registers a source

Types

type Config

type Config interface {
}

Config is the generic interface for source configuration data

type ConfigurableSource

type ConfigurableSource interface {
	Source

	// NewConfig returns a new default config of the source
	NewConfig() Config

	// GetConfig returns the effective configuration of the source
	GetConfig() Config

	// SetConfig changes the effective configuration of the source
	SetConfig(Config)
}

ConfigurableSource is an interface for a source that can be configured

func GetConfigurableSource

func GetConfigurableSource(name string) ConfigurableSource

GetConfigurableSource a registered configurable source

type FeatureLabelValue

type FeatureLabelValue interface{}

FeatureLabelValue represents the value of one feature label

type FeatureLabels

type FeatureLabels map[string]FeatureLabelValue

FeatureLabels is a collection of feature labels

type FeatureSource

type FeatureSource interface {
	Source

	// Discover does feature discovery
	Discover() error

	// GetFeatures returns discovered features in raw form
	GetFeatures() *feature.DomainFeatures
}

FeatureSource is an interface for discovering node features

func GetFeatureSource

func GetFeatureSource(name string) FeatureSource

GetFeatureSource returns a registered FeatureSource interface

type HostDir

type HostDir string

HostDir is a helper for handling host system directories

func (HostDir) Path

func (d HostDir) Path(elem ...string) string

Path returns a full path to a file under HostDir

type LabelSource

type LabelSource interface {
	Source

	// GetLabels returns discovered feature labels
	GetLabels() (FeatureLabels, error)

	// Priority returns the priority of the source
	Priority() int
}

LabelSource represents a source of node feature labels

func GetLabelSource

func GetLabelSource(name string) LabelSource

GetLabelSource a registered label source

type MockLabelSource

type MockLabelSource struct {
	mock.Mock
}

MockLabelSource is an autogenerated mock type for the LabelSource type

func (*MockLabelSource) GetLabels

func (_m *MockLabelSource) GetLabels() (FeatureLabels, error)

GetLabels provides a mock function with given fields:

func (*MockLabelSource) Name

func (_m *MockLabelSource) Name() string

Name provides a mock function with given fields:

func (*MockLabelSource) Priority

func (_m *MockLabelSource) Priority() int

Priority provides a mock function with given fields:

type Source

type Source interface {
	// Name returns a friendly name for this source
	Name() string
}

Source is the base interface for all other source interfaces

type SupplementalSource

type SupplementalSource interface {
	Source

	// DisableByDefault returns true if the source should be disabled by
	// default in production.
	DisableByDefault() bool
}

SupplementalSource represents a source that does not belong to the core set sources to be used in production, e.g. is deprecated, very experimental or purposed for testing only.