metadata

Documentation

Index

• Constants
• Variables
• func CheckMetadataSearchOrder(order string) error
• func Clear()
• func GetDevicePath(volumeID string) (string, error)
• func Set(value *Metadata)
• type DeviceMetadata
• type IMetadata
  • func GetMetadataProvider(order string) IMetadata
• type Metadata
  • func Get(order string) (*Metadata, error)
• type MetadataMock
  • func (_m *MetadataMock) GetAvailabilityZone() (string, error)
  • func (_m *MetadataMock) GetInstanceID() (string, error)
• type MetadataOpts

Constants

const (

	// MetadataID is used as an identifier on the metadata search order configuration.
	MetadataID = "metadataService"

	// ConfigDriveID is used as an identifier on the metadata search order configuration.
	ConfigDriveID = "configDrive"
)

Variables

var ErrBadMetadata = errors.New("invalid OpenStack metadata, got empty uuid")

ErrBadMetadata is used to indicate a problem parsing data from metadata server

Functions

func CheckMetadataSearchOrder

func CheckMetadataSearchOrder(order string) error

func Clear

func Clear()

Clear clears the metadatacache

func GetDevicePath

func GetDevicePath(volumeID string) (string, error)

GetDevicePath retrieves device path from metadata service

func Set

func Set(value *Metadata)

Set sets the value of metadatacache

Types

type DeviceMetadata

type DeviceMetadata struct {
	Type    string `json:"type"`
	Bus     string `json:"bus,omitempty"`
	Serial  string `json:"serial,omitempty"`
	Address string `json:"address,omitempty"`
}

DeviceMetadata is a single/simplified data structure for all kinds of device metadata types.

type IMetadata

type IMetadata interface {
	GetInstanceID() (string, error)
	GetAvailabilityZone() (string, error)
}

IMetadata implements GetInstanceID & GetAvailabilityZone

var MetadataService IMetadata

MetadataService instance of IMetadata

func GetMetadataProvider

func GetMetadataProvider(order string) IMetadata

GetMetadataProvider retrieves instance of IMetadata

type Metadata

type Metadata struct {
	UUID             string           `json:"uuid"`
	Name             string           `json:"name"`
	AvailabilityZone string           `json:"availability_zone"`
	Devices          []DeviceMetadata `json:"devices,omitempty"`
}

Metadata has the information fetched from OpenStack metadata service or config drives. Assumes the "latest" meta_data.json format.

func Get

func Get(order string) (*Metadata, error)

Get retrieves metadata from either config drive or metadata service. Search order depends on the order set in config file.

type MetadataMock

type MetadataMock struct {
	mock.Mock
}

MetadataMock is an autogenerated mock type for the IMetadata type

func (*MetadataMock) GetAvailabilityZone

func (_m *MetadataMock) GetAvailabilityZone() (string, error)

GetAvailabilityZone provides a mock function with given fields:

func (*MetadataMock) GetInstanceID

func (_m *MetadataMock) GetInstanceID() (string, error)

GetInstanceID provides a mock function with given fields:

type MetadataOpts

type MetadataOpts struct {
	SearchOrder    string          `gcfg:"search-order"`
	RequestTimeout util.MyDuration `gcfg:"request-timeout"`
}

MetadataOpts is used for configuring how to talk to metadata service or config drive